XPRS_mse_getsollist
XPRS_mse_getsollist |
Purpose
Returns a list of solution ids of solutions found during the enumeration. The list is sorted by the value of some attribute of the solutions e.g., the MIP objective value.
Synopsis
int XPRS_CC XPRS_mse_getsollist(XPRSmipsolenum mse, int iMetricId, int iRankFirstIndex, int iRankLastIndex, int iSolutionIds[], int * nReturnedSolIds, int * nSols)
Arguments
|
mse
|
The current MIP solution enumerator.
|
|
iMetricId
|
Id of the attribute whose value is used to rank the solution ids returned in the iSolutionIds array e.g., the MIP objective value is used when
MSE_METRIC_MIPOBJECT is passed down. A full list of all available attributes may be found in Chapter
MSE Attributes, or from the list in the
xprs.h header file.
|
|
iRankFirstIndex
|
Index (one-based) in the rank order of solutions for which the associated solution's id number, if there is a solution at this index, is to be returned in the first element of array
iSolutionIds. If
iRankLastIndex > iRankFirstIndex then any subsequent solutions in the rank ordering are to have their solution ids written to the subsequent elements of
iSolutionIds.
|
|
iRankLastIndex
|
If
iSolutionIds is non-NULL then at most
iRankLastIndex - iRankFirstIndex + 1 solution ids will be written to
iSolutionIds. There will be fewer solution ids written if
iRankLastIndex is greater than the number of solutions registered in the MIP solution enumerator.
|
|
iSolutionIds
|
Integer array where the solution ids will be returned. May be NULL if not required.
|
|
nReturnedSolIds
|
Pointer to an integer where the number of solution ids that were available to be written is returned. This number will always be less than or equal to
iRankLastIndex - iRankFirstIndex + 1. A value is returned for this parameter regardless of whether
iSolutionIds is passed as NULL. May be NULL if not required.
|
|
nSols
|
Pointer to an integer where the total number of solution ids that could possibly be written is returned. May be NULL if not required.
|
Related topics