Control gravity residual. More...

#include <control-gravity.hpp>

Inheritance diagram for ResidualModelControlGravTpl< _Scalar >:

Public Types
typedef ResidualModelAbstractTpl< Scalar >	Base

typedef ResidualDataControlGravTpl< Scalar >	Data

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 ActivationDataAbstractTpl< Scalar >	ActivationDataAbstract

typedef CostDataAbstractTpl< Scalar >	CostDataAbstract

typedef DataCollectorAbstractTpl< Scalar >	DataCollectorAbstract

typedef MathBase::DiagonalMatrixXs	DiagonalMatrixXs

typedef MathBaseTpl< Scalar >	MathBase

typedef MathBase::MatrixXs	MatrixXs

typedef ResidualDataAbstractTpl< Scalar >	ResidualDataAbstract

typedef StateAbstractTpl< Scalar >	StateAbstract

typedef MathBase::VectorXs	VectorXs

Public Member Functions
	ResidualModelControlGravTpl (std::shared_ptr< StateMultibody > state)
	Initialize the control gravity residual model. More...

	ResidualModelControlGravTpl (std::shared_ptr< StateMultibody > state, const std::size_t nu)
	Initialize the control gravity residual model. More...

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

virtual void	calc (const std::shared_ptr< ResidualDataAbstract > &data, const Eigen::Ref< const VectorXs > &x, const Eigen::Ref< const VectorXs > &u)
	Compute the control gravity residual. More...

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

virtual void	calcDiff (const std::shared_ptr< ResidualDataAbstract > &data, const Eigen::Ref< const VectorXs > &x, const Eigen::Ref< const VectorXs > &u)
	Compute the Jacobians of the control gravity residual. More...

virtual std::shared_ptr< ResidualDataAbstract >	createData (DataCollectorAbstract *const data)
	Create the residual data. More...

virtual void	print (std::ostream &os) const
	Print relevant information of the control-grav residual. More...

Public Member Functions inherited from ResidualModelAbstractTpl< _Scalar >
	ResidualModelAbstractTpl (std::shared_ptr< StateAbstract > state, const std::size_t nr, const bool q_dependent=true, const bool v_dependent=true, const bool u_dependent=true)
	Initialize the residual model. More...

	ResidualModelAbstractTpl (std::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	calcCostDiff (const std::shared_ptr< CostDataAbstract > &cdata, const std::shared_ptr< ResidualDataAbstract > &rdata, const std::shared_ptr< ActivationDataAbstract > &adata, const bool update_u=true)
	Compute the derivative of the cost function. 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 std::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.

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.

std::shared_ptr< StateAbstract >	state_
	State description.

bool	v_dependent_

Protected Attributes inherited from ResidualModelAbstractTpl< _Scalar >
std::size_t	nr_
	Residual vector dimension.

std::size_t	nu_
	Control dimension.

bool	q_dependent_

std::shared_ptr< StateAbstract >	state_
	State description.

bool	u_dependent_

VectorXs	unone_
	No control vector.

bool	v_dependent_

Detailed Description

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

Control gravity residual.

This residual function is defined as \(\mathbf{r}=\mathbf{u}-\mathbf{g}(\mathbf{q})\), where \(\mathbf{u}\in~\mathbb{R}^{nu}\) is the current control input, \(\mathbf{g}(\mathbf{q})\) is the gravity torque corresponding to the current configuration, \(\mathbf{q}\in~\mathbb{R}^{nq}\) the current position joints input. Note that the dimension of the residual vector is obtained from StateAbstractTpl::get_nv().

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 36 of file control-gravity.hpp.

Constructor & Destructor Documentation

◆ ResidualModelControlGravTpl() [1/2]

ResidualModelControlGravTpl	(	std::shared_ptr< StateMultibody >	state,
		const std::size_t	nu
	)

Initialize the control gravity residual model.

Parameters

[in]	state	State of the multibody system
[in]	nu	Dimension of control vector

◆ ResidualModelControlGravTpl() [2/2]

ResidualModelControlGravTpl ( std::shared_ptr< StateMultibody > state )

Initialize the control gravity residual model.

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

Parameters

[in] state State of the multibody system

Member Function Documentation

◆ calc() [1/2]

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

virtual

Compute the control gravity residual.

Parameters

[in]	data	Control residual data
[in]	x	State point \(\mathbf{x}\in\mathbb{R}^{ndx}\)
[in]	u	Control input \(\mathbf{u}\in\mathbb{R}^{nu}\)

Reimplemented from ResidualModelAbstractTpl< _Scalar >.

◆ calc() [2/2]

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

virtual

It updates the residual vector based on the state only. This function is used in the terminal nodes of an optimal control problem.

Parameters

[in]	data	Residual data
[in]	x	State point \(\mathbf{x}\in\mathbb{R}^{ndx}\)

Reimplemented from ResidualModelAbstractTpl< _Scalar >.

◆ calcDiff() [1/2]

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

virtual

Compute the Jacobians of the control gravity residual.

Parameters

[in]	data	Control residual data
[in]	x	State point \(\mathbf{x}\in\mathbb{R}^{ndx}\)
[in]	u	Control input \(\mathbf{u}\in\mathbb{R}^{nu}\)

Reimplemented from ResidualModelAbstractTpl< _Scalar >.

◆ calcDiff() [2/2]

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

virtual

Reimplemented from ResidualModelAbstractTpl< _Scalar >.

◆ createData()

virtual std::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 specialize this function if we need to create additional data, for instance, to avoid dynamic memory allocation.

Parameters

data	Data collector

Returns: the residual data

Reimplemented from ResidualModelAbstractTpl< _Scalar >.

◆ print()

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

virtual

Print relevant information of the control-grav residual.

Parameters

[out] os Output stream object

Reimplemented from ResidualModelAbstractTpl< _Scalar >.

Member Data Documentation

◆ v_dependent_

bool v_dependent_

protected

Label that indicates if the residual function depends on v

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

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

/root/robotpkg/optimization/py-crocoddyl/work/crocoddyl-2.1.0/include/crocoddyl/multibody/fwd.hpp
/root/robotpkg/optimization/py-crocoddyl/work/crocoddyl-2.1.0/include/crocoddyl/multibody/residuals/control-gravity.hpp

Public Types

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

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

Constructor & Destructor Documentation

◆ ResidualModelControlGravTpl() [1/2]

◆ ResidualModelControlGravTpl() [2/2]

Member Function Documentation

◆ calc() [1/2]

◆ calc() [2/2]

◆ calcDiff() [1/2]

◆ calcDiff() [2/2]

◆ createData()

◆ print()

Member Data Documentation

◆ v_dependent_

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