TevaluationPoint< T > Class Template Reference

Allows to setup function evaluation points. More...

#include <function_.hpp>

Public Member Functions
Tmatrix< T >	getDX () const
Tmatrix< T >	getP () const
Tmatrix< T >	getT () const
Tmatrix< T >	getU () const
Tmatrix< T >	getW () const
Tmatrix< T >	getX () const
Tmatrix< T >	getXA () const
returnValue	init (const Function &f, uint nx_=0, uint na_=0, uint np_=0, uint nu_=0, uint nw_=0, uint nd_=0, uint N_=0)
TevaluationPoint< T > &	operator= (const TevaluationPoint< T > &rhs)
returnValue	setDX (const Tmatrix< T > &dx)
returnValue	setP (const Tmatrix< T > &p)
returnValue	setT (const Tmatrix< T > &t)
returnValue	setU (const Tmatrix< T > &u)
returnValue	setW (const Tmatrix< T > &w)
returnValue	setX (const Tmatrix< T > &x)
returnValue	setXA (const Tmatrix< T > &xa)
	TevaluationPoint ()
	TevaluationPoint (const Function &f, uint nx_=0, uint na_=0, uint nu_=0, uint np_=0, uint nw_=0, uint nd_=0, uint N_=0)
	TevaluationPoint (const TevaluationPoint< T > &rhs)
virtual	~TevaluationPoint ()

Protected Member Functions
Tmatrix< T >	backCopy (const int *order, const uint &dim) const
returnValue	copy (const int *order, const Tmatrix< T > &rhs)
void	copy (const TevaluationPoint &rhs)
void	copyIdx (const uint &dim, const int *idx1, int **idx2)
void	deleteAll ()
Tmatrix< T > *	getEvaluationPointer () const

Protected Attributes
int **	idx
uint	N
uint	na
uint	nd
uint	np
uint	nu
uint	nw
uint	nx
Tmatrix< T > *	z

Friends
class	Function

Detailed Description

template<typename T>
class TevaluationPoint< T >

Allows to setup function evaluation points.

The class TevaluationPoint is an efficient data class for storing points at which
a function can be evaluated. This class can be used in combination with the class
function. The difference to the class EvaluationPoint is that it can be used with
any templated basis class.

\author Boris Houska

Definition at line 45 of file function_.hpp.

Constructor & Destructor Documentation

template<typename T >

CLOSE_NAMESPACE_ACADO BEGIN_NAMESPACE_ACADO TevaluationPoint< T >::TevaluationPoint

(

)

Default constructor.

Definition at line 173 of file t_evaluation_point.hpp.

template<typename T >

TevaluationPoint< T >::TevaluationPoint	(	const Function &	f,
		uint	nx_ = 0,
		uint	na_ = 0,
		uint	nu_ = 0,
		uint	np_ = 0,
		uint	nw_ = 0,
		uint	nd_ = 0,
		uint	N_ = 0
	)

Constructor which takes the function.

Definition at line 177 of file t_evaluation_point.hpp.

template<typename T >

TevaluationPoint< T >::TevaluationPoint

(

const TevaluationPoint< T > &

rhs

)

Copy constructor (deep copy).

Definition at line 174 of file t_evaluation_point.hpp.

template<typename T >

TevaluationPoint< T >::~TevaluationPoint ( )

virtual

Destructor.

Definition at line 175 of file t_evaluation_point.hpp.

Member Function Documentation

template<typename T>

Tmatrix<T> TevaluationPoint< T >::backCopy ( const int *  order, const uint &  dim  ) const

inlineprotected

template<typename T>

returnValue TevaluationPoint< T >::copy ( const int *  order, const Tmatrix< T > &  rhs  )

inlineprotected

template<typename T >

void TevaluationPoint< T >::copy ( const TevaluationPoint< T > &  rhs )

protected

Definition at line 265 of file t_evaluation_point.hpp.

template<typename T >

void TevaluationPoint< T >::copyIdx ( const uint &  dim, const int *  idx1, int **  idx2  )

protected

Definition at line 256 of file t_evaluation_point.hpp.

template<typename T >

void TevaluationPoint< T >::deleteAll ( )

protected

