Public Member Functions | List of all members

Allows to setup and evaluate output functions based on SymbolicExpressions. More...

#include <output_fcn.hpp>

Inheritance diagram for OutputFcn:
Inheritance graph
[legend]

Public Member Functions

returnValue evaluate (double *x, double *_result)
 
returnValue evaluate (const VariablesGrid *x, const VariablesGrid *xa, const VariablesGrid *p, const VariablesGrid *u, const VariablesGrid *w, VariablesGrid *_result)
 
DVector evaluate (const EvaluationPoint &x, const int &number=0)
 
BooleanType isDefined () const
 
Output operator() (uint componentIdx)
 
OutputFcnoperator= (const OutputFcn &rhs)
 
 OutputFcn ()
 
 OutputFcn (const OutputFcn &rhs)
 
virtual ~OutputFcn ()
 
- Public Member Functions inherited from Function
returnValue AD_backward (const DVector &seed, EvaluationPoint &df, const int &number=0)
 
returnValue AD_backward (int number, double *seed, double *df)
 
returnValue AD_backward2 (int number, double *seed1, double *seed2, double *df, double *ddf)
 
DVector AD_forward (const EvaluationPoint &x, const int &number=0)
 
returnValue AD_forward (int number, double *seed, double *df)
 
returnValue AD_forward2 (int number, double *seed1, double *seed2, double *df, double *ddf)
 
BooleanType ADisSupported () const
 
returnValue clearBuffer ()
 
DVector evaluate (const EvaluationPoint &x, const int &number=0)
 
template<typename T >
Tmatrix< Tevaluate (const TevaluationPoint< T > &x)
 
returnValue evaluate (int number, double *x, double *_result)
 
returnValue exportCode (std::ostream &stream, const char *fcnName="ACADOfcn", const char *realString="double", uint _numX=0, uint _numXA=0, uint _numU=0, uint _numP=0, uint _numDX=0, uint _numOD=0, bool allocateMemory=true, bool staticMemory=false) const
 
returnValue exportForwardDeclarations (std::ostream &stream, const char *fcnName="ACADOfcn", const char *realString="double") const
 
 Function ()
 
 Function (const Function &rhs)
 
int getDim () const
 
returnValue getExpression (Expression &expression) const
 
OperatorgetExpression (uint componentIdx) const
 
std::string getGlobalExportVariableName () const
 
unsigned getGlobalExportVariableSize () const
 
int getN () const
 
int getN (VariableType &variableType_) const
 
int getNDX () const
 
int getNOD () const
 
int getNP () const
 
int getNPI () const
 
int getNT () const
 
int getNU () const
 
int getNUI () const
 
int getNumberOfVariables () const
 
int getNW () const
 
int getNX () const
 
int getNXA () const
 
int index (VariableType variableType_, int index_) const
 
BooleanType isAffine ()
 
BooleanType isConcave ()
 
BooleanType isConstant ()
 
BooleanType isConvex ()
 
BooleanType isDependingOn (const Expression &variable)
 
BooleanType isLinearIn (const Expression &variable)
 
BooleanType isNondecreasing ()
 
BooleanType isNonincreasing ()
 
NeutralElement isOneOrZero ()
 
BooleanType isPolynomialIn (const Expression &variable)
 
BooleanType isRationalIn (const Expression &variable)
 
BooleanType isSymbolic () const
 
returnValue jacobian (DMatrix &x)
 calculate the jacobian of an evaluated function More...
 
Function operator() (uint idx) const
 
DVector operator() (const EvaluationPoint &x, const int &number=0)
 
Functionoperator<< (const Expression &arg)
 
Functionoperator<< (const double &arg)
 
Functionoperator<< (const DVector &arg)
 
Functionoperator<< (const DMatrix &arg)
 
Functionoperator= (const Function &rhs)
 
returnValue print (std::ostream &stream, const char *fcnName="ACADOfcn", const char *realString="double") const
 
returnValue reset ()
 
double scale (VariableType variableType_, int index_) const
 
returnValue setGlobalExportVariableName (const std::string &var)
 
returnValue setMemoryOffset (int memoryOffset_)
 
returnValue setScale (double *scale_)
 
returnValue substitute (VariableType variableType_, int index_, double sub_)
 
virtual ~Function ()
 

Additional Inherited Members

- Protected Attributes inherited from Function
FunctionEvaluationTree evaluationTree
 
int memoryOffset
 
double * result
 

Detailed Description

Allows to setup and evaluate output functions based on SymbolicExpressions.

The class OutputFcn allows to setup and evaluate output functions based on SymbolicExpressions.

Author
Boris Houska, Hans Joachim Ferreau

Definition at line 55 of file output_fcn.hpp.

Constructor & Destructor Documentation

BEGIN_NAMESPACE_ACADO OutputFcn::OutputFcn ( )

Default constructor.

Definition at line 48 of file output_fcn.cpp.

OutputFcn::OutputFcn ( const OutputFcn rhs)

Copy constructor (deep copy).

Definition at line 53 of file output_fcn.cpp.

OutputFcn::~OutputFcn ( )
virtual

Destructor.

Definition at line 58 of file output_fcn.cpp.

Member Function Documentation

returnValue OutputFcn::evaluate ( double *  x,
double *  _result 
)

Evaluates the function

Returns
SUCCESSFUL_RETURN
RET_NAN
Parameters
xthe input variable x
_resultthe result

Definition at line 91 of file output_fcn.cpp.

returnValue OutputFcn::evaluate ( const VariablesGrid x,
const VariablesGrid xa,
const VariablesGrid p,
const VariablesGrid u,
const VariablesGrid w,
VariablesGrid _result 
)

Evaluates the output function on a variables grid

Returns
SUCCESSFUL_RETURN

Definition at line 98 of file output_fcn.cpp.

DVector OutputFcn::evaluate ( const EvaluationPoint x,
const int &  number = 0 
)

Evaluates the function.

Parameters
xthe evaluation point
numberthe storage position

Returns
The result of the evaluation.

Definition at line 124 of file output_fcn.cpp.

BooleanType OutputFcn::isDefined ( ) const
inline
Output OutputFcn::operator() ( uint  componentIdx)

Definition at line 74 of file output_fcn.cpp.

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

Assignment operator (deep copy).

Definition at line 63 of file output_fcn.cpp.


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


acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Mon Jun 10 2019 12:35:25