Scippy

SCIP

Solving Constraint Integer Programs

cons_disjunction.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-2017 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 cons_disjunction.h
17  * @ingroup CONSHDLRS
18  * @brief constraint handler for disjunction constraints
19  * @author Stefan Heinz
20  * @author Michael Winkler
21  *
22  */
23 
24 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
25 
26 #ifndef __SCIP_CONS_DISJUNCTION_H__
27 #define __SCIP_CONS_DISJUNCTION_H__
28 
29 
30 #include "scip/scip.h"
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
36 /** creates the handler for disjunction constraints and includes it in SCIP
37  *
38  * @ingroup ConshdlrIncludes
39  * */
40 extern
41 SCIP_RETCODE SCIPincludeConshdlrDisjunction(
42  SCIP* scip /**< SCIP data structure */
43  );
44 
45 /**@addtogroup CONSHDLRS
46  *
47  * @{
48  *
49  * @name Disjunction Constraints
50  *
51  * @{
52  *
53  * A disjunction constraint \f$ C \f$ is a constraint of the form
54  * \f[
55  * C = C_1 \vee \dots \vee C_n
56  * \f]
57  * where all the \f$ C_i \f$ are individual constraints themselves.
58  */
59 
60 /** creates and captures a disjunction constraint
61  *
62  * @note the constraint gets captured, hence at one point you have to release it using the method SCIPreleaseCons()
63  */
64 extern
65 SCIP_RETCODE SCIPcreateConsDisjunction(
66  SCIP* scip, /**< SCIP data structure */
67  SCIP_CONS** cons, /**< pointer to hold the created constraint */
68  const char* name, /**< name of constraint */
69  int nconss, /**< number of initial constraints in disjunction */
70  SCIP_CONS** conss, /**< initial constraint in disjunction */
71  SCIP_CONS* relaxcons, /**< a conjunction constraint containing the linear relaxation of the disjunction constraint, or NULL */
72  SCIP_Bool initial, /**< should the LP relaxation of constraint be in the initial LP?
73  * Usually set to TRUE. Set to FALSE for 'lazy constraints'. */
74  SCIP_Bool enforce, /**< should the constraint be enforced during node processing?
75  * TRUE for model constraints, FALSE for additional, redundant constraints. */
76  SCIP_Bool check, /**< should the constraint be checked for feasibility?
77  * TRUE for model constraints, FALSE for additional, redundant constraints. */
78  SCIP_Bool local, /**< is constraint only valid locally?
79  * Usually set to FALSE. Has to be set to TRUE, e.g., for branching constraints. */
80  SCIP_Bool modifiable, /**< is constraint modifiable (subject to column generation)?
81  * Usually set to FALSE. In column generation applications, set to TRUE if pricing
82  * adds coefficients to this constraint. */
83  SCIP_Bool dynamic /**< is constraint subject to aging?
84  * Usually set to FALSE. Set to TRUE for own cuts which
85  * are separated as constraints. */
86  );
87 
88 /** creates and captures a cumulative constraint
89  * in its most basic version, i. e., all constraint flags are set to their basic value as explained for the
90  * method SCIPcreateConsDisjunction(); all flags can be set via SCIPsetConsFLAGNAME-methods in scip.h
91  *
92  * @see SCIPcreateConsDisjunction() for information about the basic constraint flag configuration
93  *
94  * @note the constraint gets captured, hence at one point you have to release it using the method SCIPreleaseCons()
95  */
96 extern
97 SCIP_RETCODE SCIPcreateConsBasicDisjunction(
98  SCIP* scip, /**< SCIP data structure */
99  SCIP_CONS** cons, /**< pointer to hold the created constraint */
100  const char* name, /**< name of constraint */
101  int nconss, /**< number of initial constraints in disjunction */
102  SCIP_CONS** conss, /**< initial constraint in disjunction */
103  SCIP_CONS* relaxcons /**< a conjunction constraint containing the linear relaxation of the disjunction constraint, or NULL */
104  );
105 
106 /** adds constraint to the disjunction of constraints */
107 extern
108 SCIP_RETCODE SCIPaddConsElemDisjunction(
109  SCIP* scip, /**< SCIP data structure */
110  SCIP_CONS* cons, /**< disjunction constraint */
111  SCIP_CONS* addcons /**< additional constraint in disjunction */
112  );
113 
114 /* @} */
115 
116 /* @} */
117 
118 #ifdef __cplusplus
119 }
120 #endif
121 
122 #endif
SCIP_RETCODE
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:53
SCIP_Cons
Definition: struct_cons.h:37
SCIPcreateConsBasicDisjunction
SCIP_RETCODE SCIPcreateConsBasicDisjunction(SCIP *scip, SCIP_CONS **cons, const char *name, int nconss, SCIP_CONS **conss, SCIP_CONS *relaxcons)
Definition: cons_disjunction.c:1097
SCIP_Bool
#define SCIP_Bool
Definition: def.h:61
SCIPaddConsElemDisjunction
SCIP_RETCODE SCIPaddConsElemDisjunction(SCIP *scip, SCIP_CONS *cons, SCIP_CONS *addcons)
Definition: cons_disjunction.c:1116
SCIPincludeConshdlrDisjunction
SCIP_RETCODE SCIPincludeConshdlrDisjunction(SCIP *scip)
Definition: cons_disjunction.c:1001
SCIPcreateConsDisjunction
SCIP_RETCODE SCIPcreateConsDisjunction(SCIP *scip, SCIP_CONS **cons, const char *name, int nconss, SCIP_CONS **conss, SCIP_CONS *relaxcons, SCIP_Bool initial, SCIP_Bool enforce, SCIP_Bool check, SCIP_Bool local, SCIP_Bool modifiable, SCIP_Bool dynamic)
Definition: cons_disjunction.c:1045
scip.h
SCIP callable library.