Skip to content

Latest commit

 

History

History
115 lines (84 loc) · 4.93 KB

CHANGELOG.md

File metadata and controls

115 lines (84 loc) · 4.93 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog

Unreleased

[0.11.0] - 2024-10-17

Changed

  • Bump minimal rustc version from 1.56 to 1.69
  • Upgrade nalgebra dependency from 0.31 to 0.33
  • Upgrade optional dependency whoami from 1.2 to 1.5
  • Upgrade optional dependency rustc_version_runtime from 0.2 to 0.3

[0.10.0] - 2021-11-14

Changed

  • Upgrade nalgebra dependency from 0.29 to 0.31

[0.9.1] - 2021-11-14

Added

  • Implement fmt::debug for RootFinder debugging

[0.9.0] - 2021-11-7

Added

  • Error definition and handling

Changed

  • Upgrade to edition 2021 and add minimal supported rust version as 1.56
  • Upgrade dependancies to nalgebra 0.29, whoami 1.2
  • Breaking change: add minidom as optional under the feature name "xml_config_file"
  • Relax dependancy constrant rustc_version_runtime from 0.2.0 to 0.2
  • Breaking change: method signature Rootfinder::solve(&mut self, model: &mut M) to ``Rootfinder::solve(&mut self, model: &mut M) -> Result<(), crate::errors::SolverError>`
  • Breaking change: method signature Model::evaluate(&mut self) to Model::evaluate(&mut self) -> Result<(), model::ModelError>
  • Breaking change: method signature Model::get_jacobian(&self) -> residuals::JacobianValues<D> to Model::get_jacobian(&mut self) -> Result<residuals::JacobianValues<D>, model::ModelError> in the model trait.

[0.8.0] - 2021-07-25

Changed

  • Upgrade to nalgebra 0.28
  • Model trait accept now static types in addition to dynamic types (SVector and DVector from nalgebra)

[0.7.0] - 2021-05-24

Added

  • License file : the licensing hasn't been changed but has been made more explicited with the adequate section in the readme and the licenses files
  • New mechanism to adapt a user model frm closure through the UserModelFromClosure and UserModelFromClosureAndJacobian structs.

Changed

  • Improve documentation and rewrite of the README.md
  • Breaking change: Define API thanks to rexport, access to newton_rootfinder::solver_advanced has been deleted, use directly newton_rootfinder from now on.
  • Breaking change: Use UserModelFromFunction and UserModelFromFunctionAndJacobian instead of UserModelWithFunction and UserModelWithFunctionJac
  • Moved from nalgebra 0.21.1 to 0.26.2

Removed

  • Breaking change: the init and len_memroy methods have been removed from the model::Model trait
  • The minimal solver has been removed from the public API, it is still a dev dependency
  • The test cases have been removed from the public API, it is still a dev dependency

[0.6.0] - 2020-08-24

Added

  • rustc_version_runtime dependency to print rustc version information in log. This was removed in version 5.0 due to a documentation build issue on doc.rs of this dependency.
  • New resolution methods: Greenstadt first and second method

Changed

  • Readme: it is not a duplicate of the documentation main page. It now points to it.
  • Documentation: change of the main page.
  • Simulation log function (changed from set_debug() to activate_debug())
  • Simulation log mecanism: instead of writing the log at the end of the simulation, write it on the fly in order to have data in case of a panic.
  • Update version of dependencies: chrono and whoami.

[0.5.0] - 2020-06-15

Added

  • Travis CI
  • Add Broyden's Methods
  • Add solver/jacobian.rs to guard the jacobian and its inverse updates
  • Add solver/resolution_method.rs to implement quasi-Newton methods
  • Refactoring the enums for the resolution method: ResolutionMethod, QuasiNewtonMethod and UpdateQuasiNewtonMethod
  • Add solver placeholder for new resolution parameters

Fixed

  • Damping activation for quasi-Newton methods (the jacobian was recomputed if it hadn't been recomputed at the previous iteration and not the current iteration)

Changed

  • Upgrade dependency nalgebra from 0.21.0 to 0.21.1
  • Upgrade dependency whoami from 0.8.1 to 0.8.2
  • Add argument damping to the default_with_guess function
  • Testing of log generation: the user info are not checked anymore (so TRAVIS or anybody else could run it)
  • Documentation of the util module: fixed a typo
  • Move util/jacobian under solver/jacobian

Removed

[0.4.0] - 2020-05-29

Added

  • New resolution method: StationaryNewton. The classical one has been named NewtonRaphson
  • Added dependencies to chrono, whoami and rustc_version_runtime for log file informations

Changed

  • Log file formatting
  • Adapt xml parser to read the resolution method
  • Upgrade dev-dependency float-cmp from 0.6 to 0.8.0

[0.3.0] - 2020-05-26

Added

This is considered the base version with all the documented features working