OSnLNodePI Class Reference

The OSnLNodePI Class. More...

#include <OSnLNode.h>

Inheritance diagram for OSnLNodePI:

List of all members.

Public Member Functions
	OSnLNodePI ()
	default constructor.
	~OSnLNodePI ()
	default destructor.
virtual std::string	getTokenNumber ()
	Returns: a string token that corresponds to the OSnLNode.
virtual std::string	getTokenName ()
	Returns: a string token that corresponds to the OSnLNode.
virtual std::string	getNonlinearExpressionInXML ()
	Returns: the OSiL XML for the number node.
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.

Definition at line 1531 of file OSnLNode.cpp.

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

Referenced by cloneOSnLNode().

OSnLNodePI::~OSnLNodePI

(

)

default destructor.

Definition at line 1543 of file OSnLNode.cpp.

References OSnLNode::m_mChildren.

---

Member Function Documentation

std::string OSnLNodePI::getTokenNumber

(

)

[virtual]

Returns:

a string token that corresponds to the OSnLNode.

Reimplemented from OSnLNode.

Definition at line 1551 of file OSnLNode.cpp.

References OSnLNode::inodeInt.

std::string OSnLNodePI::getTokenName

(

)

[virtual]

Returns:

a string token that corresponds to the OSnLNode.

Reimplemented from OSnLNode.

Definition at line 1568 of file OSnLNode.cpp.

References OSnLNode::snodeName.

std::string OSnLNodePI::getNonlinearExpressionInXML

(

)

[virtual]

Returns:

the OSiL XML for the number node.

Reimplemented from OSnLNode.

Definition at line 1585 of file OSnLNode.cpp.

References OSnLNode::snodeName.

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.

Definition at line 1605 of file OSnLNode.cpp.

References OSnLNode::m_dFunctionValue, and OS_PI_VALUE.

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.

Definition at line 1615 of file OSnLNode.cpp.

References OSnLNodePI().

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.

Definition at line 1610 of file OSnLNode.cpp.

References OSnLNode::m_CppADTape, and OS_PI_VALUE.

---

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

• /Users/kmartin/Documents/files/code/cpp/OScpp/COIN-OS/OS/src/OSCommonInterfaces/OSnLNode.h
• /Users/kmartin/Documents/files/code/cpp/OScpp/COIN-OS/OS/src/OSCommonInterfaces/OSnLNode.cpp

---