Used to hold the instance in memory. More...
#include <OSExpressionTree.h>
Public Member Functions | |
| 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 | |
| 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 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.
Definition at line 79 of file OSExpressionTree.cpp.
Member Data Documentation
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.
- Returns
- a map of the variables in the current expression tree. m_bIndexMapGenerated is set to true if getVariableIndicesMap() has been called
Definition at line 70 of file OSExpressionTree.h.
| bool OSExpressionTree::bADMustReTape |
is true if an AD Expression Tree has an expression that can change depending on the value of the input, e.g.
an if statement – false by default
Definition at line 76 of file OSExpressionTree.h.
| bool OSExpressionTree::bDestroyNlNodes |
m_bDestroyNlNodes is true if the destructor deletes the nodes in the Expression tree
Definition at line 81 of file OSExpressionTree.h.
The documentation for this class was generated from the following files:
- /tmp/OS-2.10.2/OS/src/OSCommonInterfaces/OSExpressionTree.h
- /tmp/OS-2.10.2/OS/src/OSCommonInterfaces/OSExpressionTree.cpp
