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

a generic class from which we derive matrix constructors (BaseMatrix, MatrixElements, MatrixTransformation and MatrixBlocks) as well as matrix types (OSMatrix and MatrixBlock). More...

#include <OSMatrix.h>

+ Inheritance diagram for MatrixNode:
+ Collaboration diagram for MatrixNode:

Public Member Functions

 MatrixNode ()
 default constructor More...
 
virtual ~MatrixNode ()
 destructor More...
 
virtual
ENUM_MATRIX_CONSTRUCTOR_TYPE 
getNodeType ()
 
virtual std::string getNodeName ()=0
 
virtual std::string getMatrixNodeInXML ()=0
 
std::vector< MatrixNode * > getPrefixFromNodeTree ()
 
std::vector< MatrixNode * > preOrderMatrixNodeTraversal (std::vector< MatrixNode * > *prefixVector)
 
std::vector< MatrixNode * > getPostfixFromNodeTree ()
 
std::vector< MatrixNode * > postOrderMatrixNodeTraversal (std::vector< MatrixNode * > *postfixVector)
 
virtual MatrixNodecloneMatrixNode ()=0
 
virtual bool IsEqual (MatrixNode *that)
 A function to check for the equality of two objects. More...
 
bool setRandom (double density, bool conformant, int iMin, int iMax)
 A function to make a random instance of this class. More...
 
bool deepCopyFrom (MatrixNode *that)
 A function to make a deep copy of an instance of this class. More...
 

Public Attributes

ENUM_MATRIX_TYPE matrixType
 matrixType tracks the type of elements contained in this MatrixNode, which may be useful in solver selection More...
 
ENUM_MATRIX_CONSTRUCTOR_TYPE nType
 nType is a unique integer assigned to each type of matrix node More...
 
unsigned int inumberOfChildren
 inumberOfChildren is the number of MatrixNode child elements For the matrix types (OSMatrix and MatrixBlock) this number is not fixed and is temporarily set to 0 More...
 
MatrixNode ** m_mChildren
 m_mChildren holds all the children, that is, nodes used in the definition or construction of the current node. More...
 

Detailed Description

a generic class from which we derive matrix constructors (BaseMatrix, MatrixElements, MatrixTransformation and MatrixBlocks) as well as matrix types (OSMatrix and MatrixBlock).

Definition at line 50 of file OSMatrix.h.

Constructor & Destructor Documentation

MatrixNode::MatrixNode ( )

default constructor

virtual MatrixNode::~MatrixNode ( )
virtual

destructor

Member Function Documentation

virtual ENUM_MATRIX_CONSTRUCTOR_TYPE MatrixNode::getNodeType ( )
virtual
Returns
the value of nType

Reimplemented in MatrixBlock, OSMatrix, BaseMatrix, MatrixBlocks, MatrixTransformation, and MatrixElements.

virtual std::string MatrixNode::getNodeName ( )
pure virtual
Returns
the name of the matrix constructor

Implemented in MatrixBlock, OSMatrix, BaseMatrix, MatrixBlocks, MatrixTransformation, and MatrixElements.

virtual std::string MatrixNode::getMatrixNodeInXML ( )
pure virtual

The following method writes a matrix node in OSgL format. it is used by OSgLWriter to write a <matrix> element.

Returns
the MatrixNode and its children as an OSgL string.

Implemented in MatrixBlock, OSMatrix, BaseMatrix, MatrixBlocks, MatrixTransformation, and MatrixElements.

std::vector<MatrixNode*> MatrixNode::getPrefixFromNodeTree ( )

Get a vector of pointers to OSnLNodes and OSnLMNodes that correspond to the MatrixNode tree in prefix format.

Returns
the node tree as a vector of MatrixNodes in prefix.
std::vector<MatrixNode*> MatrixNode::preOrderMatrixNodeTraversal ( std::vector< MatrixNode * > *  prefixVector)
std::vector<MatrixNode*> MatrixNode::getPostfixFromNodeTree ( )

Get a vector of pointers to MatrixNodes that correspond to the MatrixNode tree in postfix format

Returns
the node tree as a vector of MatrixNodes in postfix.
std::vector<MatrixNode*> MatrixNode::postOrderMatrixNodeTraversal ( std::vector< MatrixNode * > *  postfixVector)

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

Parameters
apointer postfixVector to a vector of pointers of MatrixNodes
Returns
a vector of pointers to MatrixNodes in postfix.
virtual MatrixNode* MatrixNode::cloneMatrixNode ( )
pure 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.

Implemented in MatrixBlock, OSMatrix, BaseMatrix, MatrixBlocks, MatrixTransformation, and MatrixElements.

virtual bool MatrixNode::IsEqual ( MatrixNode that)
virtual

A function to check for the equality of two objects.

bool MatrixNode::setRandom ( double  density,
bool  conformant,
int  iMin,
int  iMax 
)

A function to make a random instance of this class.

Parameters
density,:corresponds to the probability that a particular child element is created
conformant,:if true enforces side constraints not enforceable in the schema (e.g., agreement of "numberOfXXX" attributes and <XXX> children)
iMin,:lowest index value (inclusive) that a variable reference in this matrix can take
iMax,:greatest index value (inclusive) that a variable reference in this matrix can take
bool MatrixNode::deepCopyFrom ( MatrixNode that)

A function to make a deep copy of an instance of this class.

Parameters
that,:the instance from which information is to be copied
Returns
whether the copy was created successfully

Member Data Documentation

ENUM_MATRIX_TYPE MatrixNode::matrixType

matrixType tracks the type of elements contained in this MatrixNode, which may be useful in solver selection

Definition at line 57 of file OSMatrix.h.

ENUM_MATRIX_CONSTRUCTOR_TYPE MatrixNode::nType

nType is a unique integer assigned to each type of matrix node

Definition at line 62 of file OSMatrix.h.

unsigned int MatrixNode::inumberOfChildren

inumberOfChildren is the number of MatrixNode child elements For the matrix types (OSMatrix and MatrixBlock) this number is not fixed and is temporarily set to 0

Definition at line 68 of file OSMatrix.h.

MatrixNode** MatrixNode::m_mChildren

m_mChildren holds all the children, that is, nodes used in the definition or construction of the current node.

Definition at line 74 of file OSMatrix.h.


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