crocoddyl 1.9.0
Contact RObot COntrol by Differential DYnamic programming Library (Crocoddyl)
 
Loading...
Searching...
No Matches
ResidualModelStateTpl< _Scalar > Class Template Reference

State residual. More...

#include <crocoddyl/multibody/residuals/state.hpp>

Inheritance diagram for ResidualModelStateTpl< _Scalar >:
Collaboration diagram for ResidualModelStateTpl< _Scalar >:

Public Types

typedef ActivationModelAbstractTpl< Scalar > ActivationModelAbstract
 
typedef ResidualModelAbstractTpl< Scalar > Base
 
typedef DataCollectorAbstractTpl< Scalar > DataCollectorAbstract
 
typedef MathBaseTpl< Scalar > MathBase
 
typedef MathBase::MatrixXs MatrixXs
 
typedef ResidualDataAbstractTpl< Scalar > ResidualDataAbstract
 
typedef StateMultibodyTpl< Scalar > StateMultibody
 
typedef MathBase::VectorXs VectorXs
 
- Public Types inherited from ResidualModelAbstractTpl< _Scalar >
typedef DataCollectorAbstractTpl< Scalar > DataCollectorAbstract
 
typedef MathBaseTpl< Scalar > MathBase
 
typedef MathBase::MatrixXs MatrixXs
 
typedef ResidualDataAbstractTpl< Scalar > ResidualDataAbstract
 
typedef StateAbstractTpl< Scalar > StateAbstract
 
typedef MathBase::VectorXs VectorXs
 

Public Member Functions

 ResidualModelStateTpl (boost::shared_ptr< typename Base::StateAbstract > state)
 Initialize the state residual model. More...
 
 ResidualModelStateTpl (boost::shared_ptr< typename Base::StateAbstract > state, const std::size_t nu)
 Initialize the state residual model. More...
 
 ResidualModelStateTpl (boost::shared_ptr< typename Base::StateAbstract > state, const VectorXs &xref)
 Initialize the state residual model. More...
 
 ResidualModelStateTpl (boost::shared_ptr< typename Base::StateAbstract > state, const VectorXs &xref, const std::size_t nu)
 Initialize the state residual model. More...
 
virtual void calc (const boost::shared_ptr< ResidualDataAbstract > &data, const Eigen::Ref< const VectorXs > &x, const Eigen::Ref< const VectorXs > &u)
 Compute the state residual. More...
 
virtual void calcDiff (const boost::shared_ptr< ResidualDataAbstract > &data, const Eigen::Ref< const VectorXs > &x, const Eigen::Ref< const VectorXs > &u)
 Compute the Jacobians of the state residual. More...
 
const VectorXs & get_reference () const
 Return the reference state.
 
virtual void print (std::ostream &os) const
 Print relevant information of the state residual. More...
 
void set_reference (const VectorXs &reference)
 Modify the reference state.
 
- Public Member Functions inherited from ResidualModelAbstractTpl< _Scalar >
 ResidualModelAbstractTpl (boost::shared_ptr< StateAbstract > state, const std::size_t nr, const bool q_dependent=true, const bool v_dependent=true, const bool u_dependent=true)
 
 ResidualModelAbstractTpl (boost::shared_ptr< StateAbstract > state, const std::size_t nr, const std::size_t nu, const bool q_dependent=true, const bool v_dependent=true, const bool u_dependent=true)
 Initialize the residual model. More...
 
virtual void calc (const boost::shared_ptr< ResidualDataAbstract > &data, const Eigen::Ref< const VectorXs > &x)
 Compute the residual vector for nodes that depends only on the state. More...
 
virtual void calc (const boost::shared_ptr< ResidualDataAbstract > &data, const Eigen::Ref< const VectorXs > &x, const Eigen::Ref< const VectorXs > &u)
 Compute the residual vector. More...
 
virtual void calcDiff (const boost::shared_ptr< ResidualDataAbstract > &data, const Eigen::Ref< const VectorXs > &x)
 Compute the Jacobian of the residual functions with respect to the state only. More...
 
virtual void calcDiff (const boost::shared_ptr< ResidualDataAbstract > &data, const Eigen::Ref< const VectorXs > &x, const Eigen::Ref< const VectorXs > &u)
 Compute the Jacobian of the residual vector. More...
 
virtual boost::shared_ptr< ResidualDataAbstractcreateData (DataCollectorAbstract *const data)
 Create the residual data. More...
 
std::size_t get_nr () const
 Return the dimension of the residual vector.
 
std::size_t get_nu () const
 Return the dimension of the control input.
 
bool get_q_dependent () const
 Return true if the residual function depends on q.
 
const boost::shared_ptr< StateAbstract > & get_state () const
 Return the state.
 
bool get_u_dependent () const
 Return true if the residual function depends on u.
 
bool get_v_dependent () const
 Return true if the residual function depends on v.
 
virtual void print (std::ostream &os) const
 Print relevant information of the residual model. More...
 

Public Attributes

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

Protected Attributes

std::size_t nu_
 Control dimension. More...
 
boost::shared_ptr< StateAbstractstate_
 State description. More...
 
bool u_dependent_
 Label that indicates if the residual function depends on u. More...
 
VectorXs unone_
 No control vector. More...
 
