Enum levenberg_marquardt::TerminationReason

pub enum TerminationReason {
    User(&'static str),
    Numerical(&'static str),
    ResidualsZero,
    Orthogonal,
    Converged {
        ftol: bool,
        xtol: bool,
    },
    NoImprovementPossible(&'static str),
    LostPatience,
    NoParameters,
    NoResiduals,
    WrongDimensions(&'static str),
}

Reasons for terminating the minimization.

Variants

User(&'static str)

The residual or Jacobian computation was not successful, it returned None.

Numerical(&'static str)

Encountered NaN or $\pm\infty$.

ResidualsZero

The residuals are literally zero.

Orthogonal

The residuals vector and the Jacobian columns are almost orthogonal.

This is the gtol termination criterion.

Converged

Fields

ftol: bool

xtol: bool

The ftol or xtol criterion was fulfilled.

NoImprovementPossible(&'static str)

The bound for ftol, xtol or gtol was set so low that the test passed with the machine epsilon but not with the actual bound. This means you must increase the bound.

LostPatience

Maximum number of function evaluations was hit.

NoParameters

The number of parameters $n$ is zero.

NoResiduals

The number of residuals $m$ is zero.

WrongDimensions(&'static str)

The shape of the computed residuals or Jacobian is not correct.

Implementations

impl TerminationReason

pub fn was_successful(&self) -> bool

Compute whether the outcome is considered successful.

This does not necessarily mean we have a minimizer. Some termination criteria are approximations for necessary optimality conditions or check limitations due to floating point arithmetic.

pub fn was_usage_issue(&self) -> bool

A fundamental assumptions was not met.

For example if the number of residuals changed.

Trait Implementations

impl Debug for TerminationReason

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

Formats the value using the given formatter.

impl PartialEq<TerminationReason> for TerminationReason

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for TerminationReason

impl StructuralEq for TerminationReason

impl StructuralPartialEq for TerminationReason