OSnLNodeMatrixToScalar Class Reference

The OSnLNodeMatrixTrace Class. More...

#include <OSnLNode.h>

Inheritance diagram for OSnLNodeMatrixToScalar:

[legend]

Collaboration diagram for OSnLNodeMatrixToScalar:

[legend]

List of all members.

Public Member Functions
	OSnLNodeMatrixToScalar ()
	default constructor.
	~OSnLNodeMatrixToScalar ()
	default destructor.
virtual std::string	getTokenName ()
virtual double	calculateFunction (double *x)
	Calculate the function value given the current variable values.
virtual ADdouble	constructADTape (std::map< int, int > *ADIdx, ADvector *XAD)
	Create the AD tape to be evaluated by AD.
virtual OSnLNode *	cloneExprNode ()
	Create or clone a node of this type.

---

Detailed Description

The OSnLNodeMatrixTrace Class.

Author:

Horand Gassmann, Jun Ma, Kipp Martin

Date:

11/06/2014

Since:

OS2.8

Remarks:

The in-memory representation of the OSnL element <matrixToScalar>

Definition at line 1712 of file OSnLNode.h.

---

Constructor & Destructor Documentation

OSnLNodeMatrixToScalar::OSnLNodeMatrixToScalar

(

)

default constructor.

Definition at line 2322 of file OSnLNode.cpp.

OSnLNodeMatrixToScalar::~OSnLNodeMatrixToScalar

(

)

default destructor.

Definition at line 2331 of file OSnLNode.cpp.

---

Member Function Documentation

std::string OSnLNodeMatrixToScalar::getTokenName

(

)

[virtual]

Returns:

the value of operator name

Implements ExprNode.

Definition at line 2352 of file OSnLNode.cpp.

double OSnLNodeMatrixToScalar::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 2338 of file OSnLNode.cpp.

ADdouble OSnLNodeMatrixToScalar::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 2358 of file OSnLNode.cpp.

OSnLNode * OSnLNodeMatrixToScalar::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 2373 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