SCIP
Solving Constraint Integer Programs
type_event.h File Reference
Detailed Description
type definitions for managing events
This file defines the interface for event handler implemented in C.
Definition in file type_event.h.
#include "scip/def.h"#include "scip/type_retcode.h"#include "scip/type_scip.h"#include <inttypes.h>Go to the source code of this file.
Macro Definition Documentation
◆ SCIP_EVENTTYPE_DISABLED
| #define SCIP_EVENTTYPE_DISABLED UINT64_C(0x0000000000) |
the event was disabled and has no effect any longer
Definition at line 67 of file type_event.h.
◆ SCIP_EVENTTYPE_VARADDED
| #define SCIP_EVENTTYPE_VARADDED UINT64_C(0x0000000001) |
a variable has been added to the transformed problem
Definition at line 70 of file type_event.h.
◆ SCIP_EVENTTYPE_VARDELETED
| #define SCIP_EVENTTYPE_VARDELETED UINT64_C(0x0000000002) |
a variable will be deleted from the transformed problem
Definition at line 71 of file type_event.h.
◆ SCIP_EVENTTYPE_VARFIXED
| #define SCIP_EVENTTYPE_VARFIXED UINT64_C(0x0000000004) |
a variable has been fixed, aggregated, or multi-aggregated
Definition at line 72 of file type_event.h.
◆ SCIP_EVENTTYPE_VARUNLOCKED
| #define SCIP_EVENTTYPE_VARUNLOCKED UINT64_C(0x0000000008) |
the number of rounding locks of a variable was reduced to zero or one
Definition at line 73 of file type_event.h.
◆ SCIP_EVENTTYPE_OBJCHANGED
| #define SCIP_EVENTTYPE_OBJCHANGED UINT64_C(0x0000000010) |
the objective value of a variable has been changed
Definition at line 74 of file type_event.h.
◆ SCIP_EVENTTYPE_GLBCHANGED
| #define SCIP_EVENTTYPE_GLBCHANGED UINT64_C(0x0000000020) |
the global lower bound of a variable has been changed
Definition at line 75 of file type_event.h.
◆ SCIP_EVENTTYPE_GUBCHANGED
| #define SCIP_EVENTTYPE_GUBCHANGED UINT64_C(0x0000000040) |
the global upper bound of a variable has been changed
Definition at line 76 of file type_event.h.
◆ SCIP_EVENTTYPE_LBTIGHTENED
| #define SCIP_EVENTTYPE_LBTIGHTENED UINT64_C(0x0000000080) |
the local lower bound of a variable has been increased
Definition at line 77 of file type_event.h.
◆ SCIP_EVENTTYPE_LBRELAXED
| #define SCIP_EVENTTYPE_LBRELAXED UINT64_C(0x0000000100) |
the local lower bound of a variable has been decreased
Definition at line 78 of file type_event.h.
◆ SCIP_EVENTTYPE_UBTIGHTENED
| #define SCIP_EVENTTYPE_UBTIGHTENED UINT64_C(0x0000000200) |
the local upper bound of a variable has been decreased
Definition at line 79 of file type_event.h.
◆ SCIP_EVENTTYPE_UBRELAXED
| #define SCIP_EVENTTYPE_UBRELAXED UINT64_C(0x0000000400) |
the local upper bound of a variable has been increased
Definition at line 80 of file type_event.h.
◆ SCIP_EVENTTYPE_GHOLEADDED
| #define SCIP_EVENTTYPE_GHOLEADDED UINT64_C(0x0000000800) |
a global hole has been added to the hole list of a variable's domain
Definition at line 81 of file type_event.h.
◆ SCIP_EVENTTYPE_GHOLEREMOVED
| #define SCIP_EVENTTYPE_GHOLEREMOVED UINT64_C(0x0000001000) |
a global hole has been removed from the hole list of a variable's domain
Definition at line 82 of file type_event.h.
◆ SCIP_EVENTTYPE_LHOLEADDED
| #define SCIP_EVENTTYPE_LHOLEADDED UINT64_C(0x0000002000) |
a local hole has been added to the hole list of a variable's domain
Definition at line 83 of file type_event.h.
◆ SCIP_EVENTTYPE_LHOLEREMOVED
| #define SCIP_EVENTTYPE_LHOLEREMOVED UINT64_C(0x0000004000) |
a local hole has been removed from the hole list of a variable's domain
Definition at line 84 of file type_event.h.
◆ SCIP_EVENTTYPE_IMPLADDED
| #define SCIP_EVENTTYPE_IMPLADDED UINT64_C(0x0000008000) |
the variable's implication list, variable bound or clique information was extended
Definition at line 85 of file type_event.h.
◆ SCIP_EVENTTYPE_TYPECHANGED
| #define SCIP_EVENTTYPE_TYPECHANGED UINT64_C(0x0000010000) |
the type of a variable has changed
Definition at line 86 of file type_event.h.
◆ SCIP_EVENTTYPE_IMPLTYPECHANGED
| #define SCIP_EVENTTYPE_IMPLTYPECHANGED UINT64_C(0x0000020000) |
the type of a variable has changed
Definition at line 87 of file type_event.h.
◆ SCIP_EVENTTYPE_PRESOLVEROUND
| #define SCIP_EVENTTYPE_PRESOLVEROUND UINT64_C(0x0000040000) |
a presolving round has been finished
Definition at line 90 of file type_event.h.
◆ SCIP_EVENTTYPE_NODEFOCUSED
| #define SCIP_EVENTTYPE_NODEFOCUSED UINT64_C(0x0000080000) |
a node has been focused and is now the focus node
Definition at line 93 of file type_event.h.
◆ SCIP_EVENTTYPE_NODEFEASIBLE
| #define SCIP_EVENTTYPE_NODEFEASIBLE UINT64_C(0x0000100000) |
the LP/pseudo solution of the node was feasible
Definition at line 94 of file type_event.h.
◆ SCIP_EVENTTYPE_NODEINFEASIBLE
| #define SCIP_EVENTTYPE_NODEINFEASIBLE UINT64_C(0x0000200000) |
the focus node has been proven to be infeasible or was bounded
Definition at line 95 of file type_event.h.
◆ SCIP_EVENTTYPE_NODEBRANCHED
| #define SCIP_EVENTTYPE_NODEBRANCHED UINT64_C(0x0000400000) |
the focus node has been solved by branching
Definition at line 96 of file type_event.h.
◆ SCIP_EVENTTYPE_NODEDELETE
| #define SCIP_EVENTTYPE_NODEDELETE UINT64_C(0x0000800000) |
a node is about to be deleted from the tree
Definition at line 97 of file type_event.h.
◆ SCIP_EVENTTYPE_DUALBOUNDIMPROVED
| #define SCIP_EVENTTYPE_DUALBOUNDIMPROVED UINT64_C(0x0001000000) |
a new best dual feasible solution was found
Definition at line 98 of file type_event.h.
◆ SCIP_EVENTTYPE_FIRSTLPSOLVED
| #define SCIP_EVENTTYPE_FIRSTLPSOLVED UINT64_C(0x0002000000) |
the node's initial LP was solved
Definition at line 101 of file type_event.h.
◆ SCIP_EVENTTYPE_LPSOLVED
| #define SCIP_EVENTTYPE_LPSOLVED UINT64_C(0x0004000000) |
the node's LP was completely solved with cut & price
Definition at line 102 of file type_event.h.
◆ SCIP_EVENTTYPE_POORSOLFOUND
| #define SCIP_EVENTTYPE_POORSOLFOUND UINT64_C(0x0008000000) |
a good enough primal feasible (but not new best) solution was found
Definition at line 105 of file type_event.h.
◆ SCIP_EVENTTYPE_BESTSOLFOUND
| #define SCIP_EVENTTYPE_BESTSOLFOUND UINT64_C(0x0010000000) |
a new best primal feasible solution was found
Definition at line 106 of file type_event.h.
◆ SCIP_EVENTTYPE_ROWADDEDSEPA
| #define SCIP_EVENTTYPE_ROWADDEDSEPA UINT64_C(0x0020000000) |
a row has been added to SCIP's separation storage
Definition at line 109 of file type_event.h.
◆ SCIP_EVENTTYPE_ROWDELETEDSEPA
| #define SCIP_EVENTTYPE_ROWDELETEDSEPA UINT64_C(0x0040000000) |
a row has been removed from SCIP's separation storage
Definition at line 110 of file type_event.h.
◆ SCIP_EVENTTYPE_ROWADDEDLP
| #define SCIP_EVENTTYPE_ROWADDEDLP UINT64_C(0x0080000000) |
a row has been added to the LP
Definition at line 111 of file type_event.h.
◆ SCIP_EVENTTYPE_ROWDELETEDLP
| #define SCIP_EVENTTYPE_ROWDELETEDLP UINT64_C(0x0100000000) |
a row has been removed from the LP
Definition at line 112 of file type_event.h.
◆ SCIP_EVENTTYPE_ROWCOEFCHANGED
| #define SCIP_EVENTTYPE_ROWCOEFCHANGED UINT64_C(0x0200000000) |
a coefficient of a row has been changed (row specific event)
Definition at line 113 of file type_event.h.
◆ SCIP_EVENTTYPE_ROWCONSTCHANGED
| #define SCIP_EVENTTYPE_ROWCONSTCHANGED UINT64_C(0x0400000000) |
the constant of a row has been changed (row specific event)
Definition at line 114 of file type_event.h.
◆ SCIP_EVENTTYPE_ROWSIDECHANGED
| #define SCIP_EVENTTYPE_ROWSIDECHANGED UINT64_C(0x0800000000) |
a side of a row has been changed (row specific event)
Definition at line 115 of file type_event.h.
◆ SCIP_EVENTTYPE_SYNC
| #define SCIP_EVENTTYPE_SYNC UINT64_C(0x1000000000) |
synchronization event
Definition at line 118 of file type_event.h.
◆ SCIP_EVENTTYPE_GBDCHANGED
| #define SCIP_EVENTTYPE_GBDCHANGED (SCIP_EVENTTYPE_GLBCHANGED | SCIP_EVENTTYPE_GUBCHANGED) |
Definition at line 122 of file type_event.h.
◆ SCIP_EVENTTYPE_LBCHANGED
| #define SCIP_EVENTTYPE_LBCHANGED (SCIP_EVENTTYPE_LBTIGHTENED | SCIP_EVENTTYPE_LBRELAXED) |
Definition at line 123 of file type_event.h.
◆ SCIP_EVENTTYPE_UBCHANGED
| #define SCIP_EVENTTYPE_UBCHANGED (SCIP_EVENTTYPE_UBTIGHTENED | SCIP_EVENTTYPE_UBRELAXED) |
Definition at line 124 of file type_event.h.
◆ SCIP_EVENTTYPE_BOUNDTIGHTENED
| #define SCIP_EVENTTYPE_BOUNDTIGHTENED (SCIP_EVENTTYPE_LBTIGHTENED | SCIP_EVENTTYPE_UBTIGHTENED) |
Definition at line 125 of file type_event.h.
◆ SCIP_EVENTTYPE_BOUNDRELAXED
| #define SCIP_EVENTTYPE_BOUNDRELAXED (SCIP_EVENTTYPE_LBRELAXED | SCIP_EVENTTYPE_UBRELAXED) |
Definition at line 126 of file type_event.h.
◆ SCIP_EVENTTYPE_BOUNDCHANGED
| #define SCIP_EVENTTYPE_BOUNDCHANGED (SCIP_EVENTTYPE_LBCHANGED | SCIP_EVENTTYPE_UBCHANGED) |
Definition at line 127 of file type_event.h.
◆ SCIP_EVENTTYPE_GHOLECHANGED
| #define SCIP_EVENTTYPE_GHOLECHANGED (SCIP_EVENTTYPE_GHOLEADDED | SCIP_EVENTTYPE_GHOLEREMOVED) |
Definition at line 128 of file type_event.h.
◆ SCIP_EVENTTYPE_LHOLECHANGED
| #define SCIP_EVENTTYPE_LHOLECHANGED (SCIP_EVENTTYPE_LHOLEADDED | SCIP_EVENTTYPE_LHOLEREMOVED) |
Definition at line 129 of file type_event.h.
◆ SCIP_EVENTTYPE_HOLECHANGED
| #define SCIP_EVENTTYPE_HOLECHANGED (SCIP_EVENTTYPE_GHOLECHANGED | SCIP_EVENTTYPE_LHOLECHANGED) |
Definition at line 130 of file type_event.h.
◆ SCIP_EVENTTYPE_DOMCHANGED
| #define SCIP_EVENTTYPE_DOMCHANGED (SCIP_EVENTTYPE_BOUNDCHANGED | SCIP_EVENTTYPE_HOLECHANGED) |
Definition at line 131 of file type_event.h.
◆ SCIP_EVENTTYPE_VARCHANGED
| #define SCIP_EVENTTYPE_VARCHANGED |
Value:
Definition at line 132 of file type_event.h.
◆ SCIP_EVENTTYPE_VAREVENT
| #define SCIP_EVENTTYPE_VAREVENT (SCIP_EVENTTYPE_VARADDED | SCIP_EVENTTYPE_VARCHANGED) |
Definition at line 135 of file type_event.h.
◆ SCIP_EVENTTYPE_NODESOLVED
| #define SCIP_EVENTTYPE_NODESOLVED |
Value:
Definition at line 138 of file type_event.h.
◆ SCIP_EVENTTYPE_NODEEVENT
| #define SCIP_EVENTTYPE_NODEEVENT (SCIP_EVENTTYPE_NODEFOCUSED | SCIP_EVENTTYPE_NODESOLVED) |
Definition at line 140 of file type_event.h.
◆ SCIP_EVENTTYPE_LPEVENT
| #define SCIP_EVENTTYPE_LPEVENT (SCIP_EVENTTYPE_FIRSTLPSOLVED | SCIP_EVENTTYPE_LPSOLVED) |
Definition at line 143 of file type_event.h.
◆ SCIP_EVENTTYPE_SOLFOUND
| #define SCIP_EVENTTYPE_SOLFOUND (SCIP_EVENTTYPE_POORSOLFOUND | SCIP_EVENTTYPE_BESTSOLFOUND) |
Definition at line 146 of file type_event.h.
◆ SCIP_EVENTTYPE_SOLEVENT
| #define SCIP_EVENTTYPE_SOLEVENT (SCIP_EVENTTYPE_SOLFOUND) |
Definition at line 147 of file type_event.h.
◆ SCIP_EVENTTYPE_GAPUPDATED
| #define SCIP_EVENTTYPE_GAPUPDATED (SCIP_EVENTTYPE_BESTSOLFOUND | SCIP_EVENTTYPE_DUALBOUNDIMPROVED) |
Definition at line 150 of file type_event.h.
◆ SCIP_EVENTTYPE_ROWCHANGED
| #define SCIP_EVENTTYPE_ROWCHANGED (SCIP_EVENTTYPE_ROWCOEFCHANGED | SCIP_EVENTTYPE_ROWCONSTCHANGED | SCIP_EVENTTYPE_ROWSIDECHANGED) |
Definition at line 153 of file type_event.h.
◆ SCIP_EVENTTYPE_ROWEVENT
| #define SCIP_EVENTTYPE_ROWEVENT (SCIP_EVENTTYPE_ROWADDEDSEPA | SCIP_EVENTTYPE_ROWDELETEDSEPA | SCIP_EVENTTYPE_ROWADDEDLP | SCIP_EVENTTYPE_ROWDELETEDLP | SCIP_EVENTTYPE_ROWCHANGED) |
Definition at line 154 of file type_event.h.
◆ SCIP_EVENTTYPE_FORMAT
| #define SCIP_EVENTTYPE_FORMAT PRIx64 |
Definition at line 157 of file type_event.h.
◆ SCIP_DECL_EVENTCOPY
| #define SCIP_DECL_EVENTCOPY | ( | x | ) | SCIP_RETCODE x (SCIP* scip, SCIP_EVENTHDLR* eventhdlr) |
copy method for event handler plugins (called when SCIP copies plugins)
input:
- scip : SCIP main data structure
- eventhdlr : the event handler itself
Definition at line 189 of file type_event.h.
◆ SCIP_DECL_EVENTFREE
| #define SCIP_DECL_EVENTFREE | ( | x | ) | SCIP_RETCODE x (SCIP* scip, SCIP_EVENTHDLR* eventhdlr) |
destructor of event handler to free user data (called when SCIP is exiting)
input:
- scip : SCIP main data structure
- eventhdlr : the event handler itself
Definition at line 197 of file type_event.h.
◆ SCIP_DECL_EVENTINIT
| #define SCIP_DECL_EVENTINIT | ( | x | ) | SCIP_RETCODE x (SCIP* scip, SCIP_EVENTHDLR* eventhdlr) |
initialization method of event handler (called after problem was transformed)
input:
- scip : SCIP main data structure
- eventhdlr : the event handler itself
Definition at line 205 of file type_event.h.
◆ SCIP_DECL_EVENTEXIT
| #define SCIP_DECL_EVENTEXIT | ( | x | ) | SCIP_RETCODE x (SCIP* scip, SCIP_EVENTHDLR* eventhdlr) |
deinitialization method of event handler (called before transformed problem is freed)
input:
- scip : SCIP main data structure
- eventhdlr : the event handler itself
Definition at line 213 of file type_event.h.
◆ SCIP_DECL_EVENTINITSOL
| #define SCIP_DECL_EVENTINITSOL | ( | x | ) | SCIP_RETCODE x (SCIP* scip, SCIP_EVENTHDLR* eventhdlr) |
solving process initialization method of event handler (called when branch and bound process is about to begin)
This method is called when the presolving was finished and the branch and bound process is about to begin. The event handler may use this call to initialize its branch and bound specific data.
input:
- scip : SCIP main data structure
- eventhdlr : the event handler itself
Definition at line 224 of file type_event.h.
◆ SCIP_DECL_EVENTEXITSOL
| #define SCIP_DECL_EVENTEXITSOL | ( | x | ) | SCIP_RETCODE x (SCIP* scip, SCIP_EVENTHDLR* eventhdlr) |
solving process deinitialization method of event handler (called before branch and bound process data is freed)
This method is called before the branch and bound process is freed. The event handler should use this call to clean up its branch and bound data.
input:
- scip : SCIP main data structure
- eventhdlr : the event handler itself
Definition at line 235 of file type_event.h.
◆ SCIP_DECL_EVENTDELETE
| #define SCIP_DECL_EVENTDELETE | ( | x | ) | SCIP_RETCODE x (SCIP* scip, SCIP_EVENTHDLR* eventhdlr, SCIP_EVENTDATA** eventdata) |
frees specific event data
input:
- scip : SCIP main data structure
- eventhdlr : the event handler itself
- eventdata : pointer to the event data to free
Definition at line 244 of file type_event.h.
◆ SCIP_DECL_EVENTEXEC
| #define SCIP_DECL_EVENTEXEC | ( | x | ) | SCIP_RETCODE x (SCIP* scip, SCIP_EVENTHDLR* eventhdlr, SCIP_EVENT* event, SCIP_EVENTDATA* eventdata) |
execution method of event handler
Processes the event. The method is called every time an event occurs, for which the event handler is responsible. Event handlers may declare themselves responsible for events by calling the corresponding SCIPcatch...() method. This method creates an event filter object to point to the given event handler and event data.
input:
- scip : SCIP main data structure
- eventhdlr : the event handler itself
- event : event to process
- eventdata : user data for the event
Definition at line 259 of file type_event.h.
Typedef Documentation
◆ SCIP_EVENTTYPE
| typedef uint64_t SCIP_EVENTTYPE |
type of event (bit field)
Definition at line 156 of file type_event.h.
◆ SCIP_EVENTHDLR
| typedef struct SCIP_Eventhdlr SCIP_EVENTHDLR |
event handler for a specific events
Definition at line 159 of file type_event.h.
◆ SCIP_EVENTHDLRDATA
| typedef struct SCIP_EventhdlrData SCIP_EVENTHDLRDATA |
event handler data
Definition at line 160 of file type_event.h.
◆ SCIP_EVENT
| typedef struct SCIP_Event SCIP_EVENT |
event data structure
Definition at line 161 of file type_event.h.
◆ SCIP_EVENTVARADDED
| typedef struct SCIP_EventVarAdded SCIP_EVENTVARADDED |
data for variable addition events
Definition at line 162 of file type_event.h.
◆ SCIP_EVENTVARDELETED
| typedef struct SCIP_EventVarDeleted SCIP_EVENTVARDELETED |
data for variable deletion events
Definition at line 163 of file type_event.h.
◆ SCIP_EVENTVARFIXED
| typedef struct SCIP_EventVarFixed SCIP_EVENTVARFIXED |
data for variable fixing events
Definition at line 164 of file type_event.h.
◆ SCIP_EVENTVARUNLOCKED
| typedef struct SCIP_EventVarUnlocked SCIP_EVENTVARUNLOCKED |
data for variable unlocked events
Definition at line 165 of file type_event.h.
◆ SCIP_EVENTOBJCHG
| typedef struct SCIP_EventObjChg SCIP_EVENTOBJCHG |
data for objective value change events
Definition at line 166 of file type_event.h.
◆ SCIP_EVENTBDCHG
| typedef struct SCIP_EventBdChg SCIP_EVENTBDCHG |
data for bound change events
Definition at line 167 of file type_event.h.
◆ SCIP_EVENTHOLE
| typedef struct SCIP_EventHole SCIP_EVENTHOLE |
data for domain hole events
Definition at line 168 of file type_event.h.
◆ SCIP_EVENTIMPLADD
| typedef struct SCIP_EventImplAdd SCIP_EVENTIMPLADD |
data for implication added events
Definition at line 169 of file type_event.h.
◆ SCIP_EVENTTYPECHG
| typedef struct SCIP_EventTypeChg SCIP_EVENTTYPECHG |
data for variable type change events
Definition at line 170 of file type_event.h.
◆ SCIP_EVENTTYPEIMPLCHG
| typedef struct SCIP_EventImplTypeChg SCIP_EVENTTYPEIMPLCHG |
data for variable implied type change events
Definition at line 171 of file type_event.h.
◆ SCIP_EVENTROWADDEDSEPA
| typedef struct SCIP_EventRowAddedSepa SCIP_EVENTROWADDEDSEPA |
data for row addition to sepastorage events
Definition at line 172 of file type_event.h.
◆ SCIP_EVENTROWDELETEDSEPA
| typedef struct SCIP_EventRowDeletedSepa SCIP_EVENTROWDELETEDSEPA |
data for row deletion from sepastorage events
Definition at line 173 of file type_event.h.
◆ SCIP_EVENTROWADDEDLP
| typedef struct SCIP_EventRowAddedLP SCIP_EVENTROWADDEDLP |
data for row addition to LP events
Definition at line 174 of file type_event.h.
◆ SCIP_EVENTROWDELETEDLP
| typedef struct SCIP_EventRowDeletedLP SCIP_EVENTROWDELETEDLP |
data for row deletion from LP events
Definition at line 175 of file type_event.h.
◆ SCIP_EVENTROWCOEFCHANGED
| typedef struct SCIP_EventRowCoefChanged SCIP_EVENTROWCOEFCHANGED |
data for row coefficient change events
Definition at line 176 of file type_event.h.
◆ SCIP_EVENTROWCONSTCHANGED
| typedef struct SCIP_EventRowConstChanged SCIP_EVENTROWCONSTCHANGED |
data for row constant change events
Definition at line 177 of file type_event.h.
◆ SCIP_EVENTROWSIDECHANGED
| typedef struct SCIP_EventRowSideChanged SCIP_EVENTROWSIDECHANGED |
data for row side change events
Definition at line 178 of file type_event.h.
◆ SCIP_EVENTDATA
| typedef struct SCIP_EventData SCIP_EVENTDATA |
locally defined event specific data
Definition at line 179 of file type_event.h.
◆ SCIP_EVENTFILTER
| typedef struct SCIP_EventFilter SCIP_EVENTFILTER |
event filter to select events to be processed by an event handler
Definition at line 180 of file type_event.h.
◆ SCIP_EVENTQUEUE
| typedef struct SCIP_EventQueue SCIP_EVENTQUEUE |
event queue to cache events and process them later
Definition at line 181 of file type_event.h.