aligator  0.6.1
A primal-dual augmented Lagrangian-type solver for nonlinear trajectory optimization.
Loading...
Searching...
No Matches
aligator::FunctionSliceXprTpl< Scalar, UnaryFunctionTpl< Scalar > > Struct Template Reference

#include <aligator/modelling/function-xpr-slice.hpp>

Inheritance diagram for aligator::FunctionSliceXprTpl< Scalar, UnaryFunctionTpl< Scalar > >:
[legend]
Collaboration diagram for aligator::FunctionSliceXprTpl< Scalar, UnaryFunctionTpl< Scalar > >:
[legend]

Public Types

using BaseData = StageFunctionDataTpl<Scalar>
 
using Data = FunctionSliceDataTpl<Scalar>
 
using SliceImpl = detail::slice_impl_tpl<UnaryFunctionTpl<Scalar>>
 
- Public Types inherited from aligator::UnaryFunctionTpl< Scalar >
using Scalar
 
using Base
 
using Data
 
- Public Types inherited from aligator::StageFunctionTpl< _Scalar >
using Scalar = _Scalar
 
using Data = StageFunctionDataTpl<Scalar>
 
- Public Types inherited from aligator::detail::slice_impl_tpl< UnaryFunctionTpl< Scalar > >
using Scalar
 
using BaseData
 
using Data
 

Public Member Functions

 ALIGATOR_DYNAMIC_TYPEDEFS (Scalar)
 
 ALIGATOR_UNARY_FUNCTION_INTERFACE (Scalar)
 
 FunctionSliceXprTpl (shared_ptr< Base > func, std::vector< int > const &indices)
 
 FunctionSliceXprTpl (shared_ptr< Base > func, const int idx)
 
void evaluate (const ConstVectorRef &x, BaseData &data) const override
 
void computeJacobians (const ConstVectorRef &x, BaseData &data) const override
 
void computeVectorHessianProducts (const ConstVectorRef &x, const ConstVectorRef &lbda, BaseData &data) const override
 
shared_ptr< BaseDatacreateData () const override
 Instantiate a Data object.
 
- Public Member Functions inherited from aligator::UnaryFunctionTpl< Scalar >
 ALIGATOR_DYNAMIC_TYPEDEFS (Scalar)
 
void evaluate (const ConstVectorRef &x, const ConstVectorRef &, const ConstVectorRef &, Data &data) const override
 Evaluate the function.
 
void computeJacobians (const ConstVectorRef &x, const ConstVectorRef &, const ConstVectorRef &, Data &data) const override
 Compute Jacobians of this function.
 
void computeVectorHessianProducts (const ConstVectorRef &x, const ConstVectorRef &, const ConstVectorRef &, const ConstVectorRef &lbda, Data &data) const override
 Compute the vector-hessian products of this function.
 
- Public Member Functions inherited from aligator::StageFunctionTpl< _Scalar >
 ALIGATOR_DYNAMIC_TYPEDEFS (Scalar)
 
 StageFunctionTpl (const int ndx1, const int nu, const int ndx2, const int nr)
 
 StageFunctionTpl (const int ndx, const int nu, const int nr)
 Constructor where ndx2 = ndx1.
 
virtual ~StageFunctionTpl ()=default
 
- Public Member Functions inherited from aligator::detail::slice_impl_tpl< UnaryFunctionTpl< Scalar > >
 ALIGATOR_DYNAMIC_TYPEDEFS (Scalar)
 
 slice_impl_tpl (shared_ptr< UnaryFunctionTpl< Scalar > > func, std::vector< int > const &indices)
 
 slice_impl_tpl (shared_ptr< UnaryFunctionTpl< Scalar > > func, int idx)
 

Additional Inherited Members

- Public Attributes inherited from aligator::StageFunctionTpl< _Scalar >
const int ndx1
 Current state dimension.
 
const int nu
 Control dimension.
 
const int ndx2
 Next state dimension.
 
const int nr
 Function codimension.
 
