OSnLNode Class Reference

The OSnLNode Class. More...

#include <OSnLNode.h>

Inheritance diagram for OSnLNode:

[legend]

Collaboration diagram for OSnLNode:

[legend]

List of all members.

Public Member Functions
virtual std::string	getTokenNumber ()
virtual std::string	getTokenName ()
virtual std::string	getNonlinearExpressionInXML ()
OSnLNode *	createExpressionTreeFromPostfix (std::vector< OSnLNode * > nlNodeVec)
OSnLNode *	createExpressionTreeFromPrefix (std::vector< OSnLNode * > nlNodeVec)
std::vector< OSnLNode * >	getPrefixFromExpressionTree ()
std::vector< OSnLNode * >	preOrderOSnLNodeTraversal (std::vector< OSnLNode * > *prefixVector)
std::vector< OSnLNode * >	getPostfixFromExpressionTree ()
std::vector< OSnLNode * >	postOrderOSnLNodeTraversal (std::vector< OSnLNode * > *postfixVector)
virtual void	getVariableIndexMap (std::map< int, int > *varIdx)
virtual double	calculateFunction (double *x)=0
virtual AD< double >	constructCppADTape (std::map< int, int > cppADIdx, CppAD::vector< AD< double > > XAD)=0
virtual OSnLNode *	cloneOSnLNode ()=0
	OSnLNode ()
	default constructor.
virtual	~OSnLNode ()
	default destructor.
Public Attributes
std::string	snodeName
	nodeName holds the OSnLNode name
int	inumberOfChildren
	numberOfChildren is the number of OSnLNode child elements
int	inodeInt
	ssymbolInt is the unique integer assigned to the OSnLNode
int	inodeType
	inodeType is the number of children the node has, it is set to -1 if the number is not known a prior, e.g.
OSnLNode **	m_mChildren
	m_mChildren holds all the operands, that is nodes that the current node operate on.
double	m_dFunctionValue
	m_dFunctionValue holds the function value given the current variable values.
AD< double >	m_CppADTape
	m_CppADTape stores the espression tree for the this OSnLNode as an AD<double>.

Detailed Description

The OSnLNode Class.

Author:: Robert Fourer, Jun Ma, Kipp Martin,

Version:: 1.0, 10/05/2005

Since:: OS1.0

Remarks:: in this file we define an OSnL node for a subset of the nodes defined in the OSnL schema

Definition at line 69 of file OSnLNode.h.

Constructor & Destructor Documentation

OSnLNode::OSnLNode ( )

default constructor.

virtual OSnLNode::~OSnLNode ( ) [virtual]

default destructor.

Member Function Documentation

virtual std::string OSnLNode::getTokenNumber ( ) [virtual]

Returns:: the value of inodeInt

Reimplemented in OSnLNodeNumber, OSnLNodeE, OSnLNodePI, and OSnLNodeVariable.

virtual std::string OSnLNode::getTokenName ( ) [virtual]

Returns:: the value of snodeName

Reimplemented in OSnLNodeNumber, OSnLNodeE, OSnLNodePI, and OSnLNodeVariable.

virtual std::string OSnLNode::getNonlinearExpressionInXML ( ) [virtual]

the following method writes an OSnLNode in OSiL format, it is used by OSiLWriter to take an OSInstance and write the corresponding OSiL

Returns:: the OSnLNode and its children as an OSiL string.

Reimplemented in OSnLNodeNumber, OSnLNodeE, OSnLNodePI, and OSnLNodeVariable.

OSnLNode* OSnLNode::createExpressionTreeFromPostfix ( std::vector< OSnLNode * > nlNodeVec )

Take a vector of OSnLNodes in postfix format and create an create an OSExpressionTree root node

Parameters:

nlNodeVec

holds a vector of pointers to OSnLNodes in postfix format

Returns:: a pointer to an OSnLNode which is the root of and OSExpressionTree.

OSnLNode* OSnLNode::createExpressionTreeFromPrefix ( std::vector< OSnLNode * > nlNodeVec )

Take a vector of OSnLNodes in prefix format and create an create an OSExpressionTree root node

Parameters:

nlNodeVec

holds a vector of pointers to OSnLNodes in prefix format

