Crocoddyl
Public Types | Public Member Functions | Public Attributes | Protected Attributes | List of all members
ActivationModelNumDiffTpl< _Scalar > Class Template Reference
Inheritance diagram for ActivationModelNumDiffTpl< _Scalar >:
ActivationModelAbstractTpl< _Scalar >

Public Types

typedef ActivationDataAbstractTpl< Scalar > ActivationDataAbstract
 
typedef ActivationModelAbstractTpl< Scalar > Base
 
typedef ActivationDataNumDiffTpl< Scalar > Data
 
typedef MathBaseTpl< Scalar > MathBase
 
typedef MathBase::MatrixXs MatrixXs
 
typedef MathBase::VectorXs VectorXs
 
- Public Types inherited from ActivationModelAbstractTpl< _Scalar >
typedef ActivationDataAbstractTpl< Scalar > ActivationDataAbstract
 
typedef MathBaseTpl< Scalar > MathBase
 
typedef MathBase::MatrixXs MatrixXs
 
typedef MathBase::VectorXs VectorXs
 

Public Member Functions

 ActivationModelNumDiffTpl (boost::shared_ptr< Base > model)
 Construct a new ActivationModelNumDiff object. More...
 
virtual ~ActivationModelNumDiffTpl ()
 Destroy the ActivationModelNumDiff object.
 
virtual void calc (const boost::shared_ptr< ActivationDataAbstract > &data, const Eigen::Ref< const VectorXs > &r)
 
virtual void calcDiff (const boost::shared_ptr< ActivationDataAbstract > &data, const Eigen::Ref< const VectorXs > &r)
 
virtual boost::shared_ptr< ActivationDataAbstract > createData ()
 Create a Data object from the given model. More...
 
const Scalar get_disturbance () const
 Return the disturbance constant used in the numerical differentiation routine.
 
const boost::shared_ptr< Base > & get_model () const
 Get the model_ object. More...
 
void set_disturbance (const Scalar disturbance)
 Modify the disturbance constant used in the numerical differentiation routine.
 
- Public Member Functions inherited from ActivationModelAbstractTpl< _Scalar >
 ActivationModelAbstractTpl (const std::size_t nr)
 
std::size_t get_nr () const
 
virtual void print (std::ostream &os) const
 Print relevant information of the activation model. More...
 

Public Attributes

EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef _Scalar Scalar
 
- Public Attributes inherited from ActivationModelAbstractTpl< _Scalar >
EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef _Scalar Scalar
 

Protected Attributes

std::size_t nr_
 
- Protected Attributes inherited from ActivationModelAbstractTpl< _Scalar >
std::size_t nr_
 

Detailed Description

template<typename _Scalar>
class crocoddyl::ActivationModelNumDiffTpl< _Scalar >

Definition at line 22 of file activation.hpp.

Constructor & Destructor Documentation

◆ ActivationModelNumDiffTpl()

ActivationModelNumDiffTpl ( boost::shared_ptr< Base >  model)
explicit

Construct a new ActivationModelNumDiff object.

Parameters
model

Member Function Documentation

◆ calc()

virtual void calc ( const boost::shared_ptr< ActivationDataAbstract > &  data,
const Eigen::Ref< const VectorXs > &  r 
)
virtual

Implements ActivationModelAbstractTpl< _Scalar >.

◆ calcDiff()

virtual void calcDiff ( const boost::shared_ptr< ActivationDataAbstract > &  data,
const Eigen::Ref< const VectorXs > &  r 
)
virtual

Implements ActivationModelAbstractTpl< _Scalar >.

◆ createData()

virtual boost::shared_ptr<ActivationDataAbstract> createData ( )
virtual

Create a Data object from the given model.

Returns
boost::shared_ptr<ActivationDataAbstract>

Reimplemented from ActivationModelAbstractTpl< _Scalar >.

◆ get_model()

const boost::shared_ptr<Base>& get_model ( ) const

Get the model_ object.

Returns
Base&
The documentation for this class was generated from the following files: