OSnLNodeProduct Class Reference

The OSnLNodeProduct Class. More...

#include <OSnLNode.h>

Inheritance diagram for OSnLNodeProduct:

Inheritance graph
[legend]
Collaboration diagram for OSnLNodeProduct:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 OSnLNodeProduct ()
 default constructor.
 ~OSnLNodeProduct ()
 default destructor.
virtual std::string getTokenName ()
virtual double calculateFunction (double *x)
virtual OSnLNodecloneOSnLNode ()
virtual ADdouble constructADTape (std::map< int, int > *ADIdx, ADvector *XAD)

Detailed Description

The OSnLNodeProduct 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 <product>

Definition at line 703 of file OSnLNode.h.


Constructor & Destructor Documentation

OSnLNodeProduct::OSnLNodeProduct (  ) 

default constructor.

Definition at line 1115 of file OSnLNode.cpp.

References OSnLNode::inodeInt, OSnLNode::inodeType, and OSnLNode::inumberOfChildren.

Referenced by cloneOSnLNode().

OSnLNodeProduct::~OSnLNodeProduct (  ) 

default destructor.

Definition at line 1123 of file OSnLNode.cpp.

References OSnLNode::inumberOfChildren, and OSnLNode::m_mChildren.


Member Function Documentation

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

Returns:
the value of operator name

Implements OSnLNode.

Definition at line 1140 of file OSnLNode.cpp.

double OSnLNodeProduct::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:
x holds the values of the variables in a double array.
Returns:
the function value given the current variable values.

Implements OSnLNode.

Definition at line 1145 of file OSnLNode.cpp.

References OSnLNode::inumberOfChildren, OSnLNode::m_dFunctionValue, and OSnLNode::m_mChildren.

OSnLNode * OSnLNodeProduct::cloneOSnLNode (  )  [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.
Returns:
the function value given the current variable values.

Implements OSnLNode.

Definition at line 1170 of file OSnLNode.cpp.

References OSnLNodeProduct().

ADdouble OSnLNodeProduct::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.

Definition at line 1158 of file OSnLNode.cpp.

References OSnLNode::inumberOfChildren, OSnLNode::m_ADTape, and OSnLNode::m_mChildren.


The documentation for this class was generated from the following files:
Generated on Thu Nov 10 03:13:02 2011 by  doxygen 1.4.7