RVL::RVLScalarLogisticDeriv

RVL::RVLScalarLogisticDeriv< Scalar > Class Template Reference

This TFO implements the scalar version of the logistic function derivative $ df(x)dx = (1 + s^2 x^2)^{-3/2} dx$, where $ s=2/(f_{\rm max} - f_{\rm min})$. More...

#include <logistic.hh>

Inheritance diagram for RVL::RVLScalarLogisticDeriv< Scalar >:

RVL::TernaryLocalFunctionObject< Scalar > RVL::FunctionObject RVL::TernaryLocalEvaluation< Scalar > RVL::Writeable RVL::LocalEvaluation< Scalar > List of all members.

Public Member Functions

 RVLScalarLogisticDeriv (Scalar fmin=ScalarFieldTraits< Scalar >::Zero(), Scalar fmax=ScalarFieldTraits< Scalar >::One())
 ~RVLScalarLogisticDeriv ()
void operator() (LocalDataContainer< Scalar > &x, LocalDataContainer< Scalar > const &y, LocalDataContainer< Scalar > const &dy)
string getName () const

Detailed Description

template<class Scalar>
class RVL::RVLScalarLogisticDeriv< Scalar >

This TFO implements the scalar version of the logistic function derivative $ df(x)dx = (1 + s^2 x^2)^{-3/2} dx$, where $ s=2/(f_{\rm max} - f_{\rm min})$.

The function is applied to each component of the input LDC, value written to the corresponding component of the output LDC. Input and output must have the same length.

Definition at line 196 of file logistic.hh.

Constructor & Destructor Documentation

template<class Scalar>
RVL::RVLScalarLogisticDeriv< Scalar >::RVLScalarLogisticDeriv ( Scalar  fmin = ScalarFieldTraits<Scalar>::Zero(),
Scalar  fmax = ScalarFieldTraits<Scalar>::One() 
)

Definition at line 202 of file logistic.hh.

template<class Scalar>
RVL::RVLScalarLogisticDeriv< Scalar >::~RVLScalarLogisticDeriv (  ) 

Definition at line 219 of file logistic.hh.

Member Function Documentation

template<class Scalar>
void RVL::RVLScalarLogisticDeriv< Scalar >::operator() ( LocalDataContainer< Scalar > &  x,
LocalDataContainer< Scalar > const &  y,
LocalDataContainer< Scalar > const &  dy 
) [virtual]

Implements RVL::TernaryLocalEvaluation< Scalar >.

Definition at line 227 of file logistic.hh.

References RVL::LocalDataContainer< DataType >::getData(), and RVL::LocalDataContainer< DataType >::getSize().

template<class Scalar>
string RVL::RVLScalarLogisticDeriv< Scalar >::getName (  )  const [virtual]

Implements RVL::FunctionObject.

Definition at line 250 of file logistic.hh.

The documentation for this class was generated from the following file:
Generated on 5 Jan 2017 for LocalRVL by  doxygen 1.4.7