OS  2.9.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Public Attributes | List of all members
ConstantMatrixElements Class Reference

a data structure to represent the constant elements in a MatrixType object More...

#include <OSMatrix.h>

+ Collaboration diagram for ConstantMatrixElements:

Public Member Functions

 ConstantMatrixElements ()
 
 ~ConstantMatrixElements ()
 
bool IsEqual (ConstantMatrixElements *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 (ConstantMatrixElements *that)
 A function to make a deep copy of an instance of this class. More...
 

Public Attributes

bool rowMajor
 To indicate whether the constant matrix elements are stored in row major form or column major form. More...
 
int numberOfValues
 numberOfValues records the number of entries in the arrays that make up the instance of nonzeros More...
 
IntVectorstart
 A vector listing the row or column starts. More...
 
IntVectorindexes
 The indices and values of the (nonzero) constant elements. More...
 
DoubleVectorvalues
 

Detailed Description

a data structure to represent the constant elements in a MatrixType object

Definition at line 226 of file OSMatrix.h.

Constructor & Destructor Documentation

ConstantMatrixElements::ConstantMatrixElements ( )
ConstantMatrixElements::~ConstantMatrixElements ( )

Member Function Documentation

bool ConstantMatrixElements::IsEqual ( ConstantMatrixElements that)

A function to check for the equality of two objects.

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

bool ConstantMatrixElements::rowMajor

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

Definition at line 233 of file OSMatrix.h.

int ConstantMatrixElements::numberOfValues

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

Definition at line 239 of file OSMatrix.h.

IntVector* ConstantMatrixElements::start

A vector listing the row or column starts.

Definition at line 244 of file OSMatrix.h.

IntVector* ConstantMatrixElements::indexes

The indices and values of the (nonzero) constant elements.

Definition at line 247 of file OSMatrix.h.

DoubleVector* ConstantMatrixElements::values

Definition at line 248 of file OSMatrix.h.


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