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

The OSnLMNode Class for nonlinear expressions involving matrices. More...

#include <OSnLNode.h>

+ Inheritance diagram for OSnLMNode:
+ Collaboration diagram for OSnLMNode:

Public Member Functions

 OSnLMNode ()
 default constructor. More...
 
virtual ~OSnLMNode ()
 default destructor. More...
 
OSnLMNodecreateExpressionTreeFromPrefix (std::vector< ExprNode * > nlNodeVec)
 
std::vector< ExprNode * > getPrefixFromExpressionTree ()
 
std::vector< ExprNode * > preOrderOSnLNodeTraversal (std::vector< ExprNode * > *prefixVector)
 
OSnLMNodecreateExpressionTreeFromPostfix (std::vector< ExprNode * > nlNodeVec)
 
std::vector< ExprNode * > getPostfixFromExpressionTree ()
 
std::vector< ExprNode * > postOrderOSnLNodeTraversal (std::vector< ExprNode * > *postfixVector)
 
OSnLMNodecopyNodeAndDescendants ()
 make a copy of this node and all its descendants More...
 
bool IsEqual (OSnLMNode *that)
 A function to check for the equality of two objects. More...
 
- Public Member Functions inherited from ExprNode
 ExprNode ()
 default constructor. More...
 
virtual ~ExprNode ()
 default destructor. More...
 
virtual std::string getTokenNumber ()
 
virtual std::string getTokenName ()=0
 
virtual std::string getNonlinearExpressionInXML ()
 
virtual ExprNodecloneExprNode ()=0
 
virtual bool IsEqual (ExprNode *that)
 A function to check for the equality of two objects. More...
 

Additional Inherited Members

- Public Attributes inherited from ExprNode
int inodeInt
 inodeInt is the unique integer assigned to the OSnLNode or OSnLMNode in OSParameters.h. More...
 
int inodeType
 inodeType essentially tracks whether the number of children are known or not. More...
 
unsigned int inumberOfChildren
 inumberOfChildren is the number of OSnLNode child elements If this number is not fixed, e.g., for a sum node, it is temporarily set to 0 More...
 
unsigned int inumberOfMatrixChildren
 inumberOfMatrixChildren is the number of OSnLMNode child elements If this number is not fixed, e.g., for a matrixProduct node, it is temporarily set to 0 More...
 
OSnLNode ** m_mChildren
 m_mChildren holds all the operands, that is, nodes that the current node operates on. More...
 
OSnLMNode ** m_mMatrixChildren
 m_mMatrixChildren holds all the matrix-valued operands, if any. More...
 

Detailed Description

The OSnLMNode Class for nonlinear expressions involving matrices.

Author
Horand Gassmann, Jun Ma, Kipp Martin
Date
11/06/2014
Since
OS2.8

Definition at line 1765 of file OSnLNode.h.

Constructor & Destructor Documentation

OSnLMNode::OSnLMNode ( )

default constructor.

virtual OSnLMNode::~OSnLMNode ( )
virtual

default destructor.

Member Function Documentation

OSnLMNode* OSnLMNode::createExpressionTreeFromPrefix ( std::vector< ExprNode * >  nlNodeVec)

Take a vector of ExprNodes (OSnLNodes and OSnLMNodes) in prefix format and create a matrix-valued OSExpressionTree root node

Parameters
nlNodeVecholds a vector of pointers to OSnLNodes and OSnLMNodes in prefix format
Returns
a pointer to an OSnLMNode which is the root of an OSExpressionTree.
std::vector<ExprNode*> OSnLMNode::getPrefixFromExpressionTree ( )
virtual

Get a vector of pointers to OSnLNodes and OSnLMNodes that correspond to the (matrix-valued) expression tree in prefix format.

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

Reimplemented from ExprNode.

std::vector<ExprNode*> OSnLMNode::preOrderOSnLNodeTraversal ( std::vector< ExprNode * > *  prefixVector)
virtual

Called by getPrefixFromExpressionTree(). This method calls itself recursively and generates a vector of pointers to ExprNode in prefix

Parameters
apointer prefixVector to a vector of pointers of ExprNodes
Returns
a vector of pointers to ExprNode in prefix.

Reimplemented from ExprNode.

OSnLMNode* OSnLMNode::createExpressionTreeFromPostfix ( std::vector< ExprNode * >  nlNodeVec)

Take a vector of ExprNodes (OSnLNodes and OSnLMNodes) in postfix format and create a matrix-valued OSExpressionTree root node

Parameters
nlNodeVecholds a vector of pointers to OSnLNodes and OSnLMNodes in postfix format
Returns
a pointer to an OSnLMNode which is the root of an OSExpressionTree.
std::vector<ExprNode*> OSnLMNode::getPostfixFromExpressionTree ( )
virtual

Get a vector of pointers to ExprNodes that correspond to the expression tree in postfix format

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

Reimplemented from ExprNode.

std::vector<ExprNode*> OSnLMNode::postOrderOSnLNodeTraversal ( std::vector< ExprNode * > *  postfixVector)
virtual

Called by getPostfixFromExpressionTree(). This method calls itself recursively and generates a vector of pointers to ExprNodes in postfix.

Parameters
apointer postfixVector to a vector of pointers of ExprNodes
Returns
a vector of pointers to ExprNodes in postfix.

Reimplemented from ExprNode.

OSnLMNode* OSnLMNode::copyNodeAndDescendants ( )

make a copy of this node and all its descendants

Returns
a pointer to the duplicate node
bool OSnLMNode::IsEqual ( OSnLMNode that)

A function to check for the equality of two objects.


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