Struct varpro::model::DerivativeProxy[][src]

#[must_use =
  "Derivative Proxy should be used immediately to evaluate a derivative matrix"]pub struct DerivativeProxy<'a, ScalarType: Scalar> { /* fields omitted */ }

A helper proxy that is used in conjuntion with the method to evalue the derivative of a separable model. This structure serves no purpose other than making the function call to calculate the derivative a little more readable

Implementations

impl<'a, ScalarType: Scalar + Zero> DerivativeProxy<'a, ScalarType>[src]

pub fn at(&self, param_index: usize) -> Result<DMatrix<ScalarType>, ModelError>[src]

This function is used in conjunction with evaluating the derivative matrix of the separable model. It is documented as part of the SeparableModel interface.

pub fn at_param_name<StrType: AsRef<str>>(
    &self,
    param_name: StrType
) -> Result<DMatrix<ScalarType>, ModelError>
[src]

This function is used in conjunction with evaluating the derivative matrix of the separable model. It is documented as part of the SeparableModel interface. Allows to access the derivative by parameter name instead of index.

Returns

If the parameter is in the model parameters, returns the same result as calculating the derivative at the same parameter index. Otherwise returns an error indicating the parameter is not in the model parameters.

Auto Trait Implementations

impl<'a, ScalarType> !RefUnwindSafe for DerivativeProxy<'a, ScalarType>

impl<'a, ScalarType> !Send for DerivativeProxy<'a, ScalarType>

impl<'a, ScalarType> !Sync for DerivativeProxy<'a, ScalarType>

impl<'a, ScalarType> Unpin for DerivativeProxy<'a, ScalarType>

impl<'a, ScalarType> !UnwindSafe for DerivativeProxy<'a, ScalarType>

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP where
    SS: SubsetOf<SP>, 

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,