aligator  0.10.0
A primal-dual augmented Lagrangian-type solver for nonlinear trajectory optimization.
Loading...
Searching...
No Matches
aligator::dynamics::ExplicitIntegratorAbstractTpl< _Scalar > Struct Template Reference

Explicit integrators \(x_{k+1} = f(x_k, u_k) \). More...

#include <aligator/modelling/dynamics/integrator-explicit.hpp>

Inheritance diagram for aligator::dynamics::ExplicitIntegratorAbstractTpl< _Scalar >:
[legend]
Collaboration diagram for aligator::dynamics::ExplicitIntegratorAbstractTpl< _Scalar >:
[legend]

Public Types

using Scalar = _Scalar
 
using ODEType = ODEAbstractTpl<Scalar>
 
using Base = ExplicitDynamicsModelTpl<Scalar>
 
using Data = ExplicitIntegratorDataTpl<Scalar>
 
using Manifold = ManifoldAbstractTpl<Scalar>
 
- Public Types inherited from aligator::ExplicitDynamicsModelTpl< _Scalar >
using Scalar
 
using Base
 
using BaseData
 
using Data
 
using Manifold
 
using ManifoldPtr
 
- Public Types inherited from aligator::DynamicsModelTpl< _Scalar >
using Scalar
 
using Data
 
using Manifold
 

Public Member Functions

template<typename U >
U * getDynamics ()
 
template<typename U >
const U * getDynamics () const
 
 ExplicitIntegratorAbstractTpl (const xyz::polymorphic< ODEType > &cont_dynamics)
 
virtual ~ExplicitIntegratorAbstractTpl ()=default
 
shared_ptr< DynamicsDataTpl< Scalar > > createData () const
 
void computeJacobians (const ConstVectorRef &x, const ConstVectorRef &u, const ConstVectorRef &y, BaseData &data) const
 
void evaluate (const ConstVectorRef &x, const ConstVectorRef &u, const ConstVectorRef &y, BaseData &data) const
 
- Public Member Functions inherited from aligator::ExplicitDynamicsModelTpl< _Scalar >
 ALIGATOR_DYNAMIC_TYPEDEFS (_Scalar)
 
bool isExplicit () const
 Check if this dynamics model is implicit or explicit.
 
 ExplicitDynamicsModelTpl (const ManifoldPtr &space, const int nu)
 Constructor requires providing the next state's manifold.
 
virtual ~ExplicitDynamicsModelTpl ()=default
 
virtual void forward (const ConstVectorRef &x, const ConstVectorRef &u, Data &data) const=0
 Evaluate the forward discrete dynamics.
 
virtual void dForward (const ConstVectorRef &x, const ConstVectorRef &u, Data &data) const=0
 Compute the Jacobians of the forward dynamics.
 
- Public Member Functions inherited from aligator::DynamicsModelTpl< _Scalar >
 ALIGATOR_DYNAMIC_TYPEDEFS (_Scalar)
 
const Manifoldspace () const
 State space for the input.
 
const Manifoldspace_next () const
 State space for the output of this dynamics model.
 
int nx1 () const
 
int nx2 () const
 
 DynamicsModelTpl (xyz::polymorphic< Manifold > space, const int nu)
 Constructor for dynamics.
 
 DynamicsModelTpl (xyz::polymorphic< Manifold > space, const int nu, xyz::polymorphic< Manifold > space_next)
 Constructor for dynamics. This constructor assumes same dimension for the current and next state.
 
virtual void computeVectorHessianProducts (const ConstVectorRef &x, const ConstVectorRef &u, const ConstVectorRef &xn, const ConstVectorRef &lbda, Data &data) const
 
virtual ~DynamicsModelTpl ()=default
 

Public Attributes

xyz::polymorphic< ODETypeode_
 
- Public Attributes inherited from aligator::DynamicsModelTpl< _Scalar >
xyz::polymorphic< Manifoldspace_
 State space for the input.
 
