docs(rustdoc): add runnable examples across operators, metrics, and Pareto utilities
Completes the rustdoc audit — every public item now has at least one ```rust example block in its docstring, exercised by `cargo test --doc` (55 doctests, all passing). - Operators: BitFlipMutation, SwapMutation, RealBounds, GaussianMutation, BoundedGaussianMutation, SimulatedBinaryCrossover, PolynomialMutation, LevyMutation, ClampToBounds, ProjectToSimplex. - Metrics: hypervolume_2d, hypervolume_nd, spacing. - Pareto utilities: pareto_compare, pareto_front, best_candidate, non_dominated_sort, crowding_distance, das_dennis, ParetoArchive. Each example is short (5-15 lines) and self-contained — copy-paste into a fresh project and it runs.
This commit is contained in:
@@ -11,6 +11,28 @@ use crate::core::objective::ObjectiveSpace;
|
||||
/// `f64::INFINITY`. If the front has 0 entries an empty vector is returned;
|
||||
/// 1 or 2 entries return all `f64::INFINITY`. All comparisons happen on
|
||||
/// minimization-oriented objective values (spec §9.6).
|
||||
///
|
||||
/// # Example
|
||||
///
|
||||
/// ```
|
||||
/// use heuropt::prelude::*;
|
||||
///
|
||||
/// let s = ObjectiveSpace::new(vec![
|
||||
/// Objective::minimize("f1"),
|
||||
/// Objective::minimize("f2"),
|
||||
/// ]);
|
||||
/// // Three points along a Pareto-like trade-off; the interior point gets
|
||||
/// // a finite crowding distance, the boundaries get +∞.
|
||||
/// let pop = [
|
||||
/// Candidate::new((), Evaluation::new(vec![0.0, 4.0])),
|
||||
/// Candidate::new((), Evaluation::new(vec![2.0, 2.0])),
|
||||
/// Candidate::new((), Evaluation::new(vec![4.0, 0.0])),
|
||||
/// ];
|
||||
/// let d = crowding_distance(&pop, &[0, 1, 2], &s);
|
||||
/// assert!(d[0].is_infinite());
|
||||
/// assert!(d[1].is_finite() && d[1] > 0.0);
|
||||
/// assert!(d[2].is_infinite());
|
||||
/// ```
|
||||
pub fn crowding_distance<D>(
|
||||
population: &[Candidate<D>],
|
||||
front: &[usize],
|
||||
|
||||
Reference in New Issue
Block a user