Public Member Functions | Protected Attributes

Implements the scalar power operator with integer exponent within the symbolic operators family. More...

#include <powerint.hpp>

Inheritance diagram for Power_Int:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual returnValue AD_backward (int dim, VariableType *varType, int *component, Operator *seed, Operator **df, int &nNewIS, TreeProjection ***newIS)
virtual returnValue AD_backward (int number, double seed, double *df)
virtual returnValue AD_backward2 (int number, double seed1, double seed2, double *df, double *ddf)
virtual OperatorAD_forward (int dim, VariableType *varType, int *component, Operator **seed, int &nNewIS, TreeProjection ***newIS)
virtual returnValue AD_forward (int number, double *seed, double *df)
virtual returnValue AD_forward (int number, double *x, double *seed, double *f, double *df)
virtual returnValue AD_forward2 (int number, double *seed1, double *seed2, double *df, double *ddf)
virtual returnValue AD_symmetric (int dim, VariableType *varType, int *component, Operator *l, Operator **S, int dimS, Operator **dfS, Operator **ldf, Operator **H, int &nNewLIS, TreeProjection ***newLIS, int &nNewSIS, TreeProjection ***newSIS, int &nNewHIS, TreeProjection ***newHIS)
virtual returnValue clearBuffer ()
virtual Operatorclone () const
virtual Operatordifferentiate (int index)
virtual returnValue enumerateVariables (SymbolicIndexList *indexList)
virtual returnValue evaluate (int number, double *x, double *result)
virtual returnValue evaluate (EvaluationBase *x)
virtual CurvatureType getCurvature ()
virtual MonotonicityType getMonotonicity ()
virtual OperatorName getName ()
virtual returnValue initDerivative ()
virtual BooleanType isDependingOn (VariableType var) const
virtual BooleanType isDependingOn (int dim, VariableType *varType, int *component, BooleanType *implicit_dep)
virtual BooleanType isLinearIn (int dim, VariableType *varType, int *component, BooleanType *implicit_dep)
virtual NeutralElement isOneOrZero () const
virtual BooleanType isPolynomialIn (int dim, VariableType *varType, int *component, BooleanType *implicit_dep)
virtual BooleanType isRationalIn (int dim, VariableType *varType, int *component, BooleanType *implicit_dep)
virtual BooleanType isSymbolic () const
virtual BooleanType isVariable (VariableType &varType, int &component) const
virtual returnValue loadIndices (SymbolicIndexList *indexList)
Power_Intoperator= (const Power_Int &arg)
 Power_Int ()
 Power_Int (Operator *_argument, int _exponent)
 Power_Int (const Power_Int &arg)
virtual std::ostream & print (std::ostream &stream) const
virtual returnValue setCurvature (CurvatureType curvature_)
virtual returnValue setMonotonicity (MonotonicityType monotonicity_)
virtual returnValue setVariableExportName (const VariableType &_type, const std::vector< std::string > &_name)
virtual Operatorsubstitute (int index, const Operator *sub)
 ~Power_Int ()

Protected Attributes

Operatorargument
double * argument_result
int bufferSize
CurvatureType curvature
Operatordargument
double * dargument_result
TreeProjectionderivative
TreeProjectionderivative2
int exponent
MonotonicityType monotonicity

Detailed Description

Implements the scalar power operator with integer exponent within the symbolic operators family.

The class Power_Int implements the scalar power operator with integer exponent within the symbolic operators family.

Author:
Boris Houska, Hans Joachim Ferreau

Definition at line 55 of file powerint.hpp.


Constructor & Destructor Documentation

Default constructor.

Definition at line 45 of file powerint.cpp.

Power_Int::Power_Int ( Operator _argument,
int  _exponent 
)

Default constructor.

Definition at line 52 of file powerint.cpp.

Power_Int::Power_Int ( const Power_Int arg)

Copy constructor (deep copy).

Definition at line 69 of file powerint.cpp.

Default destructor.

Definition at line 110 of file powerint.cpp.


Member Function Documentation

returnValue Power_Int::AD_backward ( int  dim,
VariableType varType,
int *  component,
Operator seed,
Operator **  df,
int &  nNewIS,
TreeProjection ***  newIS 
) [virtual]

