CPXcutcallbackaddlocal

Note

This is an advanced routine. Advanced routines typically demand a thorough 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 CPXcutcallbackaddlocal adds local cuts during MIP branch & cut. A local cut is one that applies to the current node and the subtree rooted at this node. Global cuts, that is, cuts that apply throughout the branch & cut tree, are added with the routine CPXcutcallbackadd. This routine may be called only from within user-written cut callbacks; thus it may be called only when the value of its wherefrom argument is CPX_CALLBACK_MIP_CUT.

The cut may be for the original problem if the parameter CPX_PARAM_MIPCBREDLP was set to CPX_OFF before the call to CPXmipopt that calls the callback. Otherwise, the cut is used on the presolved problem.

Example

 status = CPXcutcallbackaddlocal (env,
                                  cbdata,
                                  wherefrom,
                                  mynzcnt,
                                  myrhs,
                                  'L',
                                  mycutind,
                                  mycutval);

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 that indicates where the user-written callback was called from. This parameter must be the value of wherefrom passed to the user-written callback.

An integer value that indicates the number of coefficients in the cut, or equivalently, the length of the arrays cutind and cutval.

A double value that indicates the value of the righthand side of the cut.

An integer value that indicates the sense of the cut.

An array containing the column indices of cut coefficients.

An array containing the values of cut coefficients.

The routine returns zero if successful and nonzero if an error occurs.

CPXcutcallbackaddlocal

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 that indicates where the user-written callback was called from. This parameter must be the value of `wherefrom` passed to the user-written callback.
nzcnt	An integer value that indicates the number of coefficients in the cut, or equivalently, the length of the arrays `cutind` and `cutval`.
rhs	A double value that indicates the value of the righthand side of the cut.
sense	An integer value that indicates the sense of the cut.
cutind	An array containing the column indices of cut coefficients.
cutval	An array containing the values of cut coefficients.