Define a control residual. More...

#include <control.hpp>

Inheritance diagram for ResidualModelControlTpl< _Scalar >:

Public Types
typedef ActivationDataAbstractTpl< Scalar >	ActivationDataAbstract
typedef ResidualModelAbstractTpl< Scalar >	Base
typedef CostDataAbstractTpl< Scalar >	CostDataAbstract
typedef DataCollectorAbstractTpl< Scalar >	DataCollectorAbstract
typedef MathBaseTpl< Scalar >	MathBase
typedef MathBase::MatrixXs	MatrixXs
typedef ResidualDataAbstractTpl< Scalar >	ResidualDataAbstract
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
	ResidualModelControlTpl (std::shared_ptr< typename Base::StateAbstract > state)
	Initialize the control residual model.
	ResidualModelControlTpl (std::shared_ptr< typename Base::StateAbstract > state, const std::size_t nu)
	Initialize the control residual model.
	ResidualModelControlTpl (std::shared_ptr< typename Base::StateAbstract > state, const VectorXs &uref)
	Initialize the control residual model.
virtual void	calc (const std::shared_ptr< ResidualDataAbstract > &data, const Eigen::Ref< const VectorXs > &x) override
	Compute the residual vector for nodes that depends only on the state.
virtual void	calc (const std::shared_ptr< ResidualDataAbstract > &data, const Eigen::Ref< const VectorXs > &x, const Eigen::Ref< const VectorXs > &u) override
	Compute the control residual.
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) override
	Compute the derivative of the control-cost function.
virtual void	calcDiff (const std::shared_ptr< ResidualDataAbstract > &data, const Eigen::Ref< const VectorXs > &x, const Eigen::Ref< const VectorXs > &u) override
	Compute the derivatives of the control residual.
template<typename NewScalar>
ResidualModelControlTpl< NewScalar >	cast () const
	Cast the control residual model to a different scalar type.
virtual std::shared_ptr< ResidualDataAbstract >	createData (DataCollectorAbstract *const data) override
	Create the control residual data.
const VectorXs &	get_reference () const
	Return the reference control vector.
virtual void	print (std::ostream &os) const override
	Print relevant information of the control residual.
void	set_reference (const VectorXs &reference)
	Modify the reference control vector.
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.
	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.
virtual void	calcDiff (const std::shared_ptr< ResidualDataAbstract > &data, const Eigen::Ref< const VectorXs > &x)
	Compute the Jacobian of the residual functions with respect to the state only.
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.
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::ResidualModelControlTpl< _Scalar >

Define a control residual.

This residual function is defined as $\mathbf{r}=\mathbf{u}-\mathbf{u}^*$ , where $\mathbf{u},\mathbf{u}^*\in~\mathbb{R}^{nu}$ are the current and reference control inputs, respectively. Note that the dimension of the residual vector is obtained from nu.

Both residual and residual Jacobians 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 35 of file control.hpp.

Member Typedef Documentation

◆ MathBase

template<typename _Scalar>

typedef MathBaseTpl<Scalar> MathBase

Definition at line 41 of file control.hpp.

◆ Base

template<typename _Scalar>

typedef ResidualModelAbstractTpl<Scalar> Base

Definition at line 42 of file control.hpp.

◆ ResidualDataAbstract

template<typename _Scalar>

typedef ResidualDataAbstractTpl<Scalar> ResidualDataAbstract

Definition at line 43 of file control.hpp.

◆ CostDataAbstract

template<typename _Scalar>

typedef CostDataAbstractTpl<Scalar> CostDataAbstract

Definition at line 44 of file control.hpp.

◆ ActivationDataAbstract

template<typename _Scalar>

typedef ActivationDataAbstractTpl<Scalar> ActivationDataAbstract

Definition at line 45 of file control.hpp.

◆ DataCollectorAbstract

template<typename _Scalar>

typedef DataCollectorAbstractTpl<Scalar> DataCollectorAbstract

Definition at line 46 of file control.hpp.

