Projection Class Reference

Implements the projection operator within the symbolic operators family. More...

#include <projection.hpp>

Inheritance diagram for Projection:

List of all members.

Public Member Functions
	Projection ()
	Default constructor.
	Projection (const String &name_)
	Default constructor.
	Projection (VariableType variableType_, int vIndex_, const String &name_)
	Default constructor.
	Projection (const Projection &arg)
	Default constructor.
virtual	~Projection ()
	Default destructor.
virtual returnValue	evaluate (int number, double *x, double *result)
	Evaluates the expression and stores the intermediate results in a buffer (needed for automatic differentiation in backward mode) .
virtual returnValue	evaluate (EvaluationBase *x)
	Evaluates the expression (templated version)
virtual Operator *	differentiate (int index)
	Returns the derivative of the expression with respect to the variable var(index).
virtual Operator *	AD_forward (int dim, VariableType *varType, int *component, Operator **seed, int &nNewIS, TreeProjection ***newIS)
	Automatic Differentiation in forward mode on the symbolic level.
virtual returnValue	AD_backward (int dim, VariableType *varType, int *component, Operator *seed, Operator **df)
	Automatic Differentiation in backward mode on the symbolic level.
virtual Operator *	substitute (int index, const Operator *sub)
	Substitutes var(index) with the expression sub.
virtual NeutralElement	isOneOrZero () const
	Checks whether the expression is zero or one .
virtual BooleanType	isDependingOn (VariableType var) const
	Asks the expression whether it is depending on a certian type of variable.
virtual BooleanType	isDependingOn (int dim, VariableType *varType, int *component, BooleanType *implicit_dep)
	Checks whether the expression is depending on a variable .
virtual BooleanType	isLinearIn (int dim, VariableType *varType, int *component, BooleanType *implicit_dep)
	Checks whether the expression is linear in (or not depending on) a variable .
virtual BooleanType	isPolynomialIn (int dim, VariableType *varType, int *component, BooleanType *implicit_dep)
	Checks whether the expression is polynomial in the specified variables .
virtual BooleanType	isRationalIn (int dim, VariableType *varType, int *component, BooleanType *implicit_dep)
	Checks whether the expression is rational in the specified variables .
virtual MonotonicityType	getMonotonicity ()
	Returns the monotonicity of the expression.
virtual CurvatureType	getCurvature ()
	Returns the curvature of the expression .
virtual returnValue	setMonotonicity (MonotonicityType monotonicity_)
	Overwrites the monotonicity of the expression.
virtual returnValue	setCurvature (CurvatureType curvature_)
	Overwrites the curvature of the expression.
virtual returnValue	AD_forward (int number, double *seed, double *df)
	Automatic Differentiation in forward mode.
virtual returnValue	AD_forward (int number, double *x, double *seed, double *f, double *df)
	Automatic Differentiation in forward mode.
virtual returnValue	AD_backward (int number, double seed, double *df)
	Automatic Differentiation in backward mode based on buffered values .
virtual returnValue	AD_forward2 (int number, double *seed1, double *seed2, double *df, double *ddf)
	Automatic Differentiation in forward mode for 2nd derivatives.
virtual returnValue	AD_backward2 (int number, double seed1, double seed2, double *df, double *ddf)
	Automatic Differentiation in backward mode for 2nd order derivatives based on buffered values.
virtual Stream &	print (Stream &stream) const
	Prints the expression into a stream.
virtual Operator *	clone () const
	Provides a deep copy of the expression.
virtual returnValue	clearBuffer ()
	Clears the buffer and resets the buffer size to 1.
virtual returnValue	enumerateVariables (SymbolicIndexList *indexList)
	Enumerates all variables based on a common IndexList.
virtual OperatorName	getName ()
	Asks the expression for its name.
virtual double	getScale () const
	Asks the expression for its scale.
virtual returnValue	setScale (const double &scale_)
	Sets the scale of the variable.
virtual BooleanType	isVariable (VariableType &varType, int &component) const
	Asks the expression whether it is a variable.
virtual int	getVariableIndex () const
	Asks the variable for its relative index.
virtual int	getGlobalIndex () const
	Returns the global type ID of this variable .
VariableType	getType () const
	Asks the variable for its type.
virtual returnValue	loadIndices (SymbolicIndexList *indexList)
	The function loadIndices passes an IndexList through the whole expression tree.
