OSnLNodeE Class Reference

The OSnLNodeE Class. More...

#include <OSnLNode.h>

Inheritance diagram for OSnLNodeE:

[legend]

Collaboration diagram for OSnLNodeE:

[legend]

List of all members.

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

Definition at line 1346 of file OSnLNode.h.

---

Constructor & Destructor Documentation

OSnLNodeE::OSnLNodeE

(

)

default constructor.

Definition at line 1837 of file OSnLNode.cpp.

OSnLNodeE::~OSnLNodeE

(

)

default destructor.

Definition at line 1850 of file OSnLNode.cpp.

---

Member Function Documentation

std::string OSnLNodeE::getTokenNumber

(

)

[virtual]

Returns:

a string token that corresponds to the OSnLNode.

Reimplemented from ExprNode.

Definition at line 1858 of file OSnLNode.cpp.

std::string OSnLNodeE::getTokenName

(

)

[virtual]

Returns:

a string token that corresponds to the OSnLNode.

Implements ExprNode.

Definition at line 1866 of file OSnLNode.cpp.

std::string OSnLNodeE::getNonlinearExpressionInXML

(

)

[virtual]

Returns:

the OSiL XML for the number node.

Reimplemented from ExprNode.

Definition at line 1874 of file OSnLNode.cpp.

double OSnLNodeE::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 1884 of file OSnLNode.cpp.

OSnLNode * OSnLNodeE::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 1896 of file OSnLNode.cpp.

ADdouble OSnLNodeE::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 1890 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