a data structure to represent the constant elements in a MatrixType object More...

#include <OSMatrix.h>

Inheritance diagram for ConstantMatrixElements:

Collaboration diagram for ConstantMatrixElements:

Public Member Functions
	ConstantMatrixElements ()

	~ConstantMatrixElements ()

virtual ENUM_MATRIX_CONSTRUCTOR_TYPE	getNodeType ()

virtual std::string	getNodeName ()

virtual ENUM_MATRIX_TYPE	getMatrixType ()

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 ConstantMatrixElements *	cloneMatrixNode ()

bool	IsEqual (ConstantMatrixElements *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 (ConstantMatrixElements *that)
	A function to make a deep copy of an instance of this class.

Public Member Functions inherited from MatrixElements
	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

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.

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
ConstantMatrixValues *	value
	The value array of the (nonzero) constant elements.

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

IntVector *	start
	A vector listing the row or column starts.

IntVector *	index
	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 constant elements in a MatrixType object

Definition at line 749 of file OSMatrix.h.

Constructor & Destructor Documentation

◆ ConstantMatrixElements()

ConstantMatrixElements::ConstantMatrixElements ( )

◆ ~ConstantMatrixElements()

ConstantMatrixElements::~ConstantMatrixElements ( )

Member Function Documentation

◆ getNodeType()

virtual ENUM_MATRIX_CONSTRUCTOR_TYPE ConstantMatrixElements::getNodeType ( )

virtual

Returns: the value of nType

Reimplemented from MatrixNode.

◆ getNodeName()

virtual std::string ConstantMatrixElements::getNodeName ( )

virtual

Returns: the name of the matrix constructor

Implements MatrixNode.

◆ getMatrixType()

virtual ENUM_MATRIX_TYPE ConstantMatrixElements::getMatrixType ( )

virtual

Returns: the type of the matrix elements

Implements MatrixNode.

◆ getMatrixNodeInXML()

virtual std::string ConstantMatrixElements::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.

◆ alignsOnBlockBoundary()

virtual bool ConstantMatrixElements::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.

◆ cloneMatrixNode()

virtual ConstantMatrixElements * ConstantMatrixElements::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.

◆ IsEqual()

bool ConstantMatrixElements::IsEqual ( ConstantMatrixElements * that )

A function to check for the equality of two objects.

◆ setRandom()

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

Member Data Documentation

◆ value

ConstantMatrixValues* ConstantMatrixElements::value

The value array of the (nonzero) constant elements.

Definition at line 753 of file OSMatrix.h.

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

/builddir/build/BUILD/OS-2.10.2/src/OSCommonInterfaces/OSMatrix.h

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ConstantMatrixElements()

◆ ~ConstantMatrixElements()

Member Function Documentation

◆ getNodeType()

◆ getNodeName()

◆ getMatrixType()

◆ getMatrixNodeInXML()

◆ alignsOnBlockBoundary()

◆ cloneMatrixNode()

◆ IsEqual()

◆ setRandom()

◆ deepCopyFrom()

Member Data Documentation

◆ value