- Public Attributes inherited from aligator::detail::slice_impl_tpl< UnaryFunctionTpl< Scalar > >
shared_ptr< UnaryFunctionTpl< Scalar > > func
 
std::vector< int > indices
 
- Protected Member Functions inherited from aligator::detail::slice_impl_tpl< UnaryFunctionTpl< Scalar > >
void evaluate_impl (BaseData &data, Args &&...args) const
 
void computeJacobians_impl (BaseData &data, Args &&...args) const
 
void computeVectorHessianProducts_impl (BaseData &data, const ConstVectorRef &lbda, Args &&...args) const
 

Detailed Description

template<typename Scalar>
struct aligator::FunctionSliceXprTpl< Scalar, UnaryFunctionTpl< Scalar > >

Definition at line 59 of file function-xpr-slice.hpp.

Member Typedef Documentation

◆ BaseData

Definition at line 63 of file function-xpr-slice.hpp.

◆ Data

Definition at line 64 of file function-xpr-slice.hpp.

◆ SliceImpl

Constructor & Destructor Documentation

◆ FunctionSliceXprTpl() [1/2]

template<typename Scalar >
aligator::FunctionSliceXprTpl< Scalar, UnaryFunctionTpl< Scalar > >::FunctionSliceXprTpl ( shared_ptr< Base > func,
std::vector< int > const & indices )
inline

Definition at line 68 of file function-xpr-slice.hpp.

◆ FunctionSliceXprTpl() [2/2]

template<typename Scalar >
aligator::FunctionSliceXprTpl< Scalar, UnaryFunctionTpl< Scalar > >::FunctionSliceXprTpl ( shared_ptr< Base > func,
const int idx )
inline

Definition at line 72 of file function-xpr-slice.hpp.

Member Function Documentation

◆ ALIGATOR_DYNAMIC_TYPEDEFS()

template<typename Scalar >
aligator::FunctionSliceXprTpl< Scalar, UnaryFunctionTpl< Scalar > >::ALIGATOR_DYNAMIC_TYPEDEFS ( Scalar )

◆ ALIGATOR_UNARY_FUNCTION_INTERFACE()

template<typename Scalar >
aligator::FunctionSliceXprTpl< Scalar, UnaryFunctionTpl< Scalar > >::ALIGATOR_UNARY_FUNCTION_INTERFACE ( Scalar )

◆ evaluate()

template<typename Scalar >
void aligator::FunctionSliceXprTpl< Scalar, UnaryFunctionTpl< Scalar > >::evaluate ( const ConstVectorRef & x,
BaseData & data ) const
inlineoverridevirtual

Implements aligator::UnaryFunctionTpl< Scalar >.

Definition at line 75 of file function-xpr-slice.hpp.

◆ computeJacobians()

template<typename Scalar >
void aligator::FunctionSliceXprTpl< Scalar, UnaryFunctionTpl< Scalar > >::computeJacobians ( const ConstVectorRef & x,
BaseData & data ) const
inlineoverridevirtual

Implements aligator::UnaryFunctionTpl< Scalar >.

Definition at line 80 of file function-xpr-slice.hpp.

◆ computeVectorHessianProducts()

template<typename Scalar >
void aligator::FunctionSliceXprTpl< Scalar, UnaryFunctionTpl< Scalar > >::computeVectorHessianProducts ( const ConstVectorRef & x,
const ConstVectorRef & lbda,
BaseData & data ) const
inlineoverridevirtual

Reimplemented from aligator::UnaryFunctionTpl< Scalar >.

Definition at line 85 of file function-xpr-slice.hpp.

◆ createData()

template<typename Scalar >
shared_ptr< BaseData > aligator::FunctionSliceXprTpl< Scalar, UnaryFunctionTpl< Scalar > >::createData ( ) const
inlineoverridevirtual

Instantiate a Data object.

Reimplemented from aligator::StageFunctionTpl< _Scalar >.

Definition at line 91 of file function-xpr-slice.hpp.


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