an abstract class to help represent the elements in a MatrixType object From this we derive concrete classes that are used to store specific types of values, such as constant values, variable references, general nonlinear expressions, etc. More...
#include <OSMatrix.h>
Public Member Functions | |
| MatrixElements () | |
| -------— Methods for class MatrixElements -------— More... | |
| virtual | ~MatrixElements () |
| bool | getRowMajor () |
| Returns whether the matrix is stored row-wise or column-wise. More... | |
| bool | IsEqual (MatrixElements *that) |
| A function to check for the equality of two objects. More... | |
 Public Member Functions inherited from MatrixConstructor | |
| MatrixConstructor () | |
| constructor More... | |
| virtual | ~MatrixConstructor () |
| destructor More... | |
| Public Member Functions inherited from MatrixNode | |
| MatrixNode () | |
| default constructor More... | |
| virtual | ~MatrixNode () |
| destructor More... | |
| virtual ENUM_MATRIX_CONSTRUCTOR_TYPE | getNodeType () |
| virtual ENUM_MATRIX_TYPE | getMatrixType ()=0 |
| 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 MatrixNode * | cloneMatrixNode ()=0 |
| virtual bool | alignsOnBlockBoundary (int firstRow, int firstColumn, int nRows, int nCols)=0 |
| Check whether a submatrix aligns with the block partition of a matrix or block or other constructor. More... | |
| 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 | |
| bool | rowMajor |
| To indicate whether the matrix elements are stored in row major form or column major form. More... | |
| int | numberOfValues |
| numberOfValues records the number of entries in the arrays that make up the instance of nonzeros More... | |
| IntVector * | start |
| A vector listing the row or column starts. More... | |
| IntVector * | index |
| The index array of the (nonzero) elements. More... | |
| 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 For an enumeration of the possible types see OSParameters.h More... | |
| ENUM_MATRIX_CONSTRUCTOR_TYPE | nType |
| nType is a unique integer assigned to each type of matrix node (see OSParameters.h) 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
an abstract class to help represent the elements in a MatrixType object From this we derive concrete classes that are used to store specific types of values, such as constant values, variable references, general nonlinear expressions, etc.
Definition at line 248 of file OSMatrix.h.
Constructor & Destructor Documentation
| MatrixElements::MatrixElements | ( | ) |
-------— Methods for class MatrixElements -------—
Definition at line 2838 of file OSMatrix.cpp.
|
virtual |
Definition at line 2849 of file OSMatrix.cpp.
Member Function Documentation
| bool MatrixElements::getRowMajor | ( | ) |
Returns whether the matrix is stored row-wise or column-wise.
Definition at line 2880 of file OSMatrix.cpp.
| bool MatrixElements::IsEqual | ( | MatrixElements * | that | ) |
A function to check for the equality of two objects.
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.
Definition at line 2897 of file OSMatrix.cpp.
Member Data Documentation
| bool MatrixElements::rowMajor |
To indicate whether the matrix elements are stored in row major form or column major form.
Definition at line 255 of file OSMatrix.h.
| int MatrixElements::numberOfValues |
numberOfValues records the number of entries in the arrays that make up the instance of nonzeros
Definition at line 261 of file OSMatrix.h.
| IntVector* MatrixElements::start |
A vector listing the row or column starts.
Definition at line 266 of file OSMatrix.h.
| IntVector* MatrixElements::index |
The index array of the (nonzero) elements.
Definition at line 269 of file OSMatrix.h.
The documentation for this class was generated from the following files:
- /tmp/OS-2.10.2/OS/src/OSCommonInterfaces/OSMatrix.h
- /tmp/OS-2.10.2/OS/src/OSCommonInterfaces/OSMatrix.cpp
