Product Class Reference

Implements the scalar product operator within the symbolic operators family. More...

#include <product.hpp>

Inheritance diagram for Product:

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 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)
Product &	operator= (const Product &arg)
virtual std::ostream &	print (std::ostream &stream) const
	Product ()
	Product (Operator *_argument1, Operator *_argument2)
	Product (const Product &arg)
virtual Operator *	substitute (int index, const Operator *sub)
	~Product ()

---

Detailed Description

Implements the scalar product operator within the symbolic operators family.

The class Product implements the scalar product operator within the symbolic operators family.

Author:

Boris Houska, Hans Joachim Ferreau

Definition at line 55 of file product.hpp.

---

Constructor & Destructor Documentation

BEGIN_NAMESPACE_ACADO Product::Product

(

)

Default constructor.

Definition at line 45 of file product.cpp.

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

Default constructor.

Definition at line 47 of file product.cpp.

Product::Product

(

const Product &

arg

)

Copy constructor (deep copy).

Definition at line 53 of file product.cpp.

Product::~Product

(

)

Default destructor.

Definition at line 58 of file product.cpp.

---

Member Function Documentation

returnValue Product::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 143 of file product.cpp.

returnValue Product::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 400 of file product.cpp.

returnValue Product::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 433 of file product.cpp.

Operator * Product::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 116 of file product.cpp.

returnValue Product::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 388 of file product.cpp.

returnValue Product::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 363 of file product.cpp.

returnValue Product::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 409 of file product.cpp.

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

Definition at line 178 of file product.cpp.

Operator * Product::clone

(

)

const [virtual]

Provides a deep copy of the expression.

Returns:

a clone of the expression.

Implements BinaryOperator.

Definition at line 467 of file product.cpp.

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

Definition at line 100 of file product.cpp.

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

Definition at line 74 of file product.cpp.

returnValue Product::evaluate

(

EvaluationBase *

x

)

[virtual]

Evaluates the expression (templated version)

Implements BinaryOperator.

Definition at line 93 of file product.cpp.

CurvatureType Product::getCurvature

(

)

[virtual]

Returns the curvature of the expression

Returns:

CT_CONSTANT
CT_AFFINE
CT_CONVEX
CT_CONCAVE

Implements BinaryOperator.

Definition at line 305 of file product.cpp.

MonotonicityType Product::getMonotonicity

(

)

[virtual]

Returns the monotonicity of the expression.

Returns:

MT_NONDECREASING
MT_NONINCREASING
MT_NONMONOTONIC

Implements BinaryOperator.

Definition at line 264 of file product.cpp.

OperatorName Product::getName

(

)

[virtual]

Asks the expression for its name.

Returns:

the name of the expression.

Implements BinaryOperator.

Definition at line 478 of file product.cpp.

double Product::getValue

(

)

const [virtual]

Return the value of the constant

Reimplemented from SmoothOperator.

Definition at line 350 of file product.cpp.

BooleanType Product::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 BinaryOperator.

Definition at line 217 of file product.cpp.

BooleanType Product::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 BinaryOperator.

Definition at line 236 of file product.cpp.

BooleanType Product::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 BinaryOperator.

Definition at line 250 of file product.cpp.

Product & Product::operator=

(

const Product &

arg

)

Assignment Operator (deep copy).

Definition at line 62 of file product.cpp.

std::ostream & Product::print

(

std::ostream &

stream

)

const [virtual]

Prints the expression into a stream.

Returns:

SUCCESFUL_RETURN

Implements BinaryOperator.

Definition at line 453 of file product.cpp.

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

Definition at line 209 of file product.cpp.

---

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

• product.hpp
• product.cpp