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>

List of all members.

Public Member Functions

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

Public Attributes

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

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

---------- Methods for class ConReferenceMatrixElement ----------

Definition at line 5769 of file OSMatrix.cpp.

ConReferenceMatrixElement::~ConReferenceMatrixElement (  ) 

Definition at line 5778 of file OSMatrix.cpp.


Member Function Documentation

bool ConReferenceMatrixElement::IsEqual ( ConReferenceMatrixElement that  ) 

A function to check for the equality of two objects.

Definition at line 5785 of file OSMatrix.cpp.

bool ConReferenceMatrixElement::setRandom ( double  density,
bool  conformant,
int  iMin,
int  iMax 
)

A function to make a random instance of this class.

Parameters:
density,: corresponds to the probability that a particular child element is created
conformant,: if true enforces side constraints not enforceable in the schema (e.g., agreement of "numberOfXXX" attributes and <XXX> children)
iMin,: lowest index value (inclusive) that a variable reference in this matrix can take
iMax,: greatest index value (inclusive) that a variable reference in this matrix can take

Definition at line 5823 of file OSMatrix.cpp.

bool ConReferenceMatrixElement::deepCopyFrom ( ConReferenceMatrixElement that  ) 

A function to make a deep copy of an instance of this class.

Parameters:
that,: the instance from which information is to be copied
Returns:
whether the copy was created successfully

Definition at line 5828 of file OSMatrix.cpp.


Member Data Documentation

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.

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.

This element contains the value.

Definition at line 469 of file OSMatrix.h.


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

Generated on 5 Jul 2015 by  doxygen 1.6.1