LinearMatrixElements Class Reference
a data structure to represent the nonzero values in a linearMatrix element More...
#include <OSMatrix.h>
Public Member Functions | |
| LinearMatrixElements () | |
| ---------- Methods for class LinearMatrixElements ---------- | |
| ~LinearMatrixElements () | |
| virtual ENUM_MATRIX_CONSTRUCTOR_TYPE | getNodeType () |
| virtual ENUM_MATRIX_TYPE | getMatrixType () |
| virtual std::string | getNodeName () |
| virtual std::string | getMatrixNodeInXML () |
| virtual bool | alignsOnBlockBoundary (int firstRow, int firstColumn, int nRows, int nCols) |
| Check whether a submatrix aligns with the block partition of a matrix or block or other constructor. | |
| virtual LinearMatrixElements * | cloneMatrixNode () |
| bool | IsEqual (LinearMatrixElements *that) |
| A function to check for the equality of two objects. | |
| bool | setRandom (double density, bool conformant, int iMin, int iMax) |
| A function to make a random instance of this class. | |
| bool | deepCopyFrom (LinearMatrixElements *that) |
| A function to make a deep copy of an instance of this class. | |
Public Attributes | |
| LinearMatrixValues * | value |
| The values are expressions of the form a_0 + a_1 x_{i_1} * a_2 x_{i_2} + . | |
Detailed Description
a data structure to represent the nonzero values in a linearMatrix element
Definition at line 917 of file OSMatrix.h.
Constructor & Destructor Documentation
| LinearMatrixElements::LinearMatrixElements | ( | ) |
---------- Methods for class LinearMatrixElements ----------
Definition at line 4604 of file OSMatrix.cpp.
| LinearMatrixElements::~LinearMatrixElements | ( | ) |
Definition at line 4612 of file OSMatrix.cpp.
Member Function Documentation
| ENUM_MATRIX_CONSTRUCTOR_TYPE LinearMatrixElements::getNodeType | ( | ) | [virtual] |
- Returns:
- the value of nType
Reimplemented from MatrixNode.
Definition at line 4630 of file OSMatrix.cpp.
| ENUM_MATRIX_TYPE LinearMatrixElements::getMatrixType | ( | ) | [virtual] |
- Returns:
- the type of the matrix elements
Implements MatrixNode.
Definition at line 4640 of file OSMatrix.cpp.
| std::string LinearMatrixElements::getNodeName | ( | ) | [virtual] |
- Returns:
- the name of the matrix constructor
Implements MatrixNode.
Definition at line 4635 of file OSMatrix.cpp.
| std::string LinearMatrixElements::getMatrixNodeInXML | ( | ) | [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.
Implements MatrixNode.
Definition at line 4647 of file OSMatrix.cpp.
| bool LinearMatrixElements::alignsOnBlockBoundary | ( | int | firstRow, | |
| int | firstColumn, | |||
| int | nRows, | |||
| int | nCols | |||
| ) | [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.
Implements MatrixNode.
Definition at line 4695 of file OSMatrix.cpp.
| LinearMatrixElements * LinearMatrixElements::cloneMatrixNode | ( | ) | [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.
Implements MatrixNode.
Definition at line 4700 of file OSMatrix.cpp.
| bool LinearMatrixElements::IsEqual | ( | LinearMatrixElements * | that | ) | [virtual] |
A function to check for the equality of two objects.
Reimplemented from MatrixElements.
Definition at line 4707 of file OSMatrix.cpp.
| bool LinearMatrixElements::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
Reimplemented from MatrixNode.
Definition at line 4749 of file OSMatrix.cpp.
| bool LinearMatrixElements::deepCopyFrom | ( | LinearMatrixElements * | 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
Reimplemented from MatrixNode.
Definition at line 4754 of file OSMatrix.cpp.
Member Data Documentation
The values are expressions of the form a_0 + a_1 x_{i_1} * a_2 x_{i_2} + .
.. Each term in this sum is stored as a separate LinearMatrixValues object
Definition at line 925 of file OSMatrix.h.
The documentation for this class was generated from the following files:
- /home/coin/svn-release/OS-2.10.0/OS/src/OSCommonInterfaces/OSMatrix.h
- /home/coin/svn-release/OS-2.10.0/OS/src/OSCommonInterfaces/OSMatrix.cpp
