Struct argmin_core::ArgminResult

pub struct ArgminResult<T> {
    pub param: T,
    pub cost: f64,
    pub iters: u64,
    pub terminated: bool,
    pub termination_reason: TerminationReason,
}

Return struct for all solvers.

Fields

param: T

Final parameter vector

cost: f64

Final cost value

iters: u64

Number of iterations

terminated: bool

Indicated whether it terminated or not

termination_reason: TerminationReason

Reason of termination

Methods

impl<T> ArgminResult<T>

pub fn new(
    param: T,
    cost: f64,
    iters: u64,
    termination_reason: TerminationReason
) -> Self

Constructor

param: Final (best) parameter vector cost: Final (best) cost function value iters: Number of iterations termination_reason: Reason of termination

Trait Implementations

impl<T> PartialEq<ArgminResult<T>> for ArgminResult<T>

fn eq(&self, other: &ArgminResult<T>) -> bool

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

#[must_use]

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

This method tests for !=.

impl<T: Default> Default for ArgminResult<T>

fn default() -> ArgminResult<T>

Returns the "default value" for a type.

impl<T> Ord for ArgminResult<T>

fn cmp(&self, other: &ArgminResult<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl<T: Clone> Clone for ArgminResult<T>

fn clone(&self) -> ArgminResult<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Eq for ArgminResult<T>

impl<T> PartialOrd<ArgminResult<T>> for ArgminResult<T>

fn partial_cmp(&self, other: &ArgminResult<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Debug> Display for ArgminResult<T>

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

Formats the value using the given formatter.

impl<T: Debug> Debug for ArgminResult<T>

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

Formats the value using the given formatter.

impl<T> Serialize for ArgminResult<T> where
    T: Serialize, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de, T> Deserialize<'de> for ArgminResult<T> where
    T: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.