MatrixBlocks Class Reference

a data structure to represent the nonzeroes of a matrix in a blockwise fashion. Each block can be given elementwise, through transformation, or by nested blocks, and so on, recursively. More...

#include <OSMatrix.h>

Inheritance diagram for MatrixBlocks:

[legend]

Collaboration diagram for MatrixBlocks:

[legend]

List of all members.

Public Member Functions
	MatrixBlocks ()
	---------- Methods for class MatrixBlocks ----------
	~MatrixBlocks ()
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 MatrixBlocks *	cloneMatrixNode ()
	The implementation of the virtual functions.
bool	IsEqual (MatrixBlocks *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 (MatrixBlocks *that)
	A function to make a deep copy of an instance of this class.
Public Attributes
IntVector *	colOffset
	An array listing the leftmost column of each block within the larger matrix It is assumed that the blocks are neatly "stacked".
IntVector *	rowOffset
	An array listing the top row of each block within the larger matrix.

---

Detailed Description

a data structure to represent the nonzeroes of a matrix in a blockwise fashion. Each block can be given elementwise, through transformation, or by nested blocks, and so on, recursively.

Definition at line 1449 of file OSMatrix.h.

---

Constructor & Destructor Documentation

MatrixBlocks::MatrixBlocks

(

)

---------- Methods for class MatrixBlocks ----------

Definition at line 6120 of file OSMatrix.cpp.

MatrixBlocks::~MatrixBlocks

(

)

Definition at line 6130 of file OSMatrix.cpp.

---

Member Function Documentation

ENUM_MATRIX_CONSTRUCTOR_TYPE MatrixBlocks::getNodeType

(

)

[virtual]

Returns:

the value of nType

Reimplemented from MatrixNode.

Definition at line 6186 of file OSMatrix.cpp.

std::string MatrixBlocks::getNodeName

(

)

[virtual]

Returns:

the name of the operator

Implements MatrixNode.

Definition at line 6191 of file OSMatrix.cpp.

ENUM_MATRIX_TYPE MatrixBlocks::getMatrixType

(

)

[virtual]

Returns:

the type of the matrix elements

Implements MatrixNode.

Definition at line 6196 of file OSMatrix.cpp.

std::string MatrixBlocks::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 6207 of file OSMatrix.cpp.

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

Implements MatrixNode.

Definition at line 6225 of file OSMatrix.cpp.

MatrixBlocks * MatrixBlocks::cloneMatrixNode

(

)

[virtual]

The implementation of the virtual functions.

Returns:

a pointer to a new MatrixNode of the proper type.

Implements MatrixNode.

Definition at line 6246 of file OSMatrix.cpp.

bool MatrixBlocks::IsEqual

(

MatrixBlocks *

that

)

[virtual]

A function to check for the equality of two objects.

Reimplemented from MatrixNode.

Definition at line 6253 of file OSMatrix.cpp.

bool MatrixBlocks::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.

bool MatrixBlocks::deepCopyFrom

(

MatrixBlocks *

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.

---

Member Data Documentation

IntVector* MatrixBlocks::colOffset

An array listing the leftmost column of each block within the larger matrix It is assumed that the blocks are neatly "stacked".

Definition at line 1456 of file OSMatrix.h.

IntVector* MatrixBlocks::rowOffset

An array listing the top row of each block within the larger matrix.

Definition at line 1461 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