OSnLNodeVariable Class Reference

The OSnLNodeVariable Class. More...

#include <OSnLNode.h>

Inheritance diagram for OSnLNodeVariable:

[legend]

Collaboration diagram for OSnLNodeVariable:

[legend]

List of all members.

Public Member Functions
	OSnLNodeVariable ()
	default constructor.
	~OSnLNodeVariable ()
	default destructor.
virtual void	getVariableIndexMap (std::map< int, int > *varIdx)
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	coef
	coef is an option coefficient on the variable, the default value is 1.o
int	idx
	idx is the index of the variable

---

Detailed Description

The OSnLNodeVariable 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 <variable>

Definition at line 1282 of file OSnLNode.h.

---

Constructor & Destructor Documentation

OSnLNodeVariable::OSnLNodeVariable

(

)

default constructor.

OSnLNodeVariable::~OSnLNodeVariable

(

)

default destructor.

---

Member Function Documentation

virtual void OSnLNodeVariable::getVariableIndexMap

(

std::map< int, int > *

varIdx

)

[virtual]

varIdx is a map where the key is the index of an OSnLNodeVariable and (*varIdx)[ idx] is the kth variable in the map, e.g. (*varIdx)[ 5] = 2 means that variable indexed by 5 is the second variable in the OSnLNode and all of its children

Parameters:

a

pointer to a map of the variables in the OSnLNode and its children

Reimplemented from OSnLNode.

virtual std::string OSnLNodeVariable::getTokenNumber

(

)

[virtual]

Returns:

a string token that corresponds to the OSnLNode.

Reimplemented from OSnLNode.

virtual std::string OSnLNodeVariable::getTokenName

(

)

[virtual]

Returns:

a std::string token that corresponds to the OSnLNode.

Reimplemented from OSnLNode.

virtual std::string OSnLNodeVariable::getNonlinearExpressionInXML

(

)

[virtual]

Returns:

the OSiL XML for the variable node.

Reimplemented from OSnLNode.

virtual double OSnLNodeVariable::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* OSnLNodeVariable::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 OSnLNodeVariable::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 OSnLNodeVariable::coef

coef is an option coefficient on the variable, the default value is 1.o

Definition at line 1288 of file OSnLNode.h.

int OSnLNodeVariable::idx

idx is the index of the variable

Definition at line 1291 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