OS  2.9.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Public Attributes | List of all members
MatrixExpressionTree Class Reference

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

#include <OSExpressionTree.h>

+ Inheritance diagram for MatrixExpressionTree:
+ Collaboration diagram for MatrixExpressionTree:

Public Member Functions

 MatrixExpressionTree ()
 default constructor. More...
 
 ~MatrixExpressionTree ()
 default destructor. More...
 
bool IsEqual (MatrixExpressionTree *that)
 A function to check for the equality of two objects. More...
 
std::vector< ExprNode * > getPrefixFromExpressionTree ()
 Get a vector of pointers to ExprNodes that correspond to a scalar-valued OSExpressionTree in prefix format. More...
 
std::vector< ExprNode * > getPostfixFromExpressionTree ()
 Get a vector of pointers to ExprNodes that correspond to a scalar-valued OSExpressionTree in postfix format. More...
 
- Public Member Functions inherited from OSExpressionTree
 OSExpressionTree ()
 default constructor. More...
 
 ~OSExpressionTree ()
 default destructor. More...
 
bool IsEqual (OSExpressionTree *that)
 A function to check for the equality of two objects. More...
 

Public Attributes

OSnLMNodem_treeRoot
 m_treeRoot holds the root node (of OSnLMNode type) of the expression tree. More...
 
- Public Attributes inherited from OSExpressionTree
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 More...
 
bool m_bIndexMapGenerated
 Retrieve a map of the indices of the variables that are in the expression tree. More...
 
bool bADMustReTape
 is true if an AD Expression Tree has an expression that can change depending on the value of the input, e.g. More...
 
bool bDestroyNlNodes
 m_bDestroyNlNodes is true if the destructor deletes the nodes in the Expression tree More...
 

Detailed Description

Used to hold the instance in memory.

Remarks
This class stores a matrix-valued linear or nonlinear expression in memory as an expression tree.

Definition at line 201 of file OSExpressionTree.h.

Constructor & Destructor Documentation

MatrixExpressionTree::MatrixExpressionTree ( )

default constructor.

MatrixExpressionTree::~MatrixExpressionTree ( )

default destructor.

Member Function Documentation

bool MatrixExpressionTree::IsEqual ( MatrixExpressionTree that)

A function to check for the equality of two objects.

std::vector<ExprNode*> MatrixExpressionTree::getPrefixFromExpressionTree ( )

Get a vector of pointers to ExprNodes that correspond to a scalar-valued OSExpressionTree in prefix format.

Returns
the expression tree as a vector of ExprNodes in prefix.
std::vector<ExprNode*> MatrixExpressionTree::getPostfixFromExpressionTree ( )

Get a vector of pointers to ExprNodes that correspond to a scalar-valued OSExpressionTree in postfix format.

Returns
the expression tree as a vector of ExprNodes in postfix.

Member Data Documentation

OSnLMNode* MatrixExpressionTree::m_treeRoot

m_treeRoot holds the root node (of OSnLMNode type) of the expression tree.

Definition at line 207 of file OSExpressionTree.h.


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