Initializing help system before first use

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
XPRS_mse_opt, XPRS_mse_minim, XPRS_mse_maxim.

Parent Topic MSE Functions

© 2001-2020 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.