aligator::python::PyUnaryFunction< UFunction > Struct Template Reference

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

Inheritance diagram for aligator::python::PyUnaryFunction< UFunction >:

Collaboration diagram for aligator::python::PyUnaryFunction< UFunction >:

Public Types
using	Scalar = typename UFunction::Scalar
using	Data = StageFunctionDataTpl<Scalar>
Public Types inherited from aligator::UnaryFunctionTpl< Scalar >
using	Scalar
using	Base
using	Data
using	Scalar
using	Base
using	Data
Public Types inherited from aligator::StageFunctionTpl< Scalar >
using	Scalar
using	Data
using	Scalar
using	Data

Public Member Functions
	ALIGATOR_DYNAMIC_TYPEDEFS (Scalar)
	ALIGATOR_UNARY_FUNCTION_INTERFACE (Scalar)
void	evaluate (const ConstVectorRef &x, Data &data) const override
void	computeJacobians (const ConstVectorRef &x, Data &data) const override
void	computeVectorHessianProducts (const ConstVectorRef &x, const ConstVectorRef &lbda, Data &data) const override
void	default_computeVectorHessianProducts (const ConstVectorRef &x, const ConstVectorRef &lbda, Data &data) const
shared_ptr< Data >	createData () const override
	Instantiate a Data object.
shared_ptr< Data >	default_createData () const
Public Member Functions inherited from aligator::UnaryFunctionTpl< Scalar >
	ALIGATOR_DYNAMIC_TYPEDEFS (Scalar)
void	evaluate (const ConstVectorRef &x, const ConstVectorRef &, Data &data) const override
	Evaluate the function.
void	computeJacobians (const ConstVectorRef &x, const ConstVectorRef &, Data &data) const override
	Compute Jacobians of this function.
void	computeVectorHessianProducts (const ConstVectorRef &x, const ConstVectorRef &, const ConstVectorRef &lbda, Data &data) const override
	Compute the vector-hessian products of this function.
	ALIGATOR_DYNAMIC_TYPEDEFS (Scalar)
void	evaluate (const ConstVectorRef &x, const ConstVectorRef &, Data &data) const override
	Evaluate the function.
void	computeJacobians (const ConstVectorRef &x, const ConstVectorRef &, Data &data) const override
	Compute Jacobians of this function.
void	computeVectorHessianProducts (const ConstVectorRef &x, 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 ndx, const int nu, const int nr)
virtual	~StageFunctionTpl ()=default
	ALIGATOR_DYNAMIC_TYPEDEFS (Scalar)
	StageFunctionTpl (const int ndx, const int nu, const int nr)
virtual	~StageFunctionTpl ()=default

Additional Inherited Members
Public Attributes inherited from aligator::StageFunctionTpl< Scalar >
const int	ndx1
	Current state dimension.
const int	nu
	Control dimension.
const int	nr
	Function codimension.
const int	ndx1
	Current state dimension.
const int	nu
	Control dimension.
const int	nr
	Function codimension.

Detailed Description

template<typename UFunction = context::UnaryFunction>
struct aligator::python::PyUnaryFunction< UFunction >

Definition at line 65 of file functions.hpp.

Member Typedef Documentation

Scalar

template<typename UFunction = context::UnaryFunction>

using aligator::python::PyUnaryFunction< UFunction >::Scalar = typename UFunction::Scalar

Definition at line 69 of file functions.hpp.

Data

template<typename UFunction = context::UnaryFunction>

using aligator::python::PyUnaryFunction< UFunction >::Data = StageFunctionDataTpl<Scalar>

Definition at line 75 of file functions.hpp.

Member Function Documentation

ALIGATOR_DYNAMIC_TYPEDEFS()

template<typename UFunction = context::UnaryFunction>

aligator::python::PyUnaryFunction< UFunction >::ALIGATOR_DYNAMIC_TYPEDEFS

(

Scalar

)

ALIGATOR_UNARY_FUNCTION_INTERFACE()

template<typename UFunction = context::UnaryFunction>

aligator::python::PyUnaryFunction< UFunction >::ALIGATOR_UNARY_FUNCTION_INTERFACE

(

Scalar

)

evaluate()

template<typename UFunction = context::UnaryFunction>

void aligator::python::PyUnaryFunction< UFunction >::evaluate ( const ConstVectorRef & x, Data & data ) const

inlineoverridevirtual

Implements aligator::UnaryFunctionTpl< Scalar >.

Definition at line 79 of file functions.hpp.

computeJacobians()

template<typename UFunction = context::UnaryFunction>

void aligator::python::PyUnaryFunction< UFunction >::computeJacobians ( const ConstVectorRef & x, Data & data ) const

inlineoverridevirtual

Implements aligator::UnaryFunctionTpl< Scalar >.

Definition at line 83 of file functions.hpp.

computeVectorHessianProducts()

template<typename UFunction = context::UnaryFunction>

void aligator::python::PyUnaryFunction< UFunction >::computeVectorHessianProducts ( const ConstVectorRef & x, const ConstVectorRef & lbda, Data & data ) const

inlineoverridevirtual

Reimplemented from aligator::UnaryFunctionTpl< Scalar >.

Definition at line 88 of file functions.hpp.

default_computeVectorHessianProducts()

template<typename UFunction = context::UnaryFunction>

void aligator::python::PyUnaryFunction< UFunction >::default_computeVectorHessianProducts ( const ConstVectorRef & x, const ConstVectorRef & lbda, Data & data ) const

inline

Definition at line 95 of file functions.hpp.

createData()

template<typename UFunction = context::UnaryFunction>

shared_ptr< Data > aligator::python::PyUnaryFunction< UFunction >::createData ( ) const

inlineoverridevirtual

Instantiate a Data object.

Reimplemented from aligator::StageFunctionTpl< Scalar >.

Definition at line 101 of file functions.hpp.

default_createData()

template<typename UFunction = context::UnaryFunction>

shared_ptr< Data > aligator::python::PyUnaryFunction< UFunction >::default_createData ( ) const

inline

Definition at line 105 of file functions.hpp.

---

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

• bindings/python/include/aligator/python/functions.hpp