Struct ModelMap 

pub struct ModelMap<Inner: FitModel, Map: DifferentiableFunction<Inner::Scalar>> {
    pub inner: Inner,
    /* private fields */
}

Model equal to application of a function on top of a model.

You can’t construct this struct manually, please use model_map for that. This is motivated by it’s fields containing two separate objects (value and derivative), that are actually dependent and should be derived from each other.

Fields

inner: Inner

Inner model.

Trait Implementations

impl<Inner: Clone + FitModel, Map: Clone + DifferentiableFunction<Inner::Scalar>> Clone for ModelMap<Inner, Map>

where Inner::Scalar: Clone, Map::ValueParams: Clone, Map::DerivativeParams: Clone,

fn clone(&self) -> ModelMap<Inner, Map>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Inner: Debug + FitModel, Map: Debug + DifferentiableFunction<Inner::Scalar>> Debug for ModelMap<Inner, Map>

where Inner::Scalar: Debug, Map::ValueParams: Debug, Map::DerivativeParams: Debug,

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

Formats the value using the given formatter.

impl<Inner, Map: DifferentiableFunction<Inner::Scalar>> FitModel for ModelMap<Inner, Map>

where Inner: FitModel, Inner::Scalar: Clone + Mul<Inner::Scalar, Output = Inner::Scalar>,

type Scalar = <Inner as FitModel>::Scalar

Type of x, y, model parameters and all the derivatives. Different types are not supported (yet)

type ParamCount = <Inner as FitModel>::ParamCount

Type representing number of parameters.

fn evaluate(&self, x: &Self::Scalar) -> Self::Scalar

Computes model value for supplied x value and current parameters.

fn jacobian( &self, x: &Self::Scalar, ) -> impl Into<GenericArray<Self::Scalar, <Self::ParamCount as Conv>::TNum>>

Computes jacobian (array of derivatives) for supplied x value and current parameters.

fn set_params( &mut self, new_params: GenericArray<Self::Scalar, <Self::ParamCount as Conv>::TNum>, )

Sets model parameters to ones contained in a generic array

fn get_params( &self, ) -> impl Into<GenericArray<Self::Scalar, <Self::ParamCount as Conv>::TNum>>

Returns current values of model params.

impl<Inner, Map> FitModelXDeriv for ModelMap<Inner, Map>

where Inner: FitModelXDeriv, Inner::Scalar: Mul<Output = Inner::Scalar>, Map: DifferentiableFunction<Inner::Scalar>, Self: FitModel<Scalar = Inner::Scalar, ParamCount = Inner::ParamCount>,

fn deriv_x(&self, x: &Self::Scalar) -> Self::Scalar

Returns derivative over x at supplied x value.

impl<Inner: Hash + FitModel, Map: Hash + DifferentiableFunction<Inner::Scalar>> Hash for ModelMap<Inner, Map>

where Inner::Scalar: Hash, Map::ValueParams: Hash, Map::DerivativeParams: Hash,

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<Inner: Ord + FitModel, Map: Ord + DifferentiableFunction<Inner::Scalar>> Ord for ModelMap<Inner, Map>

where Inner::Scalar: Ord, Map::ValueParams: Ord, Map::DerivativeParams: Ord,

fn cmp(&self, other: &ModelMap<Inner, Map>) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<Inner: PartialEq + FitModel, Map: PartialEq + DifferentiableFunction<Inner::Scalar>> PartialEq for ModelMap<Inner, Map>

where Inner::Scalar: PartialEq, Map::ValueParams: PartialEq, Map::DerivativeParams: PartialEq,

fn eq(&self, other: &ModelMap<Inner, Map>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Inner: PartialOrd + FitModel, Map: PartialOrd + DifferentiableFunction<Inner::Scalar>> PartialOrd for ModelMap<Inner, Map>

where Inner::Scalar: PartialOrd, Map::ValueParams: PartialOrd, Map::DerivativeParams: PartialOrd,

fn partial_cmp(&self, other: &ModelMap<Inner, Map>) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<Inner: Eq + FitModel, Map: Eq + DifferentiableFunction<Inner::Scalar>> Eq for ModelMap<Inner, Map>

where Inner::Scalar: Eq, Map::ValueParams: Eq, Map::DerivativeParams: Eq,

impl<Inner: FitModel, Map: DifferentiableFunction<Inner::Scalar>> StructuralPartialEq for ModelMap<Inner, Map>