Skip to main content

CmaInject

Struct CmaInject 

Source
pub struct CmaInject<I, V, M, F = f64>
where F: Scalar, I: MemeticInner<V, F>,
{ /* private fields */ }
Expand description

Memetic CMA-ES with Hansen (2011) injection: outer CMA-ES proposes λ candidates per generation, an inner local solver (MemeticInner) refines the best k, and the refined points are Mahalanobis-clipped and injected back into the population for the next CMA update.

The only departure from the standard CmaEs update is clipping each injected point’s normalized step in Mahalanobis distance:

  y_i ← min(1, c_y / ‖C^{-1/2} y_i‖) · y_i        (Hansen 2011 eq. 4)
  c_y = √n + 2n/(n+2)                              (Table 1 default)

with y_i = (x_i − m)/σ and C^{-1/2} = B D^{-1} Bᵀ from the post-update eigendecomposition CMA-ES already maintains. After clipping, replaced candidates re-enter the population on equal footing with regular samples; all subsequent CMA updates (m, p_σ, p_c, C, σ) run the standard equations unchanged. Lamarckian by construction; no Baldwinian mode in the paper.

§Inner solver

Generic over any I: MemeticInner<V>. The associated I::State determines the inner state shape. Shipped impls cover NelderMead, LevenbergMarquardt, and Lbfgsb. For L-BFGS-B inner with consistent bound flow, use the bounded sibling BoundedCmaInject over BoundedCmaEs.

§Eval aggregation

Same-problem composition: the inner shares the outer’s Problem wrapper, so every inner cost/gradient/Jacobian/ Hessian call bumps the same EvalCounts as the outer’s own evaluations. PopulationProgress preserves all six categories without folding derivative work into cost_evals. Use counts().total_work() for an explicit aggregate. Exact checkpoints retain the outer distribution, inner solver, progress, and counts together. With serde, these serialize when their constituent types do; application hooks cannot be serialized.

§Backends

Same coverage as CmaEs: Vec<F> for F = f32 or f64 (via DenseMatrix), nalgebra, ndarray, and faer. The matrix capabilities are those of CmaEs, and the shipped MemeticInner inners are backend-generic.

§Examples

See CmaEs for the base population-based Executor pattern; CmaInject adds a local-search inner via Hansen-2011 injection.

Implementations§

Source§

impl<I, V, M, F: Scalar> CmaInject<I, V, M, F>
where I: MemeticInner<V, F>,

Source

pub fn with_absolute_cost_change_tolerance<Q: Scalar>( self, value: impl Into<Option<Q>>, ) -> ConfiguredSolver<CmaInject<I, V, M, F>, (), (), CostChecks<Q>, ()>

Stop when the absolute change between consecutive observed costs is at most the tolerance.

Disabled by default. None disables; zero requests an exact-zero threshold. Values must be finite and nonnegative. Distinct enabled tests combine with OR. Evaluated at initialized iteration boundaries; repeated calls replace this setting. Change tests need two observed iterates. Trust-region solvers skip rejected iterations and compare accepted iterates.

Source

pub fn with_relative_cost_change_tolerance<Q: Scalar>( self, value: impl Into<Option<Q>>, ) -> ConfiguredSolver<CmaInject<I, V, M, F>, (), (), CostChecks<Q>, ()>

Stop when the observed cost change is at most the tolerance times the previous absolute cost.

Disabled by default. None disables; zero requests an exact-zero threshold. Values must be finite and nonnegative. Distinct enabled tests combine with OR. Evaluated at initialized iteration boundaries; repeated calls replace this setting. Change tests need two observed iterates. Trust-region solvers skip rejected iterations and compare accepted iterates.

Source§

impl<I, V, M, F: Scalar> CmaInject<I, V, M, F>
where I: MemeticInner<V, F>,

Source

pub fn with_absolute_step_tolerance<Param, Q: Scalar>( self, value: impl Into<Option<Q>>, ) -> ConfiguredSolver<CmaInject<I, V, M, F>, (), StepChecks<Param, Q>, (), ()>

Stop when the Euclidean distance between consecutive observed iterates is at most the tolerance.

Disabled by default. None disables; zero requests an exact-zero threshold. Values must be finite and nonnegative. Distinct enabled tests combine with OR. Evaluated at initialized iteration boundaries; repeated calls replace this setting. Change tests need two observed iterates. Trust-region solvers skip rejected iterations and compare accepted iterates.

Source

pub fn with_relative_step_tolerance<Param, Q: Scalar>( self, value: impl Into<Option<Q>>, ) -> ConfiguredSolver<CmaInject<I, V, M, F>, (), StepChecks<Param, Q>, (), ()>

Stop when the Euclidean iterate change is at most the tolerance times the current iterate norm.

Disabled by default. None disables; zero requests an exact-zero threshold. Values must be finite and nonnegative. Distinct enabled tests combine with OR. Evaluated at initialized iteration boundaries; repeated calls replace this setting. Change tests need two observed iterates. Trust-region solvers skip rejected iterations and compare accepted iterates.

Source§

impl<I, V, M, F> CmaInject<I, V, M, F>
where F: Scalar, I: MemeticInner<V, F>, I::State: CountsMirror,

Source

pub fn with_inner_solver(cma: CmaEs<V, M, F>, inner: I) -> Self

