Struct argmin::prelude::ArgminResult

pub struct ArgminResult<O> where
    O: ArgminOp,  {
    pub operator: O,
    pub state: IterState<O>,
}

This is returned by the Executor after the solver is run on the operator.

TODO: Think about removing this, as returning the IterState may be much better

Fields

operator: O

operator

state: IterState<O>

iteration state

Methods

impl<O> ArgminResult<O> where
    O: ArgminOp, 

pub fn new(operator: O, state: IterState<O>) -> ArgminResult<O>

Constructor

Trait Implementations

impl<O> Ord for ArgminResult<O> where
    O: ArgminOp, 

fn cmp(&self, other: &ArgminResult<O>) -> 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.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl<O> Clone for ArgminResult<O> where
    O: ArgminOp + Clone, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<O> Eq for ArgminResult<O> where
    O: ArgminOp, 

impl<O> Display for ArgminResult<O> where
    O: ArgminOp,
    <O as ArgminOp>::Param: Debug, 

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

Formats the value using the given formatter.

impl<O> Serialize for ArgminResult<O> where
    O: ArgminOp + Serialize, 

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

Serialize this value into the given Serde serializer.

impl<O> PartialOrd<ArgminResult<O>> for ArgminResult<O> where
    O: ArgminOp, 

fn partial_cmp(&self, other: &ArgminResult<O>) -> 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<'de, O> Deserialize<'de> for ArgminResult<O> where
    O: ArgminOp + Deserialize<'de>, 

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

Deserialize this value from the given Serde deserializer.

impl<O> PartialEq<ArgminResult<O>> for ArgminResult<O> where
    O: ArgminOp, 

fn eq(&self, other: &ArgminResult<O>) -> 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 !=.