From 3f2921ea60d9a686cff1dae3b69b12375ab292aa Mon Sep 17 00:00:00 2001 From: Stephen Waits Date: Mon, 4 May 2026 19:17:15 -0600 Subject: [PATCH] feat: add prelude module A single `use heuropt::prelude::*;` brings in the common user-facing types and traits available so far. Subsequent commits add Pareto helpers, operators, and algorithms to the same prelude as they land. --- src/lib.rs | 1 + src/prelude.rs | 12 ++++++++++++ 2 files changed, 13 insertions(+) create mode 100644 src/prelude.rs 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};