OSnLNodeIf Class Reference

The OSnLNodeIf Class. More...

#include <OSnLNode.h>

Inheritance diagram for OSnLNodeIf:

Inheritance graph
[legend]
Collaboration diagram for OSnLNodeIf:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 OSnLNodeIf ()
 default constructor.
 ~OSnLNodeIf ()
 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 OSnLNodeIf 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 <if>

Definition at line 1155 of file OSnLNode.h.


Constructor & Destructor Documentation

OSnLNodeIf::OSnLNodeIf (  ) 

default constructor.

Definition at line 1636 of file OSnLNode.cpp.

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

Referenced by cloneOSnLNode().

OSnLNodeIf::~OSnLNodeIf (  ) 

default destructor.

Definition at line 1648 of file OSnLNode.cpp.

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


Member Function Documentation

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

Returns:
the value of operator name

Implements OSnLNode.

Definition at line 1662 of file OSnLNode.cpp.

double OSnLNodeIf::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 1667 of file OSnLNode.cpp.

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

OSnLNode * OSnLNodeIf::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 1688 of file OSnLNode.cpp.

References OSnLNodeIf().

ADdouble OSnLNodeIf::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 1674 of file OSnLNode.cpp.

References ErrorClass::errormsg, and OSnLNode::m_ADTape.


The documentation for this class was generated from the following files:
Generated on Thu Sep 22 03:13:47 2011 by  doxygen 1.4.7