OS  2.10.2
Public Member Functions | Public Attributes | List of all members
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>

+ Collaboration diagram for LinearMatrixElement:

Public Member Functions

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

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 ( )

◆ ~LinearMatrixElement()

LinearMatrixElement::~LinearMatrixElement ( )

Member Function Documentation

◆ IsEqual()

bool LinearMatrixElement::IsEqual ( LinearMatrixElement that)

A function to check for the equality of two objects.

◆ 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

◆ 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

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 file: