Enum StopReason 

#[non_exhaustive]
pub enum StopReason {
    BudgetExhausted,
    TargetReached,
    Converged,
}

Why an optimizer stopped.

Marked #[non_exhaustive]: future versions may add reasons (e.g. internal convergence), so matches need a wildcard arm.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

BudgetExhausted

The evaluation budget was exhausted.

TargetReached

The target objective value was reached.

Converged

Internal convergence criteria fired before the budget was spent (e.g. CMA-ES TolFun/TolX/step-size collapse). Only some algorithms emit this.

Trait Implementations

impl Clone for StopReason

fn clone(&self) -> StopReason

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for StopReason

impl Debug for StopReason

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for StopReason

impl PartialEq for StopReason

fn eq(&self, other: &StopReason) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for StopReason