Enum argmin::core::TerminationReason[][src]

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

pub fn terminated(self) -> bool[src]

Returns true if a solver terminated and false otherwise

pub fn text(&self) -> &str[src]

Returns a texual representation of what happened

Trait Implementations

impl Clone for TerminationReason[src]

impl Debug for TerminationReason[src]

impl Default for TerminationReason[src]

impl<'de> Deserialize<'de> for TerminationReason[src]

impl Display for TerminationReason[src]

impl Hash for TerminationReason[src]

impl Ord for TerminationReason[src]

impl PartialEq<TerminationReason> for TerminationReason[src]

impl PartialOrd<TerminationReason> for TerminationReason[src]

impl Serialize for TerminationReason[src]

impl Copy for TerminationReason[src]

impl Eq for TerminationReason[src]

impl StructuralEq for TerminationReason[src]

impl StructuralPartialEq for TerminationReason[src]

Auto Trait Implementations

impl RefUnwindSafe for TerminationReason

impl Send for TerminationReason

impl Sync for TerminationReason

impl Unpin for TerminationReason

impl UnwindSafe for TerminationReason

Blanket Implementations

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

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

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

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

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

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> Scalar for T where
    T: Copy + PartialEq<T> + Debug + Any
[src]

impl<SS, SP> SupersetOf<SS> for SP where
    SS: SubsetOf<SP>, 

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

type Owned = T

The resulting type after obtaining ownership.

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

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<V, T> VZip<V> for T where
    V: MultiLane<T>, 

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

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