Enum Termination 

pub enum Termination {
    Gtol,
    Ftol,
    Xtol,
    ResidualsZero,
    MaxEval,
    NoImprovement,
    NumericalError,
}

Why the solve stopped.

Variants

Gtol

‖Jᵀr‖_∞ ≤ gtol — first-order optimality.

Ftol

Relative cost decrease ≤ ftol.

Xtol

Relative step size ≤ xtol.

ResidualsZero

Residuals are (numerically) zero.

MaxEval

Exhausted the residual-evaluation budget.

NoImprovement

The trust-region control diverged without an accepted step.

NumericalError

A residual/Jacobian evaluation failed.

Implementations

impl Termination

pub fn was_successful(&self) -> bool

Whether the run reached a convergence criterion (vs. a budget/error stop).

Trait Implementations

impl Clone for Termination

fn clone(&self) -> Termination

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Termination

impl Debug for Termination

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

Formats the value using the given formatter.

impl Eq for Termination

impl PartialEq for Termination

fn eq(&self, other: &Termination) -> 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 Termination