virtual BooleanType	isSymbolic () const
	Asks whether all elements are purely symbolic.
virtual returnValue	setVariableExportName (const VariableType &_type, const Stream *_name)
	Sets the name of the variable that is used for code export.
TreeProjection &	operator+= (const double &arg)
TreeProjection &	operator+= (const Vector &arg)
TreeProjection &	operator+= (const Matrix &arg)
TreeProjection &	operator+= (const Expression &arg)
TreeProjection &	operator-= (const double &arg)
TreeProjection &	operator-= (const Vector &arg)
TreeProjection &	operator-= (const Matrix &arg)
TreeProjection &	operator-= (const Expression &arg)
TreeProjection &	operator*= (const double &arg)
TreeProjection &	operator*= (const Vector &arg)
TreeProjection &	operator*= (const Matrix &arg)
TreeProjection &	operator*= (const Expression &arg)
TreeProjection &	operator/= (const double &arg)
TreeProjection &	operator/= (const Expression &arg)
Expression	operator+ (const double &arg) const
Expression	operator+ (const Vector &arg) const
Expression	operator+ (const Matrix &arg) const
Expression	operator+ (const Operator &arg) const
Expression	operator+ (const Expression &arg) const
Expression	operator- (const double &arg) const
Expression	operator- (const Vector &arg) const
Expression	operator- (const Matrix &arg) const
Expression	operator- (const Operator &arg) const
Expression	operator- (const Expression &arg) const
Expression	operator- () const
Expression	operator* (const double &arg) const
Expression	operator* (const Vector &arg) const
Expression	operator* (const Matrix &arg) const
Expression	operator* (const Operator &arg) const
Expression	operator* (const Expression &arg) const
Expression	operator/ (const double &arg) const
Expression	operator/ (const Operator &arg) const
Expression	operator/ (const Expression &arg) const
ConstraintComponent	operator<= (const double &ub) const
ConstraintComponent	operator<= (const Vector &ub) const
ConstraintComponent	operator<= (const VariablesGrid &ub) const
ConstraintComponent	operator>= (const double &lb) const
ConstraintComponent	operator>= (const Vector &lb) const
ConstraintComponent	operator>= (const VariablesGrid &lb) const
ConstraintComponent	operator== (const double &b) const
ConstraintComponent	operator== (const Vector &b) const
ConstraintComponent	operator== (const VariablesGrid &b) const
virtual BooleanType	isSmooth () const
	Checks whether the expression is smooth in time .
Stream	operator<< (Stream &stream)
	Prints the expression into a stream ("flush" version).
Stream &	operator<< (Stream &stream) const
	Prints the expression into a stream ("flush" version).
virtual TreeProjection *	cloneTreeProjection () const
	Provides a deep copy of a tree projection.
virtual double	getValue () const
	Return the value of the constant.
virtual Operator *	passArgument () const
	Returns the argument or NULL if no intermediate argument available.
Public Attributes
int	nCount
Protected Member Functions
virtual Operator *	ADforwardProtected (int dim, VariableType *varType, int *component, Operator **seed, int &nNewIS, TreeProjection ***newIS)
	Automatic Differentiation in forward mode on the symbolic level.
virtual returnValue	ADbackwardProtected (int dim, VariableType *varType, int *component, Operator *seed, Operator **df)
	Automatic Differentiation in backward mode on the symbolic level.
virtual void	copy (const Projection &arg)
	Copy function.
Protected Attributes
VariableType	variableType
int	variableIndex
int	vIndex
double	scale
Stream	name
OperatorName	operatorName
CurvatureType	curvature
MonotonicityType	monotonicity
Friends
class	FunctionEvaluationTree
Expression	operator+ (const double &arg1, const Operator &arg2)
Expression	operator+ (const Vector &arg1, const Operator &arg2)
Expression	operator+ (const Matrix &arg1, const Operator &arg2)
Expression	operator- (const double &arg1, const Operator &arg2)
Expression	operator- (const Vector &arg1, const Operator &arg2)
Expression	operator- (const Matrix &arg1, const Operator &arg2)
Expression	operator* (const double &arg1, const Operator &arg2)
Expression	operator* (const Vector &arg1, const Operator &arg2)
Expression	operator* (const Matrix &arg1, const Operator &arg2)
Expression	operator/ (const double &arg1, const Operator &arg2)
Expression	operator/ (const Vector &arg1, const Operator &arg2)
Expression	operator/ (const Matrix &arg1, const Operator &arg2)
ConstraintComponent	operator<= (double lb, const Operator &arg)
ConstraintComponent	operator<= (Vector lb, const Operator &arg)
ConstraintComponent	operator<= (VariablesGrid lb, const Operator &arg)
ConstraintComponent	operator>= (double ub, const Operator &arg)
ConstraintComponent	operator>= (Vector ub, const Operator &arg)
ConstraintComponent	operator>= (VariablesGrid ub, const Operator &arg)
ConstraintComponent	operator== (double b, const Operator &arg)
ConstraintComponent	operator== (Vector b, const Operator &arg)
ConstraintComponent	operator== (VariablesGrid b, const Operator &arg)
Stream &	operator<< (Stream &stream, const Operator &arg)
	Prints the expression into a stream ("flush" version).
