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

#include <finitediff_chain_hessian.h>

Inheritance diagram for Eigen::FiniteDiffChainHessian< Functor, mode >:
Inheritance graph
[legend]

Public Types

enum  { InputsAtCompileTime = InputType::RowsAtCompileTime, ValuesAtCompileTime = ValueType::RowsAtCompileTime, JacobianInputsAtCompileTime = Functor::JacobianColsAtCompileTime }
 
typedef Array< Matrix< Scalar, JacobianInputsAtCompileTime, JacobianInputsAtCompileTime >, ValuesAtCompileTime, 1 > HessianType
 
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

 FiniteDiffChainHessian (const Functor &f, Scalar epsfcn=0.)
 
 FiniteDiffChainHessian (const Functor &f, UpdateFunctionCallbackType update, Scalar epsfcn=0.)
 
template<typename T0 , typename T1 , typename T2 >
 FiniteDiffChainHessian (const T0 &a0, const T1 &a1, const T2 &a2, Scalar epsfcn=0.)
 
template<typename T0 , typename T1 >
 FiniteDiffChainHessian (const T0 &a0, const T1 &a1, Scalar epsfcn=0.)
 
template<typename T0 >
 FiniteDiffChainHessian (const T0 &a0, Scalar epsfcn=0.)
 
 FiniteDiffChainHessian (Scalar epsfcn=0.)
 
template<typename T0 >
 FiniteDiffChainHessian (UpdateFunctionCallbackType update, Scalar epsfcn=0., const T0 &a0)
 
template<typename T0 , typename T1 >
 FiniteDiffChainHessian (UpdateFunctionCallbackType update, Scalar epsfcn=0., const T0 &a0, const T1 &a1)
 
template<typename T0 , typename T1 , typename T2 >
 FiniteDiffChainHessian (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
 
int operator() (const InputJacobianRowType &_jx, ValueType &v, JacobianType &jac, HessianType &hess) const
 

Public Attributes

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

Detailed Description

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

Definition at line 22 of file finitediff_chain_hessian.h.

Member Typedef Documentation

◆ HessianType

template<typename Functor , NumericalDiffMode mode = Forward>
typedef Array<Matrix<Scalar, JacobianInputsAtCompileTime, JacobianInputsAtCompileTime>, ValuesAtCompileTime, 1> Eigen::FiniteDiffChainHessian< Functor, mode >::HessianType

Definition at line 38 of file finitediff_chain_hessian.h.

◆ Index

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

Definition at line 39 of file finitediff_chain_hessian.h.

◆ InputJacobianRowType

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

Definition at line 37 of file finitediff_chain_hessian.h.

◆ InputType

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

Definition at line 25 of file finitediff_chain_hessian.h.

◆ JacobianType

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

Definition at line 36 of file finitediff_chain_hessian.h.

◆ Scalar

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

Definition at line 27 of file finitediff_chain_hessian.h.

◆ UpdateFunctionCallbackType

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

Definition at line 41 of file finitediff_chain_hessian.h.

◆ ValueType

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

Definition at line 26 of file finitediff_chain_hessian.h.

Member Enumeration Documentation

◆ anonymous enum

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

Definition at line 29 of file finitediff_chain_hessian.h.

Constructor & Destructor Documentation

◆ FiniteDiffChainHessian() [1/9]

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

Definition at line 46 of file finitediff_chain_hessian.h.

◆ FiniteDiffChainHessian() [2/9]

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

Definition at line 47 of file finitediff_chain_hessian.h.

◆ FiniteDiffChainHessian() [3/9]

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

Definition at line 48 of file finitediff_chain_hessian.h.

◆ FiniteDiffChainHessian() [4/9]

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

Definition at line 61 of file finitediff_chain_hessian.h.

◆ FiniteDiffChainHessian() [5/9]

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

Definition at line 65 of file finitediff_chain_hessian.h.

◆ FiniteDiffChainHessian() [6/9]

template<typename Functor , NumericalDiffMode mode = Forward>
template<typename T0 , typename T1 , typename T2 >
Eigen::FiniteDiffChainHessian< Functor, mode >::FiniteDiffChainHessian ( const T0 &  a0,
const T1 &  a1,
const T2 &  a2,
Scalar  epsfcn = 0. 
)
inline

Definition at line 69 of file finitediff_chain_hessian.h.

◆ FiniteDiffChainHessian() [7/9]

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

Definition at line 74 of file finitediff_chain_hessian.h.

◆ FiniteDiffChainHessian() [8/9]

template<typename Functor , NumericalDiffMode mode = Forward>
template<typename T0 , typename T1 >
Eigen::FiniteDiffChainHessian< Functor, mode >::FiniteDiffChainHessian ( UpdateFunctionCallbackType  update,
Scalar  epsfcn = 0.,
const T0 &  a0,
const T1 &  a1 
)
inline

Definition at line 78 of file finitediff_chain_hessian.h.

◆ FiniteDiffChainHessian() [9/9]

template<typename Functor , NumericalDiffMode mode = Forward>
template<typename T0 , typename T1 , typename T2 >
Eigen::FiniteDiffChainHessian< Functor, mode >::FiniteDiffChainHessian ( UpdateFunctionCallbackType  update,
Scalar  epsfcn = 0.,
const T0 &  a0,
const T1 &  a1,
const T2 &  a2 
)
inline

Definition at line 82 of file finitediff_chain_hessian.h.

Member Function Documentation

◆ operator()() [1/3]

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

Definition at line 119 of file finitediff_chain_hessian.h.

◆ operator()() [2/3]

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

Definition at line 127 of file finitediff_chain_hessian.h.

◆ operator()() [3/3]

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

Definition at line 133 of file finitediff_chain_hessian.h.

Member Data Documentation

◆ epsfcn_

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

Definition at line 44 of file finitediff_chain_hessian.h.

◆ update_

template<typename Functor , NumericalDiffMode mode = Forward>
UpdateFunctionCallbackType Eigen::FiniteDiffChainHessian< Functor, mode >::update_ = [](const InputJacobianRowType &jx, InputType &x) { x = jx; }

Definition at line 43 of file finitediff_chain_hessian.h.

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

exotica_core
Author(s): Yiming Yang, Michael Camilleri
autogenerated on Fri Aug 2 2024 08:43:03