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 getTokenNumber ()
virtual std::string getTokenName ()
virtual std::string getNonlinearExpressionInXML ()
virtual double calculateFunction (double *x)
virtual OSnLNodecloneOSnLNode ()
virtual ADdouble constructADTape (std::map< int, int > *ADIdx, vector< ADdouble > *XAD)
 The implementation of the virtual functions.

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 1132 of file OSnLNode.h.


Constructor & Destructor Documentation

OSnLNodeNumber::OSnLNodeNumber (  ) 

default constructor.

Definition at line 1406 of file OSnLNode.cpp.

References OSnLNode::inodeInt, OSnLNode::inodeType, OSnLNode::inumberOfChildren, OSnLNode::m_mChildren, OSnLNode::snodeName, type, and value.

Referenced by cloneOSnLNode().

OSnLNodeNumber::~OSnLNodeNumber (  ) 

default destructor.

Definition at line 1419 of file OSnLNode.cpp.

References OSnLNode::m_mChildren.


Member Function Documentation

std::string OSnLNodeNumber::getTokenNumber (  )  [virtual]

Returns:
a string token that corresponds to the OSnLNode.

Reimplemented from OSnLNode.

Definition at line 1427 of file OSnLNode.cpp.

References id, OSnLNode::inodeInt, type, and value.

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

Returns:
a string token that corresponds to the OSnLNode.

Reimplemented from OSnLNode.

Definition at line 1444 of file OSnLNode.cpp.

References id, OSnLNode::snodeName, type, and value.

std::string OSnLNodeNumber::getNonlinearExpressionInXML (  )  [virtual]

Returns:
the OSiL XML for the number node.

Reimplemented from OSnLNode.

Definition at line 1461 of file OSnLNode.cpp.

References id, os_dtoa_format(), OSnLNode::snodeName, type, and value.

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 1481 of file OSnLNode.cpp.

References OSnLNode::m_dFunctionValue, and value.

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 1491 of file OSnLNode.cpp.

References OSnLNodeNumber().

double OSnLNodeNumber::constructADTape ( std::map< int, int > *  ADIdx,
vector< ADdouble > *  XAD 
) [virtual]

The implementation of the virtual functions.

Returns:
a ADdouble.

Implements OSnLNode.

Definition at line 1486 of file OSnLNode.cpp.

References OSnLNode::m_ADTape, and value.


Member Data Documentation

double OSnLNodeNumber::value

value is the value of the number

Definition at line 1136 of file OSnLNode.h.

Referenced by calculateFunction(), constructADTape(), OSnLNodePower::constructADTape(), OSgams2osil::createOSInstance(), getNonlinearExpressionInXML(), OSInstance::getNonlinearExpressionTreeInInfix(), getTokenName(), getTokenNumber(), main(), OSnLNodeNumber(), OSgams2osil::parseGamsInstructions(), LindoSolver::processNonlinearExpressions(), and OSnl2osil::walkTree().

std::string OSnLNodeNumber::type

in the C++ type is real

Definition at line 1138 of file OSnLNode.h.

Referenced by getNonlinearExpressionInXML(), getTokenName(), getTokenNumber(), and OSnLNodeNumber().

std::string OSnLNodeNumber::id

later, e.g.

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

Definition at line 1142 of file OSnLNode.h.

Referenced by getNonlinearExpressionInXML(), getTokenName(), and getTokenNumber().


The documentation for this class was generated from the following files:
Generated on Tue Mar 30 03:13:24 2010 by  doxygen 1.4.7