OSnLNodeSum Class Reference

The OSnLNodeSum Class. More...

#include <OSnLNode.h>

Inheritance diagram for OSnLNodeSum:

Inheritance graph
[legend]
Collaboration diagram for OSnLNodeSum:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 OSnLNodeSum ()
 default constructor.
 ~OSnLNodeSum ()
 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 OSnLNodeSum 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 <sum>

Definition at line 301 of file OSnLNode.h.


Constructor & Destructor Documentation

OSnLNodeSum::OSnLNodeSum (  ) 

default constructor.

Definition at line 528 of file OSnLNode.cpp.

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

Referenced by cloneOSnLNode().

OSnLNodeSum::~OSnLNodeSum (  ) 

default destructor.

Definition at line 535 of file OSnLNode.cpp.

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


Member Function Documentation

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

Returns:
the value of operator name

Implements OSnLNode.

Definition at line 552 of file OSnLNode.cpp.

double OSnLNodeSum::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 557 of file OSnLNode.cpp.

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

OSnLNode * OSnLNodeSum::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 580 of file OSnLNode.cpp.

References OSnLNodeSum().

ADdouble OSnLNodeSum::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 569 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:03 2011 by  doxygen 1.4.7