Eigen::FiniteDiffChainJacobian< Functor, mode > Class Template Reference

#include <finitediff_chain_jacobian.h>

Inheritance diagram for Eigen::FiniteDiffChainJacobian< Functor, mode >:

Public Types
enum	{ InputsAtCompileTime = InputType::RowsAtCompileTime, ValuesAtCompileTime = ValueType::RowsAtCompileTime, JacobianInputsAtCompileTime = Functor::JacobianColsAtCompileTime }
typedef JacobianType::Index	Index
typedef Matrix< Scalar, JacobianInputsAtCompileTime, 1 >	InputJacobianRowType
typedef Functor::InputType	InputType
typedef Matrix< Scalar, ValuesAtCompileTime, JacobianInputsAtCompileTime >	JacobianType
typedef ValueType::Scalar	Scalar
typedef std::function< void(const InputJacobianRowType &, InputType &)>	UpdateFunctionCallbackType
typedef Functor::ValueType	ValueType

Public Member Functions
	FiniteDiffChainJacobian (const Functor &f, Scalar epsfcn=0.)
	FiniteDiffChainJacobian (const Functor &f, UpdateFunctionCallbackType update, Scalar epsfcn=0.)
template<typename T0 , typename T1 , typename T2 >
	FiniteDiffChainJacobian (const T0 &a0, const T1 &a1, const T2 &a2, Scalar epsfcn=0.)
template<typename T0 , typename T1 >
	FiniteDiffChainJacobian (const T0 &a0, const T1 &a1, Scalar epsfcn=0.)
template<typename T0 >
	FiniteDiffChainJacobian (const T0 &a0, Scalar epsfcn=0.)
	FiniteDiffChainJacobian (Scalar epsfcn=0.)
template<typename T0 >
	FiniteDiffChainJacobian (UpdateFunctionCallbackType update, Scalar epsfcn=0., const T0 &a0)
template<typename T0 , typename T1 >
	FiniteDiffChainJacobian (UpdateFunctionCallbackType update, Scalar epsfcn=0., const T0 &a0, const T1 &a1)
template<typename T0 , typename T1 , typename T2 >
	FiniteDiffChainJacobian (UpdateFunctionCallbackType update, Scalar epsfcn=0., const T0 &a0, const T1 &a1, const T2 &a2)
EIGEN_STRONG_INLINE int	operator() (const InputJacobianRowType &_jx, ValueType &v) const
int	operator() (const InputJacobianRowType &_jx, ValueType &v, JacobianType &jac) const

Public Attributes
Scalar	epsfcn_
UpdateFunctionCallbackType	update_ = [](const InputJacobianRowType &jx, InputType &x) { x = jx; }

Detailed Description

template<typename Functor, NumericalDiffMode mode = Forward>
class Eigen::FiniteDiffChainJacobian< Functor, mode >

Definition at line 21 of file finitediff_chain_jacobian.h.

Member Typedef Documentation

Index

template<typename Functor , NumericalDiffMode mode = Forward>

typedef JacobianType::Index Eigen::FiniteDiffChainJacobian< Functor, mode >::Index

Definition at line 37 of file finitediff_chain_jacobian.h.

InputJacobianRowType

template<typename Functor , NumericalDiffMode mode = Forward>

typedef Matrix<Scalar, JacobianInputsAtCompileTime, 1> Eigen::FiniteDiffChainJacobian< Functor, mode >::InputJacobianRowType

Definition at line 36 of file finitediff_chain_jacobian.h.

InputType

template<typename Functor , NumericalDiffMode mode = Forward>

typedef Functor::InputType Eigen::FiniteDiffChainJacobian< Functor, mode >::InputType

Definition at line 24 of file finitediff_chain_jacobian.h.

JacobianType

template<typename Functor , NumericalDiffMode mode = Forward>

typedef Matrix<Scalar, ValuesAtCompileTime, JacobianInputsAtCompileTime> Eigen::FiniteDiffChainJacobian< Functor, mode >::JacobianType

Definition at line 35 of file finitediff_chain_jacobian.h.

Scalar

template<typename Functor , NumericalDiffMode mode = Forward>

typedef ValueType::Scalar Eigen::FiniteDiffChainJacobian< Functor, mode >::Scalar

Definition at line 26 of file finitediff_chain_jacobian.h.

UpdateFunctionCallbackType

template<typename Functor , NumericalDiffMode mode = Forward>

typedef std::function<void(const InputJacobianRowType &, InputType &)> Eigen::FiniteDiffChainJacobian< Functor, mode >::UpdateFunctionCallbackType

Definition at line 39 of file finitediff_chain_jacobian.h.

ValueType

template<typename Functor , NumericalDiffMode mode = Forward>

typedef Functor::ValueType Eigen::FiniteDiffChainJacobian< Functor, mode >::ValueType

Definition at line 25 of file finitediff_chain_jacobian.h.

Member Enumeration Documentation

anonymous enum

template<typename Functor , NumericalDiffMode mode = Forward>

anonymous enum

Enumerator
InputsAtCompileTime
ValuesAtCompileTime
JacobianInputsAtCompileTime

