OSnLNodeMin Class Reference

The OSnLNodeMin Class. More...

#include <OSnLNode.h>

Inheritance diagram for OSnLNodeMin:

Inheritance graph
[legend]
Collaboration diagram for OSnLNodeMin:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 OSnLNodeMin ()
 default constructor.
 ~OSnLNodeMin ()
 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 OSnLNodeMin 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 <min>

Definition at line 399 of file OSnLNode.h.


Constructor & Destructor Documentation

OSnLNodeMin::OSnLNodeMin (  ) 

default constructor.

Definition at line 743 of file OSnLNode.cpp.

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

Referenced by cloneOSnLNode().

OSnLNodeMin::~OSnLNodeMin (  ) 

default destructor.

Definition at line 750 of file OSnLNode.cpp.

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


Member Function Documentation

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

Returns:
the value of operator name

Implements OSnLNode.

Definition at line 768 of file OSnLNode.cpp.

double OSnLNodeMin::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 773 of file OSnLNode.cpp.

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

OSnLNode * OSnLNodeMin::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 805 of file OSnLNode.cpp.

References OSnLNodeMin().

ADdouble OSnLNodeMin::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 790 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 Nov 10 03:13:01 2011 by  doxygen 1.4.7