CPXgetcallbackincumbent

Note

This is an advanced routine. Advanced routines typically demand a profound understanding of the algorithms used by ILOG CPLEX. Thus they incur a higher risk of incorrect behavior in your application, behavior that can be difficult to debug. Therefore, ILOG encourages you to consider carefully whether you can accomplish the same task by means of other Callable Library routines instead.

The routine CPXgetcallbackincumbent is used to get the incumbent values during MIP optimization from within a user-written callback. The values are from the original problem if CPX_PARAM_MIPCBREDLP is set to CPX_OFF. Otherwise, they are from the presolved problem.

This routine may be called only when the value of the wherefrom argument is one of the following:

CPX_CALLBACK_MIP,
CPX_CALLBACK_MIP_BRANCH,
CPX_CALLBACK_MIP_INCUMBENT,
CPX_CALLBACK_MIP_NODE,
CPX_CALLBACK_MIP_HEURISTIC,
CPX_CALLBACK_MIP_SOLVE, or
CPX_CALLBACK_MIP_CUT.

Example

 status = CPXgetcallbackincumbent (env, cbdata, wherefrom,
                                   bestx, 0, cols-1);

A pointer to the CPLEX environment, as returned by CPXopenCPLEX.

The pointer passed to the user-written callback. This parameter must be the value of cbdata passed to the user-written callback.

An integer value indicating from where the user-written callback was called. The parameter must be the value of wherefrom passed to the user-written callback.

An array to receive the values of the incumbent (best available) integer solution. This array must be of length at least (end - begin + 1). If successful, x[0] through x[end-begin] contain the incumbent values.

An integer indicating the beginning of the range of incumbent values to be returned.

An integer indicating the end of the range of incumbent values to be returned.

The routine returns zero on success and nonzero if an error occurs.

CPXgetcallbackincumbent

Parameters:

Returns:

env	A pointer to the CPLEX environment, as returned by `CPXopenCPLEX`.
cbdata	The pointer passed to the user-written callback. This parameter must be the value of `cbdata` passed to the user-written callback.
wherefrom	An integer value indicating from where the user-written callback was called. The parameter must be the value of `wherefrom` passed to the user-written callback.
x	An array to receive the values of the incumbent (best available) integer solution. This array must be of length at least (`end - begin + 1`). If successful, `x[0]` through `x[end-begin]` contain the incumbent values.
begin	An integer indicating the beginning of the range of incumbent values to be returned.
end	An integer indicating the end of the range of incumbent values to be returned.