aligator::dynamics::ContinuousDynamicsAbstractTpl< Scalar > Struct Template Reference

Continuous dynamics described by differential-algebraic equations (DAEs) \(F(\dot{x}, x, u) = 0\). More...

#include <aligator/modelling/dynamics/continuous-dynamics-abstract.hpp>

Inheritance diagram for aligator::dynamics::ContinuousDynamicsAbstractTpl< Scalar >:

Public Types
using	Scalar = _Scalar
using	Manifold = proxsuite::nlp::ManifoldAbstractTpl<Scalar>
using	ManifoldPtr = xyz::polymorphic<Manifold>
using	Data = ContinuousDynamicsDataTpl<Scalar>

Public Member Functions
	ALIGATOR_DYNAMIC_TYPEDEFS (Scalar)
int	ndx () const
int	nu () const
const Manifold &	space () const
	Return a reference to the state space.
	ContinuousDynamicsAbstractTpl (ManifoldPtr space, const int nu)
virtual	~ContinuousDynamicsAbstractTpl ()=default
virtual void	evaluate (const ConstVectorRef &x, const ConstVectorRef &u, const ConstVectorRef &xdot, Data &data) const =0
	Evaluate the vector field at a point \((x, u)\).
virtual void	computeJacobians (const ConstVectorRef &x, const ConstVectorRef &u, const ConstVectorRef &xdot, Data &data) const =0
	Differentiate the vector field.
virtual shared_ptr< Data >	createData () const
	Create a data holder instance.

Public Attributes
ManifoldPtr	space_
	State space.
const int	nu_
	Control space dimension.

Detailed Description

template<typename Scalar>
struct aligator::dynamics::ContinuousDynamicsAbstractTpl< Scalar >

Continuous dynamics described by differential-algebraic equations (DAEs) \(F(\dot{x}, x, u) = 0\).

Continuous dynamics described as \( f(x, u, \dot{x}) = 0 \). The codimension of this function is the same as that of \(x\).

Definition at line 12 of file fwd.hpp.

Member Typedef Documentation

Scalar

template<typename Scalar >

using aligator::dynamics::ContinuousDynamicsAbstractTpl< Scalar >::Scalar = _Scalar

Definition at line 20 of file continuous-dynamics-abstract.hpp.

Manifold

template<typename Scalar >

using aligator::dynamics::ContinuousDynamicsAbstractTpl< Scalar >::Manifold = proxsuite::nlp::ManifoldAbstractTpl<Scalar>

Definition at line 22 of file continuous-dynamics-abstract.hpp.

ManifoldPtr

template<typename Scalar >

using aligator::dynamics::ContinuousDynamicsAbstractTpl< Scalar >::ManifoldPtr = xyz::polymorphic<Manifold>

Definition at line 23 of file continuous-dynamics-abstract.hpp.

Data

template<typename Scalar >

using aligator::dynamics::ContinuousDynamicsAbstractTpl< Scalar >::Data = ContinuousDynamicsDataTpl<Scalar>

Definition at line 24 of file continuous-dynamics-abstract.hpp.

Constructor & Destructor Documentation

ContinuousDynamicsAbstractTpl()

template<typename Scalar >

aligator::dynamics::ContinuousDynamicsAbstractTpl< Scalar >::ContinuousDynamicsAbstractTpl	(	ManifoldPtr	space,
		const int	nu )

~ContinuousDynamicsAbstractTpl()

template<typename Scalar >

virtual aligator::dynamics::ContinuousDynamicsAbstractTpl< Scalar >::~ContinuousDynamicsAbstractTpl ( )

virtualdefault

Member Function Documentation

ALIGATOR_DYNAMIC_TYPEDEFS()

template<typename Scalar >

aligator::dynamics::ContinuousDynamicsAbstractTpl< Scalar >::ALIGATOR_DYNAMIC_TYPEDEFS

(

Scalar

)

ndx()

template<typename Scalar >

int aligator::dynamics::ContinuousDynamicsAbstractTpl< Scalar >::ndx ( ) const

inline

Definition at line 31 of file continuous-dynamics-abstract.hpp.

nu()

template<typename Scalar >

int aligator::dynamics::ContinuousDynamicsAbstractTpl< Scalar >::nu ( ) const

inline

Definition at line 32 of file continuous-dynamics-abstract.hpp.

space()

template<typename Scalar >

const Manifold & aligator::dynamics::ContinuousDynamicsAbstractTpl< Scalar >::space ( ) const

inline

Return a reference to the state space.

Definition at line 35 of file continuous-dynamics-abstract.hpp.

evaluate()

template<typename Scalar >

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

pure virtual

Evaluate the vector field at a point \((x, u)\).

Parameters

	x	The input state variable.
	u	The input control variable.
	xdot	Derivative of the state.
[out]	data	The output data object.

Implemented in aligator::python::PyContinuousDynamics< T >.

computeJacobians()

template<typename Scalar >

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

pure virtual

Differentiate the vector field.

Parameters

	x	The input state variable.
	u	The input control variable.
	xdot	Derivative of the state.
[out]	data	The output data object.

Implemented in aligator::python::PyContinuousDynamics< T >.

createData()

template<typename Scalar >

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

virtual

Create a data holder instance.

Reimplemented in aligator::dynamics::CentroidalFwdDynamicsTpl< Scalar >, aligator::dynamics::ContinuousCentroidalFwdDynamicsTpl< Scalar >, aligator::dynamics::LinearODETpl< _Scalar >, aligator::dynamics::MultibodyConstraintFwdDynamicsTpl< _Scalar >, aligator::python::PyContinuousDynamics< T >, and aligator::python::PyODEAbstract< T >.

Member Data Documentation

space_

template<typename Scalar >

ManifoldPtr aligator::dynamics::ContinuousDynamicsAbstractTpl< Scalar >::space_

State space.

Definition at line 27 of file continuous-dynamics-abstract.hpp.

nu_

template<typename Scalar >

const int aligator::dynamics::ContinuousDynamicsAbstractTpl< Scalar >::nu_

Control space dimension.

Definition at line 29 of file continuous-dynamics-abstract.hpp.

---

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

• include/aligator/modelling/dynamics/continuous-dynamics-abstract.hpp
• include/aligator/modelling/dynamics/fwd.hpp