1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/* */
/* This file is part of the program and library */
/* SCIP --- Solving Constraint Integer Programs */
/* */
/* Copyright 2002-2022 Zuse Institute Berlin */
/* */
/* Licensed under the Apache License, Version 2.0 (the "License"); */
/* you may not use this file except in compliance with the License. */
/* You may obtain a copy of the License at */
/* */
/* http://www.apache.org/licenses/LICENSE-2.0 */
/* */
/* Unless required by applicable law or agreed to in writing, software */
/* distributed under the License is distributed on an "AS IS" BASIS, */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */
/* See the License for the specific language governing permissions and */
/* limitations under the License. */
/* */
/* You should have received a copy of the Apache-2.0 license */
/* along with SCIP; see the file LICENSE. If not visit scipopt.org. */
/* */
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/**@file event.h
* @brief internal methods for managing events
* @author Tobias Achterberg
*/
/*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
#ifndef __SCIP_EVENT_H__
#define __SCIP_EVENT_H__
#include "scip/def.h"
#include "blockmemshell/memory.h"
#include "scip/type_retcode.h"
#include "scip/type_set.h"
#include "scip/type_event.h"
#include "scip/type_lp.h"
#include "scip/type_var.h"
#include "scip/type_sol.h"
#include "scip/type_primal.h"
#include "scip/type_branch.h"
#include "scip/pub_event.h"
/* In optimized mode, some function calls are overwritten by defines to reduce the number of function calls and
* speed up the algorithms. For this, we need to include struct_event.h.
*/
#ifdef NDEBUG
#include "scip/struct_event.h"
#endif
#ifdef __cplusplus
extern "C" {
#endif
/*
* Event handler methods
*/
/** copies the given event handler to a new scip */
SCIP_RETCODE SCIPeventhdlrCopyInclude(
SCIP_EVENTHDLR* eventhdlr, /**< event handler */
SCIP_SET* set /**< SCIP_SET of SCIP to copy to */
);
/** creates an event handler */
SCIP_RETCODE SCIPeventhdlrCreate(
SCIP_EVENTHDLR** eventhdlr, /**< pointer to event handler data structure */
SCIP_SET* set, /**< global SCIP settings */
const char* name, /**< name of event handler */
const char* desc, /**< description of event handler */
SCIP_DECL_EVENTCOPY ((*eventcopy)), /**< copy method of event handler or NULL if you don't want to copy your plugin into sub-SCIPs */
SCIP_DECL_EVENTFREE ((*eventfree)), /**< destructor of event handler */
SCIP_DECL_EVENTINIT ((*eventinit)), /**< initialize event handler */
SCIP_DECL_EVENTEXIT ((*eventexit)), /**< deinitialize event handler */
SCIP_DECL_EVENTINITSOL((*eventinitsol)), /**< solving process initialization method of event handler */
SCIP_DECL_EVENTEXITSOL((*eventexitsol)), /**< solving process deinitialization method of event handler */
SCIP_DECL_EVENTDELETE ((*eventdelete)), /**< free specific event data */
SCIP_DECL_EVENTEXEC ((*eventexec)), /**< execute event handler */
SCIP_EVENTHDLRDATA* eventhdlrdata /**< event handler data */
);
/** calls destructor and frees memory of event handler */
SCIP_RETCODE SCIPeventhdlrFree(
SCIP_EVENTHDLR** eventhdlr, /**< pointer to event handler data structure */
SCIP_SET* set /**< global SCIP settings */
);
/** initializes event handler */
SCIP_RETCODE SCIPeventhdlrInit(
SCIP_EVENTHDLR* eventhdlr, /**< event handler for this event */
SCIP_SET* set /**< global SCIP settings */
);
/** calls exit method of event handler */
SCIP_RETCODE SCIPeventhdlrExit(
SCIP_EVENTHDLR* eventhdlr, /**< event handler for this event */
SCIP_SET* set /**< global SCIP settings */
);
/** informs event handler that the branch and bound process is being started */
SCIP_RETCODE SCIPeventhdlrInitsol(
SCIP_EVENTHDLR* eventhdlr, /**< event handler */
SCIP_SET* set /**< global SCIP settings */
);
/** informs event handler that the branch and bound process data is being freed */
SCIP_RETCODE SCIPeventhdlrExitsol(
SCIP_EVENTHDLR* eventhdlr, /**< event handler */
SCIP_SET* set /**< global SCIP settings */
);
/** calls execution method of event handler */
SCIP_RETCODE SCIPeventhdlrExec(
SCIP_EVENTHDLR* eventhdlr, /**< event handler */
SCIP_SET* set, /**< global SCIP settings */
SCIP_EVENT* event, /**< event to call event handler with */
SCIP_EVENTDATA* eventdata /**< user data for the issued event */
);
/**
* callback setter methods of event handlers
*/
/** sets copy callback for all events of this event handler */
void SCIPeventhdlrSetCopy(
SCIP_EVENTHDLR* eventhdlr, /**< event handler */
SCIP_DECL_EVENTCOPY ((*eventcopy)) /**< copy callback for events */
);
/** sets destructor callback of this event handler */
void SCIPeventhdlrSetFree(
SCIP_EVENTHDLR* eventhdlr, /**< event handler */
SCIP_DECL_EVENTFREE ((*eventfree)) /**< destructor callback of event handler */
);
/** sets initialization callback of this event handler */
void SCIPeventhdlrSetInit(
SCIP_EVENTHDLR* eventhdlr, /**< event handler */
SCIP_DECL_EVENTINIT ((*eventinit)) /**< initialization callback of event handler */
);
/** sets deinitialization callback of this event handler */
void SCIPeventhdlrSetExit(
SCIP_EVENTHDLR* eventhdlr, /**< event handler */
SCIP_DECL_EVENTEXIT ((*eventexit)) /**< deinitialization callback of event handler */
);
/** sets solving process initialization callback of this event handler */
void SCIPeventhdlrSetInitsol(
SCIP_EVENTHDLR* eventhdlr, /**< event handler */
SCIP_DECL_EVENTINITSOL((*eventinitsol)) /**< solving process initialization callback of event handler */
);
/** sets solving process deinitialization callback of this event handler */
void SCIPeventhdlrSetExitsol(
SCIP_EVENTHDLR* eventhdlr, /**< event handler */
SCIP_DECL_EVENTEXITSOL((*eventexitsol)) /**< solving process deinitialization callback of event handler */
);
/** sets callback to free specific event data */
void SCIPeventhdlrSetDelete(
SCIP_EVENTHDLR* eventhdlr, /**< event handler */
SCIP_DECL_EVENTDELETE ((*eventdelete)) /**< callback to free specific event data */
);
/** enables or disables all clocks of \p eventhdlr, depending on the value of the flag */
void SCIPeventhdlrEnableOrDisableClocks(
SCIP_EVENTHDLR* eventhdlr, /**< the event handler for which all clocks should be enabled or disabled */
SCIP_Bool enable /**< should the clocks of the event handler be enabled? */
);
/*
* Event methods
*/
/** creates a synchronization event */
SCIP_RETCODE SCIPeventCreateSync(
SCIP_EVENT** event, /**< pointer to store the event */
BMS_BLKMEM* blkmem /**< block memory */
);
/** creates an event for an addition of a variable to the problem */
SCIP_RETCODE SCIPeventCreateVarAdded(
SCIP_EVENT** event, /**< pointer to store the event */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_VAR* var /**< variable that was added to the problem */
);
/** creates an event for a deletion of a variable from the problem */
SCIP_RETCODE SCIPeventCreateVarDeleted(
SCIP_EVENT** event, /**< pointer to store the event */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_VAR* var /**< variable that is to be deleted from the problem */
);
/** creates an event for a fixing of a variable */
SCIP_RETCODE SCIPeventCreateVarFixed(
SCIP_EVENT** event, /**< pointer to store the event */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_VAR* var /**< variable that was fixed */
);
/** creates an event for a change in the number of locks of a variable down to zero or one */
SCIP_RETCODE SCIPeventCreateVarUnlocked(
SCIP_EVENT** event, /**< pointer to store the event */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_VAR* var /**< variable that changed the number of locks */
);
/** creates an event for a change in the objective value of a variable */
SCIP_RETCODE SCIPeventCreateObjChanged(
SCIP_EVENT** event, /**< pointer to store the event */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_VAR* var, /**< variable whose objective value changed */
SCIP_Real oldobj, /**< old objective value before value changed */
SCIP_Real newobj /**< new objective value after value changed */
);
/** creates an event for a change in the global lower bound of a variable */
SCIP_RETCODE SCIPeventCreateGlbChanged(
SCIP_EVENT** event, /**< pointer to store the event */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_VAR* var, /**< variable whose bound changed */
SCIP_Real oldbound, /**< old bound before bound changed */
SCIP_Real newbound /**< new bound after bound changed */
);
/** creates an event for a change in the global upper bound of a variable */
SCIP_RETCODE SCIPeventCreateGubChanged(
SCIP_EVENT** event, /**< pointer to store the event */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_VAR* var, /**< variable whose bound changed */
SCIP_Real oldbound, /**< old bound before bound changed */
SCIP_Real newbound /**< new bound after bound changed */
);
/** creates an event for a change in the lower bound of a variable */
SCIP_RETCODE SCIPeventCreateLbChanged(
SCIP_EVENT** event, /**< pointer to store the event */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_VAR* var, /**< variable whose bound changed */
SCIP_Real oldbound, /**< old bound before bound changed */
SCIP_Real newbound /**< new bound after bound changed */
);
/** creates an event for a change in the upper bound of a variable */
SCIP_RETCODE SCIPeventCreateUbChanged(
SCIP_EVENT** event, /**< pointer to store the event */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_VAR* var, /**< variable whose bound changed */
SCIP_Real oldbound, /**< old bound before bound changed */
SCIP_Real newbound /**< new bound after bound changed */
);
/** creates an event for an addition of a global domain hole to a variable */
SCIP_RETCODE SCIPeventCreateGholeAdded(
SCIP_EVENT** event, /**< pointer to store the event */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_VAR* var, /**< variable whose bound changed */
SCIP_Real left, /**< left bound of open interval in new hole */
SCIP_Real right /**< right bound of open interval in new hole */
);
/** creates an event for removing a global domain hole of a variable */
SCIP_RETCODE SCIPeventCreateGholeRemoved(
SCIP_EVENT** event, /**< pointer to store the event */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_VAR* var, /**< variable whose bound changed */
SCIP_Real left, /**< left bound of open interval in hole */
SCIP_Real right /**< right bound of open interval in hole */
);
/** creates an event for an addition of a local domain hole to a variable */
SCIP_RETCODE SCIPeventCreateLholeAdded(
SCIP_EVENT** event, /**< pointer to store the event */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_VAR* var, /**< variable whose bound changed */
SCIP_Real left, /**< left bound of open interval in new hole */
SCIP_Real right /**< right bound of open interval in new hole */
);
/** creates an event for removing a local domain hole of a variable */
SCIP_RETCODE SCIPeventCreateLholeRemoved(
SCIP_EVENT** event, /**< pointer to store the event */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_VAR* var, /**< variable whose bound changed */
SCIP_Real left, /**< left bound of open interval in hole */
SCIP_Real right /**< right bound of open interval in hole */
);
/** creates an event for an addition to the variable's implications list, clique or variable bounds information */
SCIP_RETCODE SCIPeventCreateImplAdded(
SCIP_EVENT** event, /**< pointer to store the event */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_VAR* var /**< variable that was fixed */
);
/** creates an event for a changeing the type of a variable */
SCIP_RETCODE SCIPeventCreateTypeChanged(
SCIP_EVENT** event, /**< pointer to store the event */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_VAR* var, /**< variable whose objective value changed */
SCIP_VARTYPE oldtype, /**< old variable type */
SCIP_VARTYPE newtype /**< new variable type */
);
/** creates an event for the addition of a linear row to the separation storage */
SCIP_RETCODE SCIPeventCreateRowAddedSepa(
SCIP_EVENT** event, /**< pointer to store the event */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_ROW* row /**< row that was added to the separation storage*/
);
/** creates an event for the deletion of a linear row from the separation storage */
SCIP_RETCODE SCIPeventCreateRowDeletedSepa(
SCIP_EVENT** event, /**< pointer to store the event */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_ROW* row /**< row that was deleted from the separation storage */
);
/** creates an event for the addition of a linear row to the LP */
SCIP_RETCODE SCIPeventCreateRowAddedLP(
SCIP_EVENT** event, /**< pointer to store the event */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_ROW* row /**< row that was added to the LP */
);
/** creates an event for the deletion of a linear row from the LP */
SCIP_RETCODE SCIPeventCreateRowDeletedLP(
SCIP_EVENT** event, /**< pointer to store the event */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_ROW* row /**< row that was deleted from the LP */
);
/** creates an event for the change of a coefficient in a linear row */
SCIP_RETCODE SCIPeventCreateRowCoefChanged(
SCIP_EVENT** event, /**< pointer to store the event */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_ROW* row, /**< row in which a coefficient changed */
SCIP_COL* col, /**< column which coefficient changed */
SCIP_Real oldval, /**< old value of coefficient */
SCIP_Real newval /**< new value of coefficient */
);
/** creates an event for the change of a constant in a linear row */
SCIP_RETCODE SCIPeventCreateRowConstChanged(
SCIP_EVENT** event, /**< pointer to store the event */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_ROW* row, /**< row in which the constant changed */
SCIP_Real oldval, /**< old value of constant */
SCIP_Real newval /**< new value of constant */
);
/** creates an event for the change of a side of a linear row */
SCIP_RETCODE SCIPeventCreateRowSideChanged(
SCIP_EVENT** event, /**< pointer to store the event */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_ROW* row, /**< row which side has changed */
SCIP_SIDETYPE side, /**< which side has changed */
SCIP_Real oldval, /**< old value of side */
SCIP_Real newval /**< new value of side */
);
/** frees an event */
SCIP_RETCODE SCIPeventFree(
SCIP_EVENT** event, /**< event to free */
BMS_BLKMEM* blkmem /**< block memory buffer */
);
/** sets type of event */
SCIP_RETCODE SCIPeventChgType(
SCIP_EVENT* event, /**< event */
SCIP_EVENTTYPE eventtype /**< new event type */
);
/** sets variable for a variable event */
SCIP_RETCODE SCIPeventChgVar(
SCIP_EVENT* event, /**< event */
SCIP_VAR* var /**< new variable */
);
/** sets node for a node or LP event */
SCIP_RETCODE SCIPeventChgNode(
SCIP_EVENT* event, /**< event */
SCIP_NODE* node /**< new node */
);
/** sets solution for a primal solution event */
SCIP_RETCODE SCIPeventChgSol(
SCIP_EVENT* event, /**< event */
SCIP_SOL* sol /**< new primal solution */
);
/** processes event by calling the appropriate event handlers */
SCIP_RETCODE SCIPeventProcess(
SCIP_EVENT* event, /**< event */
SCIP_SET* set, /**< global SCIP settings */
SCIP_PRIMAL* primal, /**< primal data; only needed for objchanged events, or NULL */
SCIP_LP* lp, /**< current LP data; only needed for obj/boundchanged events, or NULL */
SCIP_BRANCHCAND* branchcand, /**< branching candidate storage; only needed for bound change events, or NULL */
SCIP_EVENTFILTER* eventfilter /**< event filter for global events; not needed for variable specific events */
);
/*
* Event filter methods
*/
/** creates an event filter */
SCIP_RETCODE SCIPeventfilterCreate(
SCIP_EVENTFILTER** eventfilter, /**< pointer to store the event filter */
BMS_BLKMEM* blkmem /**< block memory buffer */
);
/** frees an event filter and the associated event data entries */
SCIP_RETCODE SCIPeventfilterFree(
SCIP_EVENTFILTER** eventfilter, /**< pointer to store the event filter */
BMS_BLKMEM* blkmem, /**< block memory buffer */
SCIP_SET* set /**< global SCIP settings */
);
/** adds element to event filter */
SCIP_RETCODE SCIPeventfilterAdd(
SCIP_EVENTFILTER* eventfilter, /**< event filter */
BMS_BLKMEM* blkmem, /**< block memory buffer */
SCIP_SET* set, /**< global SCIP settings */
SCIP_EVENTTYPE eventtype, /**< event type to catch */
SCIP_EVENTHDLR* eventhdlr, /**< event handler to call for the event processing */
SCIP_EVENTDATA* eventdata, /**< event data to pass to the event handler for the event processing */
int* filterpos /**< pointer to store position of event filter entry, or NULL */
);
/** deletes element from event filter */
SCIP_RETCODE SCIPeventfilterDel(
SCIP_EVENTFILTER* eventfilter, /**< event filter */
BMS_BLKMEM* blkmem, /**< block memory buffer */
SCIP_SET* set, /**< global SCIP settings */
SCIP_EVENTTYPE eventtype, /**< event type */
SCIP_EVENTHDLR* eventhdlr, /**< event handler to call for the event processing */
SCIP_EVENTDATA* eventdata, /**< event data to pass to the event handler for the event processing */
int filterpos /**< position of event filter entry, or -1 if unknown */
);
/** processes the event with all event handlers with matching filter setting */
SCIP_RETCODE SCIPeventfilterProcess(
SCIP_EVENTFILTER* eventfilter, /**< event filter */
SCIP_SET* set, /**< global SCIP settings */
SCIP_EVENT* event /**< event to process */
);
/*
* Event queue methods
*/
/** creates an event queue */
SCIP_RETCODE SCIPeventqueueCreate(
SCIP_EVENTQUEUE** eventqueue /**< pointer to store the event queue */
);
/** frees event queue; there must not be any unprocessed events in the queue! */
SCIP_RETCODE SCIPeventqueueFree(
SCIP_EVENTQUEUE** eventqueue /**< pointer to the event queue */
);
/** processes event or adds event to the event queue */
SCIP_RETCODE SCIPeventqueueAdd(
SCIP_EVENTQUEUE* eventqueue, /**< event queue */
BMS_BLKMEM* blkmem, /**< block memory buffer */
SCIP_SET* set, /**< global SCIP settings */
SCIP_PRIMAL* primal, /**< primal data; only needed for objchanged events, or NULL */
SCIP_LP* lp, /**< current LP data; only needed for obj/boundchanged events, or NULL */
SCIP_BRANCHCAND* branchcand, /**< branching candidate storage; only needed for bound change events, or NULL */
SCIP_EVENTFILTER* eventfilter, /**< event filter for global events; not needed for variable specific events */
SCIP_EVENT** event /**< pointer to event to add to the queue; will be NULL after queue addition */
);
/** marks queue to delay incoming events until a call to SCIPeventqueueProcess() */
SCIP_RETCODE SCIPeventqueueDelay(
SCIP_EVENTQUEUE* eventqueue /**< event queue */
);
/** processes all events in the queue */
SCIP_RETCODE SCIPeventqueueProcess(
SCIP_EVENTQUEUE* eventqueue, /**< event queue */
BMS_BLKMEM* blkmem, /**< block memory buffer */
SCIP_SET* set, /**< global SCIP settings */
SCIP_PRIMAL* primal, /**< primal data */
SCIP_LP* lp, /**< current LP data */
SCIP_BRANCHCAND* branchcand, /**< branching candidate storage */
SCIP_EVENTFILTER* eventfilter /**< event filter for global (not variable dependent) events */
);
/** returns TRUE iff events of the queue are delayed until the next SCIPeventqueueProcess() call */
SCIP_Bool SCIPeventqueueIsDelayed(
SCIP_EVENTQUEUE* eventqueue /**< event queue */
);
#ifdef NDEBUG
/* In optimized mode, the function calls are overwritten by defines to reduce the number of function calls and
* speed up the algorithms.
*/
#define SCIPeventqueueIsDelayed(eventqueue) ((eventqueue)->delayevents)
#endif
#ifdef __cplusplus
}
#endif
#endif