xyz::polymorphic< Manifoldspace_next_
 State space for the output of this dynamics model.
 
const int ndx1
 State space dimension.
 
const int nu
 Control dimension.
 
const int ndx2
 Next state space dimension.
 

Detailed Description

template<typename _Scalar>
struct aligator::dynamics::ExplicitIntegratorAbstractTpl< _Scalar >

Explicit integrators \(x_{k+1} = f(x_k, u_k) \).

This class of integrator mostly applies to integrating ODE models \(\dot{x} = \phi(x,u)\). This class is separate from IntegratorAbstractTpl and not a child class; this ensures there is no diamond inheritance problem.

Definition at line 19 of file integrator-explicit.hpp.

Member Typedef Documentation

◆ Scalar

template<typename _Scalar >
using aligator::dynamics::ExplicitIntegratorAbstractTpl< _Scalar >::Scalar = _Scalar

Definition at line 20 of file integrator-explicit.hpp.

◆ ODEType

template<typename _Scalar >
using aligator::dynamics::ExplicitIntegratorAbstractTpl< _Scalar >::ODEType = ODEAbstractTpl<Scalar>

Definition at line 21 of file integrator-explicit.hpp.

◆ Base

template<typename _Scalar >
using aligator::dynamics::ExplicitIntegratorAbstractTpl< _Scalar >::Base = ExplicitDynamicsModelTpl<Scalar>

Definition at line 22 of file integrator-explicit.hpp.

◆ Data

template<typename _Scalar >
using aligator::dynamics::ExplicitIntegratorAbstractTpl< _Scalar >::Data = ExplicitIntegratorDataTpl<Scalar>

Definition at line 23 of file integrator-explicit.hpp.

◆ Manifold

template<typename _Scalar >
using aligator::dynamics::ExplicitIntegratorAbstractTpl< _Scalar >::Manifold = ManifoldAbstractTpl<Scalar>

Definition at line 31 of file integrator-explicit.hpp.

Constructor & Destructor Documentation

◆ ExplicitIntegratorAbstractTpl()

template<typename _Scalar >
aligator::dynamics::ExplicitIntegratorAbstractTpl< _Scalar >::ExplicitIntegratorAbstractTpl ( const xyz::polymorphic< ODEType > & cont_dynamics)
explicit

◆ ~ExplicitIntegratorAbstractTpl()

template<typename _Scalar >
virtual aligator::dynamics::ExplicitIntegratorAbstractTpl< _Scalar >::~ExplicitIntegratorAbstractTpl ( )
virtualdefault

Member Function Documentation

◆ getDynamics() [1/2]

template<typename _Scalar >
template<typename U >
U * aligator::dynamics::ExplicitIntegratorAbstractTpl< _Scalar >::getDynamics ( )
inline

Definition at line 35 of file integrator-explicit.hpp.

◆ getDynamics() [2/2]

template<typename _Scalar >
template<typename U >
const U * aligator::dynamics::ExplicitIntegratorAbstractTpl< _Scalar >::getDynamics ( ) const
inline

Definition at line 36 of file integrator-explicit.hpp.

◆ createData()

◆ computeJacobians()

template<typename _Scalar >
void aligator::ExplicitDynamicsModelTpl< Scalar >::computeJacobians ( const ConstVectorRef & x,
const ConstVectorRef & u,
const ConstVectorRef & y,
BaseData & data ) const
virtual

◆ evaluate()

template<typename _Scalar >
void aligator::ExplicitDynamicsModelTpl< Scalar >::evaluate ( const ConstVectorRef & x,
const ConstVectorRef & u,
const ConstVectorRef & y,
BaseData & data ) const
virtual

Member Data Documentation

◆ ode_

template<typename _Scalar >
xyz::polymorphic<ODEType> aligator::dynamics::ExplicitIntegratorAbstractTpl< _Scalar >::ode_

Definition at line 33 of file integrator-explicit.hpp.


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