Scippy

SCIP

Solving Constraint Integer Programs

prop.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-2022 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 prop.h
17  * @ingroup INTERNALAPI
18  * @brief internal methods for propagators
19  * @author Tobias Achterberg
20  */
21 
22 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
23 
24 #ifndef __SCIP_PROP_H__
25 #define __SCIP_PROP_H__
26 
27 
28 #include "scip/def.h"
29 #include "blockmemshell/memory.h"
30 #include "scip/type_retcode.h"
31 #include "scip/type_result.h"
32 #include "scip/type_set.h"
33 #include "scip/type_stat.h"
34 #include "scip/type_lp.h"
35 #include "scip/type_var.h"
36 #include "scip/type_prop.h"
37 #include "scip/pub_prop.h"
38 
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42 
43 /** copies the given propagator to a new scip */
45  SCIP_PROP* prop, /**< propagator */
46  SCIP_SET* set /**< SCIP_SET of SCIP to copy to */
47  );
48 
49 /** creates a propagator */
51  SCIP_PROP** prop, /**< pointer to propagator data structure */
52  SCIP_SET* set, /**< global SCIP settings */
53  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
54  BMS_BLKMEM* blkmem, /**< block memory for parameter settings */
55  const char* name, /**< name of propagator */
56  const char* desc, /**< description of propagator */
57  int priority, /**< priority of propagator (>= 0: before, < 0: after constraint handlers) */
58  int freq, /**< frequency for calling propagator */
59  SCIP_Bool delay, /**< should propagator be delayed, if other propagators found reductions? */
60  SCIP_PROPTIMING timingmask, /**< positions in the node solving loop where propagator should be executed */
61  int presolpriority, /**< priority of the propagator (>= 0: before, < 0: after constraint handlers) */
62  int presolmaxrounds, /**< maximal number of presolving rounds the propagator participates in (-1: no limit) */
63  SCIP_PRESOLTIMING presoltiming, /**< timing mask of the propagator's presolving method */
64  SCIP_DECL_PROPCOPY ((*propcopy)), /**< copy method of propagator or NULL if you don't want to copy your plugin into sub-SCIPs */
65  SCIP_DECL_PROPFREE ((*propfree)), /**< destructor of propagator */
66  SCIP_DECL_PROPINIT ((*propinit)), /**< initialize propagator */
67  SCIP_DECL_PROPEXIT ((*propexit)), /**< deinitialize propagator */
68  SCIP_DECL_PROPINITPRE ((*propinitpre)), /**< presolving initialization method of propagator */
69  SCIP_DECL_PROPEXITPRE ((*propexitpre)), /**< presolving deinitialization method of propagator */
70  SCIP_DECL_PROPINITSOL ((*propinitsol)), /**< solving process initialization method of propagator */
71  SCIP_DECL_PROPEXITSOL ((*propexitsol)), /**< solving process deinitialization method of propagator */
72  SCIP_DECL_PROPPRESOL ((*proppresol)), /**< presolving method */
73  SCIP_DECL_PROPEXEC ((*propexec)), /**< execution method of propagator */
74  SCIP_DECL_PROPRESPROP ((*propresprop)), /**< propagation conflict resolving method */
75  SCIP_PROPDATA* propdata /**< propagator data */
76  );
77 
78 /** calls destructor and frees memory of propagator */
80  SCIP_PROP** prop, /**< pointer to propagator data structure */
81  SCIP_SET* set /**< global SCIP settings */
82  );
83 
84 /** initializes propagator */
86  SCIP_PROP* prop, /**< propagator */
87  SCIP_SET* set /**< global SCIP settings */
88  );
89 
90 /** calls exit method of propagator */
92  SCIP_PROP* prop, /**< propagator */
93  SCIP_SET* set /**< global SCIP settings */
94  );
95 
96 /** informs propagator that the presolving process is being started */
98  SCIP_PROP* prop, /**< propagator */
99  SCIP_SET* set /**< global SCIP settings */
100  );
101 
102 /** informs propagator that the presolving is finished */
104  SCIP_PROP* prop, /**< propagator */
105  SCIP_SET* set /**< global SCIP settings */
106  );
107 
108 /** informs propagator that the branch and bound process is being started */
110  SCIP_PROP* prop, /**< propagator */
111  SCIP_SET* set /**< global SCIP settings */
112  );
113 
114 /** informs propagator that the branch and bound process data is being freed */
116  SCIP_PROP* prop, /**< propagator */
117  SCIP_SET* set, /**< global SCIP settings */
118  SCIP_Bool restart /**< was this exit solve call triggered by a restart? */
119  );
120 
121 /** executes presolving method of propagator */
123  SCIP_PROP* prop, /**< propagator */
124  SCIP_SET* set, /**< global SCIP settings */
125  SCIP_PRESOLTIMING timing, /**< current presolving timing */
126  int nrounds, /**< number of presolving rounds already done */
127  int* nfixedvars, /**< pointer to total number of variables fixed of all presolvers */
128  int* naggrvars, /**< pointer to total number of variables aggregated of all presolvers */
129  int* nchgvartypes, /**< pointer to total number of variable type changes of all presolvers */
130  int* nchgbds, /**< pointer to total number of variable bounds tightened of all presolvers */
131  int* naddholes, /**< pointer to total number of domain holes added of all presolvers */
132  int* ndelconss, /**< pointer to total number of deleted constraints of all presolvers */
133  int* naddconss, /**< pointer to total number of added constraints of all presolvers */
134  int* nupgdconss, /**< pointer to total number of upgraded constraints of all presolvers */
135  int* nchgcoefs, /**< pointer to total number of changed coefficients of all presolvers */
136  int* nchgsides, /**< pointer to total number of changed left/right hand sides of all presolvers */
137  SCIP_RESULT* result /**< pointer to store the result of the callback method */
138  );
139 
140 /** calls execution method of propagator */
142  SCIP_PROP* prop, /**< propagator */
143  SCIP_SET* set, /**< global SCIP settings */
144  SCIP_STAT* stat, /**< dynamic problem statistics */
145  int depth, /**< depth of current node */
146  SCIP_Bool execdelayed, /**< execute propagator even if it is marked to be delayed */
147  SCIP_Bool instrongbranching, /**< are we currently doing strong branching? */
148  SCIP_PROPTIMING proptiming, /**< current point in the node solving process */
149  SCIP_RESULT* result /**< pointer to store the result of the callback method */
150  );
151 
152 /** resolves the given conflicting bound, that was deduced by the given propagator, by putting all "reason" bounds
153  * leading to the deduction into the conflict queue with calls to SCIPaddConflictLb(), SCIPaddConflictUb(), SCIPaddConflictBd(),
154  * SCIPaddConflictRelaxedLb(), SCIPaddConflictRelaxedUb(), SCIPaddConflictRelaxedBd(), or SCIPaddConflictBinvar();
155  *
156  * @note it is sufficient to explain the relaxed bound change
157  */
159  SCIP_PROP* prop, /**< propagator */
160  SCIP_SET* set, /**< global SCIP settings */
161  SCIP_VAR* infervar, /**< variable whose bound was deduced by the constraint */
162  int inferinfo, /**< user inference information attached to the bound change */
163  SCIP_BOUNDTYPE inferboundtype, /**< bound that was deduced (lower or upper bound) */
164  SCIP_BDCHGIDX* bdchgidx, /**< bound change index, representing the point of time where change took place */
165  SCIP_Real relaxedbd, /**< the relaxed bound */
166  SCIP_RESULT* result /**< pointer to store the result of the callback method */
167  );
168 
169 /** sets priority of propagator */
171  SCIP_PROP* prop, /**< propagator */
172  SCIP_SET* set, /**< global SCIP settings */
173  int priority /**< new priority of the propagator */
174  );
175 
176 /** sets presolving priority of propagator */
178  SCIP_PROP* prop, /**< propagator */
179  SCIP_SET* set, /**< global SCIP settings */
180  int presolpriority /**< new priority of the propagator */
181  );
182 
183 /** sets copy method of propagator */
184 void SCIPpropSetCopy(
185  SCIP_PROP* prop, /**< propagator */
186  SCIP_DECL_PROPCOPY ((*propcopy)) /**< copy method of propagator or NULL if you don't want to copy your plugin into sub-SCIPs */
187  );
188 
189 /** sets destructor method of propagator */
190 void SCIPpropSetFree(
191  SCIP_PROP* prop, /**< propagator */
192  SCIP_DECL_PROPFREE ((*propfree)) /**< destructor of propagator */
193  );
194 
195 /** sets initialization method of propagator */
196 void SCIPpropSetInit(
197  SCIP_PROP* prop, /**< propagator */
198  SCIP_DECL_PROPINIT ((*propinit)) /**< initialize propagator */
199  );
200 
201 /** sets deinitialization method of propagator */
202 void SCIPpropSetExit(
203  SCIP_PROP* prop, /**< propagator */
204  SCIP_DECL_PROPEXIT ((*propexit)) /**< deinitialize propagator */
205  );
206 
207 /** sets solving process initialization method of propagator */
208 void SCIPpropSetInitsol(
209  SCIP_PROP* prop, /**< propagator */
210  SCIP_DECL_PROPINITSOL((*propinitsol)) /**< solving process initialization method of propagator */
211  );
212 
213 /** sets solving process deinitialization method of propagator */
214 void SCIPpropSetExitsol(
215  SCIP_PROP* prop, /**< propagator */
216  SCIP_DECL_PROPEXITSOL ((*propexitsol)) /**< solving process deinitialization method of propagator */
217  );
218 
219 /** sets preprocessing initialization method of propagator */
220 void SCIPpropSetInitpre(
221  SCIP_PROP* prop, /**< propagator */
222  SCIP_DECL_PROPINITPRE((*propinitpre)) /**< preprocessing initialization method of propagator */
223  );
224 
225 /** sets preprocessing deinitialization method of propagator */
226 void SCIPpropSetExitpre(
227  SCIP_PROP* prop, /**< propagator */
228  SCIP_DECL_PROPEXITPRE((*propexitpre)) /**< preprocessing deinitialization method of propagator */
229  );
230 
231 /** sets presolving method of propagator */
233  SCIP_PROP* prop, /**< propagator */
234  SCIP_DECL_PROPPRESOL ((*proppresol)), /**< presolving method */
235  int presolpriority, /**< presolving priority of the propagator (>= 0: before, < 0: after constraint handlers) */
236  int presolmaxrounds, /**< maximal number of presolving rounds the propagator participates in (-1: no limit) */
237  SCIP_PRESOLTIMING presoltiming /**< timing mask of the propagator's presolving method */
238  );
239 
240 /** sets propagation conflict resolving callback of propagator */
241 void SCIPpropSetResprop(
242  SCIP_PROP* prop, /**< propagator */
243  SCIP_DECL_PROPRESPROP ((*propresprop)) /**< propagation conflict resolving callback */
244  );
245 
246 /** enables or disables all clocks of \p prop, depending on the value of the flag */
248  SCIP_PROP* prop, /**< the propagator for which all clocks should be enabled or disabled */
249  SCIP_Bool enable /**< should the clocks of the propagator be enabled? */
250  );
251 
252 #ifdef __cplusplus
253 }
254 #endif
255 
256 #endif
enum SCIP_Result SCIP_RESULT
Definition: type_result.h:52
enum SCIP_BoundType SCIP_BOUNDTYPE
Definition: type_lp.h:50
SCIP_RETCODE SCIPpropCreate(SCIP_PROP **prop, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, BMS_BLKMEM *blkmem, const char *name, const char *desc, int priority, int freq, SCIP_Bool delay, SCIP_PROPTIMING timingmask, int presolpriority, int presolmaxrounds, SCIP_PRESOLTIMING presoltiming, SCIP_DECL_PROPCOPY((*propcopy)), SCIP_DECL_PROPFREE((*propfree)), SCIP_DECL_PROPINIT((*propinit)), SCIP_DECL_PROPEXIT((*propexit)), SCIP_DECL_PROPINITPRE((*propinitpre)), SCIP_DECL_PROPEXITPRE((*propexitpre)), SCIP_DECL_PROPINITSOL((*propinitsol)), SCIP_DECL_PROPEXITSOL((*propexitsol)), SCIP_DECL_PROPPRESOL((*proppresol)), SCIP_DECL_PROPEXEC((*propexec)), SCIP_DECL_PROPRESPROP((*propresprop)), SCIP_PROPDATA *propdata)
Definition: prop.c:233
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:54
#define SCIP_DECL_PROPEXITPRE(x)
Definition: type_prop.h:105
type definitions for global SCIP settings
SCIP_RETCODE SCIPpropExit(SCIP_PROP *prop, SCIP_SET *set)
Definition: prop.c:371
void SCIPpropSetInit(SCIP_PROP *prop, SCIP_DECL_PROPINIT((*propinit)))
Definition: prop.c:823
type definitions for return codes for SCIP methods
SCIP_RETCODE SCIPpropInitpre(SCIP_PROP *prop, SCIP_SET *set)
Definition: prop.c:401
#define SCIP_DECL_PROPEXEC(x)
Definition: type_prop.h:208
void SCIPpropSetResprop(SCIP_PROP *prop, SCIP_DECL_PROPRESPROP((*propresprop)))
Definition: prop.c:921
type definitions for problem statistics
void SCIPpropSetInitsol(SCIP_PROP *prop, SCIP_DECL_PROPINITSOL((*propinitsol)))
Definition: prop.c:845
type definitions for LP management
SCIP_RETCODE SCIPpropExec(SCIP_PROP *prop, SCIP_SET *set, SCIP_STAT *stat, int depth, SCIP_Bool execdelayed, SCIP_Bool instrongbranching, SCIP_PROPTIMING proptiming, SCIP_RESULT *result)
Definition: prop.c:636
#define SCIP_DECL_PROPEXITSOL(x)
Definition: type_prop.h:132
#define SCIP_DECL_PROPCOPY(x)
Definition: type_prop.h:52
void SCIPpropSetExit(SCIP_PROP *prop, SCIP_DECL_PROPEXIT((*propexit)))
Definition: prop.c:834
void SCIPpropSetFree(SCIP_PROP *prop, SCIP_DECL_PROPFREE((*propfree)))
Definition: prop.c:812
unsigned int SCIP_PRESOLTIMING
Definition: type_timing.h:52
#define SCIP_DECL_PROPINITPRE(x)
Definition: type_prop.h:90
type definitions for problem variables
SCIP_RETCODE SCIPpropExitpre(SCIP_PROP *prop, SCIP_SET *set)
Definition: prop.c:437
SCIP_RETCODE SCIPpropCopyInclude(SCIP_PROP *prop, SCIP_SET *set)
Definition: prop.c:91
void SCIPpropSetInitpre(SCIP_PROP *prop, SCIP_DECL_PROPINITPRE((*propinitpre)))
Definition: prop.c:867
#define SCIP_Bool
Definition: def.h:84
#define SCIP_DECL_PROPFREE(x)
Definition: type_prop.h:60
#define SCIP_DECL_PROPINITSOL(x)
Definition: type_prop.h:120
SCIP_RETCODE SCIPpropInit(SCIP_PROP *prop, SCIP_SET *set)
Definition: prop.c:305
SCIP_RETCODE SCIPpropResolvePropagation(SCIP_PROP *prop, SCIP_SET *set, SCIP_VAR *infervar, int inferinfo, SCIP_BOUNDTYPE inferboundtype, SCIP_BDCHGIDX *bdchgidx, SCIP_Real relaxedbd, SCIP_RESULT *result)
Definition: prop.c:728
SCIP_RETCODE SCIPpropPresol(SCIP_PROP *prop, SCIP_SET *set, SCIP_PRESOLTIMING timing, int nrounds, int *nfixedvars, int *naggrvars, int *nchgvartypes, int *nchgbds, int *naddholes, int *ndelconss, int *naddconss, int *nupgdconss, int *nchgcoefs, int *nchgsides, SCIP_RESULT *result)
Definition: prop.c:510
type definitions for propagators
void SCIPpropSetPriority(SCIP_PROP *prop, SCIP_SET *set, int priority)
Definition: prop.c:972
SCIP_RETCODE SCIPpropSetPresol(SCIP_PROP *prop, SCIP_DECL_PROPPRESOL((*proppresol)), int presolpriority, int presolmaxrounds, SCIP_PRESOLTIMING presoltiming)
Definition: prop.c:891
unsigned int SCIP_PROPTIMING
Definition: type_timing.h:66
void SCIPpropSetExitsol(SCIP_PROP *prop, SCIP_DECL_PROPEXITSOL((*propexitsol)))
Definition: prop.c:856
#define SCIP_DECL_PROPRESPROP(x)
Definition: type_prop.h:249
#define SCIP_DECL_PROPPRESOL(x)
Definition: type_prop.h:184
#define SCIP_Real
Definition: def.h:177
struct SCIP_PropData SCIP_PROPDATA
Definition: type_prop.h:43
result codes for SCIP callback methods
SCIP_RETCODE SCIPpropInitsol(SCIP_PROP *prop, SCIP_SET *set)
Definition: prop.c:461
#define SCIP_DECL_PROPEXIT(x)
Definition: type_prop.h:76
common defines and data types used in all packages of SCIP
struct BMS_BlkMem BMS_BLKMEM
Definition: memory.h:430
SCIP_RETCODE SCIPpropFree(SCIP_PROP **prop, SCIP_SET *set)
Definition: prop.c:275
void SCIPpropSetExitpre(SCIP_PROP *prop, SCIP_DECL_PROPEXITPRE((*propexitpre)))
Definition: prop.c:880
void SCIPpropSetPresolPriority(SCIP_PROP *prop, SCIP_SET *set, int presolpriority)
Definition: prop.c:986
void SCIPpropEnableOrDisableClocks(SCIP_PROP *prop, SCIP_Bool enable)
Definition: prop.c:1010
SCIP_RETCODE SCIPpropExitsol(SCIP_PROP *prop, SCIP_SET *set, SCIP_Bool restart)
Definition: prop.c:485
void SCIPpropSetCopy(SCIP_PROP *prop, SCIP_DECL_PROPCOPY((*propcopy)))
Definition: prop.c:801
public methods for propagators
#define SCIP_DECL_PROPINIT(x)
Definition: type_prop.h:68
memory allocation routines