OSnLNodeE Class Reference

The OSnLNodeE Class. More...

#include <OSnLNode.h>

Inheritance diagram for OSnLNodeE:

Inheritance graph
[legend]
Collaboration diagram for OSnLNodeE:

Collaboration graph
[legend]
List of all members.

Public Member Functions

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

Detailed Description

The OSnLNodeE 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 <E>

Definition at line 1280 of file OSnLNode.h.


Constructor & Destructor Documentation

OSnLNodeE::OSnLNodeE (  ) 

default constructor.

Definition at line 1787 of file OSnLNode.cpp.

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

Referenced by cloneOSnLNode().

OSnLNodeE::~OSnLNodeE (  ) 

default destructor.

Definition at line 1799 of file OSnLNode.cpp.

References OSnLNode::m_mChildren.


Member Function Documentation

std::string OSnLNodeE::getTokenNumber (  )  [virtual]

Returns:
a string token that corresponds to the OSnLNode.

Reimplemented from OSnLNode.

Definition at line 1809 of file OSnLNode.cpp.

References OSnLNode::inodeInt.

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

Returns:
a string token that corresponds to the OSnLNode.

Implements OSnLNode.

Definition at line 1817 of file OSnLNode.cpp.

std::string OSnLNodeE::getNonlinearExpressionInXML (  )  [virtual]

Returns:
the OSiL XML for the number node.

Reimplemented from OSnLNode.

Definition at line 1825 of file OSnLNode.cpp.

double OSnLNodeE::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 1835 of file OSnLNode.cpp.

References OSnLNode::m_dFunctionValue, and OS_E_VALUE.

OSnLNode * OSnLNodeE::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 1847 of file OSnLNode.cpp.

References OSnLNodeE().

ADdouble OSnLNodeE::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 1841 of file OSnLNode.cpp.

References OSnLNode::m_ADTape, and OS_E_VALUE.


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