returnValue	operator<< (FILE *file, const Operator &arg)
	Prints the expression into a stream ("flush" version).

---

Detailed Description

The class Projection implements the scalar-valued projection operator within the symbolic operators family.

Author:

Boris Houska, Hans Joachim Ferreau

---

Constructor & Destructor Documentation

BEGIN_NAMESPACE_ACADO Projection::Projection

(

)

References CT_AFFINE, curvature, monotonicity, MT_NONDECREASING, SmoothOperator::nCount, ON_VARIABLE, operatorName, and scale.

Referenced by clone().

Projection::Projection

(

const String &

name_

)

References CT_AFFINE, curvature, monotonicity, MT_NONDECREASING, name, SmoothOperator::nCount, ON_VARIABLE, operatorName, and scale.

Projection::Projection	(	VariableType	variableType_,
		int	vIndex_,
		const String &	name_
	)

References CT_AFFINE, curvature, monotonicity, MT_NONDECREASING, name, SmoothOperator::nCount, ON_VARIABLE, operatorName, scale, variableIndex, variableType, vIndex, VT_ALGEBRAIC_STATE, VT_CONTROL, VT_DDIFFERENTIAL_STATE, VT_DIFFERENTIAL_STATE, VT_DISTURBANCE, VT_INTEGER_CONTROL, VT_INTEGER_PARAMETER, VT_INTERMEDIATE_STATE, VT_PARAMETER, and VT_TIME.

Projection::Projection

(

const Projection &

arg

)

References copy().

Projection::~Projection

(

)

[virtual]

---

Member Function Documentation

returnValue Projection::AD_backward	(	int	dim,
		VariableType *	varType,
		int *	component,
		Operator *	seed,
		Operator **	df
	)		[virtual]

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

Implements SmoothOperator.

References ADbackwardProtected().

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

Returns:

SUCCESSFUL_RETURN
RET_NAN

Parameters:

number	the buffer position
seed	the seed
df	the derivative of the expression

Implements SmoothOperator.

References SUCCESSFUL_RETURN, and variableIndex.

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

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.

References SUCCESSFUL_RETURN, and variableIndex.

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

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.

References ADforwardProtected().

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

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.

References SUCCESSFUL_RETURN, and variableIndex.

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

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

Returns:

SUCCESSFUL_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.

References SUCCESSFUL_RETURN, and variableIndex.

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

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.

References SUCCESSFUL_RETURN, and variableIndex.

returnValue Projection::ADbackwardProtected	(	int	dim,
		VariableType *	varType,
		int *	component,
		Operator *	seed,
		Operator **	df
	)		[protected, virtual]

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

Reimplemented in TreeProjection.

References Operator::clone(), isOneOrZero(), NE_ZERO, SUCCESSFUL_RETURN, variableType, and vIndex.

Referenced by AD_backward().

Operator * Projection::ADforwardProtected	(	int	dim,
		VariableType *	varType,
		int *	component,
		Operator **	seed,
		int &	nNewIS,
		TreeProjection ***	newIS
	)		[protected, virtual]

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

Reimplemented in TreeProjection.

References Operator::clone(), NE_ZERO, variableType, and vIndex.

Referenced by AD_forward().

returnValue Projection::clearBuffer

(

)

[virtual]

Returns:

SUCCESSFUL_RETURN

Implements SmoothOperator.

References SUCCESSFUL_RETURN.

Operator * Projection::clone

(

)

const [virtual]

Returns:

