Eigen::NumericalDiff< _Functor, mode > Class Template Reference

#include <NumericalDiff.h>

Inheritance diagram for Eigen::NumericalDiff< _Functor, mode >:

Public Types
enum	{ InputsAtCompileTime = Functor::InputsAtCompileTime , ValuesAtCompileTime = Functor::ValuesAtCompileTime }
typedef _Functor	Functor
typedef Functor::Scalar	Scalar
typedef Functor::InputType	InputType
typedef Functor::ValueType	ValueType
typedef Functor::JacobianType	JacobianType

Public Member Functions
	NumericalDiff (Scalar _epsfcn=0.)
	NumericalDiff (const Functor &f, Scalar _epsfcn=0.)
template<typename T0 >
	NumericalDiff (const T0 &a0)
template<typename T0 , typename T1 >
	NumericalDiff (const T0 &a0, const T1 &a1)
template<typename T0 , typename T1 , typename T2 >
	NumericalDiff (const T0 &a0, const T1 &a1, const T2 &a2)
int	df (const InputType &_x, JacobianType &jac) const

Detailed Description

template<typename _Functor, NumericalDiffMode mode = Forward>
class Eigen::NumericalDiff< _Functor, mode >

This class allows you to add a method df() to your functor, which will use numerical differentiation to compute an approximate of the derivative for the functor. Of course, if you have an analytical form for the derivative, you should rather implement df() by yourself.

More information on http://en.wikipedia.org/wiki/Numerical_differentiation

Currently only "Forward" and "Central" scheme are implemented.

Member Typedef Documentation

Functor

template<typename _Functor , NumericalDiffMode mode = Forward>

typedef _Functor Eigen::NumericalDiff< _Functor, mode >::Functor

InputType

template<typename _Functor , NumericalDiffMode mode = Forward>

typedef Functor::InputType Eigen::NumericalDiff< _Functor, mode >::InputType

JacobianType

template<typename _Functor , NumericalDiffMode mode = Forward>

typedef Functor::JacobianType Eigen::NumericalDiff< _Functor, mode >::JacobianType

Scalar

template<typename _Functor , NumericalDiffMode mode = Forward>

typedef Functor::Scalar Eigen::NumericalDiff< _Functor, mode >::Scalar

ValueType

template<typename _Functor , NumericalDiffMode mode = Forward>

typedef Functor::ValueType Eigen::NumericalDiff< _Functor, mode >::ValueType

Member Enumeration Documentation

anonymous enum

template<typename _Functor , NumericalDiffMode mode = Forward>

anonymous enum

Enumerator
InputsAtCompileTime
ValuesAtCompileTime

Constructor & Destructor Documentation

NumericalDiff() [1/5]

template<typename _Functor , NumericalDiffMode mode = Forward>

Eigen::NumericalDiff< _Functor, mode >::NumericalDiff ( Scalar  _epsfcn = 0. )

inline

NumericalDiff() [2/5]

template<typename _Functor , NumericalDiffMode mode = Forward>

Eigen::NumericalDiff< _Functor, mode >::NumericalDiff ( const Functor &  f, Scalar  _epsfcn = 0.  )

inline

NumericalDiff() [3/5]

template<typename _Functor , NumericalDiffMode mode = Forward>

template<typename T0 >

Eigen::NumericalDiff< _Functor, mode >::NumericalDiff ( const T0 &  a0 )

inline

NumericalDiff() [4/5]

template<typename _Functor , NumericalDiffMode mode = Forward>

template<typename T0 , typename T1 >

Eigen::NumericalDiff< _Functor, mode >::NumericalDiff ( const T0 &  a0, const T1 &  a1  )

inline

NumericalDiff() [5/5]

template<typename _Functor , NumericalDiffMode mode = Forward>

template<typename T0 , typename T1 , typename T2 >

Eigen::NumericalDiff< _Functor, mode >::NumericalDiff ( const T0 &  a0, const T1 &  a1, const T2 &  a2  )

inline

Member Function Documentation

df()

template<typename _Functor , NumericalDiffMode mode = Forward>

int Eigen::NumericalDiff< _Functor, mode >::df ( const InputType &  _x, JacobianType &  jac  ) const

inline

return the number of evaluation of functor

---

The documentation for this class was generated from the following file:

• core/util/algorithms/eigen-3.4.0/unsupported/Eigen/src/NumericalDiff/NumericalDiff.h