Definition at line 295 of file t_evaluation_point.hpp.

template<typename T>

Tmatrix<T> TevaluationPoint< T >::getDX ( ) const

inline

template<typename T>

Tmatrix<T>* TevaluationPoint< T >::getEvaluationPointer ( ) const

inlineprotected

template<typename T>

Tmatrix<T> TevaluationPoint< T >::getP ( ) const

inline

template<typename T>

Tmatrix<T> TevaluationPoint< T >::getT ( ) const

inline

template<typename T>

Tmatrix<T> TevaluationPoint< T >::getU ( ) const

inline

template<typename T>

Tmatrix<T> TevaluationPoint< T >::getW ( ) const

inline

template<typename T>

Tmatrix<T> TevaluationPoint< T >::getX ( ) const

inline

template<typename T>

Tmatrix<T> TevaluationPoint< T >::getXA ( ) const

inline

template<typename T >

returnValue TevaluationPoint< T >::init	(	const Function &	f,
		uint	nx_ = 0,
		uint	na_ = 0,
		uint	np_ = 0,
		uint	nu_ = 0,
		uint	nw_ = 0,
		uint	nd_ = 0,
		uint	N_ = 0
	)

Initializer which takes the dimensions as arguments.

Parameters

f	the function to be evaluated.
nx	number of differential states.
na	number of algebraic states.
np	number of parameters.
nu	number of controls.
nw	number of disturbances.
nd	number of diff. state derivatives.

Returns

SUCCESSFUL_RETURN

Definition at line 199 of file t_evaluation_point.hpp.

template<typename T >

TevaluationPoint< T > & TevaluationPoint< T >::operator=

(

const TevaluationPoint< T > &

rhs

)

Assignment operator (deep copy).

Definition at line 189 of file t_evaluation_point.hpp.

template<typename T>

returnValue TevaluationPoint< T >::setDX ( const Tmatrix< T > &  dx )

inline

template<typename T>

returnValue TevaluationPoint< T >::setP ( const Tmatrix< T > &  p )

inline

template<typename T>

returnValue TevaluationPoint< T >::setT ( const Tmatrix< T > &  t )

inline

template<typename T>

returnValue TevaluationPoint< T >::setU ( const Tmatrix< T > &  u )

inline

template<typename T>

returnValue TevaluationPoint< T >::setW ( const Tmatrix< T > &  w )

inline

template<typename T>

returnValue TevaluationPoint< T >::setX ( const Tmatrix< T > &  x )

inline

template<typename T>

returnValue TevaluationPoint< T >::setXA ( const Tmatrix< T > &  xa )

inline

Friends And Related Function Documentation

template<typename T>

friend class Function

friend

Definition at line 58 of file t_evaluation_point.hpp.

Member Data Documentation

template<typename T>

int** TevaluationPoint< T >::idx

protected

index lists (for efficient reordering)

Definition at line 154 of file t_evaluation_point.hpp.

template<typename T>

uint TevaluationPoint< T >::N

protected

total number of variables

Definition at line 162 of file t_evaluation_point.hpp.

template<typename T>

uint TevaluationPoint< T >::na

protected

number of alg. states

Definition at line 157 of file t_evaluation_point.hpp.

template<typename T>

uint TevaluationPoint< T >::nd

protected

number of diff. state der.

Definition at line 161 of file t_evaluation_point.hpp.

template<typename T>

uint TevaluationPoint< T >::np

protected

number of parameters

Definition at line 159 of file t_evaluation_point.hpp.

template<typename T>

uint TevaluationPoint< T >::nu

protected

number of controls

Definition at line 158 of file t_evaluation_point.hpp.

template<typename T>

uint TevaluationPoint< T >::nw

protected

number of disturbances

Definition at line 160 of file t_evaluation_point.hpp.

template<typename T>

uint TevaluationPoint< T >::nx

protected

number of diff. states

Definition at line 156 of file t_evaluation_point.hpp.

template<typename T>

Tmatrix<T>* TevaluationPoint< T >::z

protected

the function evaluation point.

Definition at line 153 of file t_evaluation_point.hpp.

---

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

• function_.hpp
• t_evaluation_point.hpp