aligator::StageFunctionTpl< Scalar > Struct Template Reference

Class representing ternary functions \(f(x,u,x')\). More...

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

Inheritance diagram for aligator::StageFunctionTpl< Scalar >:

Public Types
using	Scalar = _Scalar
using	Data = StageFunctionDataTpl<Scalar>

Public Member Functions
	ALIGATOR_DYNAMIC_TYPEDEFS (Scalar)
	StageFunctionTpl (const int ndx, const int nu, const int nr)
virtual void	evaluate (const ConstVectorRef &x, const ConstVectorRef &u, Data &data) const =0
	Evaluate the function.
virtual void	computeJacobians (const ConstVectorRef &x, const ConstVectorRef &u, Data &data) const =0
	Compute Jacobians of this function.
virtual void	computeVectorHessianProducts (const ConstVectorRef &x, const ConstVectorRef &u, const ConstVectorRef &lbda, Data &data) const
	Compute the vector-hessian products of this function.
virtual	~StageFunctionTpl ()=default
virtual shared_ptr< Data >	createData () const
	Instantiate a Data object.

Public Attributes
const int	ndx1
	Current state dimension.
const int	nu
	Control dimension.
const int	nr
	Function codimension.

Detailed Description

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

Class representing ternary functions \(f(x,u,x')\).

Definition at line 53 of file fwd.hpp.

Member Typedef Documentation

Scalar

template<typename Scalar >

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

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

Data

template<typename Scalar >

using aligator::StageFunctionTpl< Scalar >::Data = StageFunctionDataTpl<Scalar>

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

Constructor & Destructor Documentation

StageFunctionTpl()

template<typename Scalar >

aligator::StageFunctionTpl< Scalar >::StageFunctionTpl	(	const int	ndx,
		const int	nu,
		const int	nr )

~StageFunctionTpl()

template<typename Scalar >

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

virtualdefault

Member Function Documentation

ALIGATOR_DYNAMIC_TYPEDEFS()

template<typename Scalar >

aligator::StageFunctionTpl< Scalar >::ALIGATOR_DYNAMIC_TYPEDEFS

(

Scalar

)

evaluate()

template<typename Scalar >

virtual void aligator::StageFunctionTpl< Scalar >::evaluate ( const ConstVectorRef & x, const ConstVectorRef & u, Data & data ) const

pure virtual

Evaluate the function.

Parameters

x	Current state.
u	Controls.
data	Data holding struct.

Implemented in aligator::detail::StateOrControlErrorResidual< Scalar, 0 >, aligator::detail::StateOrControlErrorResidual< Scalar, 1 >, aligator::FunctionSliceXprTpl< Scalar, StageFunctionTpl< Scalar > >, aligator::LinearFunctionTpl< Scalar >, aligator::python::PyStageFunction< FunctionBase >, and aligator::UnaryFunctionTpl< _Scalar >.

computeJacobians()

template<typename Scalar >

virtual void aligator::StageFunctionTpl< Scalar >::computeJacobians ( const ConstVectorRef & x, const ConstVectorRef & u, Data & data ) const

pure virtual

Compute Jacobians of this function.

This computes the Jacobians \( (\frac{\partial f}{\partial x}, \frac{\partial f}{\partial u}, \frac{\partial f}{\partial x'}) \)

Parameters

x	Current state.
u	Controls.
y	Next state.
data	Data holding struct.

Implemented in aligator::detail::StateOrControlErrorResidual< Scalar, 0 >, aligator::detail::StateOrControlErrorResidual< Scalar, 1 >, aligator::FunctionSliceXprTpl< Scalar, StageFunctionTpl< Scalar > >, aligator::LinearFunctionTpl< Scalar >, aligator::python::PyStageFunction< FunctionBase >, and aligator::UnaryFunctionTpl< _Scalar >.

computeVectorHessianProducts()

template<typename Scalar >

virtual void aligator::StageFunctionTpl< Scalar >::computeVectorHessianProducts ( const ConstVectorRef & x, const ConstVectorRef & u, const ConstVectorRef & lbda, Data & data ) const

virtual

Compute the vector-hessian products of this function.

Parameters

x	Current state.
u	Controls.
y	Next state.
lbda	Multiplier estimate.
data	Data holding struct.

Reimplemented in aligator::FunctionSliceXprTpl< Scalar, StageFunctionTpl< Scalar > >, aligator::python::PyStageFunction< FunctionBase >, and aligator::UnaryFunctionTpl< _Scalar >.

createData()

template<typename Scalar >

virtual shared_ptr< Data > aligator::StageFunctionTpl< Scalar >::createData ( ) const

virtual

Instantiate a Data object.

Reimplemented in aligator::AngularAccelerationResidualTpl< _Scalar >, aligator::AngularMomentumResidualTpl< _Scalar >, aligator::autodiff::FiniteDifferenceHelper< _Scalar >, aligator::CenterOfMassTranslationResidualTpl< _Scalar >, aligator::CenterOfMassVelocityResidualTpl< _Scalar >, aligator::CentroidalAccelerationResidualTpl< _Scalar >, aligator::CentroidalCoMResidualTpl< _Scalar >, aligator::CentroidalFrictionConeResidualTpl< _Scalar >, aligator::CentroidalMomentumDerivativeResidualTpl< _Scalar >, aligator::CentroidalMomentumResidualTpl< _Scalar >, aligator::CentroidalWrapperResidualTpl< _Scalar >, aligator::CentroidalWrenchConeResidualTpl< _Scalar >, aligator::DCMPositionResidualTpl< _Scalar >, aligator::detail::linear_func_composition_impl< StageFunctionTpl< _Scalar > >, aligator::detail::linear_func_composition_impl< UnaryFunctionTpl< _Scalar > >, aligator::FramePlacementResidualTpl< _Scalar >, aligator::FrameTranslationResidualTpl< _Scalar >, aligator::FrameVelocityResidualTpl< _Scalar >, aligator::FunctionSliceXprTpl< Scalar, StageFunctionTpl< Scalar > >, aligator::FunctionSliceXprTpl< Scalar, UnaryFunctionTpl< Scalar > >, aligator::GravityCompensationResidualTpl< _Scalar >, aligator::LinearFunctionCompositionTpl< _Scalar >, aligator::LinearFunctionTpl< Scalar >, aligator::LinearMomentumResidualTpl< _Scalar >, aligator::LinearUnaryFunctionCompositionTpl< _Scalar >, aligator::python::PyStageFunction< FunctionBase >, and aligator::python::PyUnaryFunction< UFunction >.

Member Data Documentation

ndx1

template<typename Scalar >

const int aligator::StageFunctionTpl< Scalar >::ndx1

Current state dimension.

Definition at line 19 of file function-abstract.hpp.

nu

template<typename Scalar >

const int aligator::StageFunctionTpl< Scalar >::nu

Control dimension.

Definition at line 21 of file function-abstract.hpp.

nr

template<typename Scalar >

const int aligator::StageFunctionTpl< Scalar >::nr

Function codimension.

Definition at line 23 of file function-abstract.hpp.

---

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

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