Struct argmin::prelude::NoOperator

pub struct NoOperator<T, U, H, J> { /* fields omitted */ }

Fake Operators for testing No-op operator with free choice of the types

Methods

impl<T, U, H, J> NoOperator<T, U, H, J>

pub fn new() -> NoOperator<T, U, H, J>

Constructor

Trait Implementations

impl<T, U, H, J> Hash for NoOperator<T, U, H, J> where
    H: Hash,
    J: Hash,
    T: Hash,
    U: Hash, 

fn hash<__HTUHJ>(&self, state: &mut __HTUHJ) where
    __HTUHJ: Hasher, 

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<T, U, H, J> PartialOrd<NoOperator<T, U, H, J>> for NoOperator<T, U, H, J> where
    H: PartialOrd<H>,
    J: PartialOrd<J>,
    T: PartialOrd<T>,
    U: PartialOrd<U>, 

fn partial_cmp(&self, other: &NoOperator<T, U, H, J>) -> Option<Ordering>

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

fn lt(&self, other: &NoOperator<T, U, H, J>) -> bool

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

fn le(&self, other: &NoOperator<T, U, H, J>) -> bool

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

fn gt(&self, other: &NoOperator<T, U, H, J>) -> bool

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

fn ge(&self, other: &NoOperator<T, U, H, J>) -> bool

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

impl<T, U, H, J> ArgminOp for NoOperator<T, U, H, J> where
    H: Clone + Default + Debug + Send + Sync + Serialize + DeserializeOwned,
    J: Clone + Default + Debug + Send + Sync + Serialize + DeserializeOwned,
    T: Clone + Default + Debug + Send + Sync + Serialize + DeserializeOwned,
    U: Clone + Default + Debug + Send + Sync + Serialize + DeserializeOwned, 

type Param = T

Type of the parameter vector

type Output = U

Output of the operator

type Hessian = H

Type of Hessian

type Jacobian = J

Type of Jacobian

fn apply(
    &self,
    _p: &<NoOperator<T, U, H, J> as ArgminOp>::Param
) -> Result<<NoOperator<T, U, H, J> as ArgminOp>::Output, Error>

Do nothing, really.

fn gradient(
    &self,
    _p: &<NoOperator<T, U, H, J> as ArgminOp>::Param
) -> Result<<NoOperator<T, U, H, J> as ArgminOp>::Param, Error>

Do nothing, really.

fn hessian(
    &self,
    _p: &<NoOperator<T, U, H, J> as ArgminOp>::Param
) -> Result<<NoOperator<T, U, H, J> as ArgminOp>::Hessian, Error>

Do nothing, really.

fn modify(
    &self,
    _p: &<NoOperator<T, U, H, J> as ArgminOp>::Param,
    _t: f64
) -> Result<<NoOperator<T, U, H, J> as ArgminOp>::Param, Error>

Do nothing, really.

fn jacobian(&self, _param: &Self::Param) -> Result<Self::Jacobian, Error>

Computes the Hessian at the given parameters

impl<T, U, H, J> Serialize for NoOperator<T, U, H, J>

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<'de, T, U, H, J> Deserialize<'de> for NoOperator<T, U, H, J>

fn deserialize<__D>(
    __deserializer: __D
) -> Result<NoOperator<T, U, H, J>, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<T, U, H, J> Eq for NoOperator<T, U, H, J> where
    H: Eq,
    J: Eq,
    T: Eq,
    U: Eq, 

impl<T, U, H, J> Default for NoOperator<T, U, H, J> where
    H: Default,
    J: Default,
    T: Default,
    U: Default, 

fn default() -> NoOperator<T, U, H, J>

Returns the "default value" for a type.

impl<T, U, H, J> Clone for NoOperator<T, U, H, J> where
    H: Clone,
    J: Clone,
    T: Clone,
    U: Clone, 

fn clone(&self) -> NoOperator<T, U, H, J>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, U, H, J> PartialEq<NoOperator<T, U, H, J>> for NoOperator<T, U, H, J> where
    H: PartialEq<H>,
    J: PartialEq<J>,
    T: PartialEq<T>,
    U: PartialEq<U>, 

fn eq(&self, other: &NoOperator<T, U, H, J>) -> bool

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

fn ne(&self, other: &NoOperator<T, U, H, J>) -> bool

This method tests for !=.

impl<T, U, H, J> Debug for NoOperator<T, U, H, J> where
    H: Debug,
    J: Debug,
    T: Debug,
    U: Debug, 

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

Formats the value using the given formatter.

impl<T, U, H, J> Display for NoOperator<T, U, H, J>

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

Formats the value using the given formatter.

impl<T, U, H, J> Ord for NoOperator<T, U, H, J> where
    H: Ord,
    J: Ord,
    T: Ord,
    U: Ord, 

fn cmp(&self, other: &NoOperator<T, U, H, J>) -> 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<T, U, H, J> Copy for NoOperator<T, U, H, J> where
    H: Copy,
    J: Copy,
    T: Copy,
    U: Copy,