a data structure to represent an LP basis on both input and output
More...
#include <OSGeneral.h>
|
| BasisStatus () |
|
| ~BasisStatus () |
|
bool | IsEqual (BasisStatus *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 (BasisStatus *that) |
| A function to make a deep copy of an instance of this class. More...
|
|
bool | setIntVector (int status, int *i, int ni) |
| Set the indices for a particular status. More...
|
|
bool | addIdx (int status, int idx) |
| Add one index to a particular status. More...
|
|
int | getNumberOfEl (int status) |
| Get the number of indices for a particular status. More...
|
|
int | getEl (int status, int j) |
| Get one entry in the array of indices for a particular status. More...
|
|
bool | getIntVector (int status, int *i) |
| Get the entire array of indices for a particular status. More...
|
|
int | getBasisDense (int *resultArray, int dim, bool flipIdx) |
| Get the entire array of basis status in dense form. More...
|
|
a data structure to represent an LP basis on both input and output
Definition at line 645 of file OSGeneral.h.
§ BasisStatus()
BasisStatus::BasisStatus |
( |
| ) |
|
§ ~BasisStatus()
BasisStatus::~BasisStatus |
( |
| ) |
|
§ IsEqual()
A function to check for the equality of two objects.
§ setRandom()
bool BasisStatus::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 an entry in this basis can take |
iMax | greatest index value (inclusive) that an entry in this basis can take |
§ deepCopyFrom()
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
§ setIntVector()
bool BasisStatus::setIntVector |
( |
int |
status, |
|
|
int * |
i, |
|
|
int |
ni |
|
) |
| |
Set the indices for a particular status.
- Parameters
-
status | is a string representing the allowed statuses (as defined in enumeration ENUM_BASIS_STATUS - see below) |
i | contains the array of indices |
ni | contains the number of elements in i |
§ addIdx()
bool BasisStatus::addIdx |
( |
int |
status, |
|
|
int |
idx |
|
) |
| |
Add one index to a particular status.
- Parameters
-
status | is a string representing the allowed statuses (as defined in enumeration ENUM_BASIS_STATUS - see below) |
idx | contains the value of the index |
§ getNumberOfEl()
int BasisStatus::getNumberOfEl |
( |
int |
status | ) |
|
Get the number of indices for a particular status.
- Parameters
-
status | is a string representing the allowed statuses (at present "basic", "atLower", "atUpper", "isFree", "superbasic", "unknown") |
- Returns
- the number of indices or -1 if the object does not exist
§ getEl()
int BasisStatus::getEl |
( |
int |
status, |
|
|
int |
j |
|
) |
| |
Get one entry in the array of indices for a particular status.
- Parameters
-
status | is an integer representing the allowed statuses (as governed by enumeration ENUM_BASIS_STATUS — see below) |
j | is the (zero-based) position of the entry within the array |
- Returns
- the value
§ getIntVector()
bool BasisStatus::getIntVector |
( |
int |
status, |
|
|
int * |
i |
|
) |
| |
Get the entire array of indices for a particular status.
- Parameters
-
status | is a string representing the allowed statuses (as governed by enumeration ENUM_BASIS_STATUS — see below) |
i | is the location where the user wants to store the array |
- Returns
- whether the operation was successful
- Note
- it is the user's responsibility to reserve sufficient memory to hold the vector being returned.
§ getBasisDense()
int BasisStatus::getBasisDense |
( |
int * |
resultArray, |
|
|
int |
dim, |
|
|
bool |
flipIdx |
|
) |
| |
Get the entire array of basis status in dense form.
- Parameters
-
resultArray | is the location where the user wants to store the array |
dim | is the size of the resultArray |
flipIdx | indicates whether the index values need to be flipped (used for representations of objective rows) |
- Returns
- status of the operation: < 0: error condition = 0: no new data found (i.e., basis information is empty)
0: number of elements found
- Note
- it is the user's responsibility to reserve sufficient memory to hold the vector being returned.
§ basic
§ atLower
§ atUpper
§ atEquality
§ isFree
§ superbasic
§ unknown
The documentation for this class was generated from the following file:
- /builddir/build/BUILD/OS-2.10.1/src/OSCommonInterfaces/OSGeneral.h