OSnLNodePI Class Reference

The OSnLNodePI Class. More...

#include <OSnLNode.h>

Inheritance diagram for OSnLNodePI:

[legend]

Collaboration diagram for OSnLNodePI:

[legend]

List of all members.

Public Member Functions
	OSnLNodePI ()
	default constructor.
	~OSnLNodePI ()
	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.

---

Detailed Description

The OSnLNodePI 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 <pi>

Definition at line 1215 of file OSnLNode.h.

---

Constructor & Destructor Documentation

OSnLNodePI::OSnLNodePI

(

)

default constructor.

OSnLNodePI::~OSnLNodePI

(

)

default destructor.

---

Member Function Documentation

virtual std::string OSnLNodePI::getTokenNumber

(

)

[virtual]

Returns:

a string token that corresponds to the OSnLNode.

Reimplemented from OSnLNode.

virtual std::string OSnLNodePI::getTokenName

(

)

[virtual]

Returns:

a string token that corresponds to the OSnLNode.

Reimplemented from OSnLNode.

virtual std::string OSnLNodePI::getNonlinearExpressionInXML

(

)

[virtual]

Returns:

the OSiL XML for the number node.

Reimplemented from OSnLNode.

virtual double OSnLNodePI::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* OSnLNodePI::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 OSnLNodePI::constructCppADTape	(	std::map< int, int > *	cppADIdx,
		CppAD::vector< AD< double > > *	XAD
	)			[virtual]

The implementation of the virtual functions.

Returns:

a AD<double>.

Implements OSnLNode.

---

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

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