aligator::StageFunctionDataTpl< _Scalar > Struct Template Reference

Base struct for function data. More...

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

Inheritance diagram for aligator::StageFunctionDataTpl< _Scalar >:

Collaboration diagram for aligator::StageFunctionDataTpl< _Scalar >:

Public Types
using	Scalar = _Scalar

Public Member Functions
	ALIGATOR_DYNAMIC_TYPEDEFS (Scalar)
	StageFunctionDataTpl (const int ndx1, const int nu, const int ndx2, const int nr)
	Default constructor.
virtual	~StageFunctionDataTpl ()=default
Public Member Functions inherited from aligator::Cloneable< StageFunctionDataTpl< _Scalar > >
shared_ptr< StageFunctionDataTpl< _Scalar > >	clone () const

Public Attributes
const int	ndx1
const int	nu
const int	ndx2
const int	nr
const int	nvar = ndx1 + nu + ndx2
	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	Jy_
	Jacobian with respect to \(y\).
MatrixRef	Hxx_
MatrixRef	Hxu_
MatrixRef	Hxy_
MatrixRef	Huu_
MatrixRef	Huy_
MatrixRef	Hyy_

Protected Member Functions
virtual StageFunctionDataTpl *	clone_impl () const

Friends
template<typename T >
std::ostream &	operator<< (std::ostream &oss, const StageFunctionDataTpl< T > &self)

Detailed Description

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

Base struct for function data.

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

Member Typedef Documentation

Scalar

template<typename _Scalar >

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

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

Constructor & Destructor Documentation

StageFunctionDataTpl()

template<typename _Scalar >

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

Default constructor.

~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

)

clone_impl()

template<typename _Scalar >

virtual StageFunctionDataTpl * aligator::StageFunctionDataTpl< _Scalar >::clone_impl ( ) const

inlineprotectedvirtual

Implements aligator::Cloneable< StageFunctionDataTpl< _Scalar > >.

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

Friends And Related Symbol Documentation

operator<<

template<typename _Scalar >

template<typename T >

std::ostream & operator<< ( std::ostream & oss, const StageFunctionDataTpl< T > & self )

friend

Member Data Documentation

ndx1

template<typename _Scalar >

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

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

nu

template<typename _Scalar >

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

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

ndx2

template<typename _Scalar >

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

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

nr

template<typename _Scalar >

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

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

nvar

template<typename _Scalar >

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

Total number of variables.

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

value_

template<typename _Scalar >

VectorXs aligator::StageFunctionDataTpl< _Scalar >::value_

Function value.

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

valref_

template<typename _Scalar >

VectorRef aligator::StageFunctionDataTpl< _Scalar >::valref_

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

jac_buffer_

template<typename _Scalar >

MatrixXs aligator::StageFunctionDataTpl< _Scalar >::jac_buffer_

Full Jacobian.

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

vhp_buffer_

template<typename _Scalar >

MatrixXs aligator::StageFunctionDataTpl< _Scalar >::vhp_buffer_

Vector-Hessian product buffer.

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

Jx_

template<typename _Scalar >

MatrixRef aligator::StageFunctionDataTpl< _Scalar >::Jx_

Jacobian with respect to \(x\).

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

Ju_

template<typename _Scalar >

MatrixRef aligator::StageFunctionDataTpl< _Scalar >::Ju_

Jacobian with respect to \(u\).

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

Jy_

template<typename _Scalar >

MatrixRef aligator::StageFunctionDataTpl< _Scalar >::Jy_

Jacobian with respect to \(y\).

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

Hxx_

template<typename _Scalar >

MatrixRef aligator::StageFunctionDataTpl< _Scalar >::Hxx_

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

Hxu_

template<typename _Scalar >

MatrixRef aligator::StageFunctionDataTpl< _Scalar >::Hxu_

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

Hxy_

template<typename _Scalar >

MatrixRef aligator::StageFunctionDataTpl< _Scalar >::Hxy_

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

Huu_

template<typename _Scalar >

MatrixRef aligator::StageFunctionDataTpl< _Scalar >::Huu_

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

Huy_

template<typename _Scalar >

MatrixRef aligator::StageFunctionDataTpl< _Scalar >::Huy_

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

Hyy_

template<typename _Scalar >

MatrixRef aligator::StageFunctionDataTpl< _Scalar >::Hyy_

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

---

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

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