Scippy

SCIP

Solving Constraint Integer Programs

branch.h
Go to the documentation of this file.
1 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2 /* */
3 /* This file is part of the program and library */
4 /* SCIP --- Solving Constraint Integer Programs */
5 /* */
6 /* Copyright (C) 2002-2019 Konrad-Zuse-Zentrum */
7 /* fuer Informationstechnik Berlin */
8 /* */
9 /* SCIP is distributed under the terms of the ZIB Academic License. */
10 /* */
11 /* You should have received a copy of the ZIB Academic License */
12 /* along with SCIP; see the file COPYING. If not visit scip.zib.de. */
13 /* */
14 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
15 
16 /**@file branch.h
17  * @ingroup INTERNALAPI
18  * @brief internal methods for branching rules and branching candidate storage
19  * @author Tobias Achterberg
20  */
21 
22 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
23 
24 #ifndef __SCIP_BRANCH_H__
25 #define __SCIP_BRANCH_H__
26 
27 
28 #include "blockmemshell/memory.h"
29 #include "scip/def.h"
30 #include "scip/type_branch.h"
31 #include "scip/type_event.h"
32 #include "scip/type_lp.h"
33 #include "scip/type_message.h"
34 #include "scip/type_prob.h"
35 #include "scip/type_reopt.h"
36 #include "scip/type_result.h"
37 #include "scip/type_retcode.h"
38 #include "scip/type_scip.h"
39 #include "scip/type_sepastore.h"
40 #include "scip/type_set.h"
41 #include "scip/type_stat.h"
42 #include "scip/type_tree.h"
43 #include "scip/type_var.h"
44 
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48 
49 /*
50  * branching candidate storage methods
51  */
52 
53 /** creates a branching candidate storage */
54 extern
56  SCIP_BRANCHCAND** branchcand /**< pointer to store branching candidate storage */
57  );
58 
59 /** frees branching candidate storage */
60 extern
62  SCIP_BRANCHCAND** branchcand /**< pointer to store branching candidate storage */
63  );
64 
65 /** invalidates branching candidates storage */
66 extern
68  SCIP_BRANCHCAND* branchcand /**< pointer to store branching candidate storage */
69  );
70 
71 /** gets branching candidates for LP solution branching (fractional variables) */
72 extern
74  SCIP_BRANCHCAND* branchcand, /**< branching candidate storage */
75  SCIP_SET* set, /**< global SCIP settings */
76  SCIP_STAT* stat, /**< problem statistics */
77  SCIP_LP* lp, /**< current LP data */
78  SCIP_VAR*** lpcands, /**< pointer to store the array of LP branching candidates, or NULL */
79  SCIP_Real** lpcandssol, /**< pointer to store the array of LP candidate solution values, or NULL */
80  SCIP_Real** lpcandsfrac, /**< pointer to store the array of LP candidate fractionalities, or NULL */
81  int* nlpcands, /**< pointer to store the number of LP branching candidates, or NULL */
82  int* npriolpcands, /**< pointer to store the number of candidates with maximal priority, or NULL */
83  int* nfracimplvars /**< pointer to store the number of implicit fractional variables, or NULL */
84  );
85 
86 
87 /** gets external branching candidates */
88 extern
90  SCIP_BRANCHCAND* branchcand, /**< branching candidate storage */
91  SCIP_VAR*** externcands, /**< pointer to store the array of external branching candidates, or NULL */
92  SCIP_Real** externcandssol, /**< pointer to store the array of external candidate solution values, or NULL */
93  SCIP_Real** externcandsscore, /**< pointer to store the array of external candidate scores, or NULL */
94  int* nexterncands, /**< pointer to store the number of external branching candidates, or NULL */
95  int* nprioexterncands, /**< pointer to store the number of candidates with maximal priority, or NULL */
96  int* nprioexternbins, /**< pointer to store the number of binary candidates with maximal priority, or NULL */
97  int* nprioexternints, /**< pointer to store the number of integer candidates with maximal priority, or NULL */
98  int* nprioexternimpls /**< pointer to store the number of implicit integer candidates with maximal priority,
99  * or NULL */
100  );
101 
102 /** gets maximal branching priority of LP branching candidates */
103 extern
105  SCIP_BRANCHCAND* branchcand /**< branching candidate storage */
106  );
107 
108 /** gets number of LP branching candidates with maximal branch priority */
109 extern
111  SCIP_BRANCHCAND* branchcand /**< branching candidate storage */
112  );
113 
114 /** gets maximal branching priority of external branching candidates */
115 extern
117  SCIP_BRANCHCAND* branchcand /**< branching candidate storage */
118  );
119 
120 /** gets number of external branching candidates */
121 extern
123  SCIP_BRANCHCAND* branchcand /**< branching candidate storage */
124  );
125 
126 /** gets number of external branching candidates with maximal branch priority */
127 extern
129  SCIP_BRANCHCAND* branchcand /**< branching candidate storage */
130  );
131 
132 /** gets number of binary external branching candidates with maximal branch priority */
133 extern
135  SCIP_BRANCHCAND* branchcand /**< branching candidate storage */
136  );
137 
138 /** gets number of integer external branching candidates with maximal branch priority */
139 extern
141  SCIP_BRANCHCAND* branchcand /**< branching candidate storage */
142  );
143 
144 /** gets number of implicit integer external branching candidates with maximal branch priority */
145 extern
147  SCIP_BRANCHCAND* branchcand /**< branching candidate storage */
148  );
149 
150 /** gets number of continuous external branching candidates with maximal branch priority */
151 extern
153  SCIP_BRANCHCAND* branchcand /**< branching candidate storage */
154  );
155 
156 /** insert variable, its score and its solution value into the external branching candidate storage
157  * the absolute difference of the current lower and upper bounds of the variable must be at least epsilon
158  */
159 extern
161  SCIP_BRANCHCAND* branchcand, /**< branching candidate storage */
162  SCIP_SET* set, /**< global SCIP settings */
163  SCIP_VAR* var, /**< variable to insert */
164  SCIP_Real score, /**< score of external candidate, e.g. infeasibility */
165  SCIP_Real solval /**< value of the variable in the current solution */
166  );
167 
168 /** removes all external candidates from the storage for external branching */
169 extern
171  SCIP_BRANCHCAND* branchcand /**< branching candidate storage */
172  );
173 
174 /** checks whether the given variable is contained in the candidate storage for external branching */
175 extern
177  SCIP_BRANCHCAND* branchcand, /**< branching candidate storage */
178  SCIP_VAR* var /**< variable to look for */
179  );
180 
181 /** gets branching candidates for pseudo solution branching (non-fixed variables) */
182 extern
184  SCIP_BRANCHCAND* branchcand, /**< branching candidate storage */
185  SCIP_SET* set, /**< global SCIP settings */
186  SCIP_PROB* prob, /**< problem data */
187  SCIP_VAR*** pseudocands, /**< pointer to store the array of pseudo branching candidates, or NULL */
188  int* npseudocands, /**< pointer to store the number of pseudo branching candidates, or NULL */
189  int* npriopseudocands /**< pointer to store the number of candidates with maximal priority, or NULL */
190  );
191 
192 /** gets number of branching candidates for pseudo solution branching (non-fixed variables) */
193 extern
195  SCIP_BRANCHCAND* branchcand /**< branching candidate storage */
196  );
197 
198 /** gets number of branching candidates with maximal branch priority for pseudo solution branching */
199 extern
201  SCIP_BRANCHCAND* branchcand /**< branching candidate storage */
202  );
203 
204 /** gets number of binary branching candidates with maximal branch priority for pseudo solution branching */
205 extern
207  SCIP_BRANCHCAND* branchcand /**< branching candidate storage */
208  );
209 
210 /** gets number of integer branching candidates with maximal branch priority for pseudo solution branching */
211 extern
213  SCIP_BRANCHCAND* branchcand /**< branching candidate storage */
214  );
215 
216 /** gets number of implicit integer branching candidates with maximal branch priority for pseudo solution branching */
217 extern
219  SCIP_BRANCHCAND* branchcand /**< branching candidate storage */
220  );
221 
222 /** removes variable from branching candidate list */
223 extern
225  SCIP_BRANCHCAND* branchcand, /**< branching candidate storage */
226  SCIP_VAR* var /**< variable that changed its bounds */
227  );
228 
229 /** updates branching candidate list for a given variable */
230 extern
232  SCIP_BRANCHCAND* branchcand, /**< branching candidate storage */
233  SCIP_SET* set, /**< global SCIP settings */
234  SCIP_VAR* var /**< variable that changed its bounds */
235  );
236 
237 /** updates branching priority of the given variable and update the pseudo candidate array if needed */
238 extern
240  SCIP_BRANCHCAND* branchcand, /**< branching candidate storage */
241  SCIP_SET* set, /**< global SCIP settings */
242  SCIP_VAR* var, /**< variable that changed its bounds */
243  int branchpriority /**< branch priority of the variable */
244  );
245 
246 
247 
248 
249 /*
250  * branching rules
251  */
252 
253 /** copies the given branchrule to a new scip */
254 extern
256  SCIP_BRANCHRULE* branchrule, /**< branchrule */
257  SCIP_SET* set /**< SCIP_SET of SCIP to copy to */
258  );
259 
260 /** creates a branching rule */
261 extern
263  SCIP_BRANCHRULE** branchrule, /**< pointer to store branching rule */
264  SCIP_SET* set, /**< global SCIP settings */
265  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
266  BMS_BLKMEM* blkmem, /**< block memory for parameter settings */
267  const char* name, /**< name of branching rule */
268  const char* desc, /**< description of branching rule */
269  int priority, /**< priority of the branching rule */
270  int maxdepth, /**< maximal depth level, up to which this branching rule should be used (or -1) */
271  SCIP_Real maxbounddist, /**< maximal relative distance from current node's dual bound to primal bound
272  * compared to best node's dual bound for applying branching rule
273  * (0.0: only on current best node, 1.0: on all nodes) */
274  SCIP_DECL_BRANCHCOPY ((*branchcopy)), /**< copy method of branching rule */
275  SCIP_DECL_BRANCHFREE ((*branchfree)), /**< destructor of branching rule */
276  SCIP_DECL_BRANCHINIT ((*branchinit)), /**< initialize branching rule */
277  SCIP_DECL_BRANCHEXIT ((*branchexit)), /**< deinitialize branching rule */
278  SCIP_DECL_BRANCHINITSOL((*branchinitsol)),/**< solving process initialization method of branching rule */
279  SCIP_DECL_BRANCHEXITSOL((*branchexitsol)),/**< solving process deinitialization method of branching rule */
280  SCIP_DECL_BRANCHEXECLP((*branchexeclp)), /**< branching execution method for fractional LP solutions */
281  SCIP_DECL_BRANCHEXECEXT((*branchexecext)),/**< branching execution method for external solutions */
282  SCIP_DECL_BRANCHEXECPS((*branchexecps)), /**< branching execution method for not completely fixed pseudo solutions */
283  SCIP_BRANCHRULEDATA* branchruledata /**< branching rule data */
284  );
285 
286 /** frees memory of branching rule */
287 extern
289  SCIP_BRANCHRULE** branchrule, /**< pointer to branching rule data structure */
290  SCIP_SET* set /**< global SCIP settings */
291  );
292 
293 /** initializes branching rule */
294 extern
296  SCIP_BRANCHRULE* branchrule, /**< branching rule */
297  SCIP_SET* set /**< global SCIP settings */
298  );
299 
300 /** deinitializes branching rule */
301 extern
303  SCIP_BRANCHRULE* branchrule, /**< branching rule */
304  SCIP_SET* set /**< global SCIP settings */
305  );
306 
307 /** informs branching rule that the branch and bound process is being started */
308 extern
310  SCIP_BRANCHRULE* branchrule, /**< branching rule */
311  SCIP_SET* set /**< global SCIP settings */
312  );
313 
314 /** informs branching rule that the branch and bound process data is being freed */
315 extern
317  SCIP_BRANCHRULE* branchrule, /**< branching rule */
318  SCIP_SET* set /**< global SCIP settings */
319  );
320 
321 /** executes branching rule for fractional LP solution */
322 extern
324  SCIP_BRANCHRULE* branchrule, /**< branching rule */
325  SCIP_SET* set, /**< global SCIP settings */
326  SCIP_STAT* stat, /**< problem statistics */
327  SCIP_TREE* tree, /**< branch and bound tree */
328  SCIP_SEPASTORE* sepastore, /**< separation storage */
329  SCIP_Real cutoffbound, /**< global upper cutoff bound */
330  SCIP_Bool allowaddcons, /**< should adding constraints be allowed to avoid a branching? */
331  SCIP_RESULT* result /**< pointer to store the result of the callback method */
332  );
333 
334 /** executes branching rule for external branching candidates */
335 extern
337  SCIP_BRANCHRULE* branchrule, /**< branching rule */
338  SCIP_SET* set, /**< global SCIP settings */
339  SCIP_STAT* stat, /**< problem statistics */
340  SCIP_TREE* tree, /**< branch and bound tree */
341  SCIP_SEPASTORE* sepastore, /**< separation storage */
342  SCIP_Real cutoffbound, /**< global upper cutoff bound */
343  SCIP_Bool allowaddcons, /**< should adding constraints be allowed to avoid a branching? */
344  SCIP_RESULT* result /**< pointer to store the result of the callback method */
345  );
346 
347 /** executes branching rule for not completely fixed pseudo solution */
348 extern
350  SCIP_BRANCHRULE* branchrule, /**< branching rule */
351  SCIP_SET* set, /**< global SCIP settings */
352  SCIP_STAT* stat, /**< problem statistics */
353  SCIP_TREE* tree, /**< branch and bound tree */
354  SCIP_Real cutoffbound, /**< global upper cutoff bound */
355  SCIP_Bool allowaddcons, /**< should adding constraints be allowed to avoid a branching? */
356  SCIP_RESULT* result /**< pointer to store the result of the callback method */
357  );
358 
359 /** sets priority of branching rule */
360 extern
362  SCIP_BRANCHRULE* branchrule, /**< branching rule */
363  SCIP_SET* set, /**< global SCIP settings */
364  int priority /**< new priority of the branching rule */
365  );
366 
367 /** sets maximal depth level, up to which this branching rule should be used (-1 for no limit) */
368 extern
370  SCIP_BRANCHRULE* branchrule, /**< branching rule */
371  int maxdepth /**< new maxdepth of the branching rule */
372  );
373 
374 /** sets maximal relative distance from current node's dual bound to primal bound for applying branching rule */
375 extern
377  SCIP_BRANCHRULE* branchrule, /**< branching rule */
378  SCIP_Real maxbounddist /**< new maxbounddist of the branching rule */
379  );
380 
381 /** sets copy method of branching rule */
382 extern
384  SCIP_BRANCHRULE* branchrule, /**< branching rule */
385  SCIP_DECL_BRANCHCOPY ((*branchcopy)) /**< copy method of branching rule or NULL if you don't want to copy your plugin into sub-SCIPs */
386  );
387 
388 /** sets destructor method of branching rule */
389 extern
391  SCIP_BRANCHRULE* branchrule, /**< branching rule */
392  SCIP_DECL_BRANCHFREE ((*branchfree)) /**< destructor of branching rule */
393  );
394 
395 /** sets initialization method of branching rule */
396 extern
398  SCIP_BRANCHRULE* branchrule, /**< branching rule */
399  SCIP_DECL_BRANCHINIT ((*branchinit)) /**< initialize branching rule */
400  );
401 
402 /** sets deinitialization method of branching rule */
403 extern
405  SCIP_BRANCHRULE* branchrule, /**< branching rule */
406  SCIP_DECL_BRANCHEXIT ((*branchexit)) /**< deinitialize branching rule */
407  );
408 
409 /** sets solving process initialization method of branching rule */
410 extern
412  SCIP_BRANCHRULE* branchrule, /**< branching rule */
413  SCIP_DECL_BRANCHINITSOL((*branchinitsol)) /**< solving process initialization method of branching rule */
414  );
415 
416 /** sets solving process deinitialization method of branching rule */
417 extern
419  SCIP_BRANCHRULE* branchrule, /**< branching rule */
420  SCIP_DECL_BRANCHEXITSOL((*branchexitsol)) /**< solving process deinitialization method of branching rule */
421  );
422 
423 /** sets branching execution method for fractional LP solutions */
424 extern
426  SCIP_BRANCHRULE* branchrule, /**< branching rule */
427  SCIP_DECL_BRANCHEXECLP((*branchexeclp)) /**< branching execution method for fractional LP solutions */
428  );
429 
430 /** sets branching execution method for external candidates */
431 extern
433  SCIP_BRANCHRULE* branchrule, /**< branching rule */
434  SCIP_DECL_BRANCHEXECEXT((*branchexecext)) /**< branching execution method for external candidates */
435  );
436 
437 /** sets branching execution method for not completely fixed pseudo solutions */
438 extern
440  SCIP_BRANCHRULE* branchrule, /**< branching rule */
441  SCIP_DECL_BRANCHEXECPS((*branchexecps)) /**< branching execution method for not completely fixed pseudo solutions */
442  );
443 
444 /** enables or disables all clocks of \p branchrule, depending on the value of the flag */
445 extern
447  SCIP_BRANCHRULE* branchrule, /**< the branching rule for which all clocks should be enabled or disabled */
448  SCIP_Bool enable /**< should the clocks of the branching rule be enabled? */
449  );
450 
451 /*
452  * branching methods
453  */
454 
455 /** calculates the branching score out of the gain predictions for a binary branching */
456 extern
458  SCIP_SET* set, /**< global SCIP settings */
459  SCIP_VAR* var, /**< variable, of which the branching factor should be applied, or NULL */
460  SCIP_Real downgain, /**< prediction of objective gain for rounding downwards */
461  SCIP_Real upgain /**< prediction of objective gain for rounding upwards */
462  );
463 
464 /** calculates the branching score out of the gain predictions for a branching with arbitrary many children */
465 extern
467  SCIP_SET* set, /**< global SCIP settings */
468  SCIP_VAR* var, /**< variable, of which the branching factor should be applied, or NULL */
469  int nchildren, /**< number of children that the branching will create */
470  SCIP_Real* gains /**< prediction of objective gain for each child */
471  );
472 
473 /** computes a branching point for a (not necessarily discrete) variable
474  * a suggested branching point is first projected onto the box
475  * if no point is suggested, then the value in the current LP or pseudo solution is used
476  * if this value is at infinity, then 0.0 projected onto the bounds and then moved inside the interval is used
477  * for a discrete variable, it is ensured that the returned value is fractional
478  * for a continuous variable, the parameter branching/clamp defines how far a branching point need to be from the bounds of a variable
479  * the latter is only applied if no point has been suggested, or the suggested point is not inside the variable's interval
480  */
481 extern
483  SCIP_SET* set, /**< global SCIP settings */
484  SCIP_TREE* tree, /**< branch and bound tree */
485  SCIP_VAR* var, /**< variable, of which the branching point should be computed */
486  SCIP_Real suggestion /**< suggestion for branching point, or SCIP_INVALID if no suggestion */
487  );
488 
489 /** calls branching rules to branch on an LP solution; if no fractional variables exist, the result is SCIP_DIDNOTRUN;
490  * if the branch priority of an unfixed variable is larger than the maximal branch priority of the fractional
491  * variables, pseudo solution branching is applied on the unfixed variables with maximal branch priority
492  */
493 extern
495  BMS_BLKMEM* blkmem, /**< block memory for parameter settings */
496  SCIP_SET* set, /**< global SCIP settings */
497  SCIP_STAT* stat, /**< problem statistics */
498  SCIP_PROB* transprob, /**< transformed problem after presolve */
499  SCIP_PROB* origprob, /**< original problem */
500  SCIP_TREE* tree, /**< branch and bound tree */
501  SCIP_REOPT* reopt, /**< reoptimization data structure */
502  SCIP_LP* lp, /**< current LP data */
503  SCIP_SEPASTORE* sepastore, /**< separation storage */
504  SCIP_BRANCHCAND* branchcand, /**< branching candidate storage */
505  SCIP_EVENTQUEUE* eventqueue, /**< event queue */
506  SCIP_Real cutoffbound, /**< global upper cutoff bound */
507  SCIP_Bool allowaddcons, /**< should adding constraints be allowed to avoid a branching? */
508  SCIP_RESULT* result /**< pointer to store the result of the branching */
509  );
510 
511 /** calls branching rules to branch on an external solution; if no external branching candidates exist, the result is SCIP_DIDNOTRUN */
512 extern
514  BMS_BLKMEM* blkmem, /**< block memory for parameter settings */
515  SCIP_SET* set, /**< global SCIP settings */
516  SCIP_STAT* stat, /**< problem statistics */
517  SCIP_PROB* transprob, /**< transformed problem after presolve */
518  SCIP_PROB* origprob, /**< original problem */
519  SCIP_TREE* tree, /**< branch and bound tree */
520  SCIP_REOPT* reopt, /**< reoptimization data structure */
521  SCIP_LP* lp, /**< current LP data */
522  SCIP_SEPASTORE* sepastore, /**< separation storage */
523  SCIP_BRANCHCAND* branchcand, /**< branching candidate storage */
524  SCIP_EVENTQUEUE* eventqueue, /**< event queue */
525  SCIP_Real cutoffbound, /**< global upper cutoff bound */
526  SCIP_Bool allowaddcons, /**< should adding constraints be allowed to avoid a branching? */
527  SCIP_RESULT* result /**< pointer to store the result of the branching */
528  );
529 
530 /** calls branching rules to branch on a pseudo solution; if no unfixed variables exist, the result is SCIP_DIDNOTRUN */
531 extern
533  BMS_BLKMEM* blkmem, /**< block memory for parameter settings */
534  SCIP_SET* set, /**< global SCIP settings */
535  SCIP_STAT* stat, /**< problem statistics */
536  SCIP_PROB* transprob, /**< transformed problem after presolve */
537  SCIP_PROB* origprob, /**< original problem */
538  SCIP_TREE* tree, /**< branch and bound tree */
539  SCIP_REOPT* reopt, /**< reoptimization data structure */
540  SCIP_LP* lp, /**< current LP data */
541  SCIP_BRANCHCAND* branchcand, /**< branching candidate storage */
542  SCIP_EVENTQUEUE* eventqueue, /**< event queue */
543  SCIP_Real cutoffbound, /**< global upper cutoff bound */
544  SCIP_Bool allowaddcons, /**< should adding constraints be allowed to avoid a branching? */
545  SCIP_RESULT* result /**< pointer to store the result of the branching */
546  );
547 
548 #ifdef __cplusplus
549 }
550 #endif
551 
552 #endif
enum SCIP_Result SCIP_RESULT
Definition: type_result.h:52
SCIP_RETCODE SCIPbranchExecPseudo(BMS_BLKMEM *blkmem, SCIP_SET *set, SCIP_STAT *stat, SCIP_PROB *transprob, SCIP_PROB *origprob, SCIP_TREE *tree, SCIP_REOPT *reopt, SCIP_LP *lp, SCIP_BRANCHCAND *branchcand, SCIP_EVENTQUEUE *eventqueue, SCIP_Real cutoffbound, SCIP_Bool allowaddcons, SCIP_RESULT *result)
Definition: branch.c:2716
void SCIPbranchruleSetFree(SCIP_BRANCHRULE *branchrule, SCIP_DECL_BRANCHFREE((*branchfree)))
Definition: branch.c:1880
int SCIPbranchcandGetNPrioExternImpls(SCIP_BRANCHCAND *branchcand)
Definition: branch.c:546
int SCIPbranchcandGetNPrioExternBins(SCIP_BRANCHCAND *branchcand)
Definition: branch.c:526
int SCIPbranchcandGetNPseudoCands(SCIP_BRANCHCAND *branchcand)
Definition: branch.c:851
#define SCIP_DECL_BRANCHEXECPS(x)
Definition: type_branch.h:161
int SCIPbranchcandGetExternMaxPrio(SCIP_BRANCHCAND *branchcand)
Definition: branch.c:496
struct SCIP_BranchruleData SCIP_BRANCHRULEDATA
Definition: type_branch.h:43
SCIP_RETCODE SCIPbranchruleExitsol(SCIP_BRANCHRULE *branchrule, SCIP_SET *set)
Definition: branch.c:1509
#define SCIP_DECL_BRANCHFREE(x)
Definition: type_branch.h:60
int SCIPbranchcandGetNExternCands(SCIP_BRANCHCAND *branchcand)
Definition: branch.c:506
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:53
type definitions for global SCIP settings
void SCIPbranchruleSetCopy(SCIP_BRANCHRULE *branchrule, SCIP_DECL_BRANCHCOPY((*branchcopy)))
Definition: branch.c:1869
int SCIPbranchcandGetNPrioExternCands(SCIP_BRANCHCAND *branchcand)
Definition: branch.c:516
#define SCIP_DECL_BRANCHEXECEXT(x)
Definition: type_branch.h:140
type definitions for return codes for SCIP methods
SCIP_RETCODE SCIPbranchcandCreate(SCIP_BRANCHCAND **branchcand)
Definition: branch.c:133
#define SCIP_DECL_BRANCHEXITSOL(x)
Definition: type_branch.h:98
int SCIPbranchcandGetNPrioPseudoImpls(SCIP_BRANCHCAND *branchcand)
Definition: branch.c:891
type definitions for collecting reoptimization information
SCIP_RETCODE SCIPbranchcandGetPseudoCands(SCIP_BRANCHCAND *branchcand, SCIP_SET *set, SCIP_PROB *prob, SCIP_VAR ***pseudocands, int *npseudocands, int *npriopseudocands)
Definition: branch.c:787
void SCIPbranchruleSetInit(SCIP_BRANCHRULE *branchrule, SCIP_DECL_BRANCHINIT((*branchinit)))
Definition: branch.c:1891
void SCIPbranchcandClearExternCands(SCIP_BRANCHCAND *branchcand)
Definition: branch.c:696
type definitions for branching rules
type definitions for problem statistics
type definitions for LP management
SCIP_RETCODE SCIPbranchruleExecPseudoSol(SCIP_BRANCHRULE *branchrule, SCIP_SET *set, SCIP_STAT *stat, SCIP_TREE *tree, SCIP_Real cutoffbound, SCIP_Bool allowaddcons, SCIP_RESULT *result)
Definition: branch.c:1747
int SCIPbranchcandGetNPrioLPCands(SCIP_BRANCHCAND *branchcand)
Definition: branch.c:486
SCIP_Bool SCIPbranchcandContainsExternCand(SCIP_BRANCHCAND *branchcand, SCIP_VAR *var)
Definition: branch.c:711
#define SCIP_DECL_BRANCHINIT(x)
Definition: type_branch.h:68
int SCIPbranchcandGetNPrioExternInts(SCIP_BRANCHCAND *branchcand)
Definition: branch.c:536
SCIP_RETCODE SCIPbranchruleInitsol(SCIP_BRANCHRULE *branchrule, SCIP_SET *set)
Definition: branch.c:1485
SCIP_RETCODE SCIPbranchcandAddExternCand(SCIP_BRANCHCAND *branchcand, SCIP_SET *set, SCIP_VAR *var, SCIP_Real score, SCIP_Real solval)
Definition: branch.c:568
#define SCIP_DECL_BRANCHCOPY(x)
Definition: type_branch.h:52
SCIP_RETCODE SCIPbranchcandGetExternCands(SCIP_BRANCHCAND *branchcand, SCIP_VAR ***externcands, SCIP_Real **externcandssol, SCIP_Real **externcandsscore, int *nexterncands, int *nprioexterncands, int *nprioexternbins, int *nprioexternints, int *nprioexternimpls)
Definition: branch.c:439
type definitions for SCIP&#39;s main datastructure
#define SCIP_DECL_BRANCHINITSOL(x)
Definition: type_branch.h:87
SCIP_RETCODE SCIPbranchcandGetLPCands(SCIP_BRANCHCAND *branchcand, SCIP_SET *set, SCIP_STAT *stat, SCIP_LP *lp, SCIP_VAR ***lpcands, SCIP_Real **lpcandssol, SCIP_Real **lpcandsfrac, int *nlpcands, int *npriolpcands, int *nfracimplvars)
Definition: branch.c:404
#define SCIP_DECL_BRANCHEXECLP(x)
Definition: type_branch.h:119
SCIP_RETCODE SCIPbranchExecLP(BMS_BLKMEM *blkmem, SCIP_SET *set, SCIP_STAT *stat, SCIP_PROB *transprob, SCIP_PROB *origprob, SCIP_TREE *tree, SCIP_REOPT *reopt, SCIP_LP *lp, SCIP_SEPASTORE *sepastore, SCIP_BRANCHCAND *branchcand, SCIP_EVENTQUEUE *eventqueue, SCIP_Real cutoffbound, SCIP_Bool allowaddcons, SCIP_RESULT *result)
Definition: branch.c:2483
SCIP_RETCODE SCIPbranchruleExecLPSol(SCIP_BRANCHRULE *branchrule, SCIP_SET *set, SCIP_STAT *stat, SCIP_TREE *tree, SCIP_SEPASTORE *sepastore, SCIP_Real cutoffbound, SCIP_Bool allowaddcons, SCIP_RESULT *result)
Definition: branch.c:1533
int SCIPbranchcandGetNPrioPseudoCands(SCIP_BRANCHCAND *branchcand)
Definition: branch.c:861
void SCIPbranchruleSetExecLp(SCIP_BRANCHRULE *branchrule, SCIP_DECL_BRANCHEXECLP((*branchexeclp)))
Definition: branch.c:1937
SCIP_Real SCIPbranchGetBranchingPoint(SCIP_SET *set, SCIP_TREE *tree, SCIP_VAR *var, SCIP_Real suggestion)
Definition: branch.c:2287
type definitions for problem variables
type definitions for storing separated cuts
void SCIPbranchruleSetInitsol(SCIP_BRANCHRULE *branchrule, SCIP_DECL_BRANCHINITSOL((*branchinitsol)))
Definition: branch.c:1913
type definitions for managing events
SCIP_RETCODE SCIPbranchruleExecExternSol(SCIP_BRANCHRULE *branchrule, SCIP_SET *set, SCIP_STAT *stat, SCIP_TREE *tree, SCIP_SEPASTORE *sepastore, SCIP_Real cutoffbound, SCIP_Bool allowaddcons, SCIP_RESULT *result)
Definition: branch.c:1640
void SCIPbranchruleSetExecExt(SCIP_BRANCHRULE *branchrule, SCIP_DECL_BRANCHEXECEXT((*branchexecext)))
Definition: branch.c:1948
#define SCIP_Bool
Definition: def.h:69
SCIP_RETCODE SCIPbranchruleExit(SCIP_BRANCHRULE *branchrule, SCIP_SET *set)
Definition: branch.c:1455
SCIP_RETCODE SCIPbranchruleInit(SCIP_BRANCHRULE *branchrule, SCIP_SET *set)
Definition: branch.c:1411
int SCIPbranchcandGetLPMaxPrio(SCIP_BRANCHCAND *branchcand)
Definition: branch.c:476
SCIP_RETCODE SCIPbranchcandFree(SCIP_BRANCHCAND **branchcand)
Definition: branch.c:173
SCIP_RETCODE SCIPbranchruleFree(SCIP_BRANCHRULE **branchrule, SCIP_SET *set)
Definition: branch.c:1384
void SCIPbranchruleSetExecPs(SCIP_BRANCHRULE *branchrule, SCIP_DECL_BRANCHEXECPS((*branchexecps)))
Definition: branch.c:1959
type definitions for branch and bound tree
void SCIPbranchruleSetMaxdepth(SCIP_BRANCHRULE *branchrule, int maxdepth)
Definition: branch.c:2024
void SCIPbranchruleSetPriority(SCIP_BRANCHRULE *branchrule, SCIP_SET *set, int priority)
Definition: branch.c:2000
type definitions for storing and manipulating the main problem
SCIP_RETCODE SCIPbranchcandUpdateVar(SCIP_BRANCHCAND *branchcand, SCIP_SET *set, SCIP_VAR *var)
Definition: branch.c:1135
int SCIPbranchcandGetNPrioExternConts(SCIP_BRANCHCAND *branchcand)
Definition: branch.c:556
void SCIPbranchruleSetExit(SCIP_BRANCHRULE *branchrule, SCIP_DECL_BRANCHEXIT((*branchexit)))
Definition: branch.c:1902
int SCIPbranchcandGetNPrioPseudoInts(SCIP_BRANCHCAND *branchcand)
Definition: branch.c:881
SCIP_Real SCIPbranchGetScoreMultiple(SCIP_SET *set, SCIP_VAR *var, int nchildren, SCIP_Real *gains)
Definition: branch.c:2249
void SCIPbranchruleEnableOrDisableClocks(SCIP_BRANCHRULE *branchrule, SCIP_Bool enable)
Definition: branch.c:2058
#define SCIP_Real
Definition: def.h:157
result codes for SCIP callback methods
void SCIPbranchcandInvalidate(SCIP_BRANCHCAND *branchcand)
Definition: branch.c:192
void SCIPbranchruleSetMaxbounddist(SCIP_BRANCHRULE *branchrule, SCIP_Real maxbounddist)
Definition: branch.c:2046
SCIP_RETCODE SCIPbranchExecExtern(BMS_BLKMEM *blkmem, SCIP_SET *set, SCIP_STAT *stat, SCIP_PROB *transprob, SCIP_PROB *origprob, SCIP_TREE *tree, SCIP_REOPT *reopt, SCIP_LP *lp, SCIP_SEPASTORE *sepastore, SCIP_BRANCHCAND *branchcand, SCIP_EVENTQUEUE *eventqueue, SCIP_Real cutoffbound, SCIP_Bool allowaddcons, SCIP_RESULT *result)
Definition: branch.c:2585
SCIP_RETCODE SCIPbranchruleCopyInclude(SCIP_BRANCHRULE *branchrule, SCIP_SET *set)
Definition: branch.c:1246
type definitions for message output methods
common defines and data types used in all packages of SCIP
struct BMS_BlkMem BMS_BLKMEM
Definition: memory.h:426
int SCIPbranchcandGetNPrioPseudoBins(SCIP_BRANCHCAND *branchcand)
Definition: branch.c:871
SCIP_RETCODE SCIPbranchcandRemoveVar(SCIP_BRANCHCAND *branchcand, SCIP_VAR *var)
Definition: branch.c:1118
SCIP_RETCODE SCIPbranchruleCreate(SCIP_BRANCHRULE **branchrule, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, BMS_BLKMEM *blkmem, const char *name, const char *desc, int priority, int maxdepth, SCIP_Real maxbounddist, SCIP_DECL_BRANCHCOPY((*branchcopy)), SCIP_DECL_BRANCHFREE((*branchfree)), SCIP_DECL_BRANCHINIT((*branchinit)), SCIP_DECL_BRANCHEXIT((*branchexit)), SCIP_DECL_BRANCHINITSOL((*branchinitsol)), SCIP_DECL_BRANCHEXITSOL((*branchexitsol)), SCIP_DECL_BRANCHEXECLP((*branchexeclp)), SCIP_DECL_BRANCHEXECEXT((*branchexecext)), SCIP_DECL_BRANCHEXECPS((*branchexecps)), SCIP_BRANCHRULEDATA *branchruledata)
Definition: branch.c:1348
SCIP_RETCODE SCIPbranchcandUpdateVarBranchPriority(SCIP_BRANCHCAND *branchcand, SCIP_SET *set, SCIP_VAR *var, int branchpriority)
Definition: branch.c:1175
#define SCIP_DECL_BRANCHEXIT(x)
Definition: type_branch.h:76
void SCIPbranchruleSetExitsol(SCIP_BRANCHRULE *branchrule, SCIP_DECL_BRANCHEXITSOL((*branchexitsol)))
Definition: branch.c:1924
SCIP_Real SCIPbranchGetScore(SCIP_SET *set, SCIP_VAR *var, SCIP_Real downgain, SCIP_Real upgain)
Definition: branch.c:2189
memory allocation routines