Wrap a configured CmaEs with inner as the local refinement step. Defaults: k = 1 refinement per generation, inner max_iter = 50, c_y = Hansen-2011 Table 1 default.

Source

pub fn cma(&self) -> &CmaEs<V, M, F>

Inspect the outer distribution model without transferring its ownership.

Source

pub fn with_k(self, k: usize) -> Self

Number of best-ranked candidates to refine and inject each generation. Default 1.

§Panics

Panics if k == 0. k > λ is silently clamped at runtime.

Source

pub fn with_c_y(self, c_y: F) -> Self

Override the Hansen-2011 clipping threshold c_y (default √n + 2n/(n+2)).

§Panics

Panics if c_y <= 0.

Source

pub fn with_inner_diagnostics(self, enabled: bool) -> Self

Enable owned inner stopping reports and count snapshots. Disabled by default. Fresh initialization clears records; exact continuation retains them.

Source

pub fn inner_diagnostics(&self) -> &[Record<F>]

Inner reports consumed during this outer run, in dispatch order. A callback error retains counts and has no returned report.

Source

pub fn with_inner_max_iter(self, n: u64) -> Self

Inner solver iteration budget per outer generation (default 50).

Source

pub fn with_absolute_distribution_size_tolerance( self, value: impl Into<Option<F>>, ) -> Self

Configure the outer CMA distribution-size tolerance; None disables it.

Source

pub fn inner_stop_when_factory<Mk, CheckFn>(self, make: Mk) -> Self
where Mk: FnMut() -> CheckFn + 'static, CheckFn: FnMut(&I::State) -> Option<ApplicationStop> + 'static,

Add a factory creating fresh application-stop history for each inner run.

Trait Implementations§

Source§

impl<'de, I, V, M, F> Deserialize<'de> for CmaInject<I, V, M, F>
where F: Scalar + Deserialize<'de>, I: MemeticInner<V, F> + Deserialize<'de>, V: Deserialize<'de>, M: Deserialize<'de>,

Available on crate feature serde only.
Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<I, V, M, F> Serialize for CmaInject<I, V, M, F>
where F: Scalar + Serialize, I: MemeticInner<V, F> + Serialize, V: Serialize, M: Serialize,

Available on crate feature serde only.
Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl<P, I, V, M, F> Solver<P, PopulationProgress<V, F>> for CmaInject<I, V, M, F>
where F: Scalar, P: CostFunction<Param = V, Output = F> + ProblemConstraints<Constraints = NoConstraints>, I: MemeticInner<V, F> + Solver<P, <I as InitialState<V>>::State, Error = P::Error>, I::State: State<Param = V, Float = F> + CountsMirror, V: VectorLen + Clone + ScaledAdd<F> + ScaleInPlace<F> + ComponentMulAssign + NormSquared<F> + SampleStandardNormal + Index<usize, Output = F> + IndexMut<usize, Output = F>, M: MatrixIdentity + MatrixFromDiagonal<V> + MatVec<V> + MatTransposeVec<V> + ScaleInPlace<F> + RankOneUpdate<V, F> + SymmetricEigen<V> + Clone, CmaEs<V, M, F>: Solver<P, PopulationProgress<V, F>, Error = P::Error>,

Source§

type Error = <P as CostFunction>::Error

Hard-abort error type, mirroring the underlying problem’s type Error. See the trait docs.
Source§

fn init( &mut self, problem: &mut Problem<P>, state: PopulationProgress<V, F>, ) -> Result<PopulationProgress<V, F>, Self::Error>

One-time setup before the iteration loop. Read more
Source§

fn next_iter( &mut self, problem: &mut Problem<P>, state: PopulationProgress<V, F>, ) -> Result<SolverStep<PopulationProgress<V, F>>, Self::Error>

Advance one iteration. Read more
Source§

fn terminate(&self, state: &PopulationProgress<V, F>) -> Option<Termination<F>>

Optional pre-iteration solver-specific termination test. Read more
Source§

fn reset_convergence(&mut self)

Reset per-run convergence history without changing algorithm state. Read more
Source§

fn should_check_iterate_change(&self) -> bool

Whether the current boundary can enter cost- and step-change checks. Read more
Source§

fn check_convergence( &mut self, _problem: &Problem<P>, state: &S, ) -> Option<Termination<S::Float>>

Check convergence at an initialized iteration boundary. Read more

Auto Trait Implementations§

§

impl<I, V, M, F = f64> !RefUnwindSafe for CmaInject<I, V, M, F>

§

impl<I, V, M, F = f64> !Send for CmaInject<I, V, M, F>

§

impl<I, V, M, F = f64> !Sync for CmaInject<I, V, M, F>

§

impl<I, V, M, F = f64> !UnwindSafe for CmaInject<I, V, M, F>

§

impl<I, V, M, F> Freeze for CmaInject<I, V, M, F>
where CmaEs<V, M, F>: Freeze, InnerExecutor<<I as InitialState<V>>::State, I>: Freeze, Option<Vec<Record<F>>>: Freeze, Option<F>: Freeze,

§

impl<I, V, M, F> Unpin for CmaInject<I, V, M, F>
where CmaEs<V, M, F>: Unpin, InnerExecutor<<I as InitialState<V>>::State, I>: Unpin, Option<Vec<Record<F>>>: Unpin, Option<F>: Unpin,

§

impl<I, V, M, F> UnsafeUnpin for CmaInject<I, V, M, F>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V