Definition at line 28 of file finitediff_chain_jacobian.h.

Constructor & Destructor Documentation

FiniteDiffChainJacobian() [1/9]

template<typename Functor , NumericalDiffMode mode = Forward>

Eigen::FiniteDiffChainJacobian< Functor, mode >::FiniteDiffChainJacobian ( Scalar  epsfcn = 0. )

inline

Definition at line 44 of file finitediff_chain_jacobian.h.

FiniteDiffChainJacobian() [2/9]

template<typename Functor , NumericalDiffMode mode = Forward>

Eigen::FiniteDiffChainJacobian< Functor, mode >::FiniteDiffChainJacobian ( const Functor &  f, Scalar  epsfcn = 0.  )

inline

Definition at line 45 of file finitediff_chain_jacobian.h.

FiniteDiffChainJacobian() [3/9]

template<typename Functor , NumericalDiffMode mode = Forward>

Eigen::FiniteDiffChainJacobian< Functor, mode >::FiniteDiffChainJacobian ( const Functor &  f, UpdateFunctionCallbackType  update, Scalar  epsfcn = 0.  )

inline

Definition at line 46 of file finitediff_chain_jacobian.h.

FiniteDiffChainJacobian() [4/9]

template<typename Functor , NumericalDiffMode mode = Forward>

template<typename T0 >

Eigen::FiniteDiffChainJacobian< Functor, mode >::FiniteDiffChainJacobian ( const T0 &  a0, Scalar  epsfcn = 0.  )

inline

Definition at line 59 of file finitediff_chain_jacobian.h.

FiniteDiffChainJacobian() [5/9]

template<typename Functor , NumericalDiffMode mode = Forward>

template<typename T0 , typename T1 >

Eigen::FiniteDiffChainJacobian< Functor, mode >::FiniteDiffChainJacobian ( const T0 &  a0, const T1 &  a1, Scalar  epsfcn = 0.  )

inline

Definition at line 63 of file finitediff_chain_jacobian.h.

FiniteDiffChainJacobian() [6/9]

template<typename Functor , NumericalDiffMode mode = Forward>

template<typename T0 , typename T1 , typename T2 >

Eigen::FiniteDiffChainJacobian< Functor, mode >::FiniteDiffChainJacobian ( const T0 &  a0, const T1 &  a1, const T2 &  a2, Scalar  epsfcn = 0.  )

inline

Definition at line 67 of file finitediff_chain_jacobian.h.

FiniteDiffChainJacobian() [7/9]

template<typename Functor , NumericalDiffMode mode = Forward>

template<typename T0 >

Eigen::FiniteDiffChainJacobian< Functor, mode >::FiniteDiffChainJacobian ( UpdateFunctionCallbackType  update, Scalar  epsfcn = 0., const T0 &  a0  )

inline

Definition at line 72 of file finitediff_chain_jacobian.h.

FiniteDiffChainJacobian() [8/9]

template<typename Functor , NumericalDiffMode mode = Forward>

template<typename T0 , typename T1 >

Eigen::FiniteDiffChainJacobian< Functor, mode >::FiniteDiffChainJacobian ( UpdateFunctionCallbackType  update, Scalar  epsfcn = 0., const T0 &  a0, const T1 &  a1  )

inline

Definition at line 76 of file finitediff_chain_jacobian.h.

FiniteDiffChainJacobian() [9/9]

template<typename Functor , NumericalDiffMode mode = Forward>

template<typename T0 , typename T1 , typename T2 >

Eigen::FiniteDiffChainJacobian< Functor, mode >::FiniteDiffChainJacobian ( UpdateFunctionCallbackType  update, Scalar  epsfcn = 0., const T0 &  a0, const T1 &  a1, const T2 &  a2  )

inline

Definition at line 80 of file finitediff_chain_jacobian.h.

Member Function Documentation

operator()() [1/2]

template<typename Functor , NumericalDiffMode mode = Forward>

EIGEN_STRONG_INLINE int Eigen::FiniteDiffChainJacobian< Functor, mode >::operator() ( const InputJacobianRowType &  _jx, ValueType &  v  ) const

inline

Definition at line 110 of file finitediff_chain_jacobian.h.

operator()() [2/2]

template<typename Functor , NumericalDiffMode mode = Forward>

int Eigen::FiniteDiffChainJacobian< Functor, mode >::operator() ( const InputJacobianRowType &  _jx, ValueType &  v, JacobianType &  jac  ) const

inline

Definition at line 118 of file finitediff_chain_jacobian.h.

Member Data Documentation

epsfcn_

template<typename Functor , NumericalDiffMode mode = Forward>

Scalar Eigen::FiniteDiffChainJacobian< Functor, mode >::epsfcn_

Definition at line 42 of file finitediff_chain_jacobian.h.

update_

template<typename Functor , NumericalDiffMode mode = Forward>

UpdateFunctionCallbackType Eigen::FiniteDiffChainJacobian< Functor, mode >::update_ = [](const InputJacobianRowType &jx, InputType &x) { x = jx; }

Definition at line 41 of file finitediff_chain_jacobian.h.

---

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

• finitediff_chain_jacobian.h