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-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 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/def.h"
31 #include "scip/type_cons.h"
32 #include "scip/type_retcode.h"
33 #include "scip/type_scip.h"
34 
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38 
39 /** creates the handler for disjunction constraints and includes it in SCIP
40  *
41  * @ingroup ConshdlrIncludes
42  * */
45  SCIP* scip /**< SCIP data structure */
46  );
47 
48 /**@addtogroup CONSHDLRS
49  *
50  * @{
51  *
52  * @name Disjunction Constraints
53  *
54  * @{
55  *
56  * A disjunction constraint \f$ C \f$ is a constraint of the form
57  * \f[
58  * C = C_1 \vee \dots \vee C_n
59  * \f]
60  * where all the \f$ C_i \f$ are individual constraints themselves.
61  */
62 
63 /** creates and captures a disjunction constraint
64  *
65  * @note the constraint gets captured, hence at one point you have to release it using the method SCIPreleaseCons()
66  */
69  SCIP* scip, /**< SCIP data structure */
70  SCIP_CONS** cons, /**< pointer to hold the created constraint */
71  const char* name, /**< name of constraint */
72  int nconss, /**< number of initial constraints in disjunction */
73  SCIP_CONS** conss, /**< initial constraint in disjunction */
74  SCIP_CONS* relaxcons, /**< a conjunction constraint containing the linear relaxation of the disjunction constraint, or NULL */
75  SCIP_Bool initial, /**< should the LP relaxation of constraint be in the initial LP?
76  * Usually set to TRUE. Set to FALSE for 'lazy constraints'. */
77  SCIP_Bool enforce, /**< should the constraint be enforced during node processing?
78  * TRUE for model constraints, FALSE for additional, redundant constraints. */
79  SCIP_Bool check, /**< should the constraint be checked for feasibility?
80  * TRUE for model constraints, FALSE for additional, redundant constraints. */
81  SCIP_Bool local, /**< is constraint only valid locally?
82  * Usually set to FALSE. Has to be set to TRUE, e.g., for branching constraints. */
83  SCIP_Bool modifiable, /**< is constraint modifiable (subject to column generation)?
84  * Usually set to FALSE. In column generation applications, set to TRUE if pricing
85  * adds coefficients to this constraint. */
86  SCIP_Bool dynamic /**< is constraint subject to aging?
87  * Usually set to FALSE. Set to TRUE for own cuts which
88  * are separated as constraints. */
89  );
90 
91 /** creates and captures a cumulative constraint
92  * in its most basic version, i. e., all constraint flags are set to their basic value as explained for the
93  * method SCIPcreateConsDisjunction(); all flags can be set via SCIPsetConsFLAGNAME-methods in scip.h
94  *
95  * @see SCIPcreateConsDisjunction() for information about the basic constraint flag configuration
96  *
97  * @note the constraint gets captured, hence at one point you have to release it using the method SCIPreleaseCons()
98  */
101  SCIP* scip, /**< SCIP data structure */
102  SCIP_CONS** cons, /**< pointer to hold the created constraint */
103  const char* name, /**< name of constraint */
104  int nconss, /**< number of initial constraints in disjunction */
105  SCIP_CONS** conss, /**< initial constraint in disjunction */
106  SCIP_CONS* relaxcons /**< a conjunction constraint containing the linear relaxation of the disjunction constraint, or NULL */
107  );
108 
109 /** adds constraint to the disjunction of constraints */
112  SCIP* scip, /**< SCIP data structure */
113  SCIP_CONS* cons, /**< disjunction constraint */
114  SCIP_CONS* addcons /**< additional constraint in disjunction */
115  );
116 
117 /** @} */
118 
119 /** @} */
120 
121 #ifdef __cplusplus
122 }
123 #endif
124 
125 #endif
#define SCIP_EXPORT
Definition: def.h:100
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:54
type definitions for return codes for SCIP methods
SCIP_EXPORT SCIP_RETCODE SCIPcreateConsBasicDisjunction(SCIP *scip, SCIP_CONS **cons, const char *name, int nconss, SCIP_CONS **conss, SCIP_CONS *relaxcons)
SCIP_EXPORT 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)
type definitions for SCIP&#39;s main datastructure
#define SCIP_Bool
Definition: def.h:70
SCIP_EXPORT SCIP_RETCODE SCIPincludeConshdlrDisjunction(SCIP *scip)
SCIP_EXPORT SCIP_RETCODE SCIPaddConsElemDisjunction(SCIP *scip, SCIP_CONS *cons, SCIP_CONS *addcons)
common defines and data types used in all packages of SCIP
type definitions for constraints and constraint handlers