Initializing help system before first use

XPRS_msp_getdblattribprobsol

XPRS_msp_getdblattribprobsol


Purpose
Provides read access to the values of double attributes associated with the MIP solution pool with respect to the given solution stored in the MIP solution pool and the given problem. For example, the objective value of the given solution with respect to the given problem.
Synopsis
int XPRS_CC XPRS_msp_getdblattribprobsol(MipSolPool msp, XPRSprob prob_to_rank_against, const int iSolutionId, int * const iSolutionIdStatus, const int iAttribId, double * const Dst)
Arguments
msp 
The current MIP solution pool.
prob_context 
Problem for which the attribute iAttribId is required to be evaluated using solution iSolutionId .
iSolutionId 
The id of the solution for which the attribute iAttribId is evaluated with respect to the problem prob_context.
iSolutionIdStatus 
Pointer to an int where the status of the iSolutionId will be returned. The returned value is one of:
-2 
Solution id does not exist;
-1 
Solution with the given id is already deleted;
Solution id was for an active solution.
iAttribId 
Id of attribute whose value is to be returned. A full list of all available attributes may be found in Chapter MSP Attributes, or from the list in the xprs.h header file.
Dst 
Pointer to a double where the value of the attribute will be returned.
Further information
1. The user will obtain the solution id iSolutionId from interaction with the MIP solution pool via functions such as XPRS_msp_findsolbyname, XPRS_msp_getdblattribprobextreme, XPRS_msp_getintattribprobextreme and XPRS_msp_getsollist.
2. The attributes accessed by this function are the same as those available through XPRS_msp_getdblattribprobextreme. That is, double attributes relating to a problem and solution pair, e.g., the objective function value of a solution to the problem
Related topics