feat!: remove prelude and move important types to lib root

datamole-ai · Nov 12, 2023 · 17f8674 · 17f8674
1 parent 6c9d46a
commit 17f8674
Show file tree

Hide file tree

Showing 7 changed files with 13 additions and 16 deletions.
diff --git a/examples/rosenbrock.rs b/examples/rosenbrock.rs
@@ -1,6 +1,6 @@
 use gomez::nalgebra as na;
-use gomez::prelude::*;
 use gomez::solver::TrustRegion;
+use gomez::{Domain, Problem, Solver, System};
 use na::{Dynamic, IsContiguous};
 
 // https://en.wikipedia.org/wiki/Rosenbrock_function

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

diff --git a/src/core/function.rs b/src/core/function.rs
@@ -11,9 +11,8 @@ use super::{base::Problem, system::System};
 /// ([`apply`](Function::apply)).
 ///
 /// ```rust
-/// use gomez::core::Function;
 /// use gomez::nalgebra as na;
-/// use gomez::prelude::*;
+/// use gomez::{Domain, Function, Problem};
 /// use na::{Dynamic, IsContiguous};
 ///
 /// // A problem is represented by a type.

diff --git a/src/core/optimizer.rs b/src/core/optimizer.rs
@@ -21,7 +21,7 @@ use super::{domain::Domain, function::Function};
 ///
 /// ```rust
 /// use gomez::nalgebra as na;
-/// use gomez::core::*;
+/// use gomez::*;
 /// use na::{storage::StorageMut, Dynamic, IsContiguous, Vector};
 /// use rand::Rng;
 /// use rand_distr::{uniform::SampleUniform, Distribution, Standard};

diff --git a/src/core/solver.rs b/src/core/solver.rs
@@ -21,7 +21,7 @@ use super::{domain::Domain, system::System};
 ///
 /// ```rust
 /// use gomez::nalgebra as na;
-/// use gomez::core::*;
+/// use gomez::*;
 /// use na::{storage::StorageMut, Dynamic, IsContiguous, Vector};
 /// use rand::Rng;
 /// use rand_distr::{uniform::SampleUniform, Distribution, Standard};

diff --git a/src/core/system.rs b/src/core/system.rs
@@ -16,7 +16,7 @@ use super::{base::Problem, domain::Domain};
 ///
 /// ```rust
 /// use gomez::nalgebra as na;
-/// use gomez::prelude::*;
+/// use gomez::{Domain, Problem, System};
 /// use na::{Dynamic, IsContiguous};
 ///
 /// // A problem is represented by a type.

diff --git a/src/lib.rs b/src/lib.rs
@@ -69,7 +69,7 @@
 //! ```rust
 //! // Gomez is based on `nalgebra` crate.
 //! use gomez::nalgebra as na;
-//! use gomez::prelude::*;
+//! use gomez::{Domain, Problem, System};
 //! use na::{Dynamic, IsContiguous};
 //!
 //! // A problem is represented by a type.
@@ -117,7 +117,7 @@
 //!
 //! ```rust
 //! # use gomez::nalgebra as na;
-//! # use gomez::prelude::*;
+//! # use gomez::*;
 //! #
 //! # struct Rosenbrock {
 //! #     a: f64,
@@ -146,9 +146,10 @@
 //!
 //! ```rust
 //! use gomez::nalgebra as na;
-//! use gomez::prelude::*;
+//! use gomez::Solver;
 //! // Pick your solver.
 //! use gomez::solver::TrustRegion;
+//! # use gomez::{Domain, Problem, System};
 //! # use na::{Dynamic, IsContiguous};
 //! #
 //! # struct Rosenbrock {
@@ -234,19 +235,16 @@
 //! Licensed under MIT.
 
 pub mod analysis;
-pub mod core;
+mod core;
 pub mod derivatives;
 pub mod solver;
 
+pub use core::*;
+
 #[cfg(feature = "testing")]
 pub mod testing;
 
 #[cfg(not(feature = "testing"))]
 pub(crate) mod testing;
 
 pub use nalgebra;
-
-/// Gomez prelude.
-pub mod prelude {
-    pub use crate::core::{Domain, Problem, Solver, System};
-}