My Project
LinearMatrixElement Class Reference

a data structure to represent an expression in a linearMatrix element A LinearMatrixElement is a (finite) sum of LinearMatrixElementTerms, with an optional additive constant More...

#include <OSMatrix.h>

Public Member Functions

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

Public Attributes

int numberOfVarIdx
 
double constant
 
LinearMatrixElementTerm ** varIdx
 

Detailed Description

a data structure to represent an expression in a linearMatrix element A LinearMatrixElement is a (finite) sum of LinearMatrixElementTerms, with an optional additive constant

Parameters
numberOfVarIdxgives the number of terms in the expression

Definition at line 411 of file OSMatrix.h.

Constructor & Destructor Documentation

◆ LinearMatrixElement()

LinearMatrixElement::LinearMatrixElement ( )

-------— Methods for class LinearMatrixElement -------—

Definition at line 4866 of file OSMatrix.cpp.

◆ ~LinearMatrixElement()

LinearMatrixElement::~LinearMatrixElement ( )

Definition at line 4877 of file OSMatrix.cpp.

Member Function Documentation

◆ IsEqual()

bool LinearMatrixElement::IsEqual ( LinearMatrixElement * that)

A function to check for the equality of two objects.

Definition at line 4907 of file OSMatrix.cpp.

◆ setRandom()

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

Definition at line 4948 of file OSMatrix.cpp.

◆ deepCopyFrom()

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

Definition at line 4953 of file OSMatrix.cpp.

Member Data Documentation

◆ numberOfVarIdx

int LinearMatrixElement::numberOfVarIdx

Definition at line 414 of file OSMatrix.h.

◆ constant

double LinearMatrixElement::constant

Definition at line 415 of file OSMatrix.h.

◆ varIdx

LinearMatrixElementTerm** LinearMatrixElement::varIdx

Definition at line 417 of file OSMatrix.h.


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