Implements the scalar addition operator within the symbolic expressions family. More...

#include <addition.hpp>

Inheritance diagram for Addition:

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)
	Addition ()
	Addition (Operator _argument1, Operator _argument2)
	Addition (const Addition &arg)
virtual Operator *	clone () const
virtual Operator *	differentiate (int index)
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	isLinearIn (int dim, VariableType varType, int component, BooleanType *implicit_dep)
virtual BooleanType	isPolynomialIn (int dim, VariableType varType, int component, BooleanType *implicit_dep)
virtual BooleanType	isRationalIn (int dim, VariableType varType, int component, BooleanType *implicit_dep)
Addition &	operator= (const Addition &arg)
virtual std::ostream &	print (std::ostream &stream) const
virtual Operator *	substitute (int index, const Operator *sub)
	~Addition ()

Detailed Description

Implements the scalar addition operator within the symbolic expressions family.

The class Addition implements the scalar addition operator within the symbolic expressions family.

Author:: Boris Houska, Hans Joachim Ferreau

Definition at line 54 of file addition.hpp.

Constructor & Destructor Documentation

BEGIN_NAMESPACE_ACADO Addition::Addition ( )

Default constructor.

Definition at line 45 of file addition.cpp.

Addition::Addition	(	Operator *	_argument1,
		Operator *	_argument2
	)

Default constructor.

Definition at line 49 of file addition.cpp.

Addition::Addition ( const Addition & arg )

Copy constructor (deep copy).

Definition at line 53 of file addition.cpp.

Addition::~Addition ( )

Default destructor.

Definition at line 57 of file addition.cpp.

Member Function Documentation

returnValue Addition::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 BinaryOperator.

Definition at line 127 of file addition.cpp.

returnValue Addition::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 BinaryOperator.

Definition at line 355 of file addition.cpp.

returnValue Addition::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 BinaryOperator.

Definition at line 384 of file addition.cpp.

Operator * Addition::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 BinaryOperator.

Definition at line 107 of file addition.cpp.

returnValue Addition::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 BinaryOperator.

Definition at line 344 of file addition.cpp.

returnValue Addition::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 BinaryOperator.

Definition at line 320 of file addition.cpp.

returnValue Addition::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 BinaryOperator.

Definition at line 364 of file addition.cpp.

returnValue Addition::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