Version 0.5.0

argmin-rs · Jan 10, 2022 · cfbb17e · cfbb17e
1 parent 2061d1a
commit cfbb17e
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 12 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,35 @@
 
 ## argmin unreleased (xx xxxxxx xxxx)
 
-- Fixed simulated annealing always accepting the first iteration (#153, @dariogoetz)
+## argmin v0.5.0 (10 January 2022)
+
+- Faster CI pipeline (#179, @stefan-k)
+- Removed CircleCI and added rustfmt check to Github Actions (#178, @stefan-k)
+- Automatically build documentation in CI when merging a PR into main (#149, #176, @stefan-k) 
+- Added a section to documentation where to find examples for current release and main branch, removed other links (#145, #174, @stefan-k)
+- Fixed warnings when building docs and added building docs to the CI (#173, @stefan-k)
+- The required features for each example are now indicated in Cargo.toml (#171, #147, @stefan-k)
+- CI now includes compiling to various WASM targets (#89, #170, @stefan-k)
+- Branch master renamed to main (#148, @stefan-k)
+- nalgebra updated from 0.29.0 to 0.30.0 (#169)
+- WASM features now mentioned in documentation and README.md (#167, @Glitchy-Tozier)
+- Added tests for backtracking linesearch (#168, @stefan-k)
+- Removed unsafe code from the vec-based math module (#166, @stefan-k)
+- Added tests for GaussNewton method and fixed GaussNewton example (#164, @stefan-k)
+- Added tests for Newton method (#163, @stefan-k)
+- Treat a new parameter as "best" when both current and previous cost function values are Inf (#162, @stefan-k)
+- Corrected documentation of PSO and removed an unnecessary trait bound on Hessian (#161, #141, @stefan-k, @TheIronBorn)
+- Moved to edition 2021 (#160, @stefan-k)
+- SA acceptance now based on current cost, not previous (fix) (#157, #159, @stefan-k, @TheIronBorn)
+- LineSearchCondition now uses references (#158, @w1th0utnam3)
+- Counting of sub problem function counts fixed (#154, #156, @stefan-k, @w1th0utnam3)
+- Fixed incorrect checking for new best solution (#151, #152, @stefan-k, @Glitchy-Tozier)
+- Fixed simulated annealing always accepting the first iteration (#150, #153, @dariogoetz)
+- Fixed inconsistency between state and alpha value in Backtracking linesearch (#155, @w1th0utnam3)
+- Improved clippy linting in CI (#146, @stefan-k)
+- Unnecessary semi-colon in macro removed (#143, @CattleProdigy)
+- Allow any RNG in SA and improve example (#139, @TheIronBorn)
+- Make use of slog a feature, improve tests (#136, @ThatGeoGuy)
 
 ## argmin v0.4.7 (14 August 2021)
 

diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "argmin"
-version = "0.4.7"
+version = "0.5.0"
 authors = ["Stefan Kroboth <stefan.kroboth@gmail.com>"]
 edition = "2021"
 license = "MIT OR Apache-2.0"

diff --git a/README.md b/README.md
@@ -76,7 +76,7 @@ problems), developing tests, adding observers, implementing a C interface or
 ## Examples
 
 Examples for each solver can be found
-[here (current released version)](https://github.com/argmin-rs/argmin/tree/v0.4.7/examples) and
+[here (current released version)](https://github.com/argmin-rs/argmin/tree/v0.5.0/examples) and
 [here (main branch)](https://github.com/argmin-rs/argmin/tree/main/examples).
 
 ## Usage
@@ -85,7 +85,7 @@ Add this to your `Cargo.toml`:
 
 ```toml
 [dependencies]
-argmin = "0.4.7"
+argmin = "0.5.0"
 ```
 
 ### Optional features
@@ -96,7 +96,7 @@ There are additional features which can be activated in `Cargo.toml`:
 
 ```toml
 [dependencies]
-argmin = { version = "0.4.7", features = ["ctrlc", "ndarrayl", "nalgebral"] }
+argmin = { version = "0.5.0", features = ["ctrlc", "ndarrayl", "nalgebral"] }
 ```
 
 These may become default features in the future. Without these features compilation to
@@ -119,11 +119,11 @@ ndarray-linalg = { version = "*", features = ["intel-mkl-static"] }
 When compiling to WASM, one of the following features must be used:
 
 ```toml
-argmin = { version = "0.4.7", features = ["wasm-bindgen"] }
+argmin = { version = "0.5.0", features = ["wasm-bindgen"] }
 ```
 
 ```toml
-argmin = { version = "0.4.7", features = ["stdweb"] }
+argmin = { version = "0.5.0", features = ["stdweb"] }
 ```
 
 Note that WASM support is still experimental. Please report any issues you encounter when compiling argmin to WASM.

diff --git a/src/lib.rs b/src/lib.rs
@@ -76,7 +76,7 @@
 //! # Examples
 //!
 //! Examples for each solver can be found
-//! [here (current released version)](https://github.com/argmin-rs/argmin/tree/v0.4.7/examples) and
+//! [here (current released version)](https://github.com/argmin-rs/argmin/tree/v0.5.0/examples) and
 //! [here (main branch)](https://github.com/argmin-rs/argmin/tree/main/examples).
 //!
 //! # Usage
@@ -85,7 +85,7 @@
 //!
 //! ```toml
 //! [dependencies]
-//! argmin = "0.4.7"
+//! argmin = "0.5.0"
 //! ```
 //!
 //! ## Optional features
@@ -96,7 +96,7 @@
 //!
 //! ```toml
 //! [dependencies]
-//! argmin = { version = "0.4.7", features = ["ctrlc", "ndarrayl", "nalgebral"] }
+//! argmin = { version = "0.5.0", features = ["ctrlc", "ndarrayl", "nalgebral"] }
 //! ```
 //!
 //! These may become default features in the future. Without these features compilation to
@@ -119,11 +119,11 @@
 //! When compiling to WASM, one of the following features must be used:
 //!
 //! ```toml
-//! argmin = { version = "0.4.7", features = ["wasm-bindgen"] }
+//! argmin = { version = "0.5.0", features = ["wasm-bindgen"] }
 //! ```
 //!
 //! ```toml
-//! argmin = { version = "0.4.7", features = ["stdweb"] }
+//! argmin = { version = "0.5.0", features = ["stdweb"] }
 //! ```
 //!
 //! Note that WASM support is still experimental. Please report any issues you encounter when compiling argmin to WASM.