Returns:: a pointer to an OSnLNode which is the root of and OSExpressionTree.

std::vector<OSnLNode*> OSnLNode::getPrefixFromExpressionTree ( )

Get a vector of pointers to OSnLNodes that correspond to the OSExpressionTree in prefix format

Returns:: the expression tree as a vector of OSnLNodes in prefix.

std::vector<OSnLNode*> OSnLNode::preOrderOSnLNodeTraversal ( std::vector< OSnLNode * > * prefixVector )

Called by getPrefixFromExpressionTree(). This method calls itself recursively and generates a vector of pointers to OSnLNodes in prefix

Parameters:

a

pointer prefixVector to a vector of pointers of OSnLNodes

Returns:: a vector of pointers to OSnLNodes in prefix.

std::vector<OSnLNode*> OSnLNode::getPostfixFromExpressionTree ( )

Get a vector of pointers to OSnLNodes that correspond to the OSExpressionTree in postfix format

Returns:: the expression tree as a vector of OSnLNodes in postfix.

std::vector<OSnLNode*> OSnLNode::postOrderOSnLNodeTraversal ( std::vector< OSnLNode * > * postfixVector )

Called by getPostfixFromExpressionTree(). This method calls itself recursively and generates a vector of pointers to OSnLNodes in postfix

Parameters:

a

pointer postfixVector to a vector of pointers of OSnLNodes

Returns:: a vector of pointers to OSnLNodes in postfix.

virtual void OSnLNode::getVariableIndexMap ( std::map< int, int > * varIdx ) [virtual]

varIdx is a map where the key is the index of an OSnLNodeVariable and (*varIdx)[ idx] is the kth variable in the map, e.g. (*varIdx)[ 5] = 2 means that variable indexed by 5 is the second variable in the OSnLNode and all of its children

Parameters:

a

pointer to a map of the variables in the OSnLNode and its children

Reimplemented in OSnLNodeVariable.

virtual double OSnLNode::calculateFunction ( double * x ) [pure virtual]

Calculate the function value given the current variable values. This is an abstract method which is required to be implemented by the concrete operator nodes that derive or extend from this OSnLNode class.

Parameters:

x

holds the values of the variables in a double array.

Returns:: the function value given the current variable values.

Implemented in OSnLNodePlus, OSnLNodeSum, OSnLNodeMax, OSnLNodeMin, OSnLNodeMinus, OSnLNodeNegate, OSnLNodeTimes, OSnLNodeDivide, OSnLNodePower, OSnLNodeProduct, OSnLNodeLn, OSnLNodeSqrt, OSnLNodeSquare, OSnLNodeCos, OSnLNodeSin, OSnLNodeExp, OSnLNodeAbs, OSnLNodeIf, OSnLNodeNumber, OSnLNodeE, OSnLNodePI, OSnLNodeVariable, and OSnLNodeAllDiff.

virtual AD<double> OSnLNode::constructCppADTape	(	std::map< int, int > *	cppADIdx,
		CppAD::vector< AD< double > > *	XAD
	)			`[pure virtual]`

Create the AD tape to be evaluated by CppAD. This is an abstract method which is required to be implemented by the concrete operator nodes that derive or extend from this OSnLNode class.

Returns:: the expression tree.

Implemented in OSnLNodePlus, OSnLNodeSum, OSnLNodeMax, OSnLNodeMin, OSnLNodeMinus, OSnLNodeNegate, OSnLNodeTimes, OSnLNodeDivide, OSnLNodePower, OSnLNodeProduct, OSnLNodeLn, OSnLNodeSqrt, OSnLNodeSquare, OSnLNodeCos, OSnLNodeSin, OSnLNodeExp, OSnLNodeAbs, OSnLNodeIf, OSnLNodeNumber, OSnLNodeE, OSnLNodePI, OSnLNodeVariable, and OSnLNodeAllDiff.

virtual OSnLNode* OSnLNode::cloneOSnLNode ( ) [pure virtual]

Create or clone a node of this type. This is an abstract method which is required to be implemented by the concrete operator nodes that derive or extend from this OSnLNode class.

Parameters:

x

holds the values of the variables in a double array.