OSnLNodeNumber Class Reference

The OSnLNodeNumber Class. More...

#include <OSnLNode.h>

Inheritance diagram for OSnLNodeNumber:

[legend]

Collaboration diagram for OSnLNodeNumber:

[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)
	Calculate the function value given the current variable values.
virtual OSnLNode *	cloneExprNode ()
	Create or clone a node of this type.
virtual OSnLNode *	copyNodeAndDescendants ()
	make a copy of this node and all its descendants
virtual ADdouble	constructADTape (std::map< int, int > *ADIdx, ADvector *XAD)
	Create the AD tape to be evaluated by AD.
virtual bool	IsEqual (OSnLNodeNumber *that)
	A function to check for the equality of two objects.
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 1262 of file OSnLNode.h.

---

Constructor & Destructor Documentation

OSnLNodeNumber::OSnLNodeNumber

(

)

default constructor.

Definition at line 1646 of file OSnLNode.cpp.

OSnLNodeNumber::~OSnLNodeNumber

(

)

default destructor.

Definition at line 1661 of file OSnLNode.cpp.

---

Member Function Documentation

std::string OSnLNodeNumber::getTokenName

(

)

[virtual]

Returns:

the value of operator name

Implements ExprNode.

Definition at line 1686 of file OSnLNode.cpp.

std::string OSnLNodeNumber::getTokenNumber

(

)

[virtual]

Returns:

a string token that corresponds to the OSnLNode.

Reimplemented from ExprNode.

Definition at line 1668 of file OSnLNode.cpp.

std::string OSnLNodeNumber::getNonlinearExpressionInXML

(

)

[virtual]

Returns:

the OSiL XML for the number node.

Reimplemented from ExprNode.

Definition at line 1692 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 1717 of file OSnLNode.cpp.

OSnLNode * OSnLNodeNumber::cloneExprNode

(

)

[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 class.

Implements ExprNode.

Definition at line 1729 of file OSnLNode.cpp.

OSnLNode * OSnLNodeNumber::copyNodeAndDescendants

(

)

[virtual]

make a copy of this node and all its descendants

Returns:

a pointer to the duplicate node

Reimplemented from OSnLNode.

Definition at line 1737 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 1723 of file OSnLNode.cpp.

bool OSnLNodeNumber::IsEqual

(

OSnLNodeNumber *

that

)

[virtual]

A function to check for the equality of two objects.

Reimplemented from OSnLNode.

Definition at line 1776 of file OSnLNode.cpp.

---

Member Data Documentation

double OSnLNodeNumber::value

value is the value of the number

Definition at line 1266 of file OSnLNode.h.

std::string OSnLNodeNumber::type

in the C++ type is real

Definition at line 1269 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 1274 of file OSnLNode.h.

---

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

• /home/coin/svn-release/OS-2.10.0/OS/src/OSCommonInterfaces/OSnLNode.h
• /home/coin/svn-release/OS-2.10.0/OS/src/OSCommonInterfaces/OSnLNode.cpp