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

#include <OSMatrix.h>

Collaboration diagram for GeneralMatrixElements:

Public Member Functions
	GeneralMatrixElements ()

	~GeneralMatrixElements ()

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 Attributes
int	numberOfValues
	numberOfValues records the number of entries in the arrays that make up the instance of nonzeros More...

bool	rowMajor
	To indicate whether the general matrix elements are stored in row major form or column major form. More...

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

IntVector *	indexes
	The indexes of the (nonzero) linear matrix elements row or column indexes, depending on rowMajor. More...

GeneralMatrixValues *	values
	The values are general nonlinear expressions. More...

Detailed Description

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

Definition at line 601 of file OSMatrix.h.

Constructor & Destructor Documentation

GeneralMatrixElements::GeneralMatrixElements ( )

GeneralMatrixElements::~GeneralMatrixElements ( )

bool GeneralMatrixElements::IsEqual ( GeneralMatrixElements * that )

A function to check for the equality of two objects.

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

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

int GeneralMatrixElements::numberOfValues

numberOfValues records the number of entries in the arrays that make up the instance of nonzeros

Definition at line 608 of file OSMatrix.h.

bool GeneralMatrixElements::rowMajor

To indicate whether the general matrix elements are stored in row major form or column major form.

Definition at line 614 of file OSMatrix.h.

IntVector* GeneralMatrixElements::start

A vector listing the row or column starts.

Definition at line 619 of file OSMatrix.h.

IntVector* GeneralMatrixElements::indexes

The indexes of the (nonzero) linear matrix elements row or column indexes, depending on rowMajor.

Definition at line 624 of file OSMatrix.h.

GeneralMatrixValues* GeneralMatrixElements::values

The values are general nonlinear expressions.

Definition at line 629 of file OSMatrix.h.

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