Enum argmin::prelude::TerminationReason

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

NoChangeInCost

Cost function value did not change

AcceptedStallIterExceeded

Acceped stall iter exceeded

BestStallIterExceeded

Best stall iter exceeded

LineSearchConditionMet

Condition for Line search met

Aborted

Aborted

Methods

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 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]

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

This method tests for !=.

impl Display for TerminationReason

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

Formats the value using the given formatter.

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 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]

fn lt(&self, other: &Rhs) -> bool

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

#[must_use]

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]

fn gt(&self, other: &Rhs) -> bool

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

#[must_use]

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 as Serializer>::Ok, <__S as Serializer>::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Debug for TerminationReason

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

Formats the value using the given formatter.

impl Copy for TerminationReason

impl Eq for TerminationReason

impl Default for TerminationReason

fn default() -> TerminationReason

Returns the "default value" for a type.

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

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

Deserialize this value from the given Serde deserializer.

impl Hash for TerminationReason

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

Feeds this value into the given [Hasher].

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.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Returns max if self is greater than max, and min if self is less than min. Otherwise this will return self. Panics if min > max.