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 double calculateFunction (double *x)
virtual OSnLNodecloneOSnLNode ()
virtual ADdouble constructADTape (std::map< int, int > *ADIdx, vector< ADdouble > *XAD)
 The implementation of the virtual functions.

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 323 of file OSnLNode.h.


Constructor & Destructor Documentation

OSnLNodeSum::OSnLNodeSum (  ) 

default constructor.

Definition at line 449 of file OSnLNode.cpp.

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

Referenced by cloneOSnLNode().

OSnLNodeSum::~OSnLNodeSum (  ) 

default destructor.

Definition at line 457 of file OSnLNode.cpp.

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


Member Function Documentation

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 471 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 490 of file OSnLNode.cpp.

References OSnLNodeSum().

double OSnLNodeSum::constructADTape ( std::map< int, int > *  ADIdx,
vector< ADdouble > *  XAD 
) [virtual]

The implementation of the virtual functions.

Returns:
a ADdouble.

Implements OSnLNode.

Definition at line 481 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 Mon Aug 3 03:07:57 2009 by  doxygen 1.4.7