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

#include <powerint.hpp>

Inheritance diagram for Power_Int:

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 Operator *	AD_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 Operator *	clone () const

virtual Operator *	differentiate (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_Int &	operator= (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 Operator *	substitute (int index, const Operator *sub)

	~Power_Int ()

Public Member Functions inherited from SmoothOperator
virtual TreeProjection *	cloneTreeProjection () const

virtual int	getGlobalIndex () const

virtual double	getValue () const

virtual BooleanType	isSmooth () const

Expression	operator* (const double &arg) const

Expression	operator* (const DVector &arg) const

Expression	operator* (const DMatrix &arg) const

Expression	operator* (const Operator &arg) const

Expression	operator* (const Expression &arg) const

Operator &	operator*= (const double &arg)

Operator &	operator*= (const DVector &arg)

Operator &	operator*= (const DMatrix &arg)

Operator &	operator*= (const Expression &arg)

Expression	operator+ (const double &arg) const

Expression	operator+ (const DVector &arg) const

Expression	operator+ (const DMatrix &arg) const

Expression	operator+ (const Operator &arg) const

Expression	operator+ (const Expression &arg) const

Operator &	operator+= (const double &arg)

Operator &	operator+= (const DVector &arg)

Operator &	operator+= (const DMatrix &arg)

Operator &	operator+= (const Expression &arg)

Expression	operator- (const double &arg) const

Expression	operator- (const DVector &arg) const

Expression	operator- (const DMatrix &arg) const

Expression	operator- (const Operator &arg) const

Expression	operator- (const Expression &arg) const

Expression	operator- () const

Operator &	operator-= (const double &arg)

Operator &	operator-= (const DVector &arg)

Operator &	operator-= (const DMatrix &arg)

Operator &	operator-= (const Expression &arg)

Expression	operator/ (const double &arg) const

Expression	operator/ (const Operator &arg) const

Expression	operator/ (const Expression &arg) const

Operator &	operator/= (const double &arg)

Operator &	operator/= (const Expression &arg)

ConstraintComponent	operator<= (const double &ub) const

ConstraintComponent	operator<= (const DVector &ub) const

ConstraintComponent	operator<= (const VariablesGrid &ub) const

virtual Operator &	operator= (const double &arg)

virtual Operator &	operator= (const DVector &arg)

virtual Operator &	operator= (const DMatrix &arg)

virtual Operator &	operator= (const Expression &arg)

virtual Operator &	operator= (const Operator &arg)

ConstraintComponent	operator== (const double &b) const

ConstraintComponent	operator== (const DVector &b) const

ConstraintComponent	operator== (const VariablesGrid &b) const

ConstraintComponent	operator>= (const double &lb) const

ConstraintComponent	operator>= (const DVector &lb) const

ConstraintComponent	operator>= (const VariablesGrid &lb) const

virtual Operator *	passArgument () const

	SmoothOperator ()

virtual	~SmoothOperator ()

Public Member Functions inherited from Operator
virtual BooleanType	isTrivial () const

virtual Operator *	myAdd (Operator a, Operator b)

virtual Operator *	myLogarithm (Operator *a)

virtual Operator *	myPower (Operator a, Operator b)

virtual Operator *	myPowerInt (Operator *a, int b)

virtual Operator *	myProd (Operator a, Operator b)

virtual Operator *	mySubtract (Operator a, Operator b)

	Operator ()

Expression	operator* (const double &arg) const

Expression	operator* (const DVector &arg) const

Expression	operator* (const DMatrix &arg) const

Expression	operator* (const Operator &arg) const

Expression	operator* (const Expression &arg) const

Operator &	operator*= (const double &arg)

Operator &	operator*= (const DVector &arg)

Operator &	operator*= (const DMatrix &arg)

Operator &	operator*= (const Expression &arg)

Expression	operator+ (const double &arg) const

Expression	operator+ (const DVector &arg) const

Expression	operator+ (const DMatrix &arg) const

Expression	operator+ (const Operator &arg) const

Expression	operator+ (const Expression &arg) const

Operator &	operator+= (const double &arg)

Operator &	operator+= (const DVector &arg)

Operator &	operator+= (const DMatrix &arg)

Operator &	operator+= (const Expression &arg)

Expression	operator- (const double &arg) const

Expression	operator- (const DVector &arg) const

Expression	operator- (const DMatrix &arg) const

Expression	operator- (const Operator &arg) const

Expression	operator- (const Expression &arg) const

Expression	operator- () const

Operator &	operator-= (const double &arg)

Operator &	operator-= (const DVector &arg)

Operator &	operator-= (const DMatrix &arg)

Operator &	operator-= (const Expression &arg)

Expression	operator/ (const double &arg) const

Expression	operator/ (const Operator &arg) const

Expression	operator/ (const Expression &arg) const

Operator &	operator/= (const double &arg)

Operator &	operator/= (const Expression &arg)

ConstraintComponent	operator<= (const double &ub) const

ConstraintComponent	operator<= (const DVector &ub) const

ConstraintComponent	operator<= (const VariablesGrid &ub) const

ConstraintComponent	operator== (const double &b) const

ConstraintComponent	operator== (const DVector &b) const

ConstraintComponent	operator== (const VariablesGrid &b) const

ConstraintComponent	operator>= (const double &lb) const

ConstraintComponent	operator>= (const DVector &lb) const

ConstraintComponent	operator>= (const VariablesGrid &lb) const

virtual	~Operator ()

Protected Attributes
Operator *	argument

double *	argument_result

int	bufferSize

CurvatureType	curvature

Operator *	dargument

double *	dargument_result

TreeProjection *	derivative

TreeProjection *	derivative2

int	exponent

MonotonicityType	monotonicity

Protected Attributes inherited from Operator
BooleanType	initialized

Additional Inherited Members
Public Attributes inherited from SmoothOperator
int	nCount

Public Attributes inherited from Operator
int	nCount

Protected Member Functions inherited from Operator
returnValue	ADsymCommon (Operator a, TreeProjection &da, TreeProjection &dda, 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)

returnValue	ADsymCommon2 (Operator a, Operator b, TreeProjection &dx, TreeProjection &dy, TreeProjection &dxx, TreeProjection &dxy, TreeProjection &dyy, 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 TreeProjection *	convert2TreeProjection (Operator *a) const

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

BEGIN_NAMESPACE_ACADO Power_Int::Power_Int ( )

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.

Power_Int::~Power_Int ( )

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

dim	number of directions
varType	the variable types
component	and their components
seed	the backward seed
df	the result
nNewIS	the number of new IS
newIS	the 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

number	the buffer position
seed	the seed
df	the 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

number	the buffer position
seed1	the seed1
seed2	the seed2
df	the 1st derivative of the expression
ddf	the 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

dim	dimension of the seed
varType	the variable types
component	and their components
seed	the forward seed
nNewIS	the number of new IS
newIS	the 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

number	storage position
seed	the seed
df	the 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

number	storage position
x	The evaluation point x
seed	the seed
f	the value of the expression at x
df	the 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

number	the buffer position
seed1	the seed
seed2	the seed for the first derivative
df	the derivative of the expression
ddf	the 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

dim	number of directions
varType	the variable types
component	and their components
l	the backward seed
S	forward seed matrix
dimS	dimension of forward seed
dfS	first order foward result
ldf	first order backward result
H	upper trianglular part of the Hessian
nNewLIS	the number of newLIS
newLIS	the new LIS-pointer
nNewSIS	the number of newSIS
newSIS	the new SIS-pointer
nNewHIS	the number of newHIS
newHIS	the new HIS-pointer

Implements SmoothOperator.

Definition at line 259 of file powerint.cpp.

returnValue Power_Int::clearBuffer ( )

virtual

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

index diff. index

Implements SmoothOperator.

Definition at line 208 of file powerint.cpp.

returnValue Power_Int::enumerateVariables ( SymbolicIndexList * indexList )

virtual

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

number	storage position
x	the input variable x
result	the result

Implements SmoothOperator.

Definition at line 186 of file powerint.cpp.

returnValue Power_Int::evaluate ( EvaluationBase * x )

virtual

Evaluates the expression (templated version)

Implements SmoothOperator.

Definition at line 201 of file powerint.cpp.

CurvatureType Power_Int::getCurvature ( )

virtual

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.

MonotonicityType Power_Int::getMonotonicity ( )

virtual

Returns the monotonicity of the expression.

Returns: MT_NONDECREASING
MT_NONINCREASING
MT_NONMONOTONIC

Implements SmoothOperator.

Definition at line 383 of file powerint.cpp.

OperatorName Power_Int::getName ( )

virtual

Asks the expression for its name.

Returns: the name of the expression.

Implements SmoothOperator.

Definition at line 583 of file powerint.cpp.

returnValue Power_Int::initDerivative ( )

virtual

Reimplemented from Operator.

Definition at line 283 of file powerint.cpp.

BooleanType Power_Int::isDependingOn ( VariableType var ) const

virtual

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

dim	number of directions
varType	the variable types
component	and their components
implicit_dep	implicit 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

dim	number of directions
varType	the variable types
component	and their components
implicit_dep	implicit dependencies

Implements SmoothOperator.

Definition at line 339 of file powerint.cpp.

NeutralElement Power_Int::isOneOrZero ( ) const

virtual

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

dim	number of directions
varType	the variable types
component	and their components
implicit_dep	implicit 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

dim	number of directions
varType	the variable types
component	and their components
implicit_dep	implicit 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.

returnValue Power_Int::loadIndices ( SymbolicIndexList * indexList )

virtual

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

indexList The 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.

returnValue Power_Int::setCurvature ( CurvatureType curvature_ )

virtual

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.

returnValue Power_Int::setMonotonicity ( MonotonicityType monotonicity_ )

virtual

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

index	subst. index
sub	the substitution

Implements SmoothOperator.

Definition at line 310 of file powerint.cpp.

Member Data Documentation

Operator* Power_Int::argument

protected

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.

CurvatureType Power_Int::curvature

protected

Definition at line 476 of file powerint.hpp.

Operator* Power_Int::dargument

protected

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.

TreeProjection* Power_Int::derivative

protected

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

Definition at line 455 of file powerint.hpp.

TreeProjection* Power_Int::derivative2

protected

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.

MonotonicityType Power_Int::monotonicity

protected

Definition at line 477 of file powerint.hpp.

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation