Initializing help system before first use

XPRSgetcpcutlist

Purpose
Returns a list of cut indices from the cut pool.
Synopsis
int XPRS_CC XPRSgetcpcutlist(XPRSprob prob, int cuttype, int interp, double delta, int *p_ncuts, int maxcuts, XPRScut cutind[], double viol[]);
Arguments
prob 
The current problem.
cuttype 
The user defined type of the cuts to be returned.
interp 
Way in which the cut type is interpreted:
-1 
get all cuts;
1 
treat cut types as numbers;
2 
treat cut types as bit maps - get cut if any bit matches any bit set in cuttype;
3 
treat cut types as bit maps - get cut if all bits match those set in cuttype.
delta 
Only those cuts with a signed violation greater than delta will be returned.
p_ncuts 
Pointer to the integer where the number of cuts of type cuttype in the cut pool will be returned.
maxcuts 
Maximum number of cuts to be returned.
cutind 
Array of length maxcuts where the pointers to the cuts will be returned.
viol 
Double array of length maxcuts where the values of the signed violations of the cuts will be returned.
Further information
1. The violated cuts can be obtained by setting the delta parameter to the size of the (signed) violation required. If unviolated cuts are required as well, delta may be set to XPRS_MINUSINFINITY which is defined in the library header file.
2. If the number of active cuts is greater than maxcuts, only maxcuts cuts will be returned and p_ncuts will be set to the number of active cuts. If p_ncuts is less than maxcuts, then only p_ncuts positions will be filled in cutind.
3. In case of a cut of type ' L', the violation equals the negative of the slack associated with the row of the cut. In case of a cut of type ' G', the violation equals the slack associated with the row of the cut. For cuts of type ' E', the violation equals the absolute value of the slack.
4. Please note that the violations returned are absolute violations, while feasibility is checked by the Optimizer in the scaled problem.
Related topics
XPRSdelcpcuts, XPRSgetcpcuts, XPRSgetcutlist, XPRSloadcuts, XPRSgetcutmap, XPRSgetcutslack, Section Working with the Cut Manager.

Parent Topic Console and Library Functions

© 2001-2021 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.