OSnLNodeSquare Class Reference

The OSnLNodeSquare Class. More...

#include <OSnLNode.h>

Inheritance diagram for OSnLNodeSquare:

Inheritance graph
[legend]
Collaboration diagram for OSnLNodeSquare:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 OSnLNodeSquare ()
 default constructor.
 ~OSnLNodeSquare ()
 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 OSnLNodeSquare 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 <square>

Definition at line 855 of file OSnLNode.h.


Constructor & Destructor Documentation

OSnLNodeSquare::OSnLNodeSquare (  ) 

default constructor.

Definition at line 1291 of file OSnLNode.cpp.

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

Referenced by cloneOSnLNode().

OSnLNodeSquare::~OSnLNodeSquare (  ) 

default destructor.

Definition at line 1301 of file OSnLNode.cpp.

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


Member Function Documentation

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

Returns:
the value of operator name

Implements OSnLNode.

Definition at line 1315 of file OSnLNode.cpp.

double OSnLNodeSquare::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 1320 of file OSnLNode.cpp.

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

OSnLNode * OSnLNodeSquare::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 1333 of file OSnLNode.cpp.

References OSnLNodeSquare().

ADdouble OSnLNodeSquare::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 1327 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 Thu Sep 22 03:13:50 2011 by  doxygen 1.4.7