a clone of the expression.

Implements SmoothOperator.

Reimplemented in TreeProjection.

References Projection().

Referenced by FunctionEvaluationTree::makeImplicit(), and substitute().

TreeProjection * SmoothOperator::cloneTreeProjection

(

)

const [virtual, inherited]

Returns:

a clone of the TreeProjection or
an assertion if the type this is
expression is no TreeProjection.

Reimplemented from Operator.

Reimplemented in TreeProjection.

References ACADOERROR, ASSERT, and RET_UNKNOWN_BUG.

void Projection::copy

(

const Projection &

arg

)

[protected, virtual]

Reimplemented in TreeProjection.

References curvature, monotonicity, name, SmoothOperator::nCount, operatorName, scale, variableIndex, variableType, and vIndex.

Referenced by Projection().

Operator * Projection::differentiate

(

int

index

)

[virtual]

Returns:

The expression for the derivative.

Parameters:

index

diff. index

Implements SmoothOperator.

References NE_ONE, NE_ZERO, and variableIndex.

returnValue Projection::enumerateVariables

(

SymbolicIndexList *

indexList

)

[virtual]

Returns:

SUCCESFUL_RETURN

Implements SmoothOperator.

References SymbolicIndexList::determineVariableIndex(), scale, SUCCESSFUL_RETURN, variableIndex, variableType, and vIndex.

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

Returns:

SUCCESSFUL_RETURN
RET_NAN

Parameters:

number	storage position
x	the input variable x
result	the result

Implements SmoothOperator.

References SUCCESSFUL_RETURN, and variableIndex.

returnValue Projection::evaluate

(

EvaluationBase *

x

)

[virtual]

Implements SmoothOperator.

References EvaluationBase::project(), SUCCESSFUL_RETURN, and variableIndex.

CurvatureType Projection::getCurvature

(

)

[virtual]

Returns:

CT_CONSTANT
CT_AFFINE
CT_CONVEX
CT_CONCAVE

Implements SmoothOperator.

References curvature.

int Projection::getGlobalIndex

(

)

const [virtual]

Returns:

the requested global type ID.

Reimplemented from SmoothOperator.

References vIndex.

MonotonicityType Projection::getMonotonicity

(

)

[virtual]

Returns:

MT_NONDECREASING
MT_NONINCREASING
MT_NONMONOTONIC

Implements SmoothOperator.

References monotonicity.

OperatorName Projection::getName

(

)

[virtual]

Returns:

the name of the expression.

Implements SmoothOperator.

References operatorName.

double Projection::getScale

(

)

const [virtual]

Returns:

the scale of the expression.

References scale.

VariableType Projection::getType

(

)

const

References variableType.

double SmoothOperator::getValue

(

)

const [virtual, inherited]

Reimplemented from Operator.

Reimplemented in DoubleConstant, Addition, Product, Quotient, and Subtraction.

References INFTY.

int Projection::getVariableIndex

(

)

const [virtual]

References variableIndex.

BooleanType Projection::isDependingOn

(

VariableType

var

)

const [virtual]

Returns:

BT_TRUE if a dependency is detected,
BT_FALSE otherwise.

Implements SmoothOperator.

References BT_FALSE, BT_TRUE, and variableType.

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

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.

Reimplemented in TreeProjection.

References BT_FALSE, BT_TRUE, variableType, and vIndex.

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

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.

Reimplemented in TreeProjection.

References BT_TRUE.

NeutralElement Projection::isOneOrZero

(

)

const [virtual]

Returns:

NE_ZERO
NE_ONE
NE_NEITHER_ONE_NOR_ZERO

Implements SmoothOperator.

Reimplemented in TreeProjection.

References NE_NEITHER_ONE_NOR_ZERO.

Referenced by ADbackwardProtected().

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

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.

Reimplemented in TreeProjection.

References BT_TRUE.

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

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.

Reimplemented in TreeProjection.

References BT_TRUE.

BooleanType SmoothOperator::isSmooth

(

)

const [virtual, inherited]

Returns:

BT_FALSE if the expression is not smooth
BT_TRUE otherwise

Implements Operator.

References BT_TRUE.

BooleanType Projection::isSymbolic

(

)

const [virtual]

Returns:

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

Implements SmoothOperator.

References BT_TRUE.

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

Returns:

The answer.

Implements SmoothOperator.

References BT_TRUE, variableType, and vIndex.

