OSExpressionTree Class Reference

Used to hold the instance in memory. More...

#include <OSExpressionTree.h>

Inheritance diagram for OSExpressionTree:

Public Member Functions
	OSExpressionTree ()
	default constructor.
	~OSExpressionTree ()
	default destructor.
bool	IsEqual (OSExpressionTree *that)
	A function to check for the equality of two objects.
Public Attributes
std::map< int, int > *	mapVarIdx
	m_mapVarIdx is a map used to generate the infix expression for AD the key is idx, a variable number; the value of the map is the location of the corresponding entry in the sparse Jacobian
bool	m_bIndexMapGenerated
	Retrieve a map of the indices of the variables that are in the expression tree.
bool	bADMustReTape
	is true if an AD Expression Tree has an expression that can change depending on the value of the input, e.g.
bool	bDestroyNlNodes
	m_bDestroyNlNodes is true if the destructor deletes the nodes in the Expression tree

Detailed Description

Used to hold the instance in memory.

Remarks:: This is a generic class. Specific classes ScalarExpressionTree (for expressions that evaluate to scalar values) and MatrixExpressionTrees (for expressions that evaluate to matrices) are derived from this class.

Definition at line 37 of file OSExpressionTree.h.

Constructor & Destructor Documentation

OSExpressionTree::OSExpressionTree ( )

default constructor.

Definition at line 21 of file OSExpressionTree.cpp.

OSExpressionTree::~OSExpressionTree ( )

default destructor.

Definition at line 32 of file OSExpressionTree.cpp.

Member Function Documentation

bool OSExpressionTree::IsEqual ( OSExpressionTree * that )

A function to check for the equality of two objects.

Reimplemented in ScalarExpressionTree, and MatrixExpressionTree.

Definition at line 79 of file OSExpressionTree.cpp.

Member Data Documentation

std::map<int, int>* OSExpressionTree::mapVarIdx

m_mapVarIdx is a map used to generate the infix expression for AD the key is idx, a variable number; the value of the map is the location of the corresponding entry in the sparse Jacobian

Definition at line 55 of file OSExpressionTree.h.

bool OSExpressionTree::m_bIndexMapGenerated

Retrieve a map of the indices of the variables that are in the expression tree.