aligator::StageFunctionDataTpl< _Scalar > Struct Template Reference

Base struct for function data. More...

#include <aligator/core/function-abstract.hpp>

Public Types
using	Scalar = _Scalar

Public Member Functions
	ALIGATOR_DYNAMIC_TYPEDEFS (Scalar)
ConstMatrixRef	Jx () const
ConstMatrixRef	Ju () const
MatrixRef	Jx ()
MatrixRef	Ju ()
	StageFunctionDataTpl (const int ndx, const int nu, const int nr)
	Default constructor.
	StageFunctionDataTpl (const StageFunctionTpl< Scalar > &model)
virtual	~StageFunctionDataTpl ()=default

Public Attributes
const int	ndx1
const int	nu
const int	nr
const int	nvar = ndx1 + nu
	Total number of variables.
VectorXs	value_
	Function value.
VectorRef	valref_
MatrixXs	jac_buffer_
	Full Jacobian.
MatrixXs	vhp_buffer_
	Vector-Hessian product buffer.
MatrixRef	Jx_
	Jacobian with respect to \(x\).
MatrixRef	Ju_
	Jacobian with respect to \(u\).
MatrixRef	Hxx_
MatrixRef	Hxu_
MatrixRef	Huu_

Detailed Description

template<typename _Scalar>
struct aligator::StageFunctionDataTpl< _Scalar >

Base struct for function data.

Definition at line 73 of file function-abstract.hpp.

Member Typedef Documentation

Scalar

template<typename _Scalar>

using aligator::StageFunctionDataTpl< _Scalar >::Scalar = _Scalar

Definition at line 74 of file function-abstract.hpp.

Constructor & Destructor Documentation

StageFunctionDataTpl() [1/2]

template<typename _Scalar>

aligator::StageFunctionDataTpl< _Scalar >::StageFunctionDataTpl	(	const int	ndx,
		const int	nu,
		const int	nr )

Default constructor.

StageFunctionDataTpl() [2/2]

template<typename _Scalar>

aligator::StageFunctionDataTpl< _Scalar >::StageFunctionDataTpl ( const StageFunctionTpl< Scalar > & model )

explicit

~StageFunctionDataTpl()

template<typename _Scalar>

virtual aligator::StageFunctionDataTpl< _Scalar >::~StageFunctionDataTpl ( )

virtualdefault

Member Function Documentation

ALIGATOR_DYNAMIC_TYPEDEFS()

template<typename _Scalar>

aligator::StageFunctionDataTpl< _Scalar >::ALIGATOR_DYNAMIC_TYPEDEFS

(

Scalar

)

Jx() [1/2]

template<typename _Scalar>

ConstMatrixRef aligator::StageFunctionDataTpl< _Scalar >::Jx ( ) const

inline

Definition at line 95 of file function-abstract.hpp.

Ju() [1/2]

template<typename _Scalar>

ConstMatrixRef aligator::StageFunctionDataTpl< _Scalar >::Ju ( ) const

inline

Definition at line 96 of file function-abstract.hpp.

Jx() [2/2]

template<typename _Scalar>

MatrixRef aligator::StageFunctionDataTpl< _Scalar >::Jx ( )

inline

Definition at line 97 of file function-abstract.hpp.

Ju() [2/2]

template<typename _Scalar>

MatrixRef aligator::StageFunctionDataTpl< _Scalar >::Ju ( )

inline

Definition at line 98 of file function-abstract.hpp.

Member Data Documentation

ndx1

template<typename _Scalar>

const int aligator::StageFunctionDataTpl< _Scalar >::ndx1

Definition at line 77 of file function-abstract.hpp.

nu

template<typename _Scalar>

const int aligator::StageFunctionDataTpl< _Scalar >::nu

Definition at line 78 of file function-abstract.hpp.

nr

template<typename _Scalar>

const int aligator::StageFunctionDataTpl< _Scalar >::nr

Definition at line 79 of file function-abstract.hpp.

nvar

template<typename _Scalar>

const int aligator::StageFunctionDataTpl< _Scalar >::nvar = ndx1 + nu

Total number of variables.

Definition at line 81 of file function-abstract.hpp.

value_

template<typename _Scalar>

VectorXs aligator::StageFunctionDataTpl< _Scalar >::value_

Function value.

Definition at line 84 of file function-abstract.hpp.

valref_

template<typename _Scalar>

VectorRef aligator::StageFunctionDataTpl< _Scalar >::valref_

Definition at line 85 of file function-abstract.hpp.

jac_buffer_

template<typename _Scalar>

MatrixXs aligator::StageFunctionDataTpl< _Scalar >::jac_buffer_

Full Jacobian.

Definition at line 87 of file function-abstract.hpp.

vhp_buffer_

template<typename _Scalar>

MatrixXs aligator::StageFunctionDataTpl< _Scalar >::vhp_buffer_

Vector-Hessian product buffer.

Definition at line 89 of file function-abstract.hpp.

Jx_

template<typename _Scalar>

MatrixRef aligator::StageFunctionDataTpl< _Scalar >::Jx_

Jacobian with respect to \(x\).

Definition at line 91 of file function-abstract.hpp.

Ju_

template<typename _Scalar>

MatrixRef aligator::StageFunctionDataTpl< _Scalar >::Ju_

Jacobian with respect to \(u\).

Definition at line 93 of file function-abstract.hpp.

Hxx_

template<typename _Scalar>

MatrixRef aligator::StageFunctionDataTpl< _Scalar >::Hxx_

Definition at line 102 of file function-abstract.hpp.

Hxu_

template<typename _Scalar>

MatrixRef aligator::StageFunctionDataTpl< _Scalar >::Hxu_

Definition at line 103 of file function-abstract.hpp.

Huu_

template<typename _Scalar>

MatrixRef aligator::StageFunctionDataTpl< _Scalar >::Huu_

Definition at line 104 of file function-abstract.hpp.

---

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

• include/aligator/core/function-abstract.hpp