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>
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.
§ MatrixNode()
MatrixNode::MatrixNode |
( |
| ) |
|
§ ~MatrixNode()
virtual MatrixNode::~MatrixNode |
( |
| ) |
|
|
virtual |
§ getNodeType()
- Returns
- the value of nType
Reimplemented in MatrixBlock, OSMatrix, BaseMatrix, MatrixBlocks, MatrixTransformation, MixedRowReferenceMatrixElements, ConReferenceMatrixElements, ObjReferenceMatrixElements, GeneralMatrixElements, LinearMatrixElements, VarReferenceMatrixElements, and ConstantMatrixElements.
§ getMatrixType()
- Returns
- the type of the matrix elements
Implemented in MatrixBlock, OSMatrix, BaseMatrix, MatrixBlocks, MatrixTransformation, MixedRowReferenceMatrixElements, ConReferenceMatrixElements, ObjReferenceMatrixElements, GeneralMatrixElements, LinearMatrixElements, VarReferenceMatrixElements, and ConstantMatrixElements.
§ getNodeName()
virtual std::string MatrixNode::getNodeName |
( |
| ) |
|
|
pure virtual |
- Returns
- the name of the matrix constructor
Implemented in MatrixBlock, OSMatrix, BaseMatrix, MatrixBlocks, MatrixTransformation, MixedRowReferenceMatrixElements, ConReferenceMatrixElements, ObjReferenceMatrixElements, GeneralMatrixElements, LinearMatrixElements, VarReferenceMatrixElements, and ConstantMatrixElements.
§ getMatrixNodeInXML()
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, OSMatrixWithMatrixConIdx, OSMatrixWithMatrixObjIdx, OSMatrixWithMatrixVarIdx, OSMatrix, BaseMatrix, MatrixBlocks, MatrixTransformation, MixedRowReferenceMatrixElements, ConReferenceMatrixElements, ObjReferenceMatrixElements, GeneralMatrixElements, LinearMatrixElements, VarReferenceMatrixElements, and ConstantMatrixElements.
§ getPrefixFromNodeTree()
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.
§ preOrderMatrixNodeTraversal()
std::vector<MatrixNode*> MatrixNode::preOrderMatrixNodeTraversal |
( |
std::vector< MatrixNode *> * |
prefixVector | ) |
|
§ getPostfixFromNodeTree()
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.
§ postOrderMatrixNodeTraversal()
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
-
a | pointer postfixVector to a vector of pointers of MatrixNodes |
- Returns
- a vector of pointers to MatrixNodes in postfix.
§ cloneMatrixNode()
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, OSMatrixWithMatrixConIdx, OSMatrixWithMatrixObjIdx, OSMatrixWithMatrixVarIdx, OSMatrix, BaseMatrix, MatrixBlocks, MatrixTransformation, MixedRowReferenceMatrixElements, ConReferenceMatrixElements, ObjReferenceMatrixElements, GeneralMatrixElements, LinearMatrixElements, VarReferenceMatrixElements, and ConstantMatrixElements.
§ alignsOnBlockBoundary()
virtual bool MatrixNode::alignsOnBlockBoundary |
( |
int |
firstRow, |
|
|
int |
firstColumn, |
|
|
int |
nRows, |
|
|
int |
nCols |
|
) |
| |
|
pure virtual |
Check whether a submatrix aligns with the block partition of a matrix or block or other constructor.
- Parameters
-
firstRow | gives the number of the first row in the submatrix (zero-based) |
firstColumn | gives the number of the first column in the submatrix (zero-based) |
nRows | gives the number of rows in the submatrix |
nColumns | gives the number of columns in the submatrix |
- Returns
- true if the submatrix aligns with the boundaries of a block 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, MatrixType, BaseMatrix, MatrixBlocks, MatrixTransformation, MixedRowReferenceMatrixElements, ConReferenceMatrixElements, ObjReferenceMatrixElements, GeneralMatrixElements, LinearMatrixElements, VarReferenceMatrixElements, and ConstantMatrixElements.
§ IsEqual()
virtual bool MatrixNode::IsEqual |
( |
MatrixNode * |
that | ) |
|
|
virtual |
A function to check for the equality of two objects.
§ setRandom()
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 |
§ deepCopyFrom()
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
§ matrixType
matrixType tracks the type of elements contained in this MatrixNode, which may be useful in solver selection For an enumeration of the possible types see OSParameters.h
Definition at line 58 of file OSMatrix.h.
§ nType
§ inumberOfChildren
unsigned int MatrixNode::inumberOfChildren |
§ m_mChildren
m_mChildren holds all the children, that is, nodes used in the definition or construction of the current node.
Definition at line 76 of file OSMatrix.h.
The documentation for this class was generated from the following file:
- /builddir/build/BUILD/OS-2.10.1/src/OSCommonInterfaces/OSMatrix.h