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)
	Calculate the function value given the current variable values.
virtual OSnLNode *	cloneExprNode ()
	Create or clone a node of this type.
virtual ADdouble	constructADTape (std::map< int, int > *ADIdx, ADvector *XAD)
	Create the AD tape to be evaluated by AD.

---

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 1412 of file OSnLNode.h.

---

Constructor & Destructor Documentation

OSnLNodePI::OSnLNodePI

(

)

default constructor.

Definition at line 1906 of file OSnLNode.cpp.

OSnLNodePI::~OSnLNodePI

(

)

default destructor.

Definition at line 1917 of file OSnLNode.cpp.

---

Member Function Documentation

std::string OSnLNodePI::getTokenNumber

(

)

[virtual]

Returns:

a string token that corresponds to the OSnLNode.

Reimplemented from ExprNode.

Definition at line 1925 of file OSnLNode.cpp.

std::string OSnLNodePI::getTokenName

(

)

[virtual]

Returns:

a string token that corresponds to the OSnLNode.

Implements ExprNode.

Definition at line 1933 of file OSnLNode.cpp.

std::string OSnLNodePI::getNonlinearExpressionInXML

(

)

[virtual]

Returns:

the OSiL XML for the number node.

Reimplemented from ExprNode.

Definition at line 1941 of file OSnLNode.cpp.

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 1951 of file OSnLNode.cpp.

OSnLNode * OSnLNodePI::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 1963 of file OSnLNode.cpp.

ADdouble OSnLNodePI::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 1957 of file OSnLNode.cpp.

---

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