returnValue Projection::loadIndices

(

SymbolicIndexList *

indexList

)

[virtual]

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 ONCE 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.

Reimplemented in TreeProjection.

References SymbolicIndexList::addNewElement(), SUCCESSFUL_RETURN, variableType, and vIndex.

Expression SmoothOperator::operator*

(

const double &

arg

)

const [inherited]

Reimplemented from Operator.

Expression SmoothOperator::operator*

(

const Vector &

arg

)

const [inherited]

Reimplemented from Operator.

Expression SmoothOperator::operator*

(

const Matrix &

arg

)

const [inherited]

Reimplemented from Operator.

Expression SmoothOperator::operator*

(

const Operator &

arg

)

const [inherited]

Reimplemented from Operator.

Expression SmoothOperator::operator*

(

const Expression &

arg

)

const [inherited]

Reimplemented from Operator.

TreeProjection & SmoothOperator::operator*=

(

const double &

arg

)

[inherited]

Reimplemented from Operator.

References SmoothOperator::operator=().

TreeProjection & SmoothOperator::operator*=

(

const Vector &

arg

)

[inherited]

Reimplemented from Operator.

References SmoothOperator::operator=().

TreeProjection & SmoothOperator::operator*=

(

const Matrix &

arg

)

[inherited]

Reimplemented from Operator.

References SmoothOperator::operator=().

TreeProjection & SmoothOperator::operator*=

(

const Expression &

arg

)

[inherited]

Reimplemented from Operator.

References SmoothOperator::operator=().

Expression SmoothOperator::operator+

(

const double &

arg

)

const [inherited]

Reimplemented from Operator.

Expression SmoothOperator::operator+

(

const Vector &

arg

)

const [inherited]

Reimplemented from Operator.

Expression SmoothOperator::operator+

(

const Matrix &

arg

)

const [inherited]

Reimplemented from Operator.

Expression SmoothOperator::operator+

(

const Operator &

arg

)

const [inherited]

Reimplemented from Operator.

Expression SmoothOperator::operator+

(

const Expression &

arg

)

const [inherited]

Reimplemented from Operator.

TreeProjection & SmoothOperator::operator+=

(

const double &

arg

)

[inherited]

Reimplemented from Operator.

References SmoothOperator::operator=().

TreeProjection & SmoothOperator::operator+=

(

const Vector &

arg

)

[inherited]

Reimplemented from Operator.

References SmoothOperator::operator=().

TreeProjection & SmoothOperator::operator+=

(

const Matrix &

arg

)

[inherited]

Reimplemented from Operator.

References SmoothOperator::operator=().

TreeProjection & SmoothOperator::operator+=

(

const Expression &

arg

)

[inherited]

Reimplemented from Operator.

References SmoothOperator::operator=().

Expression SmoothOperator::operator-

(

const double &

arg

)

const [inherited]

Reimplemented from Operator.

Expression SmoothOperator::operator-

(

const Vector &

arg

)

const [inherited]

Reimplemented from Operator.

Expression SmoothOperator::operator-

(

const Matrix &

arg

)

const [inherited]

Reimplemented from Operator.

Expression SmoothOperator::operator-

(

const Operator &

arg

)

const [inherited]

Reimplemented from Operator.

Expression SmoothOperator::operator-

(

const Expression &

arg

)

const [inherited]

Reimplemented from Operator.

Expression SmoothOperator::operator-

(

)

const [inherited]

Reimplemented from Operator.

TreeProjection & SmoothOperator::operator-=

(

const double &

arg

)

[inherited]

Reimplemented from Operator.

References SmoothOperator::operator=().

TreeProjection & SmoothOperator::operator-=

(

const Vector &

arg

)

[inherited]

Reimplemented from Operator.

References SmoothOperator::operator=().

TreeProjection & SmoothOperator::operator-=

(

const Matrix &

arg

)

[inherited]

Reimplemented from Operator.

References SmoothOperator::operator=().

TreeProjection & SmoothOperator::operator-=

(

const Expression &

arg

)

[inherited]

Reimplemented from Operator.

References SmoothOperator::operator=().

Expression SmoothOperator::operator/

(

const double &

arg

)

const [inherited]

Reimplemented from Operator.

Expression SmoothOperator::operator/

(

const Operator &

arg

)

const [inherited]

Reimplemented from Operator.

