Initializing help system before first use

problem.getcpcutlist

problem.getcpcutlist

Purpose
Returns a list of cut indices from the cut pool.
Synopsis
ncuts = problem.getcpcutlist (itype, interp, delta, size, cutind, viol)
Arguments
itype 
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 itype;
3 
treat cut types as bit maps - get cut if all bits match those set in itype.
delta 
Only those cuts with a signed violation greater than delta will be returned.
size 
Maximum number of cuts to be returned.
mcutind 
Array of length size where the cuts will be returned.
dviol 
Array of length size 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 _MINUSINFINITY which is defined in the library header file.
2. If the number of active cuts is greater than size, only size cuts will be returned. Otherwise only the existing cuts will be used to fill in the positions of mcutind.
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
problem.delcpcuts, problem.getcpcuts, problem.getcutlist, problem.loadcuts, problem.getcutmap, problem.getcutslack, Section "Working with the cut manager" of the Xpress Optimizer reference manual.

Parent Topic Reference Manual

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