Crocoddyl
ActuationModelFullTpl< _Scalar > Class Template Reference

Full actuation model. More...

#include <full.hpp>

Inheritance diagram for ActuationModelFullTpl< _Scalar >:
ActuationModelAbstractTpl< _Scalar > ActuationModelBase

Public Types

typedef ActuationModelAbstractTpl< Scalar > Base
 
typedef ActuationDataAbstractTpl< Scalar > Data
 
typedef MathBaseTpl< Scalar > MathBase
 
typedef MathBase::MatrixXs MatrixXs
 
typedef StateAbstractTpl< Scalar > StateAbstract
 
typedef MathBase::VectorXs VectorXs
 
- Public Types inherited from ActuationModelAbstractTpl< _Scalar >
typedef ActuationDataAbstractTpl< Scalar > ActuationDataAbstract
 
typedef MathBaseTpl< Scalar > MathBase
 
typedef MathBase::MatrixXs MatrixXs
 
typedef StateAbstractTpl< Scalar > StateAbstract
 
typedef MathBase::VectorXs VectorXs
 

Public Member Functions

 ActuationModelFullTpl (std::shared_ptr< StateAbstract > state)
 Initialize the full actuation model. More...
 
virtual void calc (const std::shared_ptr< Data > &data, const Eigen::Ref< const VectorXs > &, const Eigen::Ref< const VectorXs > &u) override
 Compute the full actuation. More...
 
virtual void calcDiff (const std::shared_ptr< Data > &data, const Eigen::Ref< const VectorXs > &, const Eigen::Ref< const VectorXs > &) override
 Compute the Jacobians of the full actuation model. More...
 
template<typename NewScalar >
ActuationModelFullTpl< NewScalar > cast () const
 
virtual void commands (const std::shared_ptr< Data > &data, const Eigen::Ref< const VectorXs > &, const Eigen::Ref< const VectorXs > &tau) override
 Compute the joint torque input from the generalized torques. More...
 
virtual std::shared_ptr< DatacreateData () override
 Create the full actuation data. More...
 
virtual void print (std::ostream &os) const override
 Print relevant information of the joint-effort residual. More...
 
virtual void torqueTransform (const std::shared_ptr< Data > &data, const Eigen::Ref< const VectorXs > &, const Eigen::Ref< const VectorXs > &) override
 Compute the torque transform from generalized torques to joint torque inputs. More...
 
- Public Member Functions inherited from ActuationModelAbstractTpl< _Scalar >
 ActuationModelAbstractTpl (std::shared_ptr< StateAbstract > state, const std::size_t nu)
 Initialize the actuation model. More...
 
void calc (const std::shared_ptr< ActuationDataAbstract > &data, const Eigen::Ref< const VectorXs > &x)
 Ignore the computation of the actuation signal. More...
 
void calcDiff (const std::shared_ptr< ActuationDataAbstract > &data, const Eigen::Ref< const VectorXs > &x)
 Ignore the computation of the Jacobians of the actuation function. More...
 
std::size_t get_nu () const
 Return the dimension of the joint-torque input.
 
const std::shared_ptr< StateAbstract > & get_state () const
 Return the state.
 

Public Attributes

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

Protected Attributes

std::size_t nu_
 Dimension of joint torque inputs.
 
std::shared_ptr< StateAbstractstate_
 Model of the state.
 
- Protected Attributes inherited from ActuationModelAbstractTpl< _Scalar >
std::size_t nu_
 Dimension of joint torque inputs.
 
std::shared_ptr< StateAbstractstate_
 Model of the state.
 

Detailed Description

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

Full actuation model.

This actuation model applies input controls for all the nv dimensions of the system.

Both actuation and Jacobians are computed analytically by calc and calcDiff, respectively.

See also
ActuationModelAbstractTpl, calc(), calcDiff(), createData()

Definition at line 31 of file full.hpp.

Constructor & Destructor Documentation

◆ ActuationModelFullTpl()

ActuationModelFullTpl ( std::shared_ptr< StateAbstract state)
inlineexplicit

Initialize the full actuation model.

Parameters
[in]stateState of the dynamical system

Definition at line 49 of file full.hpp.

Member Function Documentation

◆ calc()

virtual void calc ( const std::shared_ptr< Data > &  data,
const Eigen::Ref< const VectorXs > &  ,
const Eigen::Ref< const VectorXs > &  u 
)
inlineoverridevirtual

Compute the full actuation.

Parameters
[in]dataFull actuation data
[in]xState point \(\mathbf{x}\in\mathbb{R}^{ndx}\)
[in]uJoint torque input \(\mathbf{u}\in\mathbb{R}^{nu}\)

Implements ActuationModelAbstractTpl< _Scalar >.

Definition at line 60 of file full.hpp.

◆ calcDiff()

virtual void calcDiff ( const std::shared_ptr< Data > &  data,
const Eigen::Ref< const VectorXs > &  ,
const Eigen::Ref< const VectorXs > &   
)
inlineoverridevirtual

Compute the Jacobians of the full actuation model.

Parameters
[in]dataFull actuation data
[in]xState point \(\mathbf{x}\in\mathbb{R}^{ndx}\)
[in]uJoint torque input \(\mathbf{u}\in\mathbb{R}^{nu}\)

Implements ActuationModelAbstractTpl< _Scalar >.

Definition at line 79 of file full.hpp.

◆ commands()

virtual void commands ( const std::shared_ptr< Data > &  data,
const Eigen::Ref< const VectorXs > &  x,
const Eigen::Ref< const VectorXs > &  tau 
)
inlineoverridevirtual

Compute the joint torque input from the generalized torques.

It stores the results in ActuationDataAbstractTpl::u.

Parameters
[in]dataActuation data
[in]xState point \(\mathbf{x}\in\mathbb{R}^{ndx}\)
[in]tauGeneralized torques \(\mathbf{u}\in\mathbb{R}^{nv}\)

Implements ActuationModelAbstractTpl< _Scalar >.

Definition at line 94 of file full.hpp.

◆ torqueTransform()

virtual void torqueTransform ( const std::shared_ptr< Data > &  data,
const Eigen::Ref< const VectorXs > &  x,
const Eigen::Ref< const VectorXs > &  u 
)
inlineoverridevirtual

Compute the torque transform from generalized torques to joint torque inputs.

It stores the results in ActuationDataAbstractTpl::Mtau.

Parameters
[in]dataActuation data
[in]xState point \(\mathbf{x}\in\mathbb{R}^{ndx}\)
[in]tauJoint-torque inputs \(\mathbf{u}\in\mathbb{R}^{nu}\)

Reimplemented from ActuationModelAbstractTpl< _Scalar >.

Definition at line 106 of file full.hpp.

◆ createData()

virtual std::shared_ptr<Data> createData ( )
inlineoverridevirtual

Create the full actuation data.

Parameters
[in]datashared data (it should be of type DataCollectorContactTpl)
Returns
the cost data.

Reimplemented from ActuationModelAbstractTpl< _Scalar >.

Definition at line 125 of file full.hpp.

◆ print()

virtual void print ( std::ostream &  os) const
inlineoverridevirtual

Print relevant information of the joint-effort residual.

Parameters
[out]osOutput stream object

Reimplemented from ActuationModelAbstractTpl< _Scalar >.

Definition at line 145 of file full.hpp.


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