Scippy

SCIP

Solving Constraint Integer Programs

branch_vanillafullstrong.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-2022 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_vanillafullstrong.h
17  * @ingroup BRANCHINGRULES
18  * @brief vanilla full strong LP branching rule
19  * @author Tobias Achterberg
20  * @author Maxime Gasse
21  *
22  * The vanilla full strong branching rule is a purged implementation of full strong branching, for academic purposes.
23  * It implements full strong branching with the following specific features:
24  * - no cutoff or domain reduction: only branching.
25  * - idempotent (optional): leave SCIP, as much as possible, in the same state before / after the strong branching
26  * calls. Basically, do not update any statistic.
27  * - donotbranch (optional): do no perform branching. So that the brancher can be called as an oracle only (on which
28  * variable would you branch ? But do not branch please).
29  * - scoreall (optional): continue scoring variables, even if infeasibility is detected along the way.
30  * - collectscores (optional): store the candidate scores from the last call, which can then be retrieved by calling
31  * SCIPgetVanillafullstrongData().
32  * - integralcands (optional): get candidates from SCIPgetPseudoBranchCands() instead of SCIPgetLPBranchCands(), i.e.,
33  * consider all non-fixed variables as branching candidates, not only fractional ones.
34  *
35  */
36 
37 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
38 
39 #ifndef __SCIP_BRANCH_VANILLAFULLSTRONG_H__
40 #define __SCIP_BRANCH_VANILLAFULLSTRONG_H__
41 
42 
43 #include "scip/def.h"
44 #include "scip/type_result.h"
45 #include "scip/type_retcode.h"
46 #include "scip/type_scip.h"
47 #include "scip/type_var.h"
48 
49 #ifdef __cplusplus
50 extern "C" {
51 #endif
52 
53 /** creates the vanilla full strong branching rule and includes it in SCIP
54  *
55  * @ingroup BranchingRuleIncludes
56  */
57 SCIP_EXPORT
59  SCIP* scip /**< SCIP data structure */
60  );
61 
62 /** recovers candidate variables and their scores from last vanilla full strong branching call */
63 SCIP_EXPORT
65  SCIP* scip, /**< SCIP data structure */
66  SCIP_VAR*** cands, /**< pointer to store candidate variables; or NULL */
67  SCIP_Real** candscores, /**< pointer to store candidate scores; or NULL */
68  int* ncands, /**< pointer to store number of candidates; or NULL */
69  int* npriocands, /**< pointer to store number of priority candidates; or NULL */
70  int* bestcand /**< pointer to store best branching candidate; or NULL */
71  );
72 
73 
74 #ifdef __cplusplus
75 }
76 #endif
77 
78 #endif
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:54
type definitions for return codes for SCIP methods
type definitions for SCIP&#39;s main datastructure
type definitions for problem variables
SCIP_RETCODE SCIPincludeBranchruleVanillafullstrong(SCIP *scip)
#define SCIP_Real
Definition: def.h:177
result codes for SCIP callback methods
SCIP_RETCODE SCIPgetVanillafullstrongData(SCIP *scip, SCIP_VAR ***cands, SCIP_Real **candscores, int *ncands, int *npriocands, int *bestcand)
common defines and data types used in all packages of SCIP