DoubleConstant Class Reference

Implements a scalar constant within the symbolic operators family. More...

#include <doubleconstant.hpp>

Inheritance diagram for DoubleConstant:

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 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)
	DoubleConstant ()
	DoubleConstant (double value_, NeutralElement neutralElement_=NE_ZERO)
	DoubleConstant (const DoubleConstant &arg)
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 double	getValue () const
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)
DoubleConstant &	operator= (const DoubleConstant &arg)
virtual std::ostream &	print (std::ostream &stream) const
virtual returnValue	setCurvature (CurvatureType curvature_)
virtual returnValue	setMonotonicity (MonotonicityType monotonicity_)
virtual Operator *	substitute (int index, const Operator *sub)
	~DoubleConstant ()
Protected Attributes
NeutralElement	neutralElement
double	value

---

Detailed Description

Implements a scalar constant within the symbolic operators family.

The class DoubleConstant implements a scalar constant within the symbolic operators family.

Author:

Boris Houska, Hans Joachim Ferreau

Definition at line 55 of file doubleconstant.hpp.

---

Constructor & Destructor Documentation

BEGIN_NAMESPACE_ACADO DoubleConstant::DoubleConstant

(

)

Default constructor.

Definition at line 45 of file doubleconstant.cpp.

DoubleConstant::DoubleConstant	(	double	value_,
		NeutralElement	neutralElement_ = NE_ZERO
	)

Default constructor.

Definition at line 53 of file doubleconstant.cpp.

DoubleConstant::DoubleConstant

(

const DoubleConstant &

arg

)

Copy constructor (deep copy).

Definition at line 70 of file doubleconstant.cpp.

DoubleConstant::~DoubleConstant

(

)

Default destructor.

Definition at line 79 of file doubleconstant.cpp.

---

Member Function Documentation

returnValue DoubleConstant::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 130 of file doubleconstant.cpp.

returnValue DoubleConstant::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 261 of file doubleconstant.cpp.

returnValue DoubleConstant::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 277 of file doubleconstant.cpp.

Operator * DoubleConstant::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 118 of file doubleconstant.cpp.

returnValue DoubleConstant::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 254 of file doubleconstant.cpp.

returnValue DoubleConstant::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 243 of file doubleconstant.cpp.

returnValue DoubleConstant::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 267 of file doubleconstant.cpp.

returnValue DoubleConstant::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 143 of file doubleconstant.cpp.

returnValue DoubleConstant::clearBuffer

(

)

[virtual]

Clears the buffer and resets the buffer size
to 1.

Returns:

SUCCESFUL_RETURN

Implements SmoothOperator.

Definition at line 297 of file doubleconstant.cpp.

Operator * DoubleConstant::clone

(

)

const [virtual]

Provides a deep copy of the expression.

Returns:

a clone of the expression.

Implements SmoothOperator.

Definition at line 291 of file doubleconstant.cpp.

Operator * DoubleConstant::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 112 of file doubleconstant.cpp.

returnValue DoubleConstant::enumerateVariables

(

SymbolicIndexList *

indexList

)

[virtual]

Enumerates all variables based on a common
IndexList.

Returns:

SUCCESFUL_RETURN

Implements SmoothOperator.

Definition at line 303 of file doubleconstant.cpp.

returnValue DoubleConstant::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 98 of file doubleconstant.cpp.

returnValue DoubleConstant::evaluate

(

EvaluationBase *

x

)

[virtual]

Evaluates the expression (templated version)

Implements SmoothOperator.

Definition at line 105 of file doubleconstant.cpp.

CurvatureType DoubleConstant::getCurvature

(

)

[virtual]

Returns the curvature of the expression

Returns:

CT_CONSTANT
CT_AFFINE
CT_CONVEX
CT_CONCAVE

Implements SmoothOperator.

Definition at line 225 of file doubleconstant.cpp.

MonotonicityType DoubleConstant::getMonotonicity

(

)

[virtual]

Returns the monotonicity of the expression.

Returns:

MT_NONDECREASING
MT_NONINCREASING
MT_NONMONOTONIC

Implements SmoothOperator.

Definition at line 219 of file doubleconstant.cpp.

OperatorName DoubleConstant::getName

(

)

[virtual]

Asks the expression for its name.

Returns:

the name of the expression.

Implements SmoothOperator.

Definition at line 312 of file doubleconstant.cpp.

double DoubleConstant::getValue

(

)

const [virtual]

Return the value of the constant

Reimplemented from SmoothOperator.

Definition at line 335 of file doubleconstant.cpp.

BooleanType DoubleConstant::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 177 of file doubleconstant.cpp.

BooleanType DoubleConstant::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 183 of file doubleconstant.cpp.

BooleanType DoubleConstant::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 192 of file doubleconstant.cpp.

NeutralElement DoubleConstant::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 171 of file doubleconstant.cpp.

BooleanType DoubleConstant::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 201 of file doubleconstant.cpp.

BooleanType DoubleConstant::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 210 of file doubleconstant.cpp.

BooleanType DoubleConstant::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 329 of file doubleconstant.cpp.

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

Asks the expression whether it is a variable.

Returns:

The answer.

Implements SmoothOperator.

Definition at line 317 of file doubleconstant.cpp.

returnValue DoubleConstant::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 323 of file doubleconstant.cpp.

DoubleConstant & DoubleConstant::operator=

(

const DoubleConstant &

arg

)

Assignment Operator (deep copy).

Definition at line 84 of file doubleconstant.cpp.

std::ostream & DoubleConstant::print

(

std::ostream &

stream

)

const [virtual]

Prints the expression into a stream.

Returns:

SUCCESFUL_RETURN

Implements SmoothOperator.

Definition at line 285 of file doubleconstant.cpp.

returnValue DoubleConstant::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 237 of file doubleconstant.cpp.

returnValue DoubleConstant::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 231 of file doubleconstant.cpp.

Operator * DoubleConstant::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 164 of file doubleconstant.cpp.

---

Member Data Documentation

NeutralElement DoubleConstant::neutralElement [protected]

The NeutralElement specifies whether the constant value is ONE, ZERO or neither one nor zero

Definition at line 453 of file doubleconstant.hpp.

double DoubleConstant::value [protected]

The value of the double constant.

Definition at line 451 of file doubleconstant.hpp.

---

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

• doubleconstant.hpp
• doubleconstant.cpp