Expression SmoothOperator::operator/

(

const Expression &

arg

)

const [inherited]

Reimplemented from Operator.

TreeProjection & SmoothOperator::operator/=

(

const double &

arg

)

[inherited]

Reimplemented from Operator.

References SmoothOperator::operator=().

TreeProjection & SmoothOperator::operator/=

(

const Expression &

arg

)

[inherited]

Reimplemented from Operator.

References SmoothOperator::operator=().

Stream SmoothOperator::operator<<

(

Stream &

stream

)

[inherited]

Returns:

SUCCESFUL_RETURN

References SmoothOperator::print().

Stream & Operator::operator<<

(

Stream &

stream

)

const [inherited]

Returns:

SUCCESFUL_RETURN

References Operator::print().

ConstraintComponent SmoothOperator::operator<=

(

const double &

ub

)

const [inherited]

Reimplemented from Operator.

ConstraintComponent SmoothOperator::operator<=

(

const Vector &

ub

)

const [inherited]

Reimplemented from Operator.

ConstraintComponent SmoothOperator::operator<=

(

const VariablesGrid &

ub

)

const [inherited]

Reimplemented from Operator.

ConstraintComponent SmoothOperator::operator==

(

const double &

b

)

const [inherited]

Reimplemented from Operator.

ConstraintComponent SmoothOperator::operator==

(

const Vector &

b

)

const [inherited]

Reimplemented from Operator.

ConstraintComponent SmoothOperator::operator==

(

const VariablesGrid &

b

)

const [inherited]

Reimplemented from Operator.

ConstraintComponent SmoothOperator::operator>=

(

const double &

lb

)

const [inherited]

Reimplemented from Operator.

ConstraintComponent SmoothOperator::operator>=

(

const Vector &

lb

)

const [inherited]

Reimplemented from Operator.

ConstraintComponent SmoothOperator::operator>=

(

const VariablesGrid &

lb

)

const [inherited]

Reimplemented from Operator.

Operator * SmoothOperator::passArgument

(

)

const [virtual, inherited]

Reimplemented from Operator.

Reimplemented in TreeProjection.

Stream & Projection::print

(

Stream &

stream

)

const [virtual]

Returns:

SUCCESFUL_RETURN

Implements SmoothOperator.

References name.

returnValue Projection::setCurvature

(

CurvatureType

curvature_

)

[virtual]

(For the case that the curvature is explicitly known)

Returns:

SUCCESSFUL_RETURN

Implements SmoothOperator.

References curvature, and SUCCESSFUL_RETURN.

Referenced by TreeProjection::ADforwardProtected().

returnValue Projection::setMonotonicity

(

MonotonicityType

monotonicity_

)

[virtual]

(For the case that the monotonicity is explicitly known)

Returns:

SUCCESSFUL_RETURN

Implements SmoothOperator.

References monotonicity, and SUCCESSFUL_RETURN.

returnValue Projection::setScale

(

const double &

scale_

)

[virtual]

Returns:

void

References scale, and SUCCESSFUL_RETURN.

returnValue Projection::setVariableExportName	(	const VariableType &	_type,
		const Stream *	_name
	)		[virtual]

Returns:

SUCCESSFUL_RETURN

Reimplemented from Operator.

Reimplemented in TreeProjection.

References name, variableType, and vIndex.

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

Returns:

The substituted expression.

Parameters:

index	subst. index
sub	the substitution

Implements SmoothOperator.

References clone(), Operator::clone(), and variableIndex.

---

Friends And Related Function Documentation

friend class FunctionEvaluationTree [friend]

Expression operator*	(	const double &	arg1,
		const Operator &	arg2
	)		[friend, inherited]

Expression operator*	(	const Vector &	arg1,
		const Operator &	arg2
	)		[friend, inherited]

Expression operator*	(	const Matrix &	arg1,
		const Operator &	arg2
	)		[friend, inherited]

Expression operator+	(	const double &	arg1,
		const Operator &	arg2
	)		[friend, inherited]

Expression operator+	(	const Vector &	arg1,
		const Operator &	arg2
	)		[friend, inherited]

Expression operator+	(	const Matrix &	arg1,
		const Operator &	arg2
	)		[friend, inherited]

Expression operator-	(	const double &	arg1,
		const Operator &	arg2
	)		[friend, inherited]

