ObjReferenceMatrixElements Class Reference

a data structure to represent objective reference elements in a MatrixType object Each nonzero element is of the form x_{k} where k is the index of an objective (i.e., less than zero) More...

#include <OSMatrix.h>

Inheritance diagram for ObjReferenceMatrixElements:

[legend]

Collaboration diagram for ObjReferenceMatrixElements:

[legend]

List of all members.

Public Member Functions
	ObjReferenceMatrixElements ()
	---------- Methods for class ObjReferenceMatrixElements ----------
	~ObjReferenceMatrixElements ()
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 ObjReferenceMatrixElements *	cloneMatrixNode ()
bool	IsEqual (ObjReferenceMatrixElements *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 (ObjReferenceMatrixElements *that)
	A function to make a deep copy of an instance of this class.
Public Attributes
ObjReferenceMatrixValues *	value
	The objective references (indexes of core objectives) of the elements.

Detailed Description

a data structure to represent objective reference elements in a MatrixType object Each nonzero element is of the form x_{k} where k is the index of an objective (i.e., less than zero)

Definition at line 1091 of file OSMatrix.h.

Constructor & Destructor Documentation

ObjReferenceMatrixElements::ObjReferenceMatrixElements ( )

---------- Methods for class ObjReferenceMatrixElements ----------

Definition at line 5289 of file OSMatrix.cpp.

ObjReferenceMatrixElements::~ObjReferenceMatrixElements ( )

Definition at line 5297 of file OSMatrix.cpp.

Member Function Documentation

ENUM_MATRIX_CONSTRUCTOR_TYPE ObjReferenceMatrixElements::getNodeType ( ) [virtual]

Returns:: the value of nType

Reimplemented from MatrixNode.

Definition at line 5315 of file OSMatrix.cpp.

ENUM_MATRIX_TYPE ObjReferenceMatrixElements::getMatrixType ( ) [virtual]

Returns:: the type of the matrix elements

Implements MatrixNode.

Definition at line 5325 of file OSMatrix.cpp.

std::string ObjReferenceMatrixElements::getNodeName ( ) [virtual]

Returns:: the name of the matrix constructor

Implements MatrixNode.

Definition at line 5320 of file OSMatrix.cpp.

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

bool ObjReferenceMatrixElements::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 5374 of file OSMatrix.cpp.

ObjReferenceMatrixElements * ObjReferenceMatrixElements::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 5379 of file OSMatrix.cpp.

bool ObjReferenceMatrixElements::IsEqual ( ObjReferenceMatrixElements * that ) [virtual]

A function to check for the equality of two objects.

Reimplemented from MatrixElements.

Definition at line 5386 of file OSMatrix.cpp.

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

Definition at line 5428 of file OSMatrix.cpp.

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

Definition at line 5433 of file OSMatrix.cpp.

Member Data Documentation

ObjReferenceMatrixValues* ObjReferenceMatrixElements::value

The objective references (indexes of core objectives) of the elements.

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

ObjReferenceMatrixElements Class Reference

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation