Enum argmin::core::TerminationStatus
source · pub enum TerminationStatus {
Terminated(TerminationReason),
NotTerminated,
}
Expand description
Status of optimization execution
Variants§
Implementations§
source§impl TerminationStatus
impl TerminationStatus
sourcepub fn terminated(&self) -> bool
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::KeyboardInterrupt).terminated());
assert!(TerminationStatus::Terminated(TerminationReason::SolverExit("Exit reason".to_string())).terminated());
Trait Implementations§
source§impl Clone for TerminationStatus
impl Clone for TerminationStatus
source§fn clone(&self) -> TerminationStatus
fn clone(&self) -> TerminationStatus
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for TerminationStatus
impl Debug for TerminationStatus
source§impl Default for TerminationStatus
impl Default for TerminationStatus
source§fn default() -> TerminationStatus
fn default() -> TerminationStatus
Returns the “default value” for a type. Read more
source§impl<'de> Deserialize<'de> for TerminationStatus
impl<'de> Deserialize<'de> for TerminationStatus
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
source§impl Display for TerminationStatus
impl Display for TerminationStatus
source§impl Hash for TerminationStatus
impl Hash for TerminationStatus
source§impl PartialEq<TerminationStatus> for TerminationStatus
impl PartialEq<TerminationStatus> for TerminationStatus
source§fn eq(&self, other: &TerminationStatus) -> bool
fn eq(&self, other: &TerminationStatus) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.