aligator  0.9.0
A primal-dual augmented Lagrangian-type solver for nonlinear trajectory optimization.
Loading...
Searching...
No Matches
aligator::python::PyODEAbstract< T > Struct Template Referencefinal

#include </home/runner/work/aligator/aligator/bindings/python/include/aligator/python/modelling/continuous.hpp>

Inheritance diagram for aligator::python::PyODEAbstract< T >:
[legend]
Collaboration diagram for aligator::python::PyODEAbstract< T >:
[legend]

Public Types

using Scalar = context::Scalar
 
using Data = context::ODEData
 
- Public Types inherited from aligator::dynamics::ODEAbstractTpl< _Scalar >
using Scalar = _Scalar
 
using Base = ContinuousDynamicsAbstractTpl<Scalar>
 
using Data = ContinuousDynamicsDataTpl<Scalar>
 
- Public Types inherited from aligator::dynamics::ContinuousDynamicsAbstractTpl< _Scalar >
using Scalar
 
using Manifold
 
using ManifoldPtr
 
using Data
 

Public Member Functions

 ALIGATOR_DYNAMIC_TYPEDEFS (Scalar)
 
void forward (const ConstVectorRef &x, const ConstVectorRef &u, Data &data) const override
 Evaluate the ODE vector field: this returns the value of \(\dot{x}\).
 
void dForward (const ConstVectorRef &x, const ConstVectorRef &u, Data &data) const override
 Evaluate the vector field Jacobians.
 
shared_ptr< DatacreateData () const override
 Create a data holder instance.
 
shared_ptr< Datadefault_createData () const
 
- Public Member Functions inherited from aligator::dynamics::ODEAbstractTpl< _Scalar >
 ALIGATOR_DYNAMIC_TYPEDEFS (Scalar)
 
virtual ~ODEAbstractTpl ()=default
 
void evaluate (const ConstVectorRef &x, const ConstVectorRef &u, const ConstVectorRef &xdot, Data &data) const override
 
void computeJacobians (const ConstVectorRef &x, const ConstVectorRef &u, const ConstVectorRef &xdot, Data &data) const override
 
- Public Member Functions inherited from aligator::dynamics::ContinuousDynamicsAbstractTpl< _Scalar >
 ALIGATOR_DYNAMIC_TYPEDEFS (_Scalar)
 
int ndx () const
 
int nu () const
 
const Manifoldspace () 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.
 

Additional Inherited Members

- Public Attributes inherited from aligator::dynamics::ODEAbstractTpl< _Scalar >
const int nu_
 Control space dimension.
 
ManifoldPtr space_
 State space.
 
- Public Attributes inherited from aligator::dynamics::ContinuousDynamicsAbstractTpl< _Scalar >
ManifoldPtr space_
 State space.
 
const int nu_
 Control space dimension.
 

Detailed Description

template<class T = context::ODEAbstract>
struct aligator::python::PyODEAbstract< T >

Definition at line 44 of file continuous.hpp.

Member Typedef Documentation

◆ Scalar

template<class T = context::ODEAbstract>
using aligator::python::PyODEAbstract< T >::Scalar = context::Scalar

Definition at line 47 of file continuous.hpp.

◆ Data

template<class T = context::ODEAbstract>
using aligator::python::PyODEAbstract< T >::Data = context::ODEData

Definition at line 49 of file continuous.hpp.

Member Function Documentation

◆ ALIGATOR_DYNAMIC_TYPEDEFS()

template<class T = context::ODEAbstract>
aligator::python::PyODEAbstract< T >::ALIGATOR_DYNAMIC_TYPEDEFS ( Scalar )

◆ forward()

template<class T = context::ODEAbstract>
void aligator::python::PyODEAbstract< T >::forward ( const ConstVectorRef & x,
const ConstVectorRef & u,
Data & data ) const
inlineoverridevirtual

Evaluate the ODE vector field: this returns the value of \(\dot{x}\).

Implements aligator::dynamics::ODEAbstractTpl< _Scalar >.

Definition at line 53 of file continuous.hpp.

◆ dForward()

template<class T = context::ODEAbstract>
void aligator::python::PyODEAbstract< T >::dForward ( const ConstVectorRef & x,
const ConstVectorRef & u,
Data & data ) const
inlineoverridevirtual

Evaluate the vector field Jacobians.

Implements aligator::dynamics::ODEAbstractTpl< _Scalar >.

Definition at line 58 of file continuous.hpp.

◆ createData()

template<class T = context::ODEAbstract>
shared_ptr< Data > aligator::python::PyODEAbstract< T >::createData ( ) const
inlineoverridevirtual

Create a data holder instance.

Reimplemented from aligator::dynamics::ContinuousDynamicsAbstractTpl< _Scalar >.

Definition at line 63 of file continuous.hpp.

◆ default_createData()

template<class T = context::ODEAbstract>
shared_ptr< Data > aligator::python::PyODEAbstract< T >::default_createData ( ) const
inline

Definition at line 67 of file continuous.hpp.


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