[]Enum argmin::prelude::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

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 Hash for TerminationReason

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

Feeds a slice of this type into the given [Hasher]. Read more

impl Debug for TerminationReason

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

impl PartialOrd<TerminationReason> for TerminationReason

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

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

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

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

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

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

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

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

impl Eq for TerminationReason

impl Default for TerminationReason

impl Copy for TerminationReason

impl Ord for TerminationReason

fn max(self, other: Self) -> Self1.21.0[src]

Compares and returns the maximum of two values. Read more

fn min(self, other: Self) -> Self1.21.0[src]

Compares and returns the minimum of two values. Read more

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

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

Restrict a value to a certain interval. Read more

impl Serialize for TerminationReason

impl PartialEq<TerminationReason> for TerminationReason

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

This method tests for !=.

impl Display for TerminationReason

impl Clone for TerminationReason

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

Auto Trait Implementations

impl Send for TerminationReason

impl Sync for TerminationReason

Blanket Implementations

impl<T> ToString for T where
    T: Display + ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> DeserializeOwned for T where
    T: Deserialize<'de>, 
[src]

impl<T> SendSyncUnwindSafe for T where
    T: Send + Sync + UnwindSafe + ?Sized