Enum TerminationStatus

pub enum TerminationStatus {
    Terminated(TerminationReason),
    NotTerminated,
}

Status of optimization execution

Variants

Terminated(TerminationReason)

Execution is terminated

NotTerminated

Execution is running

Implementations

impl TerminationStatus

pub fn terminated(&self) -> bool

Returns true if a solver terminated and false otherwise.

Example

use argmin::core::{TerminationStatus, TerminationReason};

assert!(TerminationStatus::Terminated(TerminationReason::MaxItersReached).terminated());
assert!(TerminationStatus::Terminated(TerminationReason::TargetCostReached).terminated());
assert!(TerminationStatus::Terminated(TerminationReason::SolverConverged).terminated());
assert!(TerminationStatus::Terminated(TerminationReason::Interrupt).terminated());
assert!(TerminationStatus::Terminated(TerminationReason::Timeout).terminated());
assert!(TerminationStatus::Terminated(TerminationReason::SolverExit("Exit reason".to_string())).terminated());

Trait Implementations

impl Clone for TerminationStatus

fn clone(&self) -> TerminationStatus

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TerminationStatus

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

Formats the value using the given formatter.

impl Default for TerminationStatus

fn default() -> TerminationStatus

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TerminationStatus

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TerminationStatus

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

Formats the value using the given formatter.

impl Hash for TerminationStatus

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 TerminationStatus

fn eq(&self, other: &TerminationStatus) -> 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 TerminationStatus

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 TerminationStatus

impl StructuralPartialEq for TerminationStatus