pub enum TerminationReason {
    NotTerminated,
    MaxItersReached,
    TargetCostReached,
    TargetPrecisionReached,
    NoChangeInCost,
    AcceptedStallIterExceeded,
    BestStallIterExceeded,
    LineSearchConditionMet,
    TargetToleranceReached,
    Aborted,
}
Expand description

Reasons for optimization algorithms to stop

Variants

NotTerminated

The optimization algorithm is not terminated

MaxItersReached

Reached maximum number of iterations

TargetCostReached

Reached target cost function value

TargetPrecisionReached

Reached target precision

NoChangeInCost

No change in cost function value

AcceptedStallIterExceeded

Acceped stall iter exceeded (Simulated Annealing)

BestStallIterExceeded

Best stall iter exceeded (Simulated Annealing)

LineSearchConditionMet

Condition for line search met

TargetToleranceReached

Reached target tolerance

Aborted

Algorithm aborted

Implementations

Returns true if a solver terminated and false otherwise.

Example
use argmin::core::TerminationReason;

assert!(TerminationReason::MaxItersReached.terminated());
assert!(TerminationReason::TargetCostReached.terminated());
assert!(TerminationReason::TargetPrecisionReached.terminated());
assert!(TerminationReason::NoChangeInCost.terminated());
assert!(TerminationReason::AcceptedStallIterExceeded.terminated());
assert!(TerminationReason::BestStallIterExceeded.terminated());
assert!(TerminationReason::LineSearchConditionMet.terminated());
assert!(TerminationReason::TargetToleranceReached.terminated());
assert!(TerminationReason::Aborted.terminated());
assert!(!TerminationReason::NotTerminated.terminated());

Returns a textual representation of what happened.

Example
use argmin::core::TerminationReason;

assert_eq!(
    TerminationReason::MaxItersReached.text(),
    "Maximum number of iterations reached"
);
assert_eq!(
    TerminationReason::TargetCostReached.text(),
    "Target cost value reached"
);
assert_eq!(
    TerminationReason::TargetPrecisionReached.text(),
    "Target precision reached"
);
assert_eq!(
    TerminationReason::NoChangeInCost.text(),
    "No change in cost function value"
);
assert_eq!(
    TerminationReason::AcceptedStallIterExceeded.text(),
    "Accepted stall iterations exceeded"
);
assert_eq!(
    TerminationReason::BestStallIterExceeded.text(),
    "Best stall iterations exceeded"
);
assert_eq!(
    TerminationReason::LineSearchConditionMet.text(),
    "Line search condition met"
);
assert_eq!(
    TerminationReason::TargetToleranceReached.text(),
    "Target tolerance reached"
);
assert_eq!(
    TerminationReason::Aborted.text(),
    "Optimization aborted"
);
assert_eq!(
    TerminationReason::NotTerminated.text(),
    "Not terminated"
);

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Returns the “default value” for a type. Read more

Deserialize this value from the given Serde deserializer. Read more

Formats the value using the given formatter. Read more

Feeds this value into the given Hasher. Read more

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

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=.

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

Checks if self is actually part of its subset T (and can be converted to it).

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

The inclusion map: converts self to the equivalent element of its superset.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

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

Uses borrowed data to replace owned data, usually by cloning. Read more

Converts the given value to a String. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.