Expression operator-	(	const Vector &	arg1,
		const Operator &	arg2
	)		[friend, inherited]

Expression operator-	(	const Matrix &	arg1,
		const Operator &	arg2
	)		[friend, inherited]

Expression operator/	(	const double &	arg1,
		const Operator &	arg2
	)		[friend, inherited]

Expression operator/	(	const Vector &	arg1,
		const Operator &	arg2
	)		[friend, inherited]

Expression operator/	(	const Matrix &	arg1,
		const Operator &	arg2
	)		[friend, inherited]

Stream& operator<<	(	Stream &	stream,
		const Operator &	arg
	)		[friend, inherited]

Returns:

SUCCESFUL_RETURN

returnValue operator<<	(	FILE *	file,
		const Operator &	arg
	)		[friend, inherited]

Returns:

SUCCESFUL_RETURN

ConstraintComponent operator<=	(	double	lb,
		const Operator &	arg
	)		[friend, inherited]

ConstraintComponent operator<=	(	Vector	lb,
		const Operator &	arg
	)		[friend, inherited]

ConstraintComponent operator<=	(	VariablesGrid	lb,
		const Operator &	arg
	)		[friend, inherited]

ConstraintComponent operator==	(	double	b,
		const Operator &	arg
	)		[friend, inherited]

ConstraintComponent operator==	(	Vector	b,
		const Operator &	arg
	)		[friend, inherited]

ConstraintComponent operator==	(	VariablesGrid	b,
		const Operator &	arg
	)		[friend, inherited]

ConstraintComponent operator>=	(	double	ub,
		const Operator &	arg
	)		[friend, inherited]

ConstraintComponent operator>=	(	Vector	ub,
		const Operator &	arg
	)		[friend, inherited]

ConstraintComponent operator>=	(	VariablesGrid	ub,
		const Operator &	arg
	)		[friend, inherited]

---

Member Data Documentation

CurvatureType Projection::curvature [protected]

Referenced by copy(), getCurvature(), TreeProjection::operator=(), Projection(), and setCurvature().

MonotonicityType Projection::monotonicity [protected]

Referenced by copy(), getMonotonicity(), TreeProjection::operator=(), Projection(), and setMonotonicity().

Stream Projection::name [protected]

Referenced by copy(), TreeProjection::loadIndices(), print(), Projection(), and setVariableExportName().

int SmoothOperator::nCount [inherited]

Reimplemented from Operator.

Referenced by BinaryOperator::BinaryOperator(), COperator::COperator(), BinaryOperator::copy(), COperator::copy(), copy(), DoubleConstant::DoubleConstant(), UnaryOperator::operator=(), DoubleConstant::operator=(), Power_Int::operator=(), Power_Int::Power_Int(), Projection(), and UnaryOperator::UnaryOperator().

OperatorName Projection::operatorName [protected]

Referenced by copy(), getName(), and Projection().

double Projection::scale [protected]

Referenced by copy(), enumerateVariables(), getScale(), TreeProjection::operator=(), Projection(), and setScale().

int Projection::variableIndex [protected]

Referenced by AD_backward(), AD_backward2(), AD_forward(), AD_forward2(), copy(), differentiate(), enumerateVariables(), evaluate(), getVariableIndex(), FunctionEvaluationTree::makeImplicit(), TreeProjection::operator=(), Projection(), substitute(), and TreeProjection::TreeProjection().

VariableType Projection::variableType [protected]

Referenced by ADbackwardProtected(), TreeProjection::ADforwardProtected(), ADforwardProtected(), copy(), enumerateVariables(), getType(), isDependingOn(), isVariable(), loadIndices(), FunctionEvaluationTree::makeImplicit(), Projection(), setVariableExportName(), and TreeProjection::TreeProjection().

int Projection::vIndex [protected]

Referenced by ADbackwardProtected(), TreeProjection::ADforwardProtected(), ADforwardProtected(), copy(), enumerateVariables(), getGlobalIndex(), TreeProjection::isDependingOn(), isDependingOn(), TreeProjection::isLinearIn(), TreeProjection::isPolynomialIn(), TreeProjection::isRationalIn(), isVariable(), TreeProjection::loadIndices(), loadIndices(), FunctionEvaluationTree::makeImplicit(), TreeProjection::operator=(), Projection(), setVariableExportName(), and TreeProjection::TreeProjection().

---

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

• projection.hpp
• projection.cpp