Scippy

SCIP

Solving Constraint Integer Programs

cons_or.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-2014 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_or.h
17  * @ingroup CONSHDLRS
18  * @brief Constraint handler for "or" constraints, \f$r = x_1 \vee x_2 \vee \dots \vee x_n\f$
19  * @author Tobias Achterberg
20  * @author Stefan Heinz
21  * @author Michael Winkler
22  *
23  * This constraint handler deals with "or" constraint. These are constraint of the form:
24  *
25  * \f[
26  * r = x_1 \vee x_2 \vee \dots \vee x_n
27  * \f]
28  *
29  * where \f$x_i\f$ is a binary variable for all \f$i\f$. Hence, \f$r\f$ is also of binary type. The variable \f$r\f$ is
30  * called resultant and the \f$x\f$'s operators.
31  */
32 
33 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
34 
35 #ifndef __SCIP_CONS_OR_H__
36 #define __SCIP_CONS_OR_H__
37 
38 
39 #include "scip/scip.h"
40 
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44 
45 /** creates the handler for or constraints and includes it in SCIP */
46 extern
47 SCIP_RETCODE SCIPincludeConshdlrOr(
48  SCIP* scip /**< SCIP data structure */
49  );
50 
51 /** creates and captures an or constraint
52  *
53  * @note the constraint gets captured, hence at one point you have to release it using the method SCIPreleaseCons()
54  */
55 extern
56 SCIP_RETCODE SCIPcreateConsOr(
57  SCIP* scip, /**< SCIP data structure */
58  SCIP_CONS** cons, /**< pointer to hold the created constraint */
59  const char* name, /**< name of constraint */
60  SCIP_VAR* resvar, /**< resultant variable of the operation */
61  int nvars, /**< number of operator variables in the constraint */
62  SCIP_VAR** vars, /**< array with operator variables of constraint */
63  SCIP_Bool initial, /**< should the LP relaxation of constraint be in the initial LP?
64  * Usually set to TRUE. Set to FALSE for 'lazy constraints'. */
65  SCIP_Bool separate, /**< should the constraint be separated during LP processing?
66  * Usually set to TRUE. */
67  SCIP_Bool enforce, /**< should the constraint be enforced during node processing?
68  * TRUE for model constraints, FALSE for additional, redundant constraints. */
69  SCIP_Bool check, /**< should the constraint be checked for feasibility?
70  * TRUE for model constraints, FALSE for additional, redundant constraints. */
71  SCIP_Bool propagate, /**< should the constraint be propagated during node processing?
72  * Usually set to TRUE. */
73  SCIP_Bool local, /**< is constraint only valid locally?
74  * Usually set to FALSE. Has to be set to TRUE, e.g., for branching constraints. */
75  SCIP_Bool modifiable, /**< is constraint modifiable (subject to column generation)?
76  * Usually set to FALSE. In column generation applications, set to TRUE if pricing
77  * adds coefficients to this constraint. */
78  SCIP_Bool dynamic, /**< is constraint subject to aging?
79  * Usually set to FALSE. Set to TRUE for own cuts which
80  * are separated as constraints. */
81  SCIP_Bool removable, /**< should the relaxation be removed from the LP due to aging or cleanup?
82  * Usually set to FALSE. Set to TRUE for 'lazy constraints' and 'user cuts'. */
83  SCIP_Bool stickingatnode /**< should the constraint always be kept at the node where it was added, even
84  * if it may be moved to a more global node?
85  * Usually set to FALSE. Set to TRUE to for constraints that represent node data. */
86  );
87 
88 /** creates and captures an or constraint
89  * in its most basic version, i. e., all constraint flags are set to their basic value as explained for the
90  * method SCIPcreateConsNonlinear(); all flags can be set via SCIPsetConsFLAGNAME-methods in scip.h
91  *
92  * @see SCIPcreateConsOr() 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 SCIPcreateConsBasicOr(
98  SCIP* scip, /**< SCIP data structure */
99  SCIP_CONS** cons, /**< pointer to hold the created constraint */
100  const char* name, /**< name of constraint */
101  SCIP_VAR* resvar, /**< resultant variable of the operation */
102  int nvars, /**< number of operator variables in the constraint */
103  SCIP_VAR** vars /**< array with operator variables of constraint */
104  );
105 
106 /** gets number of variables in or constraint */
107 extern
108 int SCIPgetNVarsOr(
109  SCIP* scip, /**< SCIP data structure */
110  SCIP_CONS* cons /**< constraint data */
111  );
112 
113 /** gets array of variables in or constraint */
114 extern
115 SCIP_VAR** SCIPgetVarsOr(
116  SCIP* scip, /**< SCIP data structure */
117  SCIP_CONS* cons /**< constraint data */
118  );
119 
120 /** gets the resultant variable in or constraint */
121 extern
122 SCIP_VAR* SCIPgetResultantOr(
123  SCIP* scip, /**< SCIP data structure */
124  SCIP_CONS* cons /**< constraint data */
125  );
126 
127 #ifdef __cplusplus
128 }
129 #endif
130 
131 #endif
132