Automatic Differentiation in backward mode on the symbolic
level. This function generates an expression for a
backward derivative

Returns:
SUCCESSFUL_RETURN
Parameters:
dimnumber of directions
varTypethe variable types
componentand their components
seedthe backward seed
dfthe result
nNewISthe number of new IS
newISthe new IS-pointer

Implements SmoothOperator.

Definition at line 241 of file powerint.cpp.

returnValue Power_Int::AD_backward ( int  number,
double  seed,
double *  df 
) [virtual]

Automatic Differentiation in backward mode based on
buffered values

Returns:
SUCCESFUL_RETURN
RET_NAN
Parameters:
numberthe buffer position
seedthe seed
dfthe derivative of the expression

Implements SmoothOperator.

Definition at line 479 of file powerint.cpp.

returnValue Power_Int::AD_backward2 ( int  number,
double  seed1,
double  seed2,
double *  df,
double *  ddf 
) [virtual]

Automatic Differentiation in backward mode for 2nd order
derivatives based on buffered values.

Returns:
SUCCESFUL_RETURN
RET_NAN
Parameters:
numberthe buffer position
seed1the seed1
seed2the seed2
dfthe 1st derivative of the expression
ddfthe 2nd derivative of the expression

Implements SmoothOperator.

Definition at line 503 of file powerint.cpp.

Operator * Power_Int::AD_forward ( int  dim,
VariableType varType,
int *  component,
Operator **  seed,
int &  nNewIS,
TreeProjection ***  newIS 
) [virtual]

Automatic Differentiation in forward mode on the symbolic
level. This function generates an expression for a
forward derivative

Returns:
SUCCESSFUL_RETURN
Parameters:
dimdimension of the seed
varTypethe variable types
componentand their components
seedthe forward seed
nNewISthe number of new IS
newISthe new IS-pointer

Implements SmoothOperator.

Definition at line 222 of file powerint.cpp.

returnValue Power_Int::AD_forward ( int  number,
double *  seed,
double *  df 
) [virtual]

Automatic Differentiation in forward mode.
This function uses the intermediate
results from a buffer

Returns:
SUCCESFUL_RETURN
RET_NAN
Parameters:
numberstorage position
seedthe seed
dfthe derivative of the expression

Implements SmoothOperator.

Definition at line 468 of file powerint.cpp.

returnValue Power_Int::AD_forward ( int  number,
double *  x,
double *  seed,
double *  f,
double *  df 
) [virtual]

Automatic Differentiation in forward mode.
This function stores the intermediate
results in a buffer (needed for 2nd order automatic
differentiation in backward mode)

Returns:
SUCCESFUL_RETURN
RET_NAN
Parameters:
numberstorage position
xThe evaluation point x
seedthe seed
fthe value of the expression at x
dfthe derivative of the expression

Implements SmoothOperator.

Definition at line 449 of file powerint.cpp.

returnValue Power_Int::AD_forward2 ( int  number,
double *  seed1,
double *  seed2,
double *  df,
double *  ddf 
) [virtual]

Automatic Differentiation in forward mode for
2nd derivatives.
This function uses intermediate
results from a buffer.

Returns:
SUCCESFUL_RETURN
RET_NAN
Parameters:
numberthe buffer position
seed1the seed
seed2the seed for the first derivative
dfthe derivative of the expression
ddfthe 2nd derivative of the expression

Implements SmoothOperator.

Definition at line 485 of file powerint.cpp.

returnValue Power_Int::AD_symmetric ( int  dim,
VariableType varType,
int *  component,
Operator l,
Operator **  S,
int  dimS,
Operator **  dfS,
Operator **  ldf,
Operator **  H,
int &  nNewLIS,
TreeProjection ***  newLIS,
int &  nNewSIS,
TreeProjection ***  newSIS,
int &  nNewHIS,
TreeProjection ***  newHIS 
) [virtual]

Automatic Differentiation in symmetric mode on the symbolic
level. This function generates an expression for a
second order derivative.

