Public Member Functions | Protected Member Functions | Protected Attributes | Friends

Allows to setup function evaluation points. More...

#include <evaluation_point.hpp>

List of all members.

Public Member Functions

 EvaluationPoint ()
 EvaluationPoint (const Function &f, uint nx_=0, uint na_=0, uint nu_=0, uint np_=0, uint nw_=0, uint nd_=0, uint N_=0)
 EvaluationPoint (const Function &f, const OCPiterate &iter)
 EvaluationPoint (const EvaluationPoint &rhs)
DVector getDX () const
DVector getP () const
double getT () const
DVector getU () const
DVector getW () const
DVector getX () const
DVector 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)
returnValue init (const Function &f, const OCPiterate &iter)
EvaluationPointoperator= (const EvaluationPoint &rhs)
returnValue print () const
returnValue setDX (const DVector &dx)
returnValue setP (const DVector &p)
returnValue setT (const double &t)
returnValue setU (const DVector &u)
returnValue setW (const DVector &w)
returnValue setX (const DVector &x)
returnValue setXA (const DVector &xa)
returnValue setZ (const uint &idx, const OCPiterate &iter)
returnValue setZero ()
virtual ~EvaluationPoint ()

Protected Member Functions

DVector backCopy (const int *order, const uint &dim) const
returnValue copy (const int *order, const DVector &rhs)
void copy (const EvaluationPoint &rhs)
void copyIdx (const uint &dim, const int *idx1, int **idx2)
void deleteAll ()
double * getEvaluationPointer () const

Protected Attributes

int ** idx
uint N
uint na
uint nd
uint np
uint nu
uint nw
uint nx
double * z

Friends

class Function

Detailed Description

Allows to setup function evaluation points.

The class EvaluationPoint 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.

Author:
Boris Houska, Hans Joachim Ferreau

Definition at line 58 of file evaluation_point.hpp.


Constructor & Destructor Documentation

Default constructor.

Definition at line 47 of file evaluation_point.cpp.

EvaluationPoint::EvaluationPoint ( 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 58 of file evaluation_point.cpp.

EvaluationPoint::EvaluationPoint ( const Function f,
const OCPiterate iter 
)

Constructor which takes the function.

Definition at line 68 of file evaluation_point.cpp.

Copy constructor (deep copy).

Definition at line 54 of file evaluation_point.cpp.

Destructor.

Definition at line 55 of file evaluation_point.cpp.


Member Function Documentation

DVector EvaluationPoint::backCopy ( const int *  order,
const uint dim 
) const [inline, protected]
returnValue EvaluationPoint::copy ( const int *  order,
const DVector rhs 
) [inline, protected]
void EvaluationPoint::copy ( const EvaluationPoint rhs) [protected]

Definition at line 189 of file evaluation_point.cpp.

void EvaluationPoint::copyIdx ( const uint dim,
const int *  idx1,
int **  idx2 
) [protected]

Definition at line 180 of file evaluation_point.cpp.

void EvaluationPoint::deleteAll ( ) [protected]

Definition at line 223 of file evaluation_point.cpp.

DVector EvaluationPoint::getDX ( ) const [inline]
double* EvaluationPoint::getEvaluationPointer ( ) const [inline, protected]
DVector EvaluationPoint::getP ( ) const [inline]
double EvaluationPoint::getT ( ) const [inline]
DVector EvaluationPoint::getU ( ) const [inline]
DVector EvaluationPoint::getW ( ) const [inline]
DVector EvaluationPoint::getX ( ) const [inline]
DVector EvaluationPoint::getXA ( ) const [inline]
returnValue EvaluationPoint::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:
fthe function to be evaluated.
nxnumber of differential states.
nanumber of algebraic states.
npnumber of parameters.
nunumber of controls.
nwnumber of disturbances.
ndnumber of diff. state derivatives.

Returns:
SUCCESSFUL_RETURN

Definition at line 94 of file evaluation_point.cpp.

returnValue EvaluationPoint::init ( const Function f,
const OCPiterate iter 
)

Definition at line 87 of file evaluation_point.cpp.

EvaluationPoint & EvaluationPoint::operator= ( const EvaluationPoint rhs)

Assignment operator (deep copy).

Definition at line 77 of file evaluation_point.cpp.

Prints the data of this object.
Due to the efficient implementation of
this class not everything might be stored.
Please, use this routine for debugging only.
This print routine does only work properly
if ALL values are assigned.

Definition at line 149 of file evaluation_point.cpp.

returnValue EvaluationPoint::setDX ( const DVector dx) [inline]
returnValue EvaluationPoint::setP ( const DVector p) [inline]
returnValue EvaluationPoint::setT ( const double &  t) [inline]
returnValue EvaluationPoint::setU ( const DVector u) [inline]
returnValue EvaluationPoint::setW ( const DVector w) [inline]
returnValue EvaluationPoint::setX ( const DVector x) [inline]
returnValue EvaluationPoint::setXA ( const DVector xa) [inline]
returnValue EvaluationPoint::setZ ( const uint idx,
const OCPiterate iter 
) [inline]

Friends And Related Function Documentation

friend class Function [friend]

Definition at line 60 of file evaluation_point.hpp.


Member Data Documentation

int** EvaluationPoint::idx [protected]

index lists (for efficient reordering)

Definition at line 183 of file evaluation_point.hpp.

uint EvaluationPoint::N [protected]

total number of variables

Definition at line 191 of file evaluation_point.hpp.

number of alg. states

Definition at line 186 of file evaluation_point.hpp.

number of diff. state der.

Definition at line 190 of file evaluation_point.hpp.

number of parameters

Definition at line 188 of file evaluation_point.hpp.

number of controls

Definition at line 187 of file evaluation_point.hpp.

number of disturbances

Definition at line 189 of file evaluation_point.hpp.

number of diff. states

Definition at line 185 of file evaluation_point.hpp.

double* EvaluationPoint::z [protected]

the function evaluation point.

Definition at line 182 of file evaluation_point.hpp.


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


acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Sat Jun 8 2019 19:40:23