Enum ConvergenceStatus 

pub enum ConvergenceStatus {
    Converged,
    MaxIterReached,
}

Outcome of an optimization run: whether the stopping criterion was satisfied.

Variants

Converged

The convergence criterion (e.g. gradient norm below tolerance) was met.

MaxIterReached

The iteration budget was exhausted before the criterion was met.

Trait Implementations

impl Clone for ConvergenceStatus

fn clone(&self) -> ConvergenceStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ConvergenceStatus

impl Debug for ConvergenceStatus

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

Formats the value using the given formatter.

impl Eq for ConvergenceStatus

impl PartialEq for ConvergenceStatus

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ConvergenceStatus