OSnLNodePower Class Reference

The OSnLNodePower Class. More...

#include <OSnLNode.h>

Inheritance diagram for OSnLNodePower:

Inheritance graph
[legend]
Collaboration diagram for OSnLNodePower:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 OSnLNodePower ()
 default constructor.
 ~OSnLNodePower ()
 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 OSnLNodePower 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 <power>

Definition at line 653 of file OSnLNode.h.


Constructor & Destructor Documentation

OSnLNodePower::OSnLNodePower (  ) 

default constructor.

Definition at line 1034 of file OSnLNode.cpp.

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

Referenced by cloneOSnLNode().

OSnLNodePower::~OSnLNodePower (  ) 

default destructor.

Definition at line 1045 of file OSnLNode.cpp.

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


Member Function Documentation

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

Returns:
the value of operator name

Implements OSnLNode.

Definition at line 1059 of file OSnLNode.cpp.

double OSnLNodePower::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 1064 of file OSnLNode.cpp.

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

OSnLNode * OSnLNodePower::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 1103 of file OSnLNode.cpp.

References OSnLNodePower().

ADdouble OSnLNodePower::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 1072 of file OSnLNode.cpp.

References OSnLNode::m_ADTape, OSnLNode::m_mChildren, and OSnLNodeNumber::value.


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