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

#include <OSMatrix.h>

Inheritance diagram for GeneralMatrixElements:

Collaboration diagram for GeneralMatrixElements:

Public Member Functions
	GeneralMatrixElements ()
	-------— Methods for class GeneralMatrixElements -------— More...

	~GeneralMatrixElements ()

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. More...

virtual GeneralMatrixElements *	cloneMatrixNode ()

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

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

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. 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
GeneralMatrixValues *	value
	The values are general nonlinear expressions. More...

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

a data structure to represent the nonzero values in a generalMatrix element

Definition at line 1005 of file OSMatrix.h.

Constructor & Destructor Documentation

GeneralMatrixElements::GeneralMatrixElements ( )

-------— Methods for class GeneralMatrixElements -------—

Definition at line 5046 of file OSMatrix.cpp.

GeneralMatrixElements::~GeneralMatrixElements ( )

Definition at line 5054 of file OSMatrix.cpp.

Member Function Documentation

ENUM_MATRIX_CONSTRUCTOR_TYPE GeneralMatrixElements::getNodeType ( )

virtual

Returns: the value of nType

Reimplemented from MatrixNode.

Definition at line 5072 of file OSMatrix.cpp.

ENUM_MATRIX_TYPE GeneralMatrixElements::getMatrixType ( )

virtual

Returns: the type of the matrix elements

Implements MatrixNode.

Definition at line 5082 of file OSMatrix.cpp.

std::string GeneralMatrixElements::getNodeName ( )

virtual

Returns: the name of the matrix constructor

Implements MatrixNode.

Definition at line 5077 of file OSMatrix.cpp.

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

bool GeneralMatrixElements::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 5122 of file OSMatrix.cpp.

GeneralMatrixElements * GeneralMatrixElements::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 5127 of file OSMatrix.cpp.

bool GeneralMatrixElements::IsEqual ( GeneralMatrixElements * that )

A function to check for the equality of two objects.

Definition at line 5134 of file OSMatrix.cpp.

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

Definition at line 5176 of file OSMatrix.cpp.

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

Definition at line 5181 of file OSMatrix.cpp.

Member Data Documentation

GeneralMatrixValues* GeneralMatrixElements::value

The values are general nonlinear expressions.

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

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation