type_cons.h
Go to the documentation of this file.
29 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
48 typedef struct SCIP_Conshdlr SCIP_CONSHDLR; /**< constraint handler for a specific constraint type */
51 typedef struct SCIP_ConsData SCIP_CONSDATA; /**< locally defined constraint type specific data */
52 typedef struct SCIP_ConsSetChg SCIP_CONSSETCHG; /**< tracks additions and removals of the set of active constraints */
53 typedef struct SCIP_LinConsStats SCIP_LINCONSSTATS; /**< linear constraint classification statistics used for MIPLIB */
62 SCIP_LINCONSTYPE_PRECEDENCE = 4, /**< linear constraints of the type \f$ a x - a y \leq b\f$ where \f$x\f$ and \f$y\f$ must have the same type */
63 SCIP_LINCONSTYPE_VARBOUND = 5, /**< linear constraints of the form \f$ ax + by \leq c \, x \in \{0,1\} \f$ */
64 SCIP_LINCONSTYPE_SETPARTITION = 6, /**< linear constraints of the form \f$ \sum x_i = 1\, x_i \in \{0,1\} \forall i \f$ */
65 SCIP_LINCONSTYPE_SETPACKING = 7, /**< linear constraints of the form \f$ \sum x_i \leq 1\, x_i \in \{0,1\} \forall i \f$ */
66 SCIP_LINCONSTYPE_SETCOVERING = 8, /**< linear constraints of the form \f$ \sum x_i \geq 1\, x_i \in \{0,1\} \forall i \f$ */
67 SCIP_LINCONSTYPE_CARDINALITY = 9, /**< linear constraints of the form \f$ \sum x_i = k\, x_i \in \{0,1\} \forall i, \, k\geq 2 \f$ */
68 SCIP_LINCONSTYPE_INVKNAPSACK = 10, /**< linear constraints of the form \f$ \sum x_i \leq b\, x_i \in \{0,1\} \forall i, \, b\in \mathbb{n} \geq 2 \f$ */
69 SCIP_LINCONSTYPE_EQKNAPSACK = 11, /**< linear constraints of the form \f$ \sum a_i x_i = b\, x_i \in \{0,1\} \forall i, \, b\in \mathbb{n} \geq 2 \f$ */
70 SCIP_LINCONSTYPE_BINPACKING = 12, /**< linear constraints of the form \f$ \sum a_i x_i + a x \leq a\, x, x_i \in \{0,1\} \forall i, \, a\in \mathbb{n} \geq 2 \f$ */
71 SCIP_LINCONSTYPE_KNAPSACK = 13, /**< linear constraints of the form \f$ \sum a_k x_k \leq b\, x_i \in \{0,1\} \forall i, \, b\in \mathbb{n} \geq 2 \f$ */
72 SCIP_LINCONSTYPE_INTKNAPSACK = 14, /**< linear constraints of the form \f$ \sum a_k x_k \leq b\, x_i \in \mathbb{Z} \forall i, \, b\in \mathbb{n} \f$ */
73 SCIP_LINCONSTYPE_MIXEDBINARY = 15, /**< linear constraints of the form \f$ \sum a_k x_k + \sum p_j s_j \leq/= b\, x_i \in \{0,1\} \forall i, s_j \in \text{ cont. } \forall j\f$ */
82 * If the copy process was one to one, the valid pointer can be set to TRUE. Otherwise, this pointer has to be set to
83 * FALSE. If all problem defining objects (constraint handlers and variable pricers) return valid = TRUE for all
84 * their copying calls, SCIP assumes that it is an overall one to one copy of the original instance. In this case any
85 * reductions made in the copied SCIP instance can be transfered to the original SCIP instance. If the valid pointer is
86 * set to TRUE and it was not a one to one copy, it might happen that optimal solutions are cut off.
93 #define SCIP_DECL_CONSHDLRCOPY(x) SCIP_RETCODE x (SCIP* scip, SCIP_CONSHDLR* conshdlr, SCIP_Bool* valid)
95 /** destructor of constraint handler to free constraint handler data (called when SCIP is exiting)
111 #define SCIP_DECL_CONSINIT(x) SCIP_RETCODE x (SCIP* scip, SCIP_CONSHDLR* conshdlr, SCIP_CONS** conss, int nconss)
121 #define SCIP_DECL_CONSEXIT(x) SCIP_RETCODE x (SCIP* scip, SCIP_CONSHDLR* conshdlr, SCIP_CONS** conss, int nconss)
123 /** presolving initialization method of constraint handler (called when presolving is about to begin)
125 * This method is called when the presolving process is about to begin, even if presolving is turned off.
128 * Necessary modifications that have to be performed even if presolving is turned off should be done here or in the
131 * @note Note that the constraint array might contain constraints that were created but not added to the problem.
132 * Constraints that are not added, i.e., for which SCIPconsIsAdded() returns FALSE, cannot be used for problem
141 #define SCIP_DECL_CONSINITPRE(x) SCIP_RETCODE x (SCIP* scip, SCIP_CONSHDLR* conshdlr, SCIP_CONS** conss, int nconss)
143 /** presolving deinitialization method of constraint handler (called after presolving has been finished)
145 * This method is called after the presolving has been finished, even if presolving is turned off.
148 * Necessary modifications that have to be performed even if presolving is turned off should be done here or in the
151 * Besides necessary modifications and clean up, no time consuming operations should be performed, especially if the
152 * problem has already been solved. Use the method SCIPgetStatus(), which in this case returns SCIP_STATUS_OPTIMAL,
155 * @note Note that the constraint array might contain constraints that were created but not added to the problem.
156 * Constraints that are not added, i.e., for which SCIPconsIsAdded() returns FALSE, cannot be used for problem
165 #define SCIP_DECL_CONSEXITPRE(x) SCIP_RETCODE x (SCIP* scip, SCIP_CONSHDLR* conshdlr, SCIP_CONS** conss, int nconss)
167 /** solving process initialization method of constraint handler (called when branch and bound process is about to begin)
169 * This method is called when the presolving was finished and the branch and bound process is about to begin.
172 * Besides necessary modifications and clean up, no time consuming operations should be performed, especially if the
173 * problem has already been solved. Use the method SCIPgetStatus(), which in this case returns SCIP_STATUS_OPTIMAL,
176 * @note Note that the constraint array might contain constraints that were created but not added to the problem.
177 * Constraints that are not added, i.e., for which SCIPconsIsAdded() returns FALSE, cannot be used for problem
186 #define SCIP_DECL_CONSINITSOL(x) SCIP_RETCODE x (SCIP* scip, SCIP_CONSHDLR* conshdlr, SCIP_CONS** conss, int nconss)
188 /** solving process deinitialization method of constraint handler (called before branch and bound process data is freed)
191 * The constraint handler should use this call to clean up its branch and bound data, in particular to release
201 #define SCIP_DECL_CONSEXITSOL(x) SCIP_RETCODE x (SCIP* scip, SCIP_CONSHDLR* conshdlr, SCIP_CONS** conss, int nconss, SCIP_Bool restart)
205 * @warning There may exist unprocessed events. For example, a variable's bound may have been already changed, but the
214 #define SCIP_DECL_CONSDELETE(x) SCIP_RETCODE x (SCIP* scip, SCIP_CONSHDLR* conshdlr, SCIP_CONS* cons, SCIP_CONSDATA** consdata)
224 #define SCIP_DECL_CONSTRANS(x) SCIP_RETCODE x (SCIP* scip, SCIP_CONSHDLR* conshdlr, SCIP_CONS* sourcecons, SCIP_CONS** targetcons)
226 /** LP initialization method of constraint handler (called before the initial LP relaxation at a node is solved)
228 * Puts the LP relaxations of all "initial" constraints into the LP. The method should put a canonic LP relaxation
231 * @warning It is not guaranteed that the problem is going to be declared infeasible if the infeasible pointer is set
232 * to TRUE. Therefore, it is recommended that users do not end this method prematurely when an infeasiblity
244 #define SCIP_DECL_CONSINITLP(x) SCIP_RETCODE x (SCIP* scip, SCIP_CONSHDLR* conshdlr, SCIP_CONS** conss, int nconss, SCIP_Bool* infeasible)
248 * Separates all constraints of the constraint handler. The method is called in the LP solution loop,
251 * The first nusefulconss constraints are the ones, that are identified to likely be violated. The separation
252 * method should process only the useful constraints in most runs, and only occasionally the remaining
263 * possible return values for *result (if more than one applies, the first in the list should be used):
268 * - SCIP_NEWROUND : a cutting plane was generated and a new separation round should immediately start
269 * - SCIP_DIDNOTFIND : the separator searched, but did not find domain reductions, cutting planes, or cut constraints
273 #define SCIP_DECL_CONSSEPALP(x) SCIP_RETCODE x (SCIP* scip, SCIP_CONSHDLR* conshdlr, SCIP_CONS** conss, \
278 * Separates all constraints of the constraint handler. The method is called outside the LP solution loop (e.g., by
282 * The first nusefulconss constraints are the ones, that are identified to likely be violated. The separation
283 * method should process only the useful constraints in most runs, and only occasionally the remaining
295 * possible return values for *result (if more than one applies, the first in the list should be used):
300 * - SCIP_NEWROUND : a cutting plane was generated and a new separation round should immediately start
301 * - SCIP_DIDNOTFIND : the separator searched, but did not find domain reductions, cutting planes, or cut constraints
305 #define SCIP_DECL_CONSSEPASOL(x) SCIP_RETCODE x (SCIP* scip, SCIP_CONSHDLR* conshdlr, SCIP_CONS** conss, \
310 * The method is called at the end of the node processing loop for a node where the LP was solved.
311 * The LP solution has to be checked for feasibility. If possible, an infeasibility should be resolved by
312 * branching, reducing a variable's domain to exclude the solution or separating the solution with a valid
315 * The enforcing methods of the active constraint handlers are called in decreasing order of their enforcing
316 * priorities until the first constraint handler returned with the value SCIP_CUTOFF, SCIP_SEPARATED,
318 * The integrality constraint handler has an enforcing priority of zero. A constraint handler which can
319 * (or wants) to enforce its constraints only for integral solutions should have a negative enforcing priority
321 * A constraint handler which wants to incorporate its own branching strategy even on non-integral
322 * solutions must have an enforcing priority greater than zero (e.g. the SOS-constraint incorporates
325 * The first nusefulconss constraints are the ones, that are identified to likely be violated. The enforcing
326 * method should process the useful constraints first. The other nconss - nusefulconss constraints should only
338 * possible return values for *result (if more than one applies, the first in the list should be used):
343 * - SCIP_BRANCHED : no changes were made to the problem, but a branching was applied to resolve an infeasibility
347 #define SCIP_DECL_CONSENFOLP(x) SCIP_RETCODE x (SCIP* scip, SCIP_CONSHDLR* conshdlr, SCIP_CONS** conss, int nconss, int nusefulconss, \
362 * possible return values for *result (if more than one applies, the first in the list should be used):
367 * - SCIP_BRANCHED : no changes were made to the problem, but a branching was applied to resolve an infeasibility
368 * - SCIP_SOLVELP : at least one constraint is infeasible, and this can only be resolved by solving the LP
373 #define SCIP_DECL_CONSENFORELAX(x) SCIP_RETCODE x (SCIP* scip, SCIP_SOL* sol, SCIP_CONSHDLR* conshdlr, SCIP_CONS** conss, int nconss, int nusefulconss, \
378 * The method is called at the end of the node processing loop for a node where the LP was not solved.
379 * The pseudo solution has to be checked for feasibility. If possible, an infeasibility should be resolved by
380 * branching, reducing a variable's domain to exclude the solution or adding an additional constraint.
381 * Separation is not possible, since the LP is not processed at the current node. All LP informations like
384 * Like in the enforcing method for LP solutions, the enforcing methods of the active constraint handlers are
385 * called in decreasing order of their enforcing priorities until the first constraint handler returned with
388 * The first nusefulconss constraints are the ones, that are identified to likely be violated. The enforcing
389 * method should process the useful constraints first. The other nconss - nusefulconss constraints should only
392 * If the pseudo solution's objective value is lower than the lower bound of the node, it cannot be feasible
393 * and the enforcing method may skip it's check and set *result to SCIP_DIDNOTRUN. However, it can also process
406 * possible return values for *result (if more than one applies, the first in the list should be used):
410 * - SCIP_BRANCHED : no changes were made to the problem, but a branching was applied to resolve an infeasibility
411 * - SCIP_SOLVELP : at least one constraint is infeasible, and this can only be resolved by solving the LP
416 #define SCIP_DECL_CONSENFOPS(x) SCIP_RETCODE x (SCIP* scip, SCIP_CONSHDLR* conshdlr, SCIP_CONS** conss, int nconss, int nusefulconss, \
423 * The check methods of the active constraint handlers are called in decreasing order of their check
425 * The integrality constraint handler has a check priority of zero. A constraint handler which can
426 * (or wants) to check its constraints only for integral solutions should have a negative check priority
428 * A constraint handler which wants to check feasibility even on non-integral solutions must have a
429 * check priority greater than zero (e.g. if the check is much faster than testing all variables for
432 * In some cases, integrality conditions or rows of the current LP don't have to be checked, because their
436 * If the solution is not NULL, SCIP should also be informed about the constraint violation with a call to
437 * SCIPupdateSolConsViolation() and additionally SCIPupdateSolLPRowViolation() for every row of the constraint's current
440 * is represented completely by a set of LP rows, meaning that the current constraint violation is equal to the maximum
459 #define SCIP_DECL_CONSCHECK(x) SCIP_RETCODE x (SCIP* scip, SCIP_CONSHDLR* conshdlr, SCIP_CONS** conss, int nconss, SCIP_SOL* sol, \
460 SCIP_Bool checkintegrality, SCIP_Bool checklprows, SCIP_Bool printreason, SCIP_Bool completely, SCIP_RESULT* result)
464 * The first nusefulconss constraints are the ones, that are identified to likely be violated. The propagation
465 * method should process only the useful constraints in most runs, and only occasionally the remaining
468 * @note if the constraint handler uses dual information in propagation it is nesassary to check via calling
469 * SCIPallowDualReds and SCIPallowObjProp if dual reductions and propgation with the current cutoff bound, resp.,
488 * - SCIP_DELAYNODE : the current node should be postponed (return value only valid for BEFORELP propagation)
490 #define SCIP_DECL_CONSPROP(x) SCIP_RETCODE x (SCIP* scip, SCIP_CONSHDLR* conshdlr, SCIP_CONS** conss, int nconss, int nusefulconss, \
507 * - nnewchgvartypes : number of variable type changes since the last call to the presolving method
508 * - nnewchgbds : number of variable bounds tightened since the last call to the presolving method
514 * - nnewchgsides : number of changed left or right hand sides since the last call to the presolving method
516 * @note the counters state the changes since the last call including the changes of this presolving method during its
519 * @note if the constraint handler performs dual presolving it is nesassary to check via calling SCIPallowDualReds
532 * - nchgsides : pointer to count total number of changed left/right hand sides of all presolvers
538 * - SCIP_UNBOUNDED : at least one variable is not bounded by any constraint in obj. direction -> problem is unbounded
539 * - SCIP_CUTOFF : at least one constraint is infeasible in the variable's bounds -> problem is infeasible
545 #define SCIP_DECL_CONSPRESOL(x) SCIP_RETCODE x (SCIP* scip, SCIP_CONSHDLR* conshdlr, SCIP_CONS** conss, int nconss, int nrounds, \
546 SCIP_PRESOLTIMING presoltiming, int nnewfixedvars, int nnewaggrvars, int nnewchgvartypes, int nnewchgbds, int nnewholes, \
549 int* ndelconss, int* naddconss, int* nupgdconss, int* nchgcoefs, int* nchgsides, SCIP_RESULT* result)
553 * This method is called during conflict analysis. If the constraint handler wants to support conflict analysis,
554 * it should call SCIPinferVarLbCons() or SCIPinferVarUbCons() in domain propagation instead of SCIPchgVarLb() or
556 * In the SCIPinferVarLbCons() and SCIPinferVarUbCons() calls, the handler provides the constraint, that deduced the
558 * The propagation conflict resolving method can then be implemented, to provide a "reason" for the bound
559 * changes, i.e., the bounds of variables at the time of the propagation, that forced the constraint to set the
560 * conflict variable's bound to its current value. It can use the "inferinfo" tag to identify its own propagation
561 * rule and thus identify the "reason" bounds. The bounds that form the reason of the assignment must then be provided
562 * by calls to SCIPaddConflictLb(), SCIPaddConflictUb(), SCIPaddConflictBd(), SCIPaddConflictRelaxedLb(),
563 * SCIPaddConflictRelaxedUb(), SCIPaddConflictRelaxedBd(), and/or SCIPaddConflictBinvar() in the propagation conflict
566 * For example, the logicor constraint c = "x or y or z" fixes variable z to TRUE (i.e. changes the lower bound of z
567 * to 1.0), if both, x and y, are assigned to FALSE (i.e. if the upper bounds of these variables are 0.0). It uses
568 * SCIPinferVarLbCons(scip, z, 1.0, c, 0) to apply this assignment (an inference information tag is not needed by the
570 * In the conflict analysis, the constraint handler may be asked to resolve the lower bound change on z with
572 * With a call to SCIPgetVarLbAtIndex(scip, z, bdchgidx, TRUE), the handler can find out, that the lower bound of
573 * variable z was set to 1.0 at the given point of time, and should call SCIPaddConflictUb(scip, x, bdchgidx) and
574 * SCIPaddConflictUb(scip, y, bdchgidx) to tell SCIP, that the upper bounds of x and y at this point of time were
582 * - inferinfo : the user information passed to the corresponding SCIPinferVarLbCons() or SCIPinferVarUbCons() call
584 * - bdchgidx : the index of the bound change, representing the point of time where the change took place
591 * - SCIP_SUCCESS : the conflicting bound change has been successfully resolved by adding all reason bounds
592 * - SCIP_DIDNOTFIND : the conflicting bound change could not be resolved and has to be put into the conflict set
596 #define SCIP_DECL_CONSRESPROP(x) SCIP_RETCODE x (SCIP* scip, SCIP_CONSHDLR* conshdlr, SCIP_CONS* cons, \
597 SCIP_VAR* infervar, int inferinfo, SCIP_BOUNDTYPE boundtype, SCIP_BDCHGIDX* bdchgidx, SCIP_Real relaxedbd, \
603 * It should update the rounding locks of the given type of all associated variables with calls to
607 * potentially rendering the (positive) constraint infeasible and rounding up is potentially rendering the
611 * potentially rendering the constraint's negation infeasible and rounding up is potentially rendering the
613 * - If the constraint may get violated by changing the variable in any direction, it should call
616 * Consider the linear constraint "3x -5y +2z <= 7" as an example. The variable rounding lock method of the
617 * linear constraint handler should call SCIPaddVarLocksType(scip, x, locktype, nlocksneg, nlockspos),
619 * SCIPaddVarLocksType(scip, z, type, nlocksneg, nlockspos) to tell SCIP, that rounding up of x and z and rounding
620 * down of y can destroy the feasibility of the constraint, while rounding down of x and z and rounding up of y can
623 * SCIPaddVarLocksType(scip, ..., nlockspos + nlocksneg, nlockspos + nlocksneg) on all variables, since rounding in both
624 * directions of each variable can destroy both the feasibility of the constraint and it's negation
627 * If the constraint itself contains other constraints as sub constraints (e.g. the "or" constraint concatenation
628 * "c(x) or d(x)"), the rounding lock methods of these constraints should be called in a proper way.
630 * SCIPaddConsLocksType(scip, c, locktype, nlockspos, nlocksneg), saying that infeasibility of c may lead to
631 * infeasibility of the (positive) constraint, and infeasibility of c's negation (i.e. feasibility of c) may lead
633 * - If the constraint may get violated by the feasibility of the sub constraint c, it should call
634 * SCIPaddConsLocksType(scip, c, locktype, nlocksneg, nlockspos), saying that infeasibility of c may lead to
635 * infeasibility of the constraint's negation (i.e. feasibility of the constraint), and infeasibility of c's negation
637 * - If the constraint may get violated by any change in the feasibility of the sub constraint c, it should call
640 * Consider the or concatenation "c(x) or d(x)". The variable rounding lock method of the or constraint handler
642 * SCIPaddConsLocksType(scip, d, locktype, nlockspos, nlocksneg) to tell SCIP, that infeasibility of c and d can lead
645 * As a second example, consider the equivalence constraint "y <-> c(x)" with variable y and constraint c. The
646 * constraint demands, that y == 1 if and only if c(x) is satisfied. The variable lock method of the corresponding
647 * constraint handler should call SCIPaddVarLocksType(scip, y, locktype, nlockspos + nlocksneg, nlockspos + nlocksneg) and
648 * SCIPaddConsLocksType(scip, c, locktype, nlockspos + nlocksneg, nlockspos + nlocksneg), because any modification to the
649 * value of y or to the feasibility of c can alter the feasibility of the equivalence constraint.
654 * - cons : the constraint that should lock rounding of its variables, or NULL if the constraint handler
657 * - nlockspos : number of times, the roundings should be locked for the constraint (may be negative)
658 * - nlocksneg : number of times, the roundings should be locked for the constraint's negation (may be negative)
660 #define SCIP_DECL_CONSLOCK(x) SCIP_RETCODE x (SCIP* scip, SCIP_CONSHDLR* conshdlr, SCIP_CONS* cons, SCIP_LOCKTYPE locktype, int nlockspos, int nlocksneg)
664 * WARNING! There may exist unprocessed events. For example, a variable's bound may have been already changed, but
667 * This method is always called after a constraint of the constraint handler was activated. The constraint
675 #define SCIP_DECL_CONSACTIVE(x) SCIP_RETCODE x (SCIP* scip, SCIP_CONSHDLR* conshdlr, SCIP_CONS* cons)
679 * WARNING! There may exist unprocessed events. For example, a variable's bound may have been already changed, but
682 * This method is always called before a constraint of the constraint handler is deactivated. The constraint
690 #define SCIP_DECL_CONSDEACTIVE(x) SCIP_RETCODE x (SCIP* scip, SCIP_CONSHDLR* conshdlr, SCIP_CONS* cons)
694 * WARNING! There may exist unprocessed events. For example, a variable's bound may have been already changed, but
697 * This method is always called after a constraint of the constraint handler was enabled. The constraint
705 #define SCIP_DECL_CONSENABLE(x) SCIP_RETCODE x (SCIP* scip, SCIP_CONSHDLR* conshdlr, SCIP_CONS* cons)
709 * WARNING! There may exist unprocessed events. For example, a variable's bound may have been already changed, but
712 * This method is always called before a constraint of the constraint handler is disabled. The constraint
720 #define SCIP_DECL_CONSDISABLE(x) SCIP_RETCODE x (SCIP* scip, SCIP_CONSHDLR* conshdlr, SCIP_CONS* cons)
724 * This method is optinal and only of interest if you are using SCIP as a branch-and-price framework. That means, you
725 * are generating new variables during the search. If you are not doing that just define the function pointer to be
728 * If this method gets implemented you should iterate over all constraints of the constraint handler and delete all
737 #define SCIP_DECL_CONSDELVARS(x) SCIP_RETCODE x (SCIP* scip, SCIP_CONSHDLR* conshdlr, SCIP_CONS** conss, int nconss)
741 * The constraint handler can store a representation of the constraint into the given text file. Use the method
744 * @note There are several methods which help to display variables. These are SCIPwriteVarName(), SCIPwriteVarsList(),
753 #define SCIP_DECL_CONSPRINT(x) SCIP_RETCODE x (SCIP* scip, SCIP_CONSHDLR* conshdlr, SCIP_CONS* cons, FILE* file)
757 * The constraint handler can provide a copy method which copies a constraint from one SCIP data structure into an other
758 * SCIP data structure. If a copy of a constraint is created, the constraint has to be captured. (The capture is usually
761 * If the copy process was one to one, the valid pointer can be set to TRUE. Otherwise, you have to set this pointer to
762 * FALSE. In case all problem defining objects (constraint handlers and variable pricers) return a TRUE valid for all
763 * their copying calls, SCIP assumes that it is a overall one to one copy of the original instance. In this case any
764 * reductions made in the copied SCIP instance can be transfered to the original SCIP instance. If the valid pointer is
765 * set to TRUE and it was not a one to one copy, it might happen that optimal solutions are cut off.
776 * - varmap : a SCIP_HASHMAP mapping variables of the source SCIP to corresponding variables of the target SCIP
777 * - consmap : a SCIP_HASHMAP mapping constraints of the source SCIP to corresponding constraints of the target SCIP
795 SCIP* sourcescip, SCIP_CONSHDLR* sourceconshdlr, SCIP_CONS* sourcecons, SCIP_HASHMAP* varmap, SCIP_HASHMAP* consmap, \
796 SCIP_Bool initial, SCIP_Bool separate, SCIP_Bool enforce, SCIP_Bool check, SCIP_Bool propagate, \
797 SCIP_Bool local, SCIP_Bool modifiable, SCIP_Bool dynamic, SCIP_Bool removable, SCIP_Bool stickingatnode, \
802 * The constraint handler can provide a callback to parse the output created by the display method
805 * @note For parsing there are several methods which are handy. Have a look at: SCIPparseVarName(),
806 * SCIPparseVarsList(), SCIPparseVarsLinearsum(), SCIPparseVarsPolynomial(), SCIPstrToRealValue(), and
829 #define SCIP_DECL_CONSPARSE(x) SCIP_RETCODE x (SCIP* scip, SCIP_CONSHDLR* conshdlr, SCIP_CONS** cons, \
831 SCIP_Bool initial, SCIP_Bool separate, SCIP_Bool enforce, SCIP_Bool check, SCIP_Bool propagate, SCIP_Bool local, \
832 SCIP_Bool modifiable, SCIP_Bool dynamic, SCIP_Bool removable, SCIP_Bool stickingatnode, SCIP_Bool* success)
836 * The constraint handler can (this callback is optional) provide this callback to return the variables which are
837 * involved in that particular constraint. If this is possible, the variables should be copyied into the variables
838 * array and the success pointers has to be set to TRUE. Otherwise the success has to be set FALSE or the callback
845 * - varssize : available slots in vars array which is needed to check if the array is large enough
851 #define SCIP_DECL_CONSGETVARS(x) SCIP_RETCODE x (SCIP* scip, SCIP_CONSHDLR* conshdlr, SCIP_CONS* cons, \
856 * The constraint handler can (this callback is optional) provide this callback to return the number variable which are
857 * involved in that particular constraint. If this is not possible, the success pointers has to be set to FALSE or the
867 * - success : pointer to store whether the constraint successfully returned the number of variables
869 #define SCIP_DECL_CONSGETNVARS(x) SCIP_RETCODE x (SCIP* scip, SCIP_CONSHDLR* conshdlr, SCIP_CONS* cons, \
874 * This callback is used inside the various diving heuristics of SCIP and does not affect the normal branching of the
875 * actual search. The constraint handler can provide this callback to render the current solution (even more)
876 * infeasible by suggesting one or several variable bound changes. In fact, since diving heuristics do not necessarily
877 * solve LP relaxations at every probing depth, some of the variable local bounds might already be conflicting with the
878 * solution values. The solution is rendered infeasible by determining bound changes that should be applied to the
879 * next explored search node via SCIPaddDiveBoundChange(). An alternative in case that the preferred bound change(s)
882 * The constraint handler must take care to only add bound changes that further shrink the variable domain.
884 * The success pointer must be used to indicate whether the constraint handler succeeded in selecting diving bound
885 * changes. The infeasible pointer should be set to TRUE if the constraint handler found a local infeasibility. If the
886 * constraint handler needs to select between several candidates, it may use the scoring mechanism of the diveset
891 * @note: @p sol is usually the LP relaxation solution unless the caller of the method, usually a diving heuristic,
901 * - success : pointer to store whether the constraint handler succeeded to determine dive bound changes
902 * - infeasible : pointer to store whether the constraint handler detected an infeasibility in the local node
904 #define SCIP_DECL_CONSGETDIVEBDCHGS(x) SCIP_RETCODE x (SCIP* scip, SCIP_CONSHDLR* conshdlr, SCIP_DIVESET* diveset, \
Definition: struct_cons.h:280
Definition: type_cons.h:72
timing definitions for SCIP
Definition: type_cons.h:68
Definition: type_cons.h:74
Definition: type_cons.h:66
type definitions for return codes for SCIP methods
Definition: type_cons.h:71
type definitions for LP management
Definition: type_cons.h:59
Definition: type_cons.h:61
Definition: struct_cons.h:37
type definitions for primal heuristics
Definition: struct_cons.h:117
type definitions for SCIP's main datastructure
Definition: type_cons.h:67
type definitions for problem variables
Definition: type_cons.h:58
Definition: type_cons.h:63
Definition: type_cons.h:73
type definitions for storing primal CIP solutions
Definition: type_cons.h:62
Definition: type_cons.h:69
Definition: type_cons.h:70
Definition: type_cons.h:64
Definition: struct_cons.h:106
result codes for SCIP callback methods
Definition: type_cons.h:60
common defines and data types used in all packages of SCIP
Definition: type_cons.h:65