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	getTokenNumber ()
virtual std::string	getTokenName ()
virtual std::string	getNonlinearExpressionInXML ()
virtual double	calculateFunction (double *x)
virtual OSnLNode *	cloneOSnLNode ()
virtual AD< double >	constructCppADTape (std::map< int, int > *cppADIdx, CppAD::vector< AD< double > > *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 1073 of file OSnLNode.h.

---

Constructor & Destructor Documentation

OSnLNodeNumber::OSnLNodeNumber

(

)

default constructor.

OSnLNodeNumber::~OSnLNodeNumber

(

)

default destructor.

---

Member Function Documentation

virtual std::string OSnLNodeNumber::getTokenNumber

(

)

[virtual]

Returns:

a string token that corresponds to the OSnLNode.

Reimplemented from OSnLNode.

virtual std::string OSnLNodeNumber::getTokenName

(

)

[virtual]

Returns:

a string token that corresponds to the OSnLNode.

Reimplemented from OSnLNode.

virtual std::string OSnLNodeNumber::getNonlinearExpressionInXML

(

)

[virtual]

Returns:

the OSiL XML for the number node.

Reimplemented from OSnLNode.

virtual 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.

virtual 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.

double OSnLNodeNumber::constructCppADTape	(	std::map< int, int > *	cppADIdx,
		CppAD::vector< AD< double > > *	XAD
	)			[virtual]

The implementation of the virtual functions.

Returns:

a AD<double>.

Implements OSnLNode.

---

Member Data Documentation

double OSnLNodeNumber::value

value is the value of the number

Definition at line 1077 of file OSnLNode.h.

std::string OSnLNodeNumber::type

in the C++ type is real

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

---

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

• /home/coin/svn-release/OptimizationSuite-1.1.0/OS/src/OSCommonInterfaces/OSnLNode.h