My Project
GeneralMatrixValues Class Reference

a data structure to represent the nonzeros in a generalMatrix element More...

#include <OSMatrix.h>

Inheritance diagram for GeneralMatrixValues:
MatrixElementValues

Public Member Functions

 GeneralMatrixValues ()
 -------— Methods for class GeneralMatrixValues -------—
 
 ~GeneralMatrixValues ()
 
bool IsEqual (GeneralMatrixValues *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.
 
virtual bool deepCopyFrom (GeneralMatrixValues *that)
 A function to make a deep copy of an instance of this class.
 
- Public Member Functions inherited from MatrixElementValues
 MatrixElementValues ()
 -------— Methods for class MatrixElementValues -------—
 
virtual ~MatrixElementValues ()
 
virtual bool deepCopyFrom (MatrixElementValues *that)
 A function to check for the equality of two objects.
 

Public Attributes

ScalarExpressionTree ** el
 
- Public Attributes inherited from MatrixElementValues
int numberOfEl
 each type of value is stored as an array named "el".
 

Detailed Description

a data structure to represent the nonzeros in a generalMatrix element

Definition at line 639 of file OSMatrix.h.

Constructor & Destructor Documentation

◆ GeneralMatrixValues()

GeneralMatrixValues::GeneralMatrixValues ( )

-------— Methods for class GeneralMatrixValues -------—

Definition at line 5185 of file OSMatrix.cpp.

◆ ~GeneralMatrixValues()

GeneralMatrixValues::~GeneralMatrixValues ( )

Definition at line 5193 of file OSMatrix.cpp.

Member Function Documentation

◆ IsEqual()

bool GeneralMatrixValues::IsEqual ( GeneralMatrixValues * that)

A function to check for the equality of two objects.

Definition at line 5228 of file OSMatrix.cpp.

◆ setRandom()

bool GeneralMatrixValues::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

◆ deepCopyFrom()

bool GeneralMatrixValues::deepCopyFrom ( GeneralMatrixValues * that)
virtual

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

Definition at line 5269 of file OSMatrix.cpp.

Member Data Documentation

◆ el

ScalarExpressionTree** GeneralMatrixValues::el

Definition at line 642 of file OSMatrix.h.


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