OS  2.10.1
Public Member Functions | Public Attributes | List of all members
LinearMatrixElementTerm Class Reference

a data structure to represent a term in a linearMatrix element A term has the form c*x_{k}, where c defaults to 1 and k is a valid index for a variable This is essentially an index-value pair, but with the presence of a default value More...

#include <OSMatrix.h>

Public Member Functions

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

Public Attributes

int idx
 
double coef
 

Detailed Description

a data structure to represent a term in a linearMatrix element A term has the form c*x_{k}, where c defaults to 1 and k is a valid index for a variable This is essentially an index-value pair, but with the presence of a default value

Definition at line 373 of file OSMatrix.h.

Constructor & Destructor Documentation

◆ LinearMatrixElementTerm()

LinearMatrixElementTerm::LinearMatrixElementTerm ( )

◆ ~LinearMatrixElementTerm()

LinearMatrixElementTerm::~LinearMatrixElementTerm ( )

Member Function Documentation

◆ IsEqual()

bool LinearMatrixElementTerm::IsEqual ( LinearMatrixElementTerm that)

A function to check for the equality of two objects.

◆ setRandom()

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

◆ idx

int LinearMatrixElementTerm::idx

Definition at line 376 of file OSMatrix.h.

◆ coef

double LinearMatrixElementTerm::coef

Definition at line 377 of file OSMatrix.h.


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