Integrate finitediff into argmin monorepo

.github/workflows/ci.yml

@@ -81,6 +81,15 @@ jobs:
       - name: Test (testfunctions)
         run: cargo test -p argmin_testfunctions
 
+  tests-finitediff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: Swatinem/rust-cache@v2
+      - uses: dtolnay/rust-toolchain@stable
+      - name: Test (testfunctions)
+        run: cargo test -p finitediff --all-features
+
   tests-argmin-math:
     runs-on: ubuntu-latest
     steps:

crates/argmin/Cargo.toml

@@ -31,7 +31,7 @@ serde = { version = "1.0", features = ["derive"], optional = true }
 
 [dev-dependencies]
 approx = "0.5.0"
-finitediff = { version = "0.1.4", features = ["ndarray"] }
+finitediff = { version = "0.1.4", path = "../finitediff", features = ["ndarray"] }
 argmin_testfunctions = { version = "0.2.0", path = "../argmin-testfunctions" }
 ndarray = { version = "0.15", features = ["serde-1"] }
 ndarray-linalg = { version = "0.16", features = ["intel-mkl-static"] }

crates/argmin/src/solver/brent/brentopt.rs

@@ -1,4 +1,4 @@
-// Copyright 2018-2020 argmin developers
+// Copyright 2018-2024 argmin developers
 //
 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
 // http://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or

crates/finitediff/Cargo.toml

@@ -0,0 +1,17 @@
+[package]
+name = "finitediff"
+version = "0.1.4"
+authors = ["Stefan Kroboth <[email protected]>"]
+edition = "2021"
+license = "MIT OR Apache-2.0"
+description = "Finite/numerical differentiation"
+documentation = "https://docs.rs/finitediff/"
+homepage = "http://argmin-rs.org"
+repository = "https://github.com/argmin-rs/argmin"
+readme = "README.md"
+keywords = ["differentiation", "optimization", "math", "science"]
+categories = ["science"]
+
+[dependencies]
+ndarray = { version = "0.15.0", optional = true }
+num = "0.4.1"

crates/finitediff/README.md

@@ -0,0 +1,22 @@
+[![Build Status](https://travis-ci.org/argmin-rs/finitediff.svg?branch=master)](https://travis-ci.org/argmin-rs/finitediff)
+[![Gitter chat](https://badges.gitter.im/argmin-rs/community.png)](https://gitter.im/argmin-rs/community)
+
+# finitediff: Finite Differentiation
+
+This crate contains a wide range of methods for the calculation of gradients, Jacobians and Hessians using forward and central differences.
+The methods have been implemented for input vectors of the type `Vec<f64>` and `ndarray::Array1<f64>`.
+
+See the [Documentation](https://argmin-rs.github.io/finitediff/finitediff/) for details.
+
+## License
+
+Licensed under either of
+
+  * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
+  * MIT License ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
+
+at your option.
+
+### Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.