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

a data structure to describe one step in the construction of a matrix. More...

#include <OSMatrix.h>

+ Inheritance diagram for MatrixConstructor:
+ Collaboration diagram for MatrixConstructor:

Public Member Functions

 MatrixConstructor ()
 constructor More...
 
 ~MatrixConstructor ()
 destructor More...
 
bool IsEqual (MatrixConstructor *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 (MatrixConstructor *that)
 A function to make a deep copy of an instance of this class. More...
 
- Public Member Functions inherited from MatrixNode
 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...
 

Additional Inherited Members

- Public Attributes inherited from MatrixNode
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 data structure to describe one step in the construction of a matrix.

To facilitate parsing of complicated matrix constructors and the recursion implicit in the block structure, we distinguish the following six types: 1 - BaseMatrix 2 - Elements 3 - Transformation 4 - MatrixBlocks 5 - MatrixBlock 6 - OSMatrix Most of the logic of this representation is derived from the OSnLNode class.

Definition at line 189 of file OSMatrix.h.

Constructor & Destructor Documentation

MatrixConstructor::MatrixConstructor ( )

constructor

MatrixConstructor::~MatrixConstructor ( )

destructor

Member Function Documentation

bool MatrixConstructor::IsEqual ( MatrixConstructor that)

A function to check for the equality of two objects.

bool MatrixConstructor::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 MatrixConstructor::deepCopyFrom ( MatrixConstructor 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

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