OS  2.9.3
Public Member Functions | Public Attributes | List of all members
MatrixType Class Reference

a data structure to represent a MatrixType object (from which we derive OSMatrix and MatrixBlock) More...

#include <OSMatrix.h>

+ Inheritance diagram for MatrixType:
+ Collaboration diagram for MatrixType:

Public Member Functions

 MatrixType ()
 
 ~MatrixType ()
 
bool IsEqual (MatrixType *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 (MatrixType *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...
 

Public Attributes

int numberOfRows
 
int numberOfColumns
 
ENUM_MATRIX_SYMMETRY symmetry
 
- 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 represent a MatrixType object (from which we derive OSMatrix and MatrixBlock)

Definition at line 1094 of file OSMatrix.h.

Constructor & Destructor Documentation

MatrixType::MatrixType ( )
MatrixType::~MatrixType ( )

Member Function Documentation

bool MatrixType::IsEqual ( MatrixType that)

A function to check for the equality of two objects.

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

A function to make a random instance of this class.

Parameters
densitycorresponds to the probability that a particular child element is created
conformantif true enforces side constraints not enforceable in the schema (e.g., agreement of "numberOfXXX" attributes and <XXX> children)
iMinlowest index value (inclusive) that a variable reference in this matrix can take
iMaxgreatest index value (inclusive) that a variable reference in this matrix can take
bool MatrixType::deepCopyFrom ( MatrixType that)

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

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

Member Data Documentation

int MatrixType::numberOfRows

Definition at line 1097 of file OSMatrix.h.

int MatrixType::numberOfColumns

Definition at line 1098 of file OSMatrix.h.

ENUM_MATRIX_SYMMETRY MatrixType::symmetry

Definition at line 1099 of file OSMatrix.h.


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