Scippy

SCIP

Solving Constraint Integer Programs

branch_allfullstrong.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-2015 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 email to scip@zib.de. */
13 /* */
14 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
15 
16 /**@file branch_allfullstrong.h
17  * @ingroup BRANCHINGRULES
18  * @brief all variables full strong LP branching rule
19  * @author Tobias Achterberg
20  *
21  * The all variables full strong branching rule applies strong branching to every non-fixed variable
22  * at the current node of the branch-and-bound search. The rule selects the candidate
23  * which will cause the highest gain of the dual bound in the created sub-tree among all branching variables.
24  *
25  * For calculating the gain, a look-ahead is performed by solving the child node LPs which will result
26  * from branching on a variable.
27  *
28  * For a more mathematical description and a comparison between the strong branching rule and other branching rules
29  * in SCIP, we refer to
30  *
31  * @par
32  * Tobias Achterberg@n
33  * Constraint Integer Programming@n
34  * PhD Thesis, Technische Universität Berlin, 2007@n
35  *
36 
37  */
38 
39 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
40 
41 #ifndef __SCIP_BRANCH_ALLFULLSTRONG_H__
42 #define __SCIP_BRANCH_ALLFULLSTRONG_H__
43 
44 
45 #include "scip/scip.h"
46 
47 #ifdef __cplusplus
48 extern "C" {
49 #endif
50 
51 
52 /**
53  * Selects a variable from a set of candidates by strong branching
54  *
55  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
56  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
57  *
58  * @note The variables in the lpcands array must have a fractional value in the current LP solution
59  */
60 extern
62  SCIP* scip, /**< original SCIP data structure */
63  SCIP_VAR** pseudocands, /**< branching candidates */
64  SCIP_Bool* skipdown, /**< should down branchings be skipped? */
65  SCIP_Bool* skipup, /**< should up branchings be skipped? */
66  int npseudocands, /**< number of branching candidates */
67  int npriopseudocands, /**< number of priority branching candidates */
68  SCIP_Bool allowaddcons, /**< is the branching rule allowed to add constraints? */
69  int* bestpseudocand, /**< best candidate for branching */
70  SCIP_Real* bestdown, /**< objective value of the down branch for bestcand */
71  SCIP_Real* bestup, /**< objective value of the up branch for bestcand */
72  SCIP_Real* bestscore, /**< score for bestcand */
73  SCIP_Bool* bestdownvalid, /**< is bestdown a valid dual bound for the down branch? */
74  SCIP_Bool* bestupvalid, /**< is bestup a valid dual bound for the up branch? */
75  SCIP_Real* provedbound, /**< proved dual bound for current subtree */
76  SCIP_RESULT* result /**< result pointer */
77  );
78 
79 /** creates the all variables full strong LP branching rule and includes it in SCIP */
80 extern
82  SCIP* scip /**< SCIP data structure */
83  );
84 
85 #ifdef __cplusplus
86 }
87 #endif
88 
89 #endif
enum SCIP_Result SCIP_RESULT
Definition: type_result.h:51
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:53
SCIP_RETCODE SCIPselectVarPseudoStrongBranching(SCIP *scip, SCIP_VAR **pseudocands, SCIP_Bool *skipdown, SCIP_Bool *skipup, int npseudocands, int npriopseudocands, SCIP_Bool allowaddcons, int *bestpseudocand, SCIP_Real *bestdown, SCIP_Real *bestup, SCIP_Real *bestscore, SCIP_Bool *bestdownvalid, SCIP_Bool *bestupvalid, SCIP_Real *provedbound, SCIP_RESULT *result)
struct Scip SCIP
Definition: type_scip.h:30
SCIP_RETCODE SCIPincludeBranchruleAllfullstrong(SCIP *scip)
#define SCIP_Bool
Definition: def.h:50
struct SCIP_Var SCIP_VAR
Definition: type_var.h:95
#define SCIP_Real
Definition: def.h:124
SCIP callable library.