OSnLNodeSqrt Class Reference

The OSnLNodeSqrt Class. More...

#include <OSnLNode.h>

Inheritance diagram for OSnLNodeSqrt:

Inheritance graph
[legend]
Collaboration diagram for OSnLNodeSqrt:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 OSnLNodeSqrt ()
 default constructor.
 ~OSnLNodeSqrt ()
 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 OSnLNodeSqrt 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 <sqrt>

Definition at line 805 of file OSnLNode.h.


Constructor & Destructor Documentation

OSnLNodeSqrt::OSnLNodeSqrt (  ) 

default constructor.

Definition at line 1237 of file OSnLNode.cpp.

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

Referenced by cloneOSnLNode().

OSnLNodeSqrt::~OSnLNodeSqrt (  ) 

default destructor.

Definition at line 1247 of file OSnLNode.cpp.

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


Member Function Documentation

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

Returns:
the value of operator name

Implements OSnLNode.

Definition at line 1261 of file OSnLNode.cpp.

double OSnLNodeSqrt::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 1266 of file OSnLNode.cpp.

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

OSnLNode * OSnLNodeSqrt::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 1279 of file OSnLNode.cpp.

References OSnLNodeSqrt().

ADdouble OSnLNodeSqrt::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 1273 of file OSnLNode.cpp.

References 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:08 2011 by  doxygen 1.4.7