◆ VectorXs

template<typename _Scalar>

typedef MathBase::VectorXs VectorXs

Definition at line 47 of file control.hpp.

◆ MatrixXs

template<typename _Scalar>

typedef MathBase::MatrixXs MatrixXs

Definition at line 48 of file control.hpp.

Constructor & Destructor Documentation

◆ ResidualModelControlTpl() [1/3]

template<typename _Scalar>

ResidualModelControlTpl	(	std::shared_ptr< typename Base::StateAbstract >	state,
		const VectorXs &	uref )

Initialize the control residual model.

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

Parameters

[in]	state	State of the multibody system
[in]	uref	Reference control input

◆ ResidualModelControlTpl() [2/3]

template<typename _Scalar>

ResidualModelControlTpl	(	std::shared_ptr< typename Base::StateAbstract >	state,
		const std::size_t	nu )

Initialize the control residual model.

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

Parameters

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

◆ ResidualModelControlTpl() [3/3]

template<typename _Scalar>

ResidualModelControlTpl ( std::shared_ptr< typename Base::StateAbstract > state )

explicit

Initialize the control residual model.

The default reference control is obtained from MathBaseTpl<>::VectorXs::Zero(nu).

Parameters

[in] state State of the multibody system

Member Function Documentation

◆ calc() [1/2]

template<typename _Scalar>

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

overridevirtual

Compute the control 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]

template<typename _Scalar>

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

overridevirtual

Compute the residual vector for nodes that depends only on the state.

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()

template<typename _Scalar>

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

overridevirtual

Compute the derivatives of the control 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 >.

◆ createData()

template<typename _Scalar>

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

overridevirtual

Create the control residual data.

Reimplemented from ResidualModelAbstractTpl< _Scalar >.

◆ calcCostDiff()

template<typename _Scalar>

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 )

overridevirtual

Compute the derivative of the control-cost function.

This function assumes that the derivatives of the activation and residual are computed via calcDiff functions.

Parameters

cdata	Cost data
rdata	Residual data
adata	Activation data
update_u	Update the derivative of the cost function w.r.t. to the control if True.

Reimplemented from ResidualModelAbstractTpl< _Scalar >.

◆ cast()

template<typename _Scalar>

template<typename NewScalar>

ResidualModelControlTpl< NewScalar > cast ( ) const

Cast the control residual model to a different scalar type.

It is useful for operations requiring different precision or scalar types.

Template Parameters

NewScalar The new scalar type to cast to.

Returns: ResidualModelControlTpl<NewScalar> A residual model with the new scalar type.

◆ print()

template<typename _Scalar>

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

overridevirtual

Print relevant information of the control residual.

Parameters

[out] os Output stream object

Reimplemented from ResidualModelAbstractTpl< _Scalar >.

Member Data Documentation

◆ Scalar

template<typename _Scalar>

EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef _Scalar Scalar

Definition at line 40 of file control.hpp.

◆ nu_

template<typename _Scalar>

std::size_t nu_

protected

Control dimension.

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

◆ state_

template<typename _Scalar>

std::shared_ptr<StateAbstract> state_

protected

State description.

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

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

/build/source/include/crocoddyl/core/fwd.hpp
/build/source/include/crocoddyl/core/residuals/control.hpp

Public Types

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ MathBase

◆ Base

◆ ResidualDataAbstract

◆ CostDataAbstract

◆ ActivationDataAbstract

◆ DataCollectorAbstract

◆ VectorXs

◆ MatrixXs

Constructor & Destructor Documentation

◆ ResidualModelControlTpl() [1/3]

◆ ResidualModelControlTpl() [2/3]

◆ ResidualModelControlTpl() [3/3]

Member Function Documentation

◆ calc() [1/2]

◆ calc() [2/2]

◆ calcDiff()

◆ createData()

◆ calcCostDiff()

◆ cast()

◆ print()

Member Data Documentation

◆ Scalar

◆ nu_

◆ state_