feat!: rename solver module to algo

datamole-ai · Nov 13, 2023 · 8c59165 · 8c59165
1 parent 639a8af
commit 8c59165
Show file tree

Hide file tree

Showing 9 changed files with 9 additions and 9 deletions.
diff --git a/examples/rosenbrock.rs b/examples/rosenbrock.rs
@@ -1,5 +1,5 @@
+use gomez::algo::TrustRegion;
 use gomez::nalgebra as na;
-use gomez::solver::TrustRegion;
 use gomez::{Domain, Problem, Solver, System};
 use na::{Dynamic, IsContiguous};
 

diff --git a/gomez-bench/benches/main.rs b/gomez-bench/benches/main.rs
@@ -3,9 +3,9 @@ fn main() {
 }
 
 use gomez::{
+    algo::{NelderMead, TrustRegion},
     nalgebra as na,
     nalgebra::Dynamic,
-    solver::{NelderMead, TrustRegion},
     testing::*,
     Domain, Problem, Solver,
 };

diff --git a/src/solver.rs → src/algo.rs b/src/solver.rs → src/algo.rs
diff --git a/src/solver/lipo.rs → src/algo/lipo.rs b/src/solver/lipo.rs → src/algo/lipo.rs
diff --git a/src/solver/nelder_mead.rs → src/algo/nelder_mead.rs b/src/solver/nelder_mead.rs → src/algo/nelder_mead.rs
diff --git a/src/solver/steffensen.rs → src/algo/steffensen.rs b/src/solver/steffensen.rs → src/algo/steffensen.rs
diff --git a/src/solver/trust_region.rs → src/algo/trust_region.rs b/src/solver/trust_region.rs → src/algo/trust_region.rs
diff --git a/src/analysis.rs b/src/analysis.rs
@@ -32,7 +32,7 @@ pub fn estimate_magnitude_from_bounds<T: RealField + Copy>(lower: T, upper: T) -
 /// Based on \[1\]. Linear variables have no effect on Jacobian matrix, thus it
 /// makes sense to focus on non-linear variables and their initial guesses for
 /// Newton-based algorithms (e.g.,
-/// [`TrustRegion`](crate::solver::trust_region)).
+/// [`TrustRegion`](crate::algo::trust_region)).
 ///
 /// \[1\] [On the Choice of Initial Guesses for the Newton-Raphson
 /// Algorithm](https://arxiv.org/abs/1911.12433)

diff --git a/src/lib.rs b/src/lib.rs
@@ -22,13 +22,13 @@
 //!
 //! ## Algorithms
 //!
-//! * [Trust region](solver::trust_region) -- Recommended method to be used as a
+//! * [Trust region](algo::trust_region) -- Recommended method to be used as a
 //!   default and it will just work in most of the cases.
-//! * [LIPO](solver::lipo) -- A global optimization algorithm useful for initial
+//! * [LIPO](algo::lipo) -- A global optimization algorithm useful for initial
 //!   guesses search in combination with a numerical solver.
-//! * [Steffensen](solver::steffensen) -- Fast and lightweight method for
+//! * [Steffensen](algo::steffensen) -- Fast and lightweight method for
 //!   one-dimensional systems.
-//! * [Nelder-Mead](solver::nelder_mead) -- Not generally recommended, but may
+//! * [Nelder-Mead](algo::nelder_mead) -- Not generally recommended, but may
 //!   be useful for low-dimensionality problems with ill-defined Jacobian
 //!   matrix.
 //!
@@ -148,7 +148,7 @@
 //! use gomez::nalgebra as na;
 //! use gomez::Solver;
 //! // Pick your solver.
-//! use gomez::solver::TrustRegion;
+//! use gomez::algo::TrustRegion;
 //! # use gomez::{Domain, Problem, System};
 //! # use na::{Dynamic, IsContiguous};
 //! #
@@ -234,10 +234,10 @@
 //!
 //! Licensed under MIT.
 
+pub mod algo;
 pub mod analysis;
 mod core;
 pub mod derivatives;
-pub mod solver;
 
 pub use core::*;