Scippy

SCIP

Solving Constraint Integer Programs

cons_conjunction.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-2016 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_conjunction.h
17  * @ingroup CONSHDLRS
18  * @brief constraint handler for conjunction constraints
19  * @author Tobias Achterberg
20  *
21  * A conjunction constraint \f$ C \f$ is a constraint of the form
22  * \f[
23  * C = C_1 \wedge \dots \wedge C_n
24  * \f]
25  * where all the \f$ C_i \f$ are individual constraints themselves.
26  */
27 
28 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
29 
30 #ifndef __SCIP_CONS_CONJUNCTION_H__
31 #define __SCIP_CONS_CONJUNCTION_H__
32 
33 
34 #include "scip/scip.h"
35 
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39 
40 /** creates the handler for conjunction constraints and includes it in SCIP */
41 extern
43  SCIP* scip /**< SCIP data structure */
44  );
45 
46 /** creates and captures a conjunction constraint
47  *
48  * @note the constraint gets captured, hence at one point you have to release it using the method SCIPreleaseCons()
49  */
50 extern
52  SCIP* scip, /**< SCIP data structure */
53  SCIP_CONS** cons, /**< pointer to hold the created constraint */
54  const char* name, /**< name of constraint */
55  int nconss, /**< number of initial constraints in conjunction */
56  SCIP_CONS** conss, /**< initial constraint in conjunction */
57  SCIP_Bool enforce, /**< should the constraint be enforced during node processing?
58  * TRUE for model constraints, FALSE for additional, redundant constraints. */
59  SCIP_Bool check, /**< should the constraint be checked for feasibility?
60  * TRUE for model constraints, FALSE for additional, redundant constraints. */
61  SCIP_Bool local, /**< is constraint only valid locally?
62  * Usually set to FALSE. Has to be set to TRUE, e.g., for branching constraints. */
63  SCIP_Bool modifiable, /**< is constraint modifiable (subject to column generation)?
64  * Usually set to FALSE. In column generation applications, set to TRUE if pricing
65  * adds coefficients to this constraint. */
66  SCIP_Bool dynamic /**< is constraint subject to aging?
67  * Usually set to FALSE. Set to TRUE for own cuts which
68  * are separated as constraints. */
69  );
70 
71 /** creates and captures an and constraint
72  * in its most basic version, i. e., all constraint flags are set to their basic value as explained for the
73  * method SCIPcreateConsConjunction(); all flags can be set via SCIPsetConsFLAGNAME-methods in scip.h
74  *
75  * @see SCIPcreateConsConjunction() for information about the basic constraint flag configuration
76  *
77  * @note the constraint gets captured, hence at one point you have to release it using the method SCIPreleaseCons()
78  */
79 extern
81  SCIP* scip, /**< SCIP data structure */
82  SCIP_CONS** cons, /**< pointer to hold the created constraint */
83  const char* name, /**< name of constraint */
84  int nconss, /**< number of initial constraints in conjunction */
85  SCIP_CONS** conss /**< initial constraint in conjunction */
86  );
87 
88 /** adds constraint to the conjunction of constraints */
89 extern
91  SCIP* scip, /**< SCIP data structure */
92  SCIP_CONS* cons, /**< conjunction constraint */
93  SCIP_CONS* addcons /**< additional constraint in conjunction */
94  );
95 
96 #ifdef __cplusplus
97 }
98 #endif
99 
100 #endif
SCIP_RETCODE SCIPcreateConsConjunction(SCIP *scip, SCIP_CONS **cons, const char *name, int nconss, SCIP_CONS **conss, SCIP_Bool enforce, SCIP_Bool check, SCIP_Bool local, SCIP_Bool modifiable, SCIP_Bool dynamic)
SCIP_RETCODE SCIPaddConsElemConjunction(SCIP *scip, SCIP_CONS *cons, SCIP_CONS *addcons)
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:53
#define SCIP_Bool
Definition: def.h:53
SCIP_RETCODE SCIPcreateConsBasicConjunction(SCIP *scip, SCIP_CONS **cons, const char *name, int nconss, SCIP_CONS **conss)
SCIP callable library.
SCIP_RETCODE SCIPincludeConshdlrConjunction(SCIP *scip)