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

a data structure to represent an entry in a conReferenceMatrix element, which consists of a constraint reference as well as a value type. More...

#include <OSMatrix.h>

Public Member Functions

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

Public Attributes

int conReference
 contains a reference to a row of the problem (objective if negative, constraint otherwise) More...
 
ENUM_CONREFERENCE_VALUETYPE valueType
 Several different types of values can be derived from a problem constraint. More...
 
double value
 This element contains the value. More...
 

Detailed Description

a data structure to represent an entry in a conReferenceMatrix element, which consists of a constraint reference as well as a value type.

Remarks
We use the same class to describe MixedRowReferenceMatrix elements. A MixedRowReferenceMatrix is obtained by combining ObjReferenceMatrix elements and ConReferenceMatrix elements into a single matrix constructor.

Definition at line 453 of file OSMatrix.h.

Constructor & Destructor Documentation

◆ ConReferenceMatrixElement()

ConReferenceMatrixElement::ConReferenceMatrixElement ( )

◆ ~ConReferenceMatrixElement()

ConReferenceMatrixElement::~ConReferenceMatrixElement ( )

Member Function Documentation

◆ IsEqual()

bool ConReferenceMatrixElement::IsEqual ( ConReferenceMatrixElement that)

A function to check for the equality of two objects.

◆ setRandom()

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

◆ conReference

int ConReferenceMatrixElement::conReference

contains a reference to a row of the problem (objective if negative, constraint otherwise)

Remarks
If used in a ConReferenceMatrix, the nonnegativity required is verified and enforced

Definition at line 460 of file OSMatrix.h.

◆ valueType

ENUM_CONREFERENCE_VALUETYPE ConReferenceMatrixElement::valueType

Several different types of values can be derived from a problem constraint.

(See OSParameters.h for an enumeration.)

Definition at line 466 of file OSMatrix.h.

◆ value

double ConReferenceMatrixElement::value

This element contains the value.

Definition at line 469 of file OSMatrix.h.


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