My Project
LinearMatrixElements Class Reference

a data structure to represent the nonzero values in a linearMatrix element More...

#include <OSMatrix.h>

Inheritance diagram for LinearMatrixElements:
MatrixElements MatrixConstructor MatrixNode

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 LinearMatrixElementscloneMatrixNode ()
 
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 Member Functions inherited from MatrixElements
 MatrixElements ()
 -------— Methods for class MatrixElements -------—
 
virtual ~MatrixElements ()
 
bool getRowMajor ()
 Returns whether the matrix is stored row-wise or column-wise.
 
bool IsEqual (MatrixElements *that)
 A function to check for the equality of two objects.
 
- Public Member Functions inherited from MatrixConstructor
 MatrixConstructor ()
 constructor
 
virtual ~MatrixConstructor ()
 destructor
 
- Public Member Functions inherited from MatrixNode
 MatrixNode ()
 default constructor
 
virtual ~MatrixNode ()
 destructor
 
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 bool IsEqual (MatrixNode *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 (MatrixNode *that)
 A function to make a deep copy of an instance of this class.
 

Public Attributes

LinearMatrixValuesvalue
 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.
 
- Public Attributes inherited from MatrixElements
bool rowMajor
 To indicate whether the matrix elements are stored in row major form or column major form.
 
int numberOfValues
 numberOfValues records the number of entries in the arrays that make up the instance of nonzeros
 
IntVectorstart
 A vector listing the row or column starts.
 
IntVectorindex
 The index array of the (nonzero) elements.
 
- 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
 
ENUM_MATRIX_CONSTRUCTOR_TYPE nType
 nType is a unique integer assigned to each type of matrix node (see OSParameters.h)
 
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
 
MatrixNode ** m_mChildren
 m_mChildren holds all the children, that is, nodes used in the definition or construction of the current node.
 

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::LinearMatrixElements ( )

-------— Methods for class LinearMatrixElements -------—

Definition at line 4601 of file OSMatrix.cpp.

◆ ~LinearMatrixElements()

LinearMatrixElements::~LinearMatrixElements ( )

Definition at line 4609 of file OSMatrix.cpp.

Member Function Documentation

◆ getNodeType()

ENUM_MATRIX_CONSTRUCTOR_TYPE LinearMatrixElements::getNodeType ( )
virtual
Returns
the value of nType

Reimplemented from MatrixNode.

Definition at line 4627 of file OSMatrix.cpp.

◆ getMatrixType()

ENUM_MATRIX_TYPE LinearMatrixElements::getMatrixType ( )
virtual
Returns
the type of the matrix elements

Implements MatrixNode.

Definition at line 4637 of file OSMatrix.cpp.

◆ getNodeName()

std::string LinearMatrixElements::getNodeName ( )
virtual
Returns
the name of the matrix constructor

Implements MatrixNode.

Definition at line 4632 of file OSMatrix.cpp.

◆ getMatrixNodeInXML()

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 4644 of file OSMatrix.cpp.

◆ alignsOnBlockBoundary()

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
firstRowgives the number of the first row in the submatrix (zero-based)
firstColumngives the number of the first column in the submatrix (zero-based)
nRowsgives the number of rows in the submatrix
nColumnsgives 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 4692 of file OSMatrix.cpp.

◆ cloneMatrixNode()

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 4697 of file OSMatrix.cpp.

◆ IsEqual()

bool LinearMatrixElements::IsEqual ( LinearMatrixElements * that)

A function to check for the equality of two objects.

Definition at line 4704 of file OSMatrix.cpp.

◆ setRandom()

bool LinearMatrixElements::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

Definition at line 4746 of file OSMatrix.cpp.

◆ deepCopyFrom()

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

Definition at line 4751 of file OSMatrix.cpp.

Member Data Documentation

◆ value

LinearMatrixValues* LinearMatrixElements::value

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: