Struct argmin::core::ArgminResult

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

Final struct returned by the run method of Executor.

Fields

operator: O

operator

state: IterState<O>

iteration state

Implementations

impl<O: ArgminOp> ArgminResult<O>

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

Constructor

pub fn operator(&self) -> &O

Return handle to operator

pub fn state(&self) -> &IterState<O>

Return handle to state

Trait Implementations

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

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> Display for ArgminResult<O> where
    O: ArgminOp,
    O::Param: Debug, 

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

Formats the value using the given formatter.

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

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

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]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: ArgminOp> PartialEq<ArgminResult<O>> for ArgminResult<O>

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 !=.

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

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.