Enum TerminationReason 

pub enum TerminationReason {
    GradientNorm,
    StepSize,
    FunctionChange,
    MaxIterations,
    LineSearchFailed,
    NumericalError,
}

Why the optimizer stopped.

Variants

GradientNorm

Gradient norm fell below tolerance.

StepSize

Step size fell below tolerance.

FunctionChange

Change in objective value fell below tolerance.

MaxIterations

Reached the maximum number of iterations.

LineSearchFailed

Line search could not find a sufficient decrease.

NumericalError

A numerical error occurred (e.g. singular Hessian, NaN).

Trait Implementations

impl Clone for TerminationReason

fn clone(&self) -> TerminationReason

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TerminationReason

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

Formats the value using the given formatter.

impl Display for TerminationReason

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

Formats the value using the given formatter.

impl PartialEq for TerminationReason

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

impl Eq for TerminationReason

impl StructuralPartialEq for TerminationReason