- Protected Attributes inherited from ResidualModelAbstractTpl< _Scalar >
std::size_t nr_
 Residual vector dimension. More...
 
std::size_t nu_
 Control dimension. More...
 
bool q_dependent_
 Label that indicates if the residual function depends on q. More...
 
boost::shared_ptr< StateAbstractstate_
 State description. More...
 
bool u_dependent_
 Label that indicates if the residual function depends on u. More...
 
VectorXs unone_
 No control vector. More...
 
bool v_dependent_
 Label that indicates if the residual function depends on v. More...
 

Detailed Description

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

State residual.

This residual function defines the state tracking as \(\mathbf{r}=\mathbf{x}\ominus\mathbf{x}^*\), where \(\mathbf{x},\mathbf{x}^*\in~\mathcal{X}\) are the current and reference states, respectively, which belong to the state manifold \(\mathcal{X}\). Note that the dimension of the residual vector is obtained from StateAbstract::get_ndx(). Furthermore, the Jacobians of the residual function are computed analytically.

As described in ResidualModelAbstractTpl(), the residual value and its derivatives are calculated by calc and calcDiff, respectively.

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

Definition at line 35 of file state.hpp.

Member Typedef Documentation

◆ MathBase

typedef MathBaseTpl<Scalar> MathBase

Definition at line 40 of file state.hpp.

◆ Base

typedef ResidualModelAbstractTpl<Scalar> Base

Definition at line 41 of file state.hpp.

◆ StateMultibody

Definition at line 42 of file state.hpp.

◆ ResidualDataAbstract

Definition at line 43 of file state.hpp.

◆ ActivationModelAbstract

Definition at line 44 of file state.hpp.

◆ DataCollectorAbstract

Definition at line 45 of file state.hpp.

◆ VectorXs

typedef MathBase::VectorXs VectorXs

Definition at line 46 of file state.hpp.

◆ MatrixXs

typedef MathBase::MatrixXs MatrixXs

Definition at line 47 of file state.hpp.

Constructor & Destructor Documentation

◆ ResidualModelStateTpl() [1/4]

ResidualModelStateTpl ( boost::shared_ptr< typename Base::StateAbstract state,
const VectorXs &  xref,
const std::size_t  nu 
)

Initialize the state residual model.

Parameters
[in]stateState of the multibody system
[in]xrefReference state
[in]nuDimension of the control vector

◆ ResidualModelStateTpl() [2/4]

ResidualModelStateTpl ( boost::shared_ptr< typename Base::StateAbstract state,
const VectorXs &  xref 
)

Initialize the state residual model.

The default nu value is obtained from StateAbstractTpl::get_nv().

Parameters
[in]stateState of the multibody system
[in]xrefReference state

◆ ResidualModelStateTpl() [3/4]

ResidualModelStateTpl ( boost::shared_ptr< typename Base::StateAbstract state,
const std::size_t  nu 
)

Initialize the state residual model.

The default reference state is obtained from StateAbstractTpl::zero().

Parameters
[in]stateState of the multibody system
[in]nuDimension of the control vector

◆ ResidualModelStateTpl() [4/4]

ResidualModelStateTpl ( boost::shared_ptr< typename Base::StateAbstract state)

Initialize the state residual model.

The default state reference is obtained from StateAbstractTpl::zero(), and nu from StateAbstractTpl::get_nv().

Parameters
[in]stateState of the multibody system
[in]activationActivation model

Member Function Documentation

◆ calc()

virtual void calc ( const boost::shared_ptr< ResidualDataAbstract > &  data,
const Eigen::Ref< const VectorXs > &  x,
const Eigen::Ref< const VectorXs > &  u 
)
virtual

Compute the state residual.

Parameters
[in]dataState residual data
[in]xState point \(\mathbf{x}\in\mathbb{R}^{ndx}\)
[in]uControl input \(\mathbf{u}\in\mathbb{R}^{nu}\)

Reimplemented from ResidualModelAbstractTpl< _Scalar >.

◆ calcDiff()

virtual void calcDiff ( const boost::shared_ptr< ResidualDataAbstract > &  data,
const Eigen::Ref< const VectorXs > &  x,
const Eigen::Ref< const VectorXs > &  u 
)
virtual

Compute the Jacobians of the state residual.

Parameters
[in]dataState residual data
[in]xState point \(\mathbf{x}\in\mathbb{R}^{ndx}\)
[in]uControl input \(\mathbf{u}\in\mathbb{R}^{nu}\)

Reimplemented from ResidualModelAbstractTpl< _Scalar >.

◆ print()

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

Print relevant information of the state residual.

Parameters
[out]osOutput stream object

Reimplemented from ResidualModelAbstractTpl< _Scalar >.

Member Data Documentation

◆ Scalar

EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef _Scalar Scalar

Definition at line 39 of file state.hpp.

◆ nu_

std::size_t nu_
protected

Control dimension.

Definition at line 181 of file residual-base.hpp.

◆ state_

boost::shared_ptr<StateAbstract> state_
protected

State description.

Definition at line 179 of file residual-base.hpp.

◆ u_dependent_

bool u_dependent_
protected

Label that indicates if the residual function depends on u.

Definition at line 185 of file residual-base.hpp.

◆ unone_

VectorXs unone_
protected

No control vector.

Definition at line 182 of file residual-base.hpp.


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