Exotica
Public Types | Public Member Functions | Public Attributes | List of all members
Eigen::FiniteDiffChainJacobian< Functor, mode > Class Template Reference

#include <finitediff_chain_jacobian.h>

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

Public Types

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

Public Member Functions

 FiniteDiffChainJacobian (Scalar epsfcn=0.)
 
 FiniteDiffChainJacobian (const Functor &f, Scalar epsfcn=0.)
 
 FiniteDiffChainJacobian (const Functor &f, UpdateFunctionCallbackType update, Scalar epsfcn=0.)
 
template<typename T0 >
 FiniteDiffChainJacobian (const T0 &a0, Scalar epsfcn=0.)
 
template<typename T0 , typename T1 >
 FiniteDiffChainJacobian (const T0 &a0, const T1 &a1, 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 >
 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

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

Member Typedef Documentation

◆ Index

template<typename Functor , NumericalDiffMode mode = Forward>
typedef JacobianType::Index Eigen::FiniteDiffChainJacobian< Functor, mode >::Index

◆ InputJacobianRowType

template<typename Functor , NumericalDiffMode mode = Forward>
typedef Matrix<Scalar, JacobianInputsAtCompileTime, 1> Eigen::FiniteDiffChainJacobian< Functor, mode >::InputJacobianRowType

◆ InputType

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

◆ JacobianType

template<typename Functor , NumericalDiffMode mode = Forward>
typedef Matrix<Scalar, ValuesAtCompileTime, JacobianInputsAtCompileTime> Eigen::FiniteDiffChainJacobian< Functor, mode >::JacobianType

◆ Scalar

template<typename Functor , NumericalDiffMode mode = Forward>
typedef ValueType::Scalar Eigen::FiniteDiffChainJacobian< Functor, mode >::Scalar

◆ UpdateFunctionCallbackType

template<typename Functor , NumericalDiffMode mode = Forward>
typedef std::function<void(const InputJacobianRowType &, InputType &)> Eigen::FiniteDiffChainJacobian< Functor, mode >::UpdateFunctionCallbackType

◆ ValueType

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

Member Enumeration Documentation

◆ anonymous enum

template<typename Functor , NumericalDiffMode mode = Forward>
anonymous enum
Enumerator
InputsAtCompileTime 
ValuesAtCompileTime 
JacobianInputsAtCompileTime 

Constructor & Destructor Documentation

◆ FiniteDiffChainJacobian() [1/9]

template<typename Functor , NumericalDiffMode mode = Forward>
Eigen::FiniteDiffChainJacobian< Functor, mode >::FiniteDiffChainJacobian ( Scalar  epsfcn = 0.)
inline

◆ FiniteDiffChainJacobian() [2/9]

template<typename Functor , NumericalDiffMode mode = Forward>
Eigen::FiniteDiffChainJacobian< Functor, mode >::FiniteDiffChainJacobian ( const Functor &  f,
Scalar  epsfcn = 0. 
)
inline

◆ FiniteDiffChainJacobian() [3/9]

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

◆ FiniteDiffChainJacobian() [4/9]

template<typename Functor , NumericalDiffMode mode = Forward>
template<typename T0 >
Eigen::FiniteDiffChainJacobian< Functor, mode >::FiniteDiffChainJacobian ( const T0 &  a0,
Scalar  epsfcn = 0. 
)
inline

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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

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

◆ operator()() [2/2]

template<typename Functor , NumericalDiffMode mode = Forward>
int Eigen::FiniteDiffChainJacobian< Functor, mode >::operator() ( const InputJacobianRowType &  _jx,
ValueType &  v,
JacobianType &  jac 
) const
inline

Member Data Documentation

◆ epsfcn_

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

◆ update_

template<typename Functor , NumericalDiffMode mode = Forward>
UpdateFunctionCallbackType Eigen::FiniteDiffChainJacobian< Functor, mode >::update_ = [](const InputJacobianRowType &jx, InputType &x) { x = jx; }
The documentation for this class was generated from the following file:
Generated on Fri Jul 23 2021 12:11:41 for Exotica by   doxygen 1.8.17