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-2023 Zuse Institute Berlin (ZIB) */
7 /* */
8 /* Licensed under the Apache License, Version 2.0 (the "License"); */
9 /* you may not use this file except in compliance with the License. */
10 /* You may obtain a copy of the License at */
11 /* */
12 /* http://www.apache.org/licenses/LICENSE-2.0 */
13 /* */
14 /* Unless required by applicable law or agreed to in writing, software */
15 /* distributed under the License is distributed on an "AS IS" BASIS, */
16 /* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */
17 /* See the License for the specific language governing permissions and */
18 /* limitations under the License. */
19 /* */
20 /* You should have received a copy of the Apache-2.0 license */
21 /* along with SCIP; see the file LICENSE. If not visit scipopt.org. */
22 /* */
23 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
24 
25 /**@file branch_vanillafullstrong.h
26  * @ingroup BRANCHINGRULES
27  * @brief vanilla full strong LP branching rule
28  * @author Tobias Achterberg
29  * @author Maxime Gasse
30  *
31  * The vanilla full strong branching rule is a purged implementation of full strong branching, for academic purposes.
32  * It implements full strong branching with the following specific features:
33  * - no cutoff or domain reduction: only branching.
34  * - idempotent (optional): leave SCIP, as much as possible, in the same state before / after the strong branching
35  * calls. Basically, do not update any statistic.
36  * - donotbranch (optional): do no perform branching. So that the brancher can be called as an oracle only (on which
37  * variable would you branch ? But do not branch please).
38  * - scoreall (optional): continue scoring variables, even if infeasibility is detected along the way.
39  * - collectscores (optional): store the candidate scores from the last call, which can then be retrieved by calling
40  * SCIPgetVanillafullstrongData().
41  * - integralcands (optional): get candidates from SCIPgetPseudoBranchCands() instead of SCIPgetLPBranchCands(), i.e.,
42  * consider all non-fixed variables as branching candidates, not only fractional ones.
43  *
44  */
45 
46 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
47 
48 #ifndef __SCIP_BRANCH_VANILLAFULLSTRONG_H__
49 #define __SCIP_BRANCH_VANILLAFULLSTRONG_H__
50 
51 
52 #include "scip/def.h"
53 #include "scip/type_result.h"
54 #include "scip/type_retcode.h"
55 #include "scip/type_scip.h"
56 #include "scip/type_var.h"
57 
58 #ifdef __cplusplus
59 extern "C" {
60 #endif
61 
62 /** creates the vanilla full strong branching rule and includes it in SCIP
63  *
64  * @ingroup BranchingRuleIncludes
65  */
66 SCIP_EXPORT
68  SCIP* scip /**< SCIP data structure */
69  );
70 
71 /** recovers candidate variables and their scores from last vanilla full strong branching call */
72 SCIP_EXPORT
74  SCIP* scip, /**< SCIP data structure */
75  SCIP_VAR*** cands, /**< pointer to store candidate variables; or NULL */
76  SCIP_Real** candscores, /**< pointer to store candidate scores; or NULL */
77  int* ncands, /**< pointer to store number of candidates; or NULL */
78  int* npriocands, /**< pointer to store number of priority candidates; or NULL */
79  int* bestcand /**< pointer to store best branching candidate; or NULL */
80  );
81 
82 
83 #ifdef __cplusplus
84 }
85 #endif
86 
87 #endif
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:63
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:186
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