aligator::CostAbstractTpl< Scalar > Struct Template Reference

Stage costs \( \ell(x, u) \) for control problems. More...

#include <aligator/core/cost-abstract.hpp>

Inheritance diagram for aligator::CostAbstractTpl< Scalar >:

Public Types
using	Scalar = _Scalar
using	CostData = CostDataAbstractTpl<Scalar>
using	Manifold = ManifoldAbstractTpl<Scalar>

Public Member Functions
	ALIGATOR_DYNAMIC_TYPEDEFS (Scalar)
int	nx () const
int	ndx () const
template<class U >
	CostAbstractTpl (U &&space, const int nu)
virtual void	evaluate (const ConstVectorRef &x, const ConstVectorRef &u, CostData &data) const
	Evaluate the cost function.
virtual void	computeGradients (const ConstVectorRef &x, const ConstVectorRef &u, CostData &data) const
	Compute the cost gradients \((\ell_x, \ell_u)\).
virtual void	computeHessians (const ConstVectorRef &x, const ConstVectorRef &u, CostData &data) const
	Compute the cost Hessians \((\ell_{ij})_{i,j \in \{x,u\}}\).
virtual shared_ptr< CostData >	createData () const
virtual	~CostAbstractTpl ()=default

Public Attributes
xyz::polymorphic< Manifold >	space
	State dimension.
int	nu
	Control dimension.

Detailed Description

template<typename Scalar>
struct aligator::CostAbstractTpl< Scalar >

Stage costs \( \ell(x, u) \) for control problems.

Definition at line 65 of file fwd.hpp.

Member Typedef Documentation

Scalar

template<typename Scalar >

using aligator::CostAbstractTpl< Scalar >::Scalar = _Scalar

Definition at line 14 of file cost-abstract.hpp.

CostData

template<typename Scalar >

using aligator::CostAbstractTpl< Scalar >::CostData = CostDataAbstractTpl<Scalar>

Definition at line 16 of file cost-abstract.hpp.

Manifold

template<typename Scalar >

using aligator::CostAbstractTpl< Scalar >::Manifold = ManifoldAbstractTpl<Scalar>

Definition at line 17 of file cost-abstract.hpp.

Constructor & Destructor Documentation

CostAbstractTpl()

template<typename Scalar >

template<class U >

aligator::CostAbstractTpl< Scalar >::CostAbstractTpl ( U && space, const int nu )

inline

Definition at line 28 of file cost-abstract.hpp.

~CostAbstractTpl()

template<typename Scalar >

virtual aligator::CostAbstractTpl< Scalar >::~CostAbstractTpl ( )

virtualdefault

Member Function Documentation

ALIGATOR_DYNAMIC_TYPEDEFS()

template<typename Scalar >

aligator::CostAbstractTpl< Scalar >::ALIGATOR_DYNAMIC_TYPEDEFS

(

Scalar

)

nx()

template<typename Scalar >

int aligator::CostAbstractTpl< Scalar >::nx ( ) const

inline

Definition at line 24 of file cost-abstract.hpp.

ndx()

template<typename Scalar >

int aligator::CostAbstractTpl< Scalar >::ndx ( ) const

inline

Definition at line 25 of file cost-abstract.hpp.

evaluate()

template<typename Scalar >

void aligator::CostAbstractTpl< Scalar >::evaluate ( const ConstVectorRef & x, const ConstVectorRef & u, CostData & data ) const

virtual

Evaluate the cost function.

Reimplemented in aligator::autodiff::CostFiniteDifferenceHelper< Scalar >, aligator::LogResidualCostTpl< Scalar >, aligator::python::PyCostFunction, and aligator::QuadraticResidualCostTpl< Scalar >.

Definition at line 51 of file cost-abstract.hpp.

computeGradients()

template<typename Scalar >

void aligator::CostAbstractTpl< Scalar >::computeGradients ( const ConstVectorRef & x, const ConstVectorRef & u, CostData & data ) const

virtual

Compute the cost gradients \((\ell_x, \ell_u)\).

Reimplemented in aligator::autodiff::CostFiniteDifferenceHelper< Scalar >, aligator::LogResidualCostTpl< Scalar >, aligator::python::PyCostFunction, and aligator::QuadraticResidualCostTpl< Scalar >.

Definition at line 58 of file cost-abstract.hpp.

computeHessians()

template<typename Scalar >

void aligator::CostAbstractTpl< Scalar >::computeHessians ( const ConstVectorRef & x, const ConstVectorRef & u, CostData & data ) const

virtual

Compute the cost Hessians \((\ell_{ij})_{i,j \in \{x,u\}}\).

Reimplemented in aligator::autodiff::CostFiniteDifferenceHelper< Scalar >, aligator::LogResidualCostTpl< Scalar >, aligator::python::PyCostFunction, and aligator::QuadraticResidualCostTpl< Scalar >.

Definition at line 65 of file cost-abstract.hpp.

createData()

template<typename Scalar >

virtual shared_ptr< CostData > aligator::CostAbstractTpl< Scalar >::createData ( ) const

inlinevirtual

Reimplemented in aligator::autodiff::CostFiniteDifferenceHelper< Scalar >, aligator::compat::croc::CrocCostModelWrapperTpl< Scalar >, aligator::ConstantCostTpl< _Scalar >, aligator::CostStackTpl< _Scalar >, aligator::DirectSumCostTpl< _Scalar >, aligator::LogResidualCostTpl< Scalar >, aligator::python::PyCostFunction, aligator::QuadraticCostTpl< _Scalar >, aligator::QuadraticResidualCostTpl< _Scalar >, and aligator::QuadraticResidualCostTpl< Scalar >.

Definition at line 43 of file cost-abstract.hpp.

Member Data Documentation

space

template<typename Scalar >

xyz::polymorphic<Manifold> aligator::CostAbstractTpl< Scalar >::space

State dimension.

Definition at line 20 of file cost-abstract.hpp.

nu

template<typename Scalar >

int aligator::CostAbstractTpl< Scalar >::nu

Control dimension.

Definition at line 22 of file cost-abstract.hpp.

---

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

• include/aligator/core/cost-abstract.hpp
• include/aligator/fwd.hpp