Enum argmin_core::TerminationReason

pub enum TerminationReason {
    NotTerminated,
    MaxItersReached,
    TargetCostReached,
    TargetPrecisionReached,
    AcceptedStallIterExceeded,
    BestStallIterExceeded,
    LineSearchConditionMet,
    Aborted,
}

Indicates why the optimization algorithm stopped

Variants

NotTerminated

In case it has not terminated yet

MaxItersReached

Maximum number of iterations reached

TargetCostReached

Target cost function value reached

TargetPrecisionReached

Target precision reached

AcceptedStallIterExceeded

Acceped stall iter exceeded

BestStallIterExceeded

Best stall iter exceeded

LineSearchConditionMet

Condition for Line search met

Aborted

Aborted

Implementations

impl TerminationReason

pub fn terminated(&self) -> bool

Returns true if a solver terminated and false otherwise

pub fn text(&self) -> &str

Returns a texual representation of what happened

TODO: I am not sure if this is the best way to solve this.

Trait Implementations

impl Clone for TerminationReason

fn clone(&self) -> TerminationReason

Returns a copy 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 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: &Rhs) -> bool

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

impl StructuralPartialEq for TerminationReason