Enum argmin::core::TerminationReason

pub enum TerminationReason {
    NotTerminated,
    MaxItersReached,
    TargetCostReached,
    TargetPrecisionReached,
    NoChangeInCost,
    AcceptedStallIterExceeded,
    BestStallIterExceeded,
    LineSearchConditionMet,
    TargetToleranceReached,
    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

NoChangeInCost

Cost function value did not change

AcceptedStallIterExceeded

Acceped stall iter exceeded

BestStallIterExceeded

Best stall iter exceeded

LineSearchConditionMet

Condition for Line search met

TargetToleranceReached

Target tolerance reached

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

Trait Implementations

impl Clone for TerminationReason

fn clone(&self) -> TerminationReason

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for TerminationReason

impl Debug for TerminationReason

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

Formats the value using the given formatter.

impl Default for TerminationReason

fn default() -> Self

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for TerminationReason

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for TerminationReason

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

Formats the value using the given formatter.

impl Eq for TerminationReason

impl Hash for TerminationReason

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for TerminationReason

fn cmp(&self, other: &TerminationReason) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

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 ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<TerminationReason> for TerminationReason

fn partial_cmp(&self, other: &TerminationReason) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for TerminationReason

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for TerminationReason

impl StructuralPartialEq for TerminationReason