OS  2.9.3
Public Member Functions | List of all members
OSnLNodeTimes Class Reference

The OSnLNodeTimes Class. More...

#include <OSnLNode.h>

+ Inheritance diagram for OSnLNodeTimes:
+ Collaboration diagram for OSnLNodeTimes:

Public Member Functions

 OSnLNodeTimes ()
 default constructor. More...
 
 ~OSnLNodeTimes ()
 default destructor. More...
 
virtual std::string getTokenName ()
 
virtual double calculateFunction (double *x)
 
virtual OSnLNodecloneExprNode ()
 The implementation of the virtual functions. More...
 
virtual ADdouble constructADTape (std::map< int, int > *ADIdx, ADvector *XAD)
 
- Public Member Functions inherited from OSnLNode
 OSnLNode ()
 default constructor. More...
 
virtual ~OSnLNode ()
 default destructor. More...
 
virtual void getVariableIndexMap (std::map< int, int > *varIdx)
 
OSnLNodecreateExpressionTreeFromPrefix (std::vector< ExprNode * > nlNodeVec)
 
virtual std::vector< ExprNode * > getPrefixFromExpressionTree ()
 
virtual std::vector< ExprNode * > preOrderOSnLNodeTraversal (std::vector< ExprNode * > *prefixVector)
 
OSnLNodecreateExpressionTreeFromPostfix (std::vector< ExprNode * > nlNodeVec)
 
virtual std::vector< ExprNode * > getPostfixFromExpressionTree ()
 
virtual std::vector< ExprNode * > postOrderOSnLNodeTraversal (std::vector< ExprNode * > *postfixVector)
 
OSnLNodecopyNodeAndDescendants ()
 make a copy of this node and all its descendants More...
 
bool IsEqual (OSnLNode *that)
 A function to check for the equality of two objects. More...
 
- Public Member Functions inherited from ExprNode
 ExprNode ()
 default constructor. More...
 
virtual ~ExprNode ()
 default destructor. More...
 
virtual std::string getTokenNumber ()
 
virtual std::string getNonlinearExpressionInXML ()
 
virtual bool IsEqual (ExprNode *that)
 A function to check for the equality of two objects. More...
 

Additional Inherited Members

- Public Attributes inherited from OSnLNode
double m_dFunctionValue
 m_dFunctionValue holds the function value given the current variable values. More...
 
ADdouble m_ADTape
 m_ADTape stores the expression tree for the this OSnLNode as an ADdouble. More...
 
- Public Attributes inherited from ExprNode
int inodeInt
 inodeInt is the unique integer assigned to the OSnLNode or OSnLMNode in OSParameters.h. More...
 
int inodeType
 inodeType essentially tracks whether the number of children are known or not. More...
 
unsigned int inumberOfChildren
 inumberOfChildren is the number of OSnLNode child elements If this number is not fixed, e.g., for a sum node, it is temporarily set to 0 More...
 
unsigned int inumberOfMatrixChildren
 inumberOfMatrixChildren is the number of OSnLMNode child elements If this number is not fixed, e.g., for a matrixProduct node, it is temporarily set to 0 More...
 
OSnLNode ** m_mChildren
 m_mChildren holds all the operands, that is, nodes that the current node operates on. More...
 
OSnLMNode ** m_mMatrixChildren
 m_mMatrixChildren holds all the matrix-valued operands, if any. More...
 

Detailed Description

The OSnLNodeTimes Class.

Author
Robert Fourer, Jun Ma, Kipp Martin
Version
1.0, 10/05/2005
Since
OS1.0
Remarks
The in-memory representation of the OSnL element <times>

Definition at line 643 of file OSnLNode.h.

Constructor & Destructor Documentation

OSnLNodeTimes::OSnLNodeTimes ( )

default constructor.

OSnLNodeTimes::~OSnLNodeTimes ( )

default destructor.

Member Function Documentation

virtual std::string OSnLNodeTimes::getTokenName ( )
virtual
Returns
the value of operator name

Implements ExprNode.

virtual double OSnLNodeTimes::calculateFunction ( double *  x)
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
xholds the values of the variables in a double array.
Returns
the function value given the current variable values.

Implements OSnLNode.

OSnLNode * OSnLNodeTimes::cloneExprNode ( )
virtual

The implementation of the virtual functions.

Returns
a pointer to a new OSnLNode of the proper type.

Implements ExprNode.

virtual ADdouble OSnLNodeTimes::constructADTape ( std::map< int, int > *  ADIdx,
ADvector XAD 
)
virtual

Create the AD tape to be evaluated by AD. 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.

Implements OSnLNode.


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