Enum argmin::core::TerminationReason

pub enum TerminationReason {
    MaxItersReached,
    TargetCostReached,
    Interrupt,
    SolverConverged,
    Timeout,
    SolverExit(String),
}

Reasons for optimization algorithms to stop

Variants

MaxItersReached

Reached maximum number of iterations

TargetCostReached

Reached target cost function value

Interrupt

Algorithm manually interrupted with SIGINT (Ctrl+C), SIGTERM or SIGHUP

SolverConverged

Converged

Timeout

Timeout reached

SolverExit(String)

Solver exit with given reason

Implementations

impl TerminationReason

pub fn text(&self) -> &str

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::Interrupt.text(),
    "Interrupt"
);
assert_eq!(
    TerminationReason::SolverConverged.text(),
    "Solver converged"
);
assert_eq!(
    TerminationReason::Timeout.text(),
    "Timeout reached"
);
assert_eq!(
    TerminationReason::SolverExit("Aborted".to_string()).text(),
    "Aborted"
);

Trait Implementations

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

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for TerminationReason

fn eq(&self, other: &TerminationReason) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

impl StructuralPartialEq for TerminationReason