OS  2.9.3
Public Member Functions | Public Attributes | List of all members
VarReferenceMatrixElements Class Reference

a data structure to represent variable reference elements in a MatrixType object Each nonzero element is of the form x_{k} where k is the index of a variable More...

#include <OSMatrix.h>

+ Collaboration diagram for VarReferenceMatrixElements:

Public Member Functions

 VarReferenceMatrixElements ()
 
 ~VarReferenceMatrixElements ()
 
bool IsEqual (VarReferenceMatrixElements *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 (VarReferenceMatrixElements *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 varReference matrix elements are stored in row major form or column major form. More...
 
IntVectorstart
 A vector listing the row or column starts. More...
 
IntVectorindexes
 The row (or column) indices and variable references of the elements. More...
 
IntVectorvalues
 

Detailed Description

a data structure to represent variable reference elements in a MatrixType object Each nonzero element is of the form x_{k} where k is the index of a variable

Definition at line 282 of file OSMatrix.h.

Constructor & Destructor Documentation

VarReferenceMatrixElements::VarReferenceMatrixElements ( )
VarReferenceMatrixElements::~VarReferenceMatrixElements ( )

Member Function Documentation

bool VarReferenceMatrixElements::IsEqual ( VarReferenceMatrixElements that)

A function to check for the equality of two objects.

bool VarReferenceMatrixElements::setRandom ( double  density,
bool  conformant,
int  iMin,
int  iMax 
)

A function to make a random instance of this class.

Parameters
densitycorresponds to the probability that a particular child element is created
conformantif true enforces side constraints not enforceable in the schema (e.g., agreement of "numberOfXXX" attributes and <XXX> children)
iMinlowest index value (inclusive) that a variable reference in this matrix can take
iMaxgreatest index value (inclusive) that a variable reference in this matrix can take
bool VarReferenceMatrixElements::deepCopyFrom ( VarReferenceMatrixElements that)

A function to make a deep copy of an instance of this class.

Parameters
thatthe instance from which information is to be copied
Returns
whether the copy was created successfully

Member Data Documentation

int VarReferenceMatrixElements::numberOfValues

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

Definition at line 289 of file OSMatrix.h.

bool VarReferenceMatrixElements::rowMajor

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

Definition at line 295 of file OSMatrix.h.

IntVector* VarReferenceMatrixElements::start

A vector listing the row or column starts.

Definition at line 300 of file OSMatrix.h.

IntVector* VarReferenceMatrixElements::indexes

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

Definition at line 303 of file OSMatrix.h.

IntVector* VarReferenceMatrixElements::values

Definition at line 304 of file OSMatrix.h.


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