Returns:
SUCCESSFUL_RETURN
Parameters:
dimnumber of directions
varTypethe variable types
componentand their components
lthe backward seed
Sforward seed matrix
dimSdimension of forward seed
dfSfirst order foward result
ldffirst order backward result
Hupper trianglular part of the Hessian
nNewLISthe number of newLIS
newLISthe new LIS-pointer
nNewSISthe number of newSIS
newSISthe new SIS-pointer
nNewHISthe number of newHIS
newHISthe new HIS-pointer

Implements SmoothOperator.

Definition at line 259 of file powerint.cpp.

Clears the buffer and resets the buffer size
to 1.

Returns:
SUCCESFUL_RETURN

Implements SmoothOperator.

Definition at line 560 of file powerint.cpp.

Operator * Power_Int::clone ( ) const [virtual]

Provides a deep copy of the expression.

Returns:
a clone of the expression.

Implements SmoothOperator.

Definition at line 554 of file powerint.cpp.

Operator * Power_Int::differentiate ( int  index) [virtual]

Returns the derivative of the expression with respect
to the variable var(index).

Returns:
The expression for the derivative.
Parameters:
indexdiff. index

Implements SmoothOperator.

Definition at line 208 of file powerint.cpp.

Enumerates all variables based on a common
IndexList.

Returns:
SUCCESFUL_RETURN

Implements SmoothOperator.

Definition at line 572 of file powerint.cpp.

returnValue Power_Int::evaluate ( int  number,
double *  x,
double *  result 
) [virtual]

Evaluates the expression and stores the intermediate
results in a buffer (needed for automatic differentiation
in backward mode)

Returns:
SUCCESFUL_RETURN
RET_NAN
Parameters:
numberstorage position
xthe input variable x
resultthe result

Implements SmoothOperator.

Definition at line 186 of file powerint.cpp.

Evaluates the expression (templated version)

Implements SmoothOperator.

Definition at line 201 of file powerint.cpp.

Returns the curvature of the expression

Returns:
CT_CONSTANT
CT_AFFINE
CT_CONVEX
CT_CONCAVE

Implements SmoothOperator.

Definition at line 408 of file powerint.cpp.

Returns the monotonicity of the expression.

Returns:
MT_NONDECREASING
MT_NONINCREASING
MT_NONMONOTONIC

Implements SmoothOperator.

Definition at line 383 of file powerint.cpp.

Asks the expression for its name.

Returns:
the name of the expression.

Implements SmoothOperator.

Definition at line 583 of file powerint.cpp.

Reimplemented from Operator.

Definition at line 283 of file powerint.cpp.

Asks the expression whether it is depending on a certian type of
variable.

Returns:
BT_TRUE if a dependency is detected,
BT_FALSE otherwise.

Implements SmoothOperator.

Definition at line 320 of file powerint.cpp.

BooleanType Power_Int::isDependingOn ( int  dim,
VariableType varType,
int *  component,
BooleanType implicit_dep 
) [virtual]

Checks whether the expression is depending on a variable

Returns:
BT_FALSE if no dependence is detected
BT_TRUE otherwise
Parameters:
dimnumber of directions
varTypethe variable types
componentand their components
implicit_depimplicit dependencies

Implements SmoothOperator.

Definition at line 326 of file powerint.cpp.

BooleanType Power_Int::isLinearIn ( int  dim,
VariableType varType,
int *  component,
BooleanType implicit_dep 
) [virtual]

Checks whether the expression is linear in
(or not depending on) a variable

Returns:
BT_FALSE if no linearity is
detected
BT_TRUE otherwise
Parameters:
dimnumber of directions
varTypethe variable types
componentand their components
implicit_depimplicit dependencies

Implements SmoothOperator.

Definition at line 339 of file powerint.cpp.

Checks whether the expression is zero or one

Returns:
NE_ZERO
NE_ONE
NE_NEITHER_ONE_NOR_ZERO

Implements SmoothOperator.

Definition at line 317 of file powerint.cpp.

BooleanType Power_Int::isPolynomialIn ( int  dim,
VariableType varType,
int *  component,
BooleanType implicit_dep 
) [virtual]

Checks whether the expression is polynomial in
the specified variables

Returns:
BT_FALSE if the expression is not polynomial
BT_TRUE otherwise
Parameters:
dimnumber of directions
varTypethe variable types
componentand their components
implicit_depimplicit dependencies

