Eigen::SampleNumericalDiff< _Functor > Class Template Reference

#include <samplenumericaldiff.h>

List of all members.

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
	SampleNumericalDiff (Scalar _epsfcn=0.)
	SampleNumericalDiff (const Functor &f, Scalar _epsfcn=0.)
template<typename T0 >
	SampleNumericalDiff (const T0 &a0)
template<typename T0 , typename T1 >
	SampleNumericalDiff (const T0 &a0, const T1 &a1)
template<typename T0 , typename T1 , typename T2 >
	SampleNumericalDiff (const T0 &a0, const T1 &a1, const T2 &a2)
int	df (const InputType &_x, JacobianType &jac)

---

Detailed Description

template<typename _Functor>
class Eigen::SampleNumericalDiff< _Functor >

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

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

---

Member Typedef Documentation

template<typename _Functor>

typedef _Functor Eigen::SampleNumericalDiff< _Functor >::Functor

template<typename _Functor>

typedef Functor::InputType Eigen::SampleNumericalDiff< _Functor >::InputType

template<typename _Functor>

typedef Functor::JacobianType Eigen::SampleNumericalDiff< _Functor >::JacobianType

template<typename _Functor>

typedef Functor::Scalar Eigen::SampleNumericalDiff< _Functor >::Scalar

template<typename _Functor>

typedef Functor::ValueType Eigen::SampleNumericalDiff< _Functor >::ValueType

---

Member Enumeration Documentation

template<typename _Functor>

anonymous enum

Enumerator:

InputsAtCompileTime
ValuesAtCompileTime

---

Constructor & Destructor Documentation

template<typename _Functor>

Eigen::SampleNumericalDiff< _Functor >::SampleNumericalDiff

(

Scalar

_epsfcn = 0.

)

[inline]

template<typename _Functor>

Eigen::SampleNumericalDiff< _Functor >::SampleNumericalDiff	(	const Functor &	f,
		Scalar	_epsfcn = 0.
	)		[inline]

template<typename _Functor>

template<typename T0 >

Eigen::SampleNumericalDiff< _Functor >::SampleNumericalDiff

(

const T0 &

a0

)

[inline]

template<typename _Functor>

template<typename T0 , typename T1 >

Eigen::SampleNumericalDiff< _Functor >::SampleNumericalDiff	(	const T0 &	a0,
		const T1 &	a1
	)		[inline]

template<typename _Functor>

template<typename T0 , typename T1 , typename T2 >

Eigen::SampleNumericalDiff< _Functor >::SampleNumericalDiff	(	const T0 &	a0,
		const T1 &	a1,
		const T2 &	a2
	)		[inline]

---

Member Function Documentation

template<typename _Functor>

int Eigen::SampleNumericalDiff< _Functor >::df	(	const InputType &	_x,
		JacobianType &	jac
	)		[inline]

return the number of evaluation of functor

---

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

• lib/utils/samplenumericaldiff.h