RVL::RVLScalarLogistic< Scalar > Class Template Reference

This BFO implements the scalar version of the logistic function $ f(x) = x (1 + s^2 x^2)^{-1/2} + m $, where $ s=2/(f_{\rm max} - f_{\rm min})$ and $ m=(f_{\rm max} + f_{\rm min})/2$. More...

#include <logistic.hh>

Inheritance diagram for RVL::RVLScalarLogistic< Scalar >:

RVL::BinaryLocalFunctionObject< Scalar > RVL::FunctionObject RVL::BinaryLocalEvaluation< Scalar > RVL::Writeable RVL::LocalEvaluation< Scalar > List of all members.

Public Member Functions

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

Detailed Description

template<class Scalar>
class RVL::RVLScalarLogistic< Scalar >

This BFO implements the scalar version of the logistic function $ f(x) = x (1 + s^2 x^2)^{-1/2} + m $, where $ s=2/(f_{\rm max} - f_{\rm min})$ and $ m=(f_{\rm max} + f_{\rm min})/2$.

This function has the properties

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 57 of file logistic.hh.


Constructor & Destructor Documentation

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

Definition at line 63 of file logistic.hh.

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

Definition at line 81 of file logistic.hh.


Member Function Documentation

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

Implements RVL::BinaryLocalEvaluation< Scalar >.

Definition at line 89 of file logistic.hh.

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

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

Implements RVL::FunctionObject.

Definition at line 106 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