diff --git a/src/lib.rs b/src/lib.rs index f8d3e55..0c1284a 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -3,4 +3,5 @@ //! full design. pub mod core; +pub mod prelude; pub mod traits; diff --git a/src/prelude.rs b/src/prelude.rs new file mode 100644 index 0000000..e639a3d --- /dev/null +++ b/src/prelude.rs @@ -0,0 +1,12 @@ +//! Common imports for users of `heuropt`. +//! +//! ``` +//! use heuropt::prelude::*; +//! ``` + +pub use crate::core::{ + Candidate, Direction, Evaluation, Objective, ObjectiveSpace, OptimizationResult, + Population, Problem, Rng, rng_from_seed, +}; + +pub use crate::traits::{Initializer, Optimizer, Variation};