OSnLNodeDivide Class Reference

The OSnLNodeDivide Class. More...

#include <OSnLNode.h>

Inheritance diagram for OSnLNodeDivide:

Inheritance graph
[legend]
Collaboration diagram for OSnLNodeDivide:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 OSnLNodeDivide ()
 default constructor.
 ~OSnLNodeDivide ()
 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 OSnLNodeDivide 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 <divide>

Definition at line 603 of file OSnLNode.h.


Constructor & Destructor Documentation

OSnLNodeDivide::OSnLNodeDivide (  ) 

default constructor.

Definition at line 979 of file OSnLNode.cpp.

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

Referenced by cloneOSnLNode().

OSnLNodeDivide::~OSnLNodeDivide (  ) 

default destructor.

Definition at line 990 of file OSnLNode.cpp.

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


Member Function Documentation

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

Returns:
the value of operator name

Implements OSnLNode.

Definition at line 1004 of file OSnLNode.cpp.

double OSnLNodeDivide::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 1009 of file OSnLNode.cpp.

References OSnLNode::calculateFunction(), OSnLNode::m_dFunctionValue, and OSnLNode::m_mChildren.

OSnLNode * OSnLNodeDivide::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 1024 of file OSnLNode.cpp.

References OSnLNodeDivide().

ADdouble OSnLNodeDivide::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 1017 of file OSnLNode.cpp.

References OSnLNode::constructADTape(), OSnLNode::m_ADTape, and OSnLNode::m_mChildren.


The documentation for this class was generated from the following files:
Generated on Wed Nov 30 03:12:04 2011 by  doxygen 1.4.7