scip_conflict.h
Go to the documentation of this file.
38 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
65 * @note method has all conflict handler callbacks as arguments and is thus changed every time a new
76 SCIP_DECL_CONFLICTCOPY((*conflictcopy)), /**< copy method of conflict handler or NULL if you don't want to copy your plugin into sub-SCIPs */
80 SCIP_DECL_CONFLICTINITSOL((*conflictinitsol)),/**< solving process initialization method of conflict handler */
81 SCIP_DECL_CONFLICTEXITSOL((*conflictexitsol)),/**< solving process deinitialization method of conflict handler */
86 /** creates a conflict handler and includes it in SCIP with its most fundamental callbacks. All non-fundamental
88 * Optional callbacks can be set via specific setter functions SCIPsetConflicthdlrCopy(), SCIPsetConflicthdlrFree(),
92 * @note if you want to set all callbacks with a single method call, consider using SCIPincludeConflicthdlr() instead
142 SCIP_DECL_CONFLICTINITSOL((*conflictinitsol))/**< solving process initialization method of conflict handler */
150 SCIP_DECL_CONFLICTEXITSOL((*conflictexitsol))/**< solving process deinitialization method of conflict handler */
187 /** return TRUE if conflict analysis is applicable; In case the function return FALSE there is no need to initialize the
190 * @return return TRUE if conflict analysis is applicable; In case the function return FALSE there is no need to initialize the
206 /** initializes the conflict analysis by clearing the conflict candidate queue; this method must be called before you
207 * enter the conflict variables by calling SCIPaddConflictLb(), SCIPaddConflictUb(), SCIPaddConflictBd(),
208 * SCIPaddConflictRelaxedLb(), SCIPaddConflictRelaxedUb(), SCIPaddConflictRelaxedBd(), or SCIPaddConflictBinvar();
210 * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
226 /** adds lower bound of variable at the time of the given bound change index to the conflict analysis' candidate storage;
228 * 1. Before calling the SCIPanalyzeConflict() method, SCIPaddConflictLb() should be called for each lower bound
230 * 2. In the propagation conflict resolving method of a constraint handler, SCIPaddConflictLb() should be called
231 * for each lower bound, whose current assignment led to the deduction of the given conflict bound.
233 * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
246 SCIP_BDCHGIDX* bdchgidx /**< bound change index representing time on path to current node, when the
250 /** adds lower bound of variable at the time of the given bound change index to the conflict analysis' candidate storage
251 * with the additional information of a relaxed lower bound; this relaxed lower bound is the one which would be enough
254 * 1. Before calling the SCIPanalyzeConflict() method, SCIPaddConflictRelaxedLb() should be called for each (relaxed) lower bound
256 * 2. In the propagation conflict resolving method of a constraint handler, SCIPaddConflictRelexedLb() should be called
257 * for each (relaxed) lower bound, whose current assignment led to the deduction of the given conflict bound.
259 * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
272 SCIP_BDCHGIDX* bdchgidx, /**< bound change index representing time on path to current node, when the
277 /** adds upper bound of variable at the time of the given bound change index to the conflict analysis' candidate storage;
279 * 1. Before calling the SCIPanalyzeConflict() method, SCIPaddConflictUb() should be called for each upper bound that
281 * 2. In the propagation conflict resolving method of a constraint handler, SCIPaddConflictUb() should be called for
284 * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
297 SCIP_BDCHGIDX* bdchgidx /**< bound change index representing time on path to current node, when the
301 /** adds upper bound of variable at the time of the given bound change index to the conflict analysis' candidate storage
302 * with the additional information of a relaxed upper bound; this relaxed upper bound is the one which would be enough
305 * 1. Before calling the SCIPanalyzeConflict() method, SCIPaddConflictRelaxedUb() should be called for each (relaxed) upper
306 * bound that led to the conflict (e.g. the infeasibility of globally or locally valid constraint).
307 * 2. In the propagation conflict resolving method of a constraint handler, SCIPaddConflictRelaxedUb() should be
308 * called for each (relaxed) upper bound, whose current assignment led to the deduction of the given conflict
311 * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
324 SCIP_BDCHGIDX* bdchgidx, /**< bound change index representing time on path to current node, when the
329 /** adds lower or upper bound of variable at the time of the given bound change index to the conflict analysis' candidate
331 * 1. Before calling the SCIPanalyzeConflict() method, SCIPaddConflictBd() should be called for each bound
333 * 2. In the propagation conflict resolving method of a constraint handler, SCIPaddConflictBd() should be called
336 * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
350 SCIP_BDCHGIDX* bdchgidx /**< bound change index representing time on path to current node, when the
354 /** adds lower or upper bound of variable at the time of the given bound change index to the conflict analysis'
355 * candidate storage; with the additional information of a relaxed upper bound; this relaxed upper bound is the one
358 * 1. Before calling the SCIPanalyzeConflict() method, SCIPaddConflictRelaxedBd() should be called for each (relaxed)
359 * bound that led to the conflict (e.g. the infeasibility of globally or locally valid constraint).
360 * 2. In the propagation conflict resolving method of a constraint handler, SCIPaddConflictRelaxedBd() should be
361 * called for each (relaxed) bound, whose current assignment led to the deduction of the given conflict bound.
363 * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
377 SCIP_BDCHGIDX* bdchgidx, /**< bound change index representing time on path to current node, when the
384 * 1. Before calling the SCIPanalyzeConflict() method, SCIPaddConflictBinvar() should be called for each fixed binary
385 * variable that led to the conflict (e.g. the infeasibility of globally or locally valid constraint).
386 * 2. In the propagation conflict resolving method of a constraint handler, SCIPaddConflictBinvar() should be called
387 * for each binary variable, whose current fixing led to the deduction of the given conflict bound.
389 * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
404 /** checks if the given variable is already part of the current conflict set or queued for resolving with the same or
407 * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
421 SCIP_BDCHGIDX* bdchgidx, /**< bound change index representing time on path to current node, when the
426 /** returns the conflict lower bound if the variable is present in the current conflict set; otherwise the global lower
429 * @return returns the conflict lower bound if the variable is present in the current conflict set; otherwise the global lower
444 /** returns the conflict upper bound if the variable is present in the current conflict set; otherwise minus global
447 * @return returns the conflict upper bound if the variable is present in the current conflict set; otherwise minus global
462 /** analyzes conflict bounds that were added after a call to SCIPinitConflictAnalysis() with calls to
464 * SCIPaddConflictRelaxedUb(), SCIPaddConflictRelaxedBd(), or SCIPaddConflictBinvar(); on success, calls the conflict
465 * handlers to create a conflict constraint out of the resulting conflict set; the given valid depth must be a depth
466 * level, at which the conflict set defined by calls to SCIPaddConflictLb(), SCIPaddConflictUb(), SCIPaddConflictBd(),
467 * SCIPaddConflictRelaxedLb(), SCIPaddConflictRelaxedUb(), SCIPaddConflictRelaxedBd(), and SCIPaddConflictBinvar() is
468 * valid for the whole subtree; if the conflict was found by a violated constraint, use SCIPanalyzeConflictCons()
471 * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
487 /** analyzes conflict bounds that were added with calls to SCIPaddConflictLb(), SCIPaddConflictUb(),
488 * SCIPaddConflictBd(), SCIPaddConflictRelaxedLb(), SCIPaddConflictRelaxedUb(), SCIPaddConflictRelaxedBd(), or
489 * SCIPaddConflictBinvar(); on success, calls the conflict handlers to create a conflict constraint out of the
490 * resulting conflict set; the given constraint must be the constraint that detected the conflict, i.e. the constraint
491 * that is infeasible in the local bounds of the initial conflict set (defined by calls to SCIPaddConflictLb(),
492 * SCIPaddConflictUb(), SCIPaddConflictBd(), SCIPaddConflictRelaxedLb(), SCIPaddConflictRelaxedUb(),
495 * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
Definition: struct_var.h:108
SCIP_RETCODE SCIPsetConflicthdlrInit(SCIP *scip, SCIP_CONFLICTHDLR *conflicthdlr, SCIP_DECL_CONFLICTINIT((*conflictinit)))
Definition: scip_conflict.c:172
Definition: struct_scip.h:68
SCIP_RETCODE SCIPaddConflictBinvar(SCIP *scip, SCIP_VAR *var)
Definition: scip_conflict.c:556
Definition: struct_var.h:207
SCIP_RETCODE SCIPsetConflicthdlrCopy(SCIP *scip, SCIP_CONFLICTHDLR *conflicthdlr, SCIP_DECL_CONFLICTCOPY((*conflictcopy)))
Definition: scip_conflict.c:140
SCIP_Real SCIPgetConflictVarUb(SCIP *scip, SCIP_VAR *var)
Definition: scip_conflict.c:642
SCIP_RETCODE SCIPaddConflictUb(SCIP *scip, SCIP_VAR *var, SCIP_BDCHGIDX *bdchgidx)
Definition: scip_conflict.c:419
SCIP_RETCODE SCIPisConflictVarUsed(SCIP *scip, SCIP_VAR *var, SCIP_BOUNDTYPE boundtype, SCIP_BDCHGIDX *bdchgidx, SCIP_Bool *used)
Definition: scip_conflict.c:590
SCIP_RETCODE SCIPaddConflictRelaxedLb(SCIP *scip, SCIP_VAR *var, SCIP_BDCHGIDX *bdchgidx, SCIP_Real relaxedlb)
Definition: scip_conflict.c:386
SCIP_RETCODE SCIPinitConflictAnalysis(SCIP *scip, SCIP_CONFTYPE conftype, SCIP_Bool iscutoffinvolved)
Definition: scip_conflict.c:323
SCIP_RETCODE SCIPsetConflicthdlrExit(SCIP *scip, SCIP_CONFLICTHDLR *conflicthdlr, SCIP_DECL_CONFLICTEXIT((*conflictexit)))
Definition: scip_conflict.c:188
type definitions for return codes for SCIP methods
SCIP_RETCODE SCIPsetConflicthdlrExitsol(SCIP *scip, SCIP_CONFLICTHDLR *conflicthdlr, SCIP_DECL_CONFLICTEXITSOL((*conflictexitsol)))
Definition: scip_conflict.c:220
SCIP_RETCODE SCIPaddConflictLb(SCIP *scip, SCIP_VAR *var, SCIP_BDCHGIDX *bdchgidx)
Definition: scip_conflict.c:352
SCIP_RETCODE SCIPsetConflicthdlrInitsol(SCIP *scip, SCIP_CONFLICTHDLR *conflicthdlr, SCIP_DECL_CONFLICTINITSOL((*conflictinitsol)))
Definition: scip_conflict.c:204
SCIP_RETCODE SCIPincludeConflicthdlr(SCIP *scip, const char *name, const char *desc, int priority, SCIP_DECL_CONFLICTCOPY((*conflictcopy)), SCIP_DECL_CONFLICTFREE((*conflictfree)), SCIP_DECL_CONFLICTINIT((*conflictinit)), SCIP_DECL_CONFLICTEXIT((*conflictexit)), SCIP_DECL_CONFLICTINITSOL((*conflictinitsol)), SCIP_DECL_CONFLICTEXITSOL((*conflictexitsol)), SCIP_DECL_CONFLICTEXEC((*conflictexec)), SCIP_CONFLICTHDLRDATA *conflicthdlrdata)
Definition: scip_conflict.c:65
Definition: struct_conflict.h:49
type definitions for LP management
SCIP_Bool SCIPisConflictAnalysisApplicable(SCIP *scip)
Definition: scip_conflict.c:301
Definition: struct_cons.h:46
type definitions for SCIP's main datastructure
SCIP_Real SCIPgetConflictVarLb(SCIP *scip, SCIP_VAR *var)
Definition: scip_conflict.c:618
SCIP_RETCODE SCIPaddConflictRelaxedBd(SCIP *scip, SCIP_VAR *var, SCIP_BOUNDTYPE boundtype, SCIP_BDCHGIDX *bdchgidx, SCIP_Real relaxedbd)
Definition: scip_conflict.c:522
struct SCIP_ConflicthdlrData SCIP_CONFLICTHDLRDATA
Definition: type_conflict.h:49
type definitions for problem variables
SCIP_RETCODE SCIPanalyzeConflictCons(SCIP *scip, SCIP_CONS *cons, SCIP_Bool *success)
Definition: scip_conflict.c:703
type definitions for conflict analysis
SCIP_CONFLICTHDLR ** SCIPgetConflicthdlrs(SCIP *scip)
Definition: scip_conflict.c:249
SCIP_RETCODE SCIPaddConflictRelaxedUb(SCIP *scip, SCIP_VAR *var, SCIP_BDCHGIDX *bdchgidx, SCIP_Real relaxedub)
Definition: scip_conflict.c:454
SCIP_RETCODE SCIPaddConflictBd(SCIP *scip, SCIP_VAR *var, SCIP_BOUNDTYPE boundtype, SCIP_BDCHGIDX *bdchgidx)
Definition: scip_conflict.c:487
type definitions for branch and bound tree
SCIP_RETCODE SCIPsetConflicthdlrFree(SCIP *scip, SCIP_CONFLICTHDLR *conflicthdlr, SCIP_DECL_CONFLICTFREE((*conflictfree)))
Definition: scip_conflict.c:156
SCIP_CONFLICTHDLR * SCIPfindConflicthdlr(SCIP *scip, const char *name)
Definition: scip_conflict.c:236
SCIP_RETCODE SCIPincludeConflicthdlrBasic(SCIP *scip, SCIP_CONFLICTHDLR **conflicthdlrptr, const char *name, const char *desc, int priority, SCIP_DECL_CONFLICTEXEC((*conflictexec)), SCIP_CONFLICTHDLRDATA *conflicthdlrdata)
Definition: scip_conflict.c:108
result codes for SCIP callback methods
common defines and data types used in all packages of SCIP
Definition: objbenders.h:43
SCIP_RETCODE SCIPanalyzeConflict(SCIP *scip, int validdepth, SCIP_Bool *success)
Definition: scip_conflict.c:672
SCIP_RETCODE SCIPsetConflicthdlrPriority(SCIP *scip, SCIP_CONFLICTHDLR *conflicthdlr, int priority)
Definition: scip_conflict.c:273
type definitions for constraints and constraint handlers