Implements SmoothOperator.

Definition at line 356 of file powerint.cpp.

BooleanType Power_Int::isRationalIn ( int  dim,
VariableType varType,
int *  component,
BooleanType implicit_dep 
) [virtual]

Checks whether the expression is rational in
the specified variables

Returns:
BT_FALSE if the expression is not rational
BT_TRUE otherwise
Parameters:
dimnumber of directions
varTypethe variable types
componentand their components
implicit_depimplicit dependencies

Implements SmoothOperator.

Definition at line 370 of file powerint.cpp.

BooleanType Power_Int::isSymbolic ( ) const [virtual]

Asks whether all elements are purely symbolic.

Returns:
BT_TRUE if the complete tree is symbolic.
BT_FALSE otherwise (e.g. if C functions are linked).

Implements SmoothOperator.

Definition at line 599 of file powerint.cpp.

BooleanType Power_Int::isVariable ( VariableType varType,
int &  component 
) const [virtual]

Asks the expression whether it is a variable.

Returns:
The answer.

Implements SmoothOperator.

Definition at line 588 of file powerint.cpp.

The function loadIndices passes an IndexList through
the whole expression tree. Whenever a variable gets the
IndexList it tries to make an entry. However if a
variable recognices that it has already been added
before it will not be allowed to make a second entry.
Note that all variables, in paticular the intermediate
states, will keep in mind whether they were allowed
to make an entry or not. This guarantees that
intermediate states are never evaluated twice if they
occur at several knots of the tree.

THIS FUNCTION IS FOR INTERNAL USE ONLY.

PLEASE CALL THIS FUNTION AT MOST ONES FOR AN EXPRESSION
AS A KIND OF INIT ROUTINE.

Returns:
the name of the expression.
Parameters:
indexListThe index list to be filled with entries

Implements SmoothOperator.

Definition at line 593 of file powerint.cpp.

Power_Int & Power_Int::operator= ( const Power_Int arg)

Assignment Operator (deep copy).

Definition at line 141 of file powerint.cpp.

std::ostream & Power_Int::print ( std::ostream &  stream) const [virtual]

Prints the expression into a stream.

Returns:
SUCCESFUL_RETURN

Implements SmoothOperator.

Definition at line 520 of file powerint.cpp.

Overwrites the curvature of the expression.
(For the case that the curvature is explicitly known)

Returns:
SUCCESSFUL_RETURN

Implements SmoothOperator.

Definition at line 442 of file powerint.cpp.

Overwrites the monotonicity of the expression.
(For the case that the monotonicity is explicitly known)

Returns:
SUCCESSFUL_RETURN

Implements SmoothOperator.

Definition at line 435 of file powerint.cpp.

returnValue Power_Int::setVariableExportName ( const VariableType _type,
const std::vector< std::string > &  _name 
) [virtual]

Sets the name of the variable that is used for code export.

Returns:
SUCCESSFUL_RETURN

Reimplemented from Operator.

Definition at line 605 of file powerint.cpp.

Operator * Power_Int::substitute ( int  index,
const Operator sub 
) [virtual]

Substitutes var(index) with the expression sub.

Returns:
The substituted expression.
Parameters:
indexsubst. index
subthe substitution

Implements SmoothOperator.

Definition at line 310 of file powerint.cpp.


Member Data Documentation

The basis argument of the power.

Definition at line 458 of file powerint.hpp.

double* Power_Int::argument_result [protected]

The results for the argument.

Definition at line 467 of file powerint.hpp.

int Power_Int::bufferSize [protected]

The size of the buffer

Definition at line 474 of file powerint.hpp.

Definition at line 476 of file powerint.hpp.

The derivative of the argument

Definition at line 464 of file powerint.hpp.

double* Power_Int::dargument_result [protected]

The results for the first derivative of the argument.

Definition at line 470 of file powerint.hpp.

An auxiliary variable to define the first order derivative of the power.

Definition at line 455 of file powerint.hpp.

An auxiliary variable to define the second order derivative of the power.

Definition at line 456 of file powerint.hpp.

int Power_Int::exponent [protected]

The integer valued exponent.

Definition at line 461 of file powerint.hpp.

Definition at line 477 of file powerint.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:25