OSnLNodeNumber Class Reference

The OSnLNodeNumber Class. More...

#include <OSnLNode.h>

Inheritance diagram for OSnLNodeNumber:
Inheritance graph
[legend]
Collaboration diagram for OSnLNodeNumber:
Collaboration graph
[legend]

List of all members.

Public Member Functions

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

Public Attributes

double value
 value is the value of the number
std::string type
 in the C++ type is real
std::string id
 later, e.g.

Detailed Description

The OSnLNodeNumber 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 <number>

Definition at line 1207 of file OSnLNode.h.


Constructor & Destructor Documentation

OSnLNodeNumber::OSnLNodeNumber (  ) 

default constructor.

Definition at line 1713 of file OSnLNode.cpp.

OSnLNodeNumber::~OSnLNodeNumber (  ) 

default destructor.

Definition at line 1725 of file OSnLNode.cpp.


Member Function Documentation

std::string OSnLNodeNumber::getTokenName (  )  [virtual]
Returns:
the value of operator name

Implements OSnLNode.

Definition at line 1751 of file OSnLNode.cpp.

std::string OSnLNodeNumber::getTokenNumber (  )  [virtual]
Returns:
a string token that corresponds to the OSnLNode.

Reimplemented from OSnLNode.

Definition at line 1733 of file OSnLNode.cpp.

std::string OSnLNodeNumber::getNonlinearExpressionInXML (  )  [virtual]
Returns:
the OSiL XML for the number node.

Reimplemented from OSnLNode.

Definition at line 1757 of file OSnLNode.cpp.

double OSnLNodeNumber::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 1779 of file OSnLNode.cpp.

OSnLNode * OSnLNodeNumber::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 1791 of file OSnLNode.cpp.

ADdouble OSnLNodeNumber::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 1785 of file OSnLNode.cpp.


Member Data Documentation

value is the value of the number

Definition at line 1212 of file OSnLNode.h.

std::string OSnLNodeNumber::type

in the C++ type is real

Definition at line 1214 of file OSnLNode.h.

std::string OSnLNodeNumber::id

later, e.g.

stochastic programming, we may wish to give an id to a number

Definition at line 1218 of file OSnLNode.h.


The documentation for this class was generated from the following files:

Generated on 22 May 2012 by  doxygen 1.6.1