RVL::RVLVectorLogistic

RVL::RVLVectorLogistic< Scalar > Class Template Reference

This QFO implements the vector 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::RVLVectorLogistic< Scalar >:

RVL::QuaternaryLocalFunctionObject< Scalar > RVL::FunctionObject RVL::QuaternaryLocalEvaluation< Scalar > RVL::Writeable RVL::LocalEvaluation< Scalar > List of all members.

Public Member Functions

 RVLVectorLogistic ()
 ~RVLVectorLogistic ()
void operator() (LocalDataContainer< Scalar > &x, LocalDataContainer< Scalar > const &y, LocalDataContainer< Scalar > const &lb, LocalDataContainer< Scalar > const &ub)
string getName () const

Detailed Description

template<class Scalar>
class RVL::RVLVectorLogistic< Scalar >

This QFO implements the vector 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. Values of $f_{\rm min}$ and $f_{\rm max}$ taken from two other LDCs of same length, third and fourth arguments respectively.

Definition at line 272 of file logistic.hh.

Constructor & Destructor Documentation

template<class Scalar>
RVL::RVLVectorLogistic< Scalar >::RVLVectorLogistic (  ) 

Definition at line 276 of file logistic.hh.

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

Definition at line 285 of file logistic.hh.

Member Function Documentation

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

Implements RVL::QuaternaryLocalEvaluation< Scalar >.

Definition at line 293 of file logistic.hh.

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

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

Implements RVL::FunctionObject.

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