a data structure to represent the nonzeroes of a matrix by transformation from other (previously defined) matrices More...

#include <OSMatrix.h>

Inheritance diagram for MatrixTransformation:

[legend]

Collaboration diagram for MatrixTransformation:

[legend]

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

	~MatrixTransformation ()

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

virtual MatrixTransformation *	cloneMatrixNode ()
	The implementation of the virtual functions. More...

bool	IsEqual (MatrixTransformation *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 (MatrixTransformation *that)
	A function to make a deep copy of an instance of this class. 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
OSnLMNode *	transformation
	A transformation is essentially an expression tree that evaluates to a matrix. More...

ENUM_NL_EXPR_SHAPE	shape
	shape can be used to specify linearity etc. 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 nonzeroes of a matrix by transformation from other (previously defined) matrices

Definition at line 1358 of file OSMatrix.h.

Constructor & Destructor Documentation

MatrixTransformation::MatrixTransformation ( )

-------— Methods for class MatrixTransformation -------—

Definition at line 4034 of file OSMatrix.cpp.

MatrixTransformation::~MatrixTransformation ( )

Definition at line 4044 of file OSMatrix.cpp.

Member Function Documentation

ENUM_MATRIX_CONSTRUCTOR_TYPE MatrixTransformation::getNodeType ( )

virtual

Returns: the value of nType

Reimplemented from MatrixNode.

Definition at line 4054 of file OSMatrix.cpp.

std::string MatrixTransformation::getNodeName ( )

virtual

Returns: the name of the operator

Implements MatrixNode.

Definition at line 4059 of file OSMatrix.cpp.

ENUM_MATRIX_TYPE MatrixTransformation::getMatrixType ( )

virtual

Returns: the type of the matrix elements

Implements MatrixNode.

Definition at line 4064 of file OSMatrix.cpp.

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

bool MatrixTransformation::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 4085 of file OSMatrix.cpp.

MatrixTransformation * MatrixTransformation::cloneMatrixNode ( )

virtual

The implementation of the virtual functions.

Returns: a pointer to a new MatrixNode of the proper type.

Implements MatrixNode.

Definition at line 4090 of file OSMatrix.cpp.

bool MatrixTransformation::IsEqual ( MatrixTransformation * that )

A function to check for the equality of two objects.

Definition at line 4097 of file OSMatrix.cpp.

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

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

OSnLMNode* MatrixTransformation::transformation

A transformation is essentially an expression tree that evaluates to a matrix.

Definition at line 1364 of file OSMatrix.h.

ENUM_NL_EXPR_SHAPE MatrixTransformation::shape

shape can be used to specify linearity etc.

of an expression For possible values, see OSParamaters.h

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