CPXgetcallbackorder

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 CPXgetcallbackorder is used to get MIP priority order information 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 values:

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 = CPXgetcallbackorder (env, cbdata, wherefrom,
                               priority, NULL, 0, cols-1);

Branching direction
`CPX_BRANCH_GLOBAL`	0	use global branching direction setting `CPX_PARAM_BRDIR`
`CPX_BRANCH_DOWN`	-1	branch down first on variable `j+begin`
`CPX_BRANCH_UP`	1	branch up first on variable `j+begin`

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 where the priority values are to be returned. This array must be of length at least (end - begin + 1). If successful, priority[0] through priority[end-begin] contain the priority order values. May be NULL. The value of direction[j] will be a value from the table of branching directions.

An integer indicating the beginning of the range of priority order information to be returned.

An integer indicating the end of the range of priority order information to be returned.

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

CPXgetcallbackorder

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.
priority	An array where the priority values are to be returned. This array must be of length at least (`end - begin + 1`). If successful, `priority[0]` through `priority[end-begin]` contain the priority order values. May be NULL. The value of direction[j] will be a value from the table of branching directions.
begin	An integer indicating the beginning of the range of priority order information to be returned.
end	An integer indicating the end of the range of priority order information to be returned.