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-2020 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 scipopt.org. */
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 */
55  SCIP_BRANCHCAND** branchcand /**< pointer to store branching candidate storage */
56  );
57 
58 /** frees branching candidate storage */
60  SCIP_BRANCHCAND** branchcand /**< pointer to store branching candidate storage */
61  );
62 
63 /** invalidates branching candidates storage */
65  SCIP_BRANCHCAND* branchcand /**< pointer to store branching candidate storage */
66  );
67 
68 /** gets branching candidates for LP solution branching (fractional variables) */
70  SCIP_BRANCHCAND* branchcand, /**< branching candidate storage */
71  SCIP_SET* set, /**< global SCIP settings */
72  SCIP_STAT* stat, /**< problem statistics */
73  SCIP_LP* lp, /**< current LP data */
74  SCIP_VAR*** lpcands, /**< pointer to store the array of LP branching candidates, or NULL */
75  SCIP_Real** lpcandssol, /**< pointer to store the array of LP candidate solution values, or NULL */
76  SCIP_Real** lpcandsfrac, /**< pointer to store the array of LP candidate fractionalities, or NULL */
77  int* nlpcands, /**< pointer to store the number of LP branching candidates, or NULL */
78  int* npriolpcands, /**< pointer to store the number of candidates with maximal priority, or NULL */
79  int* nfracimplvars /**< pointer to store the number of implicit fractional variables, or NULL */
80  );
81 
82 
83 /** gets external branching candidates */
85  SCIP_BRANCHCAND* branchcand, /**< branching candidate storage */
86  SCIP_VAR*** externcands, /**< pointer to store the array of external branching candidates, or NULL */
87  SCIP_Real** externcandssol, /**< pointer to store the array of external candidate solution values, or NULL */
88  SCIP_Real** externcandsscore, /**< pointer to store the array of external candidate scores, or NULL */
89  int* nexterncands, /**< pointer to store the number of external branching candidates, or NULL */
90  int* nprioexterncands, /**< pointer to store the number of candidates with maximal priority, or NULL */
91  int* nprioexternbins, /**< pointer to store the number of binary candidates with maximal priority, or NULL */
92  int* nprioexternints, /**< pointer to store the number of integer candidates with maximal priority, or NULL */
93  int* nprioexternimpls /**< pointer to store the number of implicit integer candidates with maximal priority,
94  * or NULL */
95  );
96 
97 /** gets maximal branching priority of LP branching candidates */
99  SCIP_BRANCHCAND* branchcand /**< branching candidate storage */
100  );
101 
102 /** gets number of LP branching candidates with maximal branch priority */
104  SCIP_BRANCHCAND* branchcand /**< branching candidate storage */
105  );
106 
107 /** gets maximal branching priority of external branching candidates */
109  SCIP_BRANCHCAND* branchcand /**< branching candidate storage */
110  );
111 
112 /** gets number of external branching candidates */
114  SCIP_BRANCHCAND* branchcand /**< branching candidate storage */
115  );
116 
117 /** gets number of external branching candidates with maximal branch priority */
119  SCIP_BRANCHCAND* branchcand /**< branching candidate storage */
120  );
121 
122 /** gets number of binary external branching candidates with maximal branch priority */
124  SCIP_BRANCHCAND* branchcand /**< branching candidate storage */
125  );
126 
127 /** gets number of integer external branching candidates with maximal branch priority */
129  SCIP_BRANCHCAND* branchcand /**< branching candidate storage */
130  );
131 
132 /** gets number of implicit integer external branching candidates with maximal branch priority */
134  SCIP_BRANCHCAND* branchcand /**< branching candidate storage */
135  );
136 
137 /** gets number of continuous external branching candidates with maximal branch priority */
139  SCIP_BRANCHCAND* branchcand /**< branching candidate storage */
140  );
141 
142 /** insert variable, its score and its solution value into the external branching candidate storage
143  * the absolute difference of the current lower and upper bounds of the variable must be at least epsilon
144  */
146  SCIP_BRANCHCAND* branchcand, /**< branching candidate storage */
147  SCIP_SET* set, /**< global SCIP settings */
148  SCIP_VAR* var, /**< variable to insert */
149  SCIP_Real score, /**< score of external candidate, e.g. infeasibility */
150  SCIP_Real solval /**< value of the variable in the current solution */
151  );
152 
153 /** removes all external candidates from the storage for external branching */
155  SCIP_BRANCHCAND* branchcand /**< branching candidate storage */
156  );
157 
158 /** checks whether the given variable is contained in the candidate storage for external branching */
160  SCIP_BRANCHCAND* branchcand, /**< branching candidate storage */
161  SCIP_VAR* var /**< variable to look for */
162  );
163 
164 /** gets branching candidates for pseudo solution branching (non-fixed variables) */
166  SCIP_BRANCHCAND* branchcand, /**< branching candidate storage */
167  SCIP_SET* set, /**< global SCIP settings */
168  SCIP_PROB* prob, /**< problem data */
169  SCIP_VAR*** pseudocands, /**< pointer to store the array of pseudo branching candidates, or NULL */
170  int* npseudocands, /**< pointer to store the number of pseudo branching candidates, or NULL */
171  int* npriopseudocands /**< pointer to store the number of candidates with maximal priority, or NULL */
172  );
173 
174 /** gets number of branching candidates for pseudo solution branching (non-fixed variables) */
176  SCIP_BRANCHCAND* branchcand /**< branching candidate storage */
177  );
178 
179 /** gets number of branching candidates with maximal branch priority for pseudo solution branching */
181  SCIP_BRANCHCAND* branchcand /**< branching candidate storage */
182  );
183 
184 /** gets number of binary branching candidates with maximal branch priority for pseudo solution branching */
186  SCIP_BRANCHCAND* branchcand /**< branching candidate storage */
187  );
188 
189 /** gets number of integer branching candidates with maximal branch priority for pseudo solution branching */
191  SCIP_BRANCHCAND* branchcand /**< branching candidate storage */
192  );
193 
194 /** gets number of implicit integer branching candidates with maximal branch priority for pseudo solution branching */
196  SCIP_BRANCHCAND* branchcand /**< branching candidate storage */
197  );
198 
199 /** removes variable from branching candidate list */
201  SCIP_BRANCHCAND* branchcand, /**< branching candidate storage */
202  SCIP_VAR* var /**< variable that changed its bounds */
203  );
204 
205 /** updates branching candidate list for a given variable */
207  SCIP_BRANCHCAND* branchcand, /**< branching candidate storage */
208  SCIP_SET* set, /**< global SCIP settings */
209  SCIP_VAR* var /**< variable that changed its bounds */
210  );
211 
212 /** updates branching priority of the given variable and update the pseudo candidate array if needed */
214  SCIP_BRANCHCAND* branchcand, /**< branching candidate storage */
215  SCIP_SET* set, /**< global SCIP settings */
216  SCIP_VAR* var, /**< variable that changed its bounds */
217  int branchpriority /**< branch priority of the variable */
218  );
219 
220 
221 
222 
223 /*
224  * branching rules
225  */
226 
227 /** copies the given branchrule to a new scip */
229  SCIP_BRANCHRULE* branchrule, /**< branchrule */
230  SCIP_SET* set /**< SCIP_SET of SCIP to copy to */
231  );
232 
233 /** creates a branching rule */
235  SCIP_BRANCHRULE** branchrule, /**< pointer to store branching rule */
236  SCIP_SET* set, /**< global SCIP settings */
237  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
238  BMS_BLKMEM* blkmem, /**< block memory for parameter settings */
239  const char* name, /**< name of branching rule */
240  const char* desc, /**< description of branching rule */
241  int priority, /**< priority of the branching rule */
242  int maxdepth, /**< maximal depth level, up to which this branching rule should be used (or -1) */
243  SCIP_Real maxbounddist, /**< maximal relative distance from current node's dual bound to primal bound
244  * compared to best node's dual bound for applying branching rule
245  * (0.0: only on current best node, 1.0: on all nodes) */
246  SCIP_DECL_BRANCHCOPY ((*branchcopy)), /**< copy method of branching rule */
247  SCIP_DECL_BRANCHFREE ((*branchfree)), /**< destructor of branching rule */
248  SCIP_DECL_BRANCHINIT ((*branchinit)), /**< initialize branching rule */
249  SCIP_DECL_BRANCHEXIT ((*branchexit)), /**< deinitialize branching rule */
250  SCIP_DECL_BRANCHINITSOL((*branchinitsol)),/**< solving process initialization method of branching rule */
251  SCIP_DECL_BRANCHEXITSOL((*branchexitsol)),/**< solving process deinitialization method of branching rule */
252  SCIP_DECL_BRANCHEXECLP((*branchexeclp)), /**< branching execution method for fractional LP solutions */
253  SCIP_DECL_BRANCHEXECEXT((*branchexecext)),/**< branching execution method for external solutions */
254  SCIP_DECL_BRANCHEXECPS((*branchexecps)), /**< branching execution method for not completely fixed pseudo solutions */
255  SCIP_BRANCHRULEDATA* branchruledata /**< branching rule data */
256  );
257 
258 /** frees memory of branching rule */
260  SCIP_BRANCHRULE** branchrule, /**< pointer to branching rule data structure */
261  SCIP_SET* set /**< global SCIP settings */
262  );
263 
264 /** initializes branching rule */
266  SCIP_BRANCHRULE* branchrule, /**< branching rule */
267  SCIP_SET* set /**< global SCIP settings */
268  );
269 
270 /** deinitializes branching rule */
272  SCIP_BRANCHRULE* branchrule, /**< branching rule */
273  SCIP_SET* set /**< global SCIP settings */
274  );
275 
276 /** informs branching rule that the branch and bound process is being started */
278  SCIP_BRANCHRULE* branchrule, /**< branching rule */
279  SCIP_SET* set /**< global SCIP settings */
280  );
281 
282 /** informs branching rule that the branch and bound process data is being freed */
284  SCIP_BRANCHRULE* branchrule, /**< branching rule */
285  SCIP_SET* set /**< global SCIP settings */
286  );
287 
288 /** executes branching rule for fractional LP solution */
290  SCIP_BRANCHRULE* branchrule, /**< branching rule */
291  SCIP_SET* set, /**< global SCIP settings */
292  SCIP_STAT* stat, /**< problem statistics */
293  SCIP_TREE* tree, /**< branch and bound tree */
294  SCIP_SEPASTORE* sepastore, /**< separation storage */
295  SCIP_Real cutoffbound, /**< global upper cutoff bound */
296  SCIP_Bool allowaddcons, /**< should adding constraints be allowed to avoid a branching? */
297  SCIP_RESULT* result /**< pointer to store the result of the callback method */
298  );
299 
300 /** executes branching rule for external branching candidates */
302  SCIP_BRANCHRULE* branchrule, /**< branching rule */
303  SCIP_SET* set, /**< global SCIP settings */
304  SCIP_STAT* stat, /**< problem statistics */
305  SCIP_TREE* tree, /**< branch and bound tree */
306  SCIP_SEPASTORE* sepastore, /**< separation storage */
307  SCIP_Real cutoffbound, /**< global upper cutoff bound */
308  SCIP_Bool allowaddcons, /**< should adding constraints be allowed to avoid a branching? */
309  SCIP_RESULT* result /**< pointer to store the result of the callback method */
310  );
311 
312 /** executes branching rule for not completely fixed pseudo solution */
314  SCIP_BRANCHRULE* branchrule, /**< branching rule */
315  SCIP_SET* set, /**< global SCIP settings */
316  SCIP_STAT* stat, /**< problem statistics */
317  SCIP_TREE* tree, /**< branch and bound tree */
318  SCIP_Real cutoffbound, /**< global upper cutoff bound */
319  SCIP_Bool allowaddcons, /**< should adding constraints be allowed to avoid a branching? */
320  SCIP_RESULT* result /**< pointer to store the result of the callback method */
321  );
322 
323 /** sets priority of branching rule */
325  SCIP_BRANCHRULE* branchrule, /**< branching rule */
326  SCIP_SET* set, /**< global SCIP settings */
327  int priority /**< new priority of the branching rule */
328  );
329 
330 /** sets maximal depth level, up to which this branching rule should be used (-1 for no limit) */
332  SCIP_BRANCHRULE* branchrule, /**< branching rule */
333  int maxdepth /**< new maxdepth of the branching rule */
334  );
335 
336 /** sets maximal relative distance from current node's dual bound to primal bound for applying branching rule */
338  SCIP_BRANCHRULE* branchrule, /**< branching rule */
339  SCIP_Real maxbounddist /**< new maxbounddist of the branching rule */
340  );
341 
342 /** sets copy method of branching rule */
344  SCIP_BRANCHRULE* branchrule, /**< branching rule */
345  SCIP_DECL_BRANCHCOPY ((*branchcopy)) /**< copy method of branching rule or NULL if you don't want to copy your plugin into sub-SCIPs */
346  );
347 
348 /** sets destructor method of branching rule */
350  SCIP_BRANCHRULE* branchrule, /**< branching rule */
351  SCIP_DECL_BRANCHFREE ((*branchfree)) /**< destructor of branching rule */
352  );
353 
354 /** sets initialization method of branching rule */
356  SCIP_BRANCHRULE* branchrule, /**< branching rule */
357  SCIP_DECL_BRANCHINIT ((*branchinit)) /**< initialize branching rule */
358  );
359 
360 /** sets deinitialization method of branching rule */
362  SCIP_BRANCHRULE* branchrule, /**< branching rule */
363  SCIP_DECL_BRANCHEXIT ((*branchexit)) /**< deinitialize branching rule */
364  );
365 
366 /** sets solving process initialization method of branching rule */
368  SCIP_BRANCHRULE* branchrule, /**< branching rule */
369  SCIP_DECL_BRANCHINITSOL((*branchinitsol)) /**< solving process initialization method of branching rule */
370  );
371 
372 /** sets solving process deinitialization method of branching rule */
374  SCIP_BRANCHRULE* branchrule, /**< branching rule */
375  SCIP_DECL_BRANCHEXITSOL((*branchexitsol)) /**< solving process deinitialization method of branching rule */
376  );
377 
378 /** sets branching execution method for fractional LP solutions */
380  SCIP_BRANCHRULE* branchrule, /**< branching rule */
381  SCIP_DECL_BRANCHEXECLP((*branchexeclp)) /**< branching execution method for fractional LP solutions */
382  );
383 
384 /** sets branching execution method for external candidates */
386  SCIP_BRANCHRULE* branchrule, /**< branching rule */
387  SCIP_DECL_BRANCHEXECEXT((*branchexecext)) /**< branching execution method for external candidates */
388  );
389 
390 /** sets branching execution method for not completely fixed pseudo solutions */
392  SCIP_BRANCHRULE* branchrule, /**< branching rule */
393  SCIP_DECL_BRANCHEXECPS((*branchexecps)) /**< branching execution method for not completely fixed pseudo solutions */
394  );
395 
396 /** enables or disables all clocks of \p branchrule, depending on the value of the flag */
398  SCIP_BRANCHRULE* branchrule, /**< the branching rule for which all clocks should be enabled or disabled */
399  SCIP_Bool enable /**< should the clocks of the branching rule be enabled? */
400  );
401 
402 /*
403  * branching methods
404  */
405 
406 /** calculates the branching score out of the gain predictions for a binary branching */
408  SCIP_SET* set, /**< global SCIP settings */
409  SCIP_VAR* var, /**< variable, of which the branching factor should be applied, or NULL */
410  SCIP_Real downgain, /**< prediction of objective gain for rounding downwards */
411  SCIP_Real upgain /**< prediction of objective gain for rounding upwards */
412  );
413 
414 /** calculates the branching score out of the gain predictions for a branching with arbitrary many children */
416  SCIP_SET* set, /**< global SCIP settings */
417  SCIP_VAR* var, /**< variable, of which the branching factor should be applied, or NULL */
418  int nchildren, /**< number of children that the branching will create */
419  SCIP_Real* gains /**< prediction of objective gain for each child */
420  );
421 
422 /** computes a branching point for a (not necessarily discrete) variable
423  * a suggested branching point is first projected onto the box
424  * if no point is suggested, then the value in the current LP or pseudo solution is used
425  * if this value is at infinity, then 0.0 projected onto the bounds and then moved inside the interval is used
426  * for a discrete variable, it is ensured that the returned value is fractional
427  * for a continuous variable, the parameter branching/clamp defines how far a branching point need to be from the bounds of a variable
428  * the latter is only applied if no point has been suggested, or the suggested point is not inside the variable's interval
429  */
431  SCIP_SET* set, /**< global SCIP settings */
432  SCIP_TREE* tree, /**< branch and bound tree */
433  SCIP_VAR* var, /**< variable, of which the branching point should be computed */
434  SCIP_Real suggestion /**< suggestion for branching point, or SCIP_INVALID if no suggestion */
435  );
436 
437 /** calls branching rules to branch on an LP solution; if no fractional variables exist, the result is SCIP_DIDNOTRUN;
438  * if the branch priority of an unfixed variable is larger than the maximal branch priority of the fractional
439  * variables, pseudo solution branching is applied on the unfixed variables with maximal branch priority
440  */
442  BMS_BLKMEM* blkmem, /**< block memory for parameter settings */
443  SCIP_SET* set, /**< global SCIP settings */
444  SCIP_STAT* stat, /**< problem statistics */
445  SCIP_PROB* transprob, /**< transformed problem after presolve */
446  SCIP_PROB* origprob, /**< original problem */
447  SCIP_TREE* tree, /**< branch and bound tree */
448  SCIP_REOPT* reopt, /**< reoptimization data structure */
449  SCIP_LP* lp, /**< current LP data */
450  SCIP_SEPASTORE* sepastore, /**< separation storage */
451  SCIP_BRANCHCAND* branchcand, /**< branching candidate storage */
452  SCIP_EVENTQUEUE* eventqueue, /**< event queue */
453  SCIP_Real cutoffbound, /**< global upper cutoff bound */
454  SCIP_Bool allowaddcons, /**< should adding constraints be allowed to avoid a branching? */
455  SCIP_RESULT* result /**< pointer to store the result of the branching */
456  );
457 
458 /** calls branching rules to branch on an external solution; if no external branching candidates exist, the result is SCIP_DIDNOTRUN */
460  BMS_BLKMEM* blkmem, /**< block memory for parameter settings */
461  SCIP_SET* set, /**< global SCIP settings */
462  SCIP_STAT* stat, /**< problem statistics */
463  SCIP_PROB* transprob, /**< transformed problem after presolve */
464  SCIP_PROB* origprob, /**< original problem */
465  SCIP_TREE* tree, /**< branch and bound tree */
466  SCIP_REOPT* reopt, /**< reoptimization data structure */
467  SCIP_LP* lp, /**< current LP data */
468  SCIP_SEPASTORE* sepastore, /**< separation storage */
469  SCIP_BRANCHCAND* branchcand, /**< branching candidate storage */
470  SCIP_EVENTQUEUE* eventqueue, /**< event queue */
471  SCIP_Real cutoffbound, /**< global upper cutoff bound */
472  SCIP_Bool allowaddcons, /**< should adding constraints be allowed to avoid a branching? */
473  SCIP_RESULT* result /**< pointer to store the result of the branching */
474  );
475 
476 /** calls branching rules to branch on a pseudo solution; if no unfixed variables exist, the result is SCIP_DIDNOTRUN */
478  BMS_BLKMEM* blkmem, /**< block memory for parameter settings */
479  SCIP_SET* set, /**< global SCIP settings */
480  SCIP_STAT* stat, /**< problem statistics */
481  SCIP_PROB* transprob, /**< transformed problem after presolve */
482  SCIP_PROB* origprob, /**< original problem */
483  SCIP_TREE* tree, /**< branch and bound tree */
484  SCIP_REOPT* reopt, /**< reoptimization data structure */
485  SCIP_LP* lp, /**< current LP data */
486  SCIP_BRANCHCAND* branchcand, /**< branching candidate storage */
487  SCIP_EVENTQUEUE* eventqueue, /**< event queue */
488  SCIP_Real cutoffbound, /**< global upper cutoff bound */
489  SCIP_Bool allowaddcons, /**< should adding constraints be allowed to avoid a branching? */
490  SCIP_RESULT* result /**< pointer to store the result of the branching */
491  );
492 
493 #ifdef __cplusplus
494 }
495 #endif
496 
497 #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:2747
void SCIPbranchruleSetFree(SCIP_BRANCHRULE *branchrule, SCIP_DECL_BRANCHFREE((*branchfree)))
Definition: branch.c:1881
int SCIPbranchcandGetNPrioExternImpls(SCIP_BRANCHCAND *branchcand)
Definition: branch.c:547
int SCIPbranchcandGetNPrioExternBins(SCIP_BRANCHCAND *branchcand)
Definition: branch.c:527
int SCIPbranchcandGetNPseudoCands(SCIP_BRANCHCAND *branchcand)
Definition: branch.c:852
#define SCIP_DECL_BRANCHEXECPS(x)
Definition: type_branch.h:167
int SCIPbranchcandGetExternMaxPrio(SCIP_BRANCHCAND *branchcand)
Definition: branch.c:497
struct SCIP_BranchruleData SCIP_BRANCHRULEDATA
Definition: type_branch.h:48
SCIP_RETCODE SCIPbranchruleExitsol(SCIP_BRANCHRULE *branchrule, SCIP_SET *set)
Definition: branch.c:1510
#define SCIP_DECL_BRANCHFREE(x)
Definition: type_branch.h:66
int SCIPbranchcandGetNExternCands(SCIP_BRANCHCAND *branchcand)
Definition: branch.c:507
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:54
type definitions for global SCIP settings
void SCIPbranchruleSetCopy(SCIP_BRANCHRULE *branchrule, SCIP_DECL_BRANCHCOPY((*branchcopy)))
Definition: branch.c:1870
int SCIPbranchcandGetNPrioExternCands(SCIP_BRANCHCAND *branchcand)
Definition: branch.c:517
#define SCIP_DECL_BRANCHEXECEXT(x)
Definition: type_branch.h:146
type definitions for return codes for SCIP methods
SCIP_RETCODE SCIPbranchcandCreate(SCIP_BRANCHCAND **branchcand)
Definition: branch.c:134
#define SCIP_DECL_BRANCHEXITSOL(x)
Definition: type_branch.h:104
int SCIPbranchcandGetNPrioPseudoImpls(SCIP_BRANCHCAND *branchcand)
Definition: branch.c:892
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:788
void SCIPbranchruleSetInit(SCIP_BRANCHRULE *branchrule, SCIP_DECL_BRANCHINIT((*branchinit)))
Definition: branch.c:1892
void SCIPbranchcandClearExternCands(SCIP_BRANCHCAND *branchcand)
Definition: branch.c:697
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:1748
int SCIPbranchcandGetNPrioLPCands(SCIP_BRANCHCAND *branchcand)
Definition: branch.c:487
SCIP_Bool SCIPbranchcandContainsExternCand(SCIP_BRANCHCAND *branchcand, SCIP_VAR *var)
Definition: branch.c:712
#define SCIP_DECL_BRANCHINIT(x)
Definition: type_branch.h:74
int SCIPbranchcandGetNPrioExternInts(SCIP_BRANCHCAND *branchcand)
Definition: branch.c:537
SCIP_RETCODE SCIPbranchruleInitsol(SCIP_BRANCHRULE *branchrule, SCIP_SET *set)
Definition: branch.c:1486
SCIP_RETCODE SCIPbranchcandAddExternCand(SCIP_BRANCHCAND *branchcand, SCIP_SET *set, SCIP_VAR *var, SCIP_Real score, SCIP_Real solval)
Definition: branch.c:569
#define SCIP_DECL_BRANCHCOPY(x)
Definition: type_branch.h:58
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:440
type definitions for SCIP&#39;s main datastructure
#define SCIP_DECL_BRANCHINITSOL(x)
Definition: type_branch.h:93
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:405
#define SCIP_DECL_BRANCHEXECLP(x)
Definition: type_branch.h:125
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:2514
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:1534
int SCIPbranchcandGetNPrioPseudoCands(SCIP_BRANCHCAND *branchcand)
Definition: branch.c:862
void SCIPbranchruleSetExecLp(SCIP_BRANCHRULE *branchrule, SCIP_DECL_BRANCHEXECLP((*branchexeclp)))
Definition: branch.c:1938
SCIP_Real SCIPbranchGetBranchingPoint(SCIP_SET *set, SCIP_TREE *tree, SCIP_VAR *var, SCIP_Real suggestion)
Definition: branch.c:2288
type definitions for problem variables
type definitions for storing separated cuts
void SCIPbranchruleSetInitsol(SCIP_BRANCHRULE *branchrule, SCIP_DECL_BRANCHINITSOL((*branchinitsol)))
Definition: branch.c:1914
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:1641
void SCIPbranchruleSetExecExt(SCIP_BRANCHRULE *branchrule, SCIP_DECL_BRANCHEXECEXT((*branchexecext)))
Definition: branch.c:1949
#define SCIP_Bool
Definition: def.h:70
SCIP_RETCODE SCIPbranchruleExit(SCIP_BRANCHRULE *branchrule, SCIP_SET *set)
Definition: branch.c:1456
SCIP_RETCODE SCIPbranchruleInit(SCIP_BRANCHRULE *branchrule, SCIP_SET *set)
Definition: branch.c:1412
int SCIPbranchcandGetLPMaxPrio(SCIP_BRANCHCAND *branchcand)
Definition: branch.c:477
SCIP_RETCODE SCIPbranchcandFree(SCIP_BRANCHCAND **branchcand)
Definition: branch.c:174
SCIP_RETCODE SCIPbranchruleFree(SCIP_BRANCHRULE **branchrule, SCIP_SET *set)
Definition: branch.c:1385
void SCIPbranchruleSetExecPs(SCIP_BRANCHRULE *branchrule, SCIP_DECL_BRANCHEXECPS((*branchexecps)))
Definition: branch.c:1960
type definitions for branch and bound tree
void SCIPbranchruleSetMaxdepth(SCIP_BRANCHRULE *branchrule, int maxdepth)
Definition: branch.c:2025
void SCIPbranchruleSetPriority(SCIP_BRANCHRULE *branchrule, SCIP_SET *set, int priority)
Definition: branch.c:2001
type definitions for storing and manipulating the main problem
SCIP_RETCODE SCIPbranchcandUpdateVar(SCIP_BRANCHCAND *branchcand, SCIP_SET *set, SCIP_VAR *var)
Definition: branch.c:1136
int SCIPbranchcandGetNPrioExternConts(SCIP_BRANCHCAND *branchcand)
Definition: branch.c:557
void SCIPbranchruleSetExit(SCIP_BRANCHRULE *branchrule, SCIP_DECL_BRANCHEXIT((*branchexit)))
Definition: branch.c:1903
int SCIPbranchcandGetNPrioPseudoInts(SCIP_BRANCHCAND *branchcand)
Definition: branch.c:882
SCIP_Real SCIPbranchGetScoreMultiple(SCIP_SET *set, SCIP_VAR *var, int nchildren, SCIP_Real *gains)
Definition: branch.c:2250
void SCIPbranchruleEnableOrDisableClocks(SCIP_BRANCHRULE *branchrule, SCIP_Bool enable)
Definition: branch.c:2059
#define SCIP_Real
Definition: def.h:163
result codes for SCIP callback methods
void SCIPbranchcandInvalidate(SCIP_BRANCHCAND *branchcand)
Definition: branch.c:193
void SCIPbranchruleSetMaxbounddist(SCIP_BRANCHRULE *branchrule, SCIP_Real maxbounddist)
Definition: branch.c:2047
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:2616
SCIP_RETCODE SCIPbranchruleCopyInclude(SCIP_BRANCHRULE *branchrule, SCIP_SET *set)
Definition: branch.c:1247
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:429
int SCIPbranchcandGetNPrioPseudoBins(SCIP_BRANCHCAND *branchcand)
Definition: branch.c:872
SCIP_RETCODE SCIPbranchcandRemoveVar(SCIP_BRANCHCAND *branchcand, SCIP_VAR *var)
Definition: branch.c:1119
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:1349
SCIP_RETCODE SCIPbranchcandUpdateVarBranchPriority(SCIP_BRANCHCAND *branchcand, SCIP_SET *set, SCIP_VAR *var, int branchpriority)
Definition: branch.c:1176
#define SCIP_DECL_BRANCHEXIT(x)
Definition: type_branch.h:82
void SCIPbranchruleSetExitsol(SCIP_BRANCHRULE *branchrule, SCIP_DECL_BRANCHEXITSOL((*branchexitsol)))
Definition: branch.c:1925
SCIP_Real SCIPbranchGetScore(SCIP_SET *set, SCIP_VAR *var, SCIP_Real downgain, SCIP_Real upgain)
Definition: branch.c:2190
memory allocation routines