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

CoM position residual. More...

#include <crocoddyl/multibody/residuals/com-position.hpp>

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

Public Types

typedef ResidualModelAbstractTpl< Scalar > Base
 
typedef ResidualDataCoMPositionTpl< Scalar > Data
 
typedef DataCollectorAbstractTpl< Scalar > DataCollectorAbstract
 
typedef MathBaseTpl< Scalar > MathBase
 
typedef ResidualDataAbstractTpl< Scalar > ResidualDataAbstract
 
typedef StateMultibodyTpl< Scalar > StateMultibody
 
typedef MathBase::Vector3s Vector3s
 
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

 ResidualModelCoMPositionTpl (boost::shared_ptr< StateMultibody > state, const Vector3s &cref)
 Initialize the CoM position residual model. More...
 
 ResidualModelCoMPositionTpl (boost::shared_ptr< StateMultibody > state, const Vector3s &cref, const std::size_t nu)
 Initialize the CoM position 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 CoM position 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 derivatives of the CoM position residual. More...
 
virtual boost::shared_ptr< ResidualDataAbstractcreateData (DataCollectorAbstract *const data)
 Create the residual data. More...
 
const Vector3s & get_reference () const
 Return the CoM position reference.
 
virtual void print (std::ostream &os) const
 Print relevant information of the com-position residual. More...
 
void set_reference (const Vector3s &cref)
 Modify the CoM position reference.
 
- 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...
 
bool v_dependent_
 Label that indicates if the residual function depends on v. 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::ResidualModelCoMPositionTpl< _Scalar >

CoM position residual.

This residual function defines the CoM tracking as \(\mathbf{r}=\mathbf{c}-\mathbf{c}^*\), where \(\mathbf{c},\mathbf{c}^*\in~\mathbb{R}^3\) are the current and reference CoM position, respectively. Note that the dimension of the residual vector is obtained from 3. Furthermore, the Jacobians of the residual function are computed analytically.

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

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

Definition at line 33 of file com-position.hpp.

Member Typedef Documentation

◆ MathBase

typedef MathBaseTpl<Scalar> MathBase

Definition at line 38 of file com-position.hpp.

◆ Base

typedef ResidualModelAbstractTpl<Scalar> Base

Definition at line 39 of file com-position.hpp.

◆ Data

Definition at line 40 of file com-position.hpp.

◆ StateMultibody

Definition at line 41 of file com-position.hpp.

◆ ResidualDataAbstract

Definition at line 42 of file com-position.hpp.

◆ DataCollectorAbstract

Definition at line 43 of file com-position.hpp.

◆ Vector3s

typedef MathBase::Vector3s Vector3s

Definition at line 44 of file com-position.hpp.

◆ VectorXs

typedef MathBase::VectorXs VectorXs

Definition at line 45 of file com-position.hpp.

Constructor & Destructor Documentation

◆ ResidualModelCoMPositionTpl() [1/2]

ResidualModelCoMPositionTpl ( boost::shared_ptr< StateMultibody state,
const Vector3s &  cref,
const std::size_t  nu 
)

Initialize the CoM position residual model.

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

◆ ResidualModelCoMPositionTpl() [2/2]

ResidualModelCoMPositionTpl ( boost::shared_ptr< StateMultibody state,
const Vector3s &  cref 
)

Initialize the CoM position residual model.

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

Parameters
[in]stateState of the multibody system
[in]crefReference CoM position

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 CoM position residual.

Parameters
[in]dataCoM position 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 derivatives of the CoM position residual.

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

Reimplemented from ResidualModelAbstractTpl< _Scalar >.

◆ createData()

virtual boost::shared_ptr< ResidualDataAbstract > createData ( DataCollectorAbstract *const  data)
virtual

Create the residual data.

The default data contains objects to store the values of the residual vector and their Jacobians. However, it is possible to specialized this function if we need to create additional data, for instance, to avoid dynamic memory allocation.

Parameters
dataData collector
Returns
the residual data

Reimplemented from ResidualModelAbstractTpl< _Scalar >.

◆ print()

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

Print relevant information of the com-position 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 37 of file com-position.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.

◆ v_dependent_

bool v_dependent_
protected

Label that indicates if the residual function depends on v.

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


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