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>

Collaboration diagram for ObjReferenceMatrixElements:

Public Member Functions
	ObjReferenceMatrixElements ()
	~ObjReferenceMatrixElements ()
bool	IsEqual (ObjReferenceMatrixElements *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 (ObjReferenceMatrixElements *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 objReference 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 row (or column) indices and objective references of the elements. More...
IntVector *	values

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 662 of file OSMatrix.h.

Constructor & Destructor Documentation

ObjReferenceMatrixElements::ObjReferenceMatrixElements

(

)

ObjReferenceMatrixElements::~ObjReferenceMatrixElements

(

)

Member Function Documentation

bool ObjReferenceMatrixElements::IsEqual

(

ObjReferenceMatrixElements *

that

)

A function to check for the equality of two objects.

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

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

Member Data Documentation

int ObjReferenceMatrixElements::numberOfValues

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

Definition at line 669 of file OSMatrix.h.

bool ObjReferenceMatrixElements::rowMajor

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

Definition at line 675 of file OSMatrix.h.

IntVector* ObjReferenceMatrixElements::start

A vector listing the row or column starts.

Definition at line 680 of file OSMatrix.h.

IntVector* ObjReferenceMatrixElements::indexes

The row (or column) indices and objective references of the elements.

Definition at line 683 of file OSMatrix.h.

IntVector* ObjReferenceMatrixElements::values

Definition at line 684 of file OSMatrix.h.

---

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

• /builddir/build/BUILD/OS-2.9.3/src/OSCommonInterfaces/OSMatrix.h