|
type definitions for managing events
- Author
- Tobias Achterberg
This file defines the interface for event handler implemented in C.
Definition in file type_event.h.
Go to the source code of this file.
|
#define | SCIP_EVENTTYPE_DISABLED 0x00000000u |
|
#define | SCIP_EVENTTYPE_VARADDED 0x00000001u |
|
#define | SCIP_EVENTTYPE_VARDELETED 0x00000002u |
|
#define | SCIP_EVENTTYPE_VARFIXED 0x00000004u |
|
#define | SCIP_EVENTTYPE_VARUNLOCKED 0x00000008u |
|
#define | SCIP_EVENTTYPE_OBJCHANGED 0x00000010u |
|
#define | SCIP_EVENTTYPE_GLBCHANGED 0x00000020u |
|
#define | SCIP_EVENTTYPE_GUBCHANGED 0x00000040u |
|
#define | SCIP_EVENTTYPE_LBTIGHTENED 0x00000080u |
|
#define | SCIP_EVENTTYPE_LBRELAXED 0x00000100u |
|
#define | SCIP_EVENTTYPE_UBTIGHTENED 0x00000200u |
|
#define | SCIP_EVENTTYPE_UBRELAXED 0x00000400u |
|
#define | SCIP_EVENTTYPE_GHOLEADDED 0x00000800u |
|
#define | SCIP_EVENTTYPE_GHOLEREMOVED 0x00001000u |
|
#define | SCIP_EVENTTYPE_LHOLEADDED 0x00002000u |
|
#define | SCIP_EVENTTYPE_LHOLEREMOVED 0x00004000u |
|
#define | SCIP_EVENTTYPE_IMPLADDED 0x00008000u |
|
#define | SCIP_EVENTTYPE_PRESOLVEROUND 0x00010000u |
|
#define | SCIP_EVENTTYPE_NODEFOCUSED 0x00020000u |
|
#define | SCIP_EVENTTYPE_NODEFEASIBLE 0x00040000u |
|
#define | SCIP_EVENTTYPE_NODEINFEASIBLE 0x00080000u |
|
#define | SCIP_EVENTTYPE_NODEBRANCHED 0x00100000u |
|
#define | SCIP_EVENTTYPE_FIRSTLPSOLVED 0x00200000u |
|
#define | SCIP_EVENTTYPE_LPSOLVED 0x00400000u |
|
#define | SCIP_EVENTTYPE_POORSOLFOUND 0x00800000u |
|
#define | SCIP_EVENTTYPE_BESTSOLFOUND 0x01000000u |
|
#define | SCIP_EVENTTYPE_ROWADDEDSEPA 0x02000000u |
|
#define | SCIP_EVENTTYPE_ROWDELETEDSEPA 0x04000000u |
|
#define | SCIP_EVENTTYPE_ROWADDEDLP 0x08000000u |
|
#define | SCIP_EVENTTYPE_ROWDELETEDLP 0x10000000u |
|
#define | SCIP_EVENTTYPE_ROWCOEFCHANGED 0x20000000u |
|
#define | SCIP_EVENTTYPE_ROWCONSTCHANGED 0x40000000u |
|
#define | SCIP_EVENTTYPE_ROWSIDECHANGED 0x80000000u |
|
#define | SCIP_EVENTTYPE_GBDCHANGED (SCIP_EVENTTYPE_GLBCHANGED | SCIP_EVENTTYPE_GUBCHANGED) |
|
#define | SCIP_EVENTTYPE_LBCHANGED (SCIP_EVENTTYPE_LBTIGHTENED | SCIP_EVENTTYPE_LBRELAXED) |
|
#define | SCIP_EVENTTYPE_UBCHANGED (SCIP_EVENTTYPE_UBTIGHTENED | SCIP_EVENTTYPE_UBRELAXED) |
|
#define | SCIP_EVENTTYPE_BOUNDTIGHTENED (SCIP_EVENTTYPE_LBTIGHTENED | SCIP_EVENTTYPE_UBTIGHTENED) |
|
#define | SCIP_EVENTTYPE_BOUNDRELAXED (SCIP_EVENTTYPE_LBRELAXED | SCIP_EVENTTYPE_UBRELAXED) |
|
#define | SCIP_EVENTTYPE_BOUNDCHANGED (SCIP_EVENTTYPE_LBCHANGED | SCIP_EVENTTYPE_UBCHANGED) |
|
#define | SCIP_EVENTTYPE_GHOLECHANGED (SCIP_EVENTTYPE_GHOLEADDED | SCIP_EVENTTYPE_GHOLEREMOVED) |
|
#define | SCIP_EVENTTYPE_LHOLECHANGED (SCIP_EVENTTYPE_LHOLEADDED | SCIP_EVENTTYPE_LHOLEREMOVED) |
|
#define | SCIP_EVENTTYPE_HOLECHANGED (SCIP_EVENTTYPE_GHOLECHANGED | SCIP_EVENTTYPE_LHOLECHANGED) |
|
#define | SCIP_EVENTTYPE_DOMCHANGED (SCIP_EVENTTYPE_BOUNDCHANGED | SCIP_EVENTTYPE_HOLECHANGED) |
|
#define | SCIP_EVENTTYPE_VARCHANGED |
|
#define | SCIP_EVENTTYPE_VAREVENT (SCIP_EVENTTYPE_VARADDED | SCIP_EVENTTYPE_VARCHANGED) |
|
#define | SCIP_EVENTTYPE_NODESOLVED |
|
#define | SCIP_EVENTTYPE_NODEEVENT (SCIP_EVENTTYPE_NODEFOCUSED | SCIP_EVENTTYPE_NODESOLVED) |
|
#define | SCIP_EVENTTYPE_LPEVENT (SCIP_EVENTTYPE_FIRSTLPSOLVED | SCIP_EVENTTYPE_LPSOLVED) |
|
#define | SCIP_EVENTTYPE_SOLFOUND (SCIP_EVENTTYPE_POORSOLFOUND | SCIP_EVENTTYPE_BESTSOLFOUND) |
|
#define | SCIP_EVENTTYPE_SOLEVENT (SCIP_EVENTTYPE_SOLFOUND) |
|
#define | SCIP_EVENTTYPE_ROWCHANGED (SCIP_EVENTTYPE_ROWCOEFCHANGED | SCIP_EVENTTYPE_ROWCONSTCHANGED | SCIP_EVENTTYPE_ROWSIDECHANGED) |
|
#define | SCIP_EVENTTYPE_ROWEVENT (SCIP_EVENTTYPE_ROWADDEDSEPA | SCIP_EVENTTYPE_ROWDELETEDSEPA | SCIP_EVENTTYPE_ROWADDEDLP | SCIP_EVENTTYPE_ROWDELETEDLP | SCIP_EVENTTYPE_ROWCHANGED) |
|
#define | SCIP_DECL_EVENTCOPY(x) SCIP_RETCODE x (SCIP* scip, SCIP_EVENTHDLR* eventhdlr) |
|
#define | SCIP_DECL_EVENTFREE(x) SCIP_RETCODE x (SCIP* scip, SCIP_EVENTHDLR* eventhdlr) |
|
#define | SCIP_DECL_EVENTINIT(x) SCIP_RETCODE x (SCIP* scip, SCIP_EVENTHDLR* eventhdlr) |
|
#define | SCIP_DECL_EVENTEXIT(x) SCIP_RETCODE x (SCIP* scip, SCIP_EVENTHDLR* eventhdlr) |
|
#define | SCIP_DECL_EVENTINITSOL(x) SCIP_RETCODE x (SCIP* scip, SCIP_EVENTHDLR* eventhdlr) |
|
#define | SCIP_DECL_EVENTEXITSOL(x) SCIP_RETCODE x (SCIP* scip, SCIP_EVENTHDLR* eventhdlr) |
|
#define | SCIP_DECL_EVENTDELETE(x) SCIP_RETCODE x (SCIP* scip, SCIP_EVENTHDLR* eventhdlr, SCIP_EVENTDATA** eventdata) |
|
#define | SCIP_DECL_EVENTEXEC(x) SCIP_RETCODE x (SCIP* scip, SCIP_EVENTHDLR* eventhdlr, SCIP_EVENT* event, SCIP_EVENTDATA* eventdata) |
|
#define SCIP_EVENTTYPE_DISABLED 0x00000000u |
the event was disabled and has no effect any longer
Definition at line 43 of file type_event.h.
Referenced by catchLinearVarEvents(), catchVarEvents(), dropLinearVarEvents(), dropVarEvents(), eventDisable(), eventfilterDelayUpdates(), eventfilterProcessUpdates(), eventfilterSearch(), SCIPeventfilterAdd(), SCIPeventfilterCreate(), SCIPeventfilterDel(), SCIPeventfilterFree(), SCIPeventProcess(), and SCIPeventqueueAdd().
#define SCIP_EVENTTYPE_VARADDED 0x00000001u |
a variable has been added to the transformed problem
Definition at line 46 of file type_event.h.
Referenced by SCIP_DECL_EVENTEXEC(), SCIP_DECL_EVENTEXIT(), SCIP_DECL_EVENTINIT(), SCIP_DECL_PROPEXITSOL(), SCIP_DECL_PROPINITSOL(), SCIPeventChgVar(), SCIPeventCreateVarAdded(), SCIPeventGetVar(), SCIPeventProcess(), SCIPeventqueueAdd(), SCIPnlpCreate(), and SCIPnlpFree().
#define SCIP_EVENTTYPE_VARDELETED 0x00000002u |
#define SCIP_EVENTTYPE_VARFIXED 0x00000004u |
a variable has been fixed, aggregated, or multi-aggregated
Definition at line 48 of file type_event.h.
Referenced by addCoef(), catchEvents(), catchLinearVarEvents(), catchQuadVarEvents(), delCoefPos(), dropEvents(), dropLinearVarEvents(), dropQuadVarEvents(), nlpAddVars(), nlpDelVarPos(), SCIP_DECL_EVENTEXEC(), SCIP_DECL_EXPRGRAPHVARADDED(), SCIP_DECL_EXPRGRAPHVARREMOVE(), SCIPcreateConsLogicor(), SCIPeventChgVar(), SCIPeventCreateVarFixed(), SCIPeventGetVar(), SCIPeventProcess(), and SCIPeventqueueAdd().
#define SCIP_EVENTTYPE_VARUNLOCKED 0x00000008u |
#define SCIP_EVENTTYPE_OBJCHANGED 0x00000010u |
the objective value of a variable has been changed
Definition at line 52 of file type_event.h.
Referenced by nlpAddVars(), nlpDelVarPos(), SCIP_DECL_EVENTEXEC(), SCIP_DECL_EVENTEXIT(), SCIP_DECL_EVENTINIT(), SCIPeventChgVar(), SCIPeventCreateObjChanged(), SCIPeventGetNewobj(), SCIPeventGetOldobj(), SCIPeventGetVar(), SCIPeventProcess(), SCIPeventqueueAdd(), and SCIPeventqueueProcess().
#define SCIP_EVENTTYPE_GLBCHANGED 0x00000020u |
the global lower bound of a variable has been changed
Definition at line 53 of file type_event.h.
Referenced by catchEvents(), catchObjEvent(), dropEvents(), dropObjEvent(), SCIP_DECL_EVENTEXEC(), SCIPeventChgVar(), SCIPeventCreateGlbChanged(), SCIPeventGetNewbound(), SCIPeventGetOldbound(), SCIPeventGetVar(), SCIPeventProcess(), SCIPeventqueueAdd(), and varEventGlbChanged().
#define SCIP_EVENTTYPE_GUBCHANGED 0x00000040u |
the global upper bound of a variable has been changed
Definition at line 54 of file type_event.h.
Referenced by catchEvents(), catchObjEvent(), dropEvents(), dropObjEvent(), SCIP_DECL_EVENTEXEC(), SCIPeventChgVar(), SCIPeventCreateGubChanged(), SCIPeventGetNewbound(), SCIPeventGetOldbound(), SCIPeventGetVar(), SCIPeventProcess(), SCIPeventqueueAdd(), and varEventGubChanged().
#define SCIP_EVENTTYPE_LBTIGHTENED 0x00000080u |
the local lower bound of a variable has been increased
Definition at line 55 of file type_event.h.
Referenced by addCoef(), catchEvents(), catchLinearVarEvents(), catchVarEvents(), consdataCatchEvents(), consdataCatchWatchedEvents(), consdataDropEvents(), consdataDropWatchedEvents(), delCoefPos(), dropAndFreeEvents(), dropEvents(), dropLinearVarEvents(), dropVarEvents(), SCIP_DECL_EVENTEXEC(), SCIPeventChgVar(), SCIPeventCreateLbChanged(), SCIPeventGetNewbound(), SCIPeventGetOldbound(), SCIPeventGetVar(), SCIPeventProcess(), SCIPeventqueueAdd(), and setUpEvents().
#define SCIP_EVENTTYPE_LBRELAXED 0x00000100u |
the local lower bound of a variable has been decreased
Definition at line 56 of file type_event.h.
Referenced by addCoef(), catchEvents(), consdataCatchEvents(), consdataCatchWatchedEvents(), consdataDropEvents(), consdataDropWatchedEvents(), delCoefPos(), dropEvents(), SCIP_DECL_EVENTEXEC(), SCIPeventChgVar(), SCIPeventCreateLbChanged(), SCIPeventGetNewbound(), SCIPeventGetOldbound(), SCIPeventGetVar(), SCIPeventProcess(), SCIPeventqueueAdd(), and switchWatchedvars().
#define SCIP_EVENTTYPE_UBTIGHTENED 0x00000200u |
the local upper bound of a variable has been decreased
Definition at line 57 of file type_event.h.
Referenced by addCoef(), catchEvents(), catchLinearVarEvents(), catchRhsVarEvents(), catchVarEvents(), consdataCatchEvents(), consdataCatchWatchedEvents(), consdataDropEvents(), consdataDropWatchedEvents(), delCoefPos(), dropAndFreeEvents(), dropEvents(), dropLinearVarEvents(), dropRhsVarEvents(), dropVarEvents(), SCIP_DECL_EVENTEXEC(), SCIPeventChgVar(), SCIPeventCreateUbChanged(), SCIPeventGetNewbound(), SCIPeventGetOldbound(), SCIPeventGetVar(), SCIPeventProcess(), SCIPeventqueueAdd(), setUpEvents(), and switchWatchedvars().
#define SCIP_EVENTTYPE_UBRELAXED 0x00000400u |
the local upper bound of a variable has been increased
Definition at line 58 of file type_event.h.
Referenced by addCoef(), catchEvents(), consdataCatchEvents(), consdataCatchWatchedEvents(), consdataDropEvents(), consdataDropWatchedEvents(), delCoefPos(), dropEvents(), SCIP_DECL_EVENTEXEC(), SCIPeventChgVar(), SCIPeventCreateUbChanged(), SCIPeventGetNewbound(), SCIPeventGetOldbound(), SCIPeventGetVar(), SCIPeventProcess(), and SCIPeventqueueAdd().
#define SCIP_EVENTTYPE_GHOLEADDED 0x00000800u |
#define SCIP_EVENTTYPE_GHOLEREMOVED 0x00001000u |
#define SCIP_EVENTTYPE_LHOLEADDED 0x00002000u |
#define SCIP_EVENTTYPE_LHOLEREMOVED 0x00004000u |
#define SCIP_EVENTTYPE_IMPLADDED 0x00008000u |
#define SCIP_EVENTTYPE_PRESOLVEROUND 0x00010000u |
#define SCIP_EVENTTYPE_NODEFOCUSED 0x00020000u |
#define SCIP_EVENTTYPE_NODEFEASIBLE 0x00040000u |
#define SCIP_EVENTTYPE_NODEINFEASIBLE 0x00080000u |
#define SCIP_EVENTTYPE_NODEBRANCHED 0x00100000u |
#define SCIP_EVENTTYPE_FIRSTLPSOLVED 0x00200000u |
#define SCIP_EVENTTYPE_LPSOLVED 0x00400000u |
#define SCIP_EVENTTYPE_POORSOLFOUND 0x00800000u |
#define SCIP_EVENTTYPE_BESTSOLFOUND 0x01000000u |
#define SCIP_EVENTTYPE_ROWADDEDSEPA 0x02000000u |
#define SCIP_EVENTTYPE_ROWDELETEDSEPA 0x04000000u |
#define SCIP_EVENTTYPE_ROWADDEDLP 0x08000000u |
#define SCIP_EVENTTYPE_ROWDELETEDLP 0x10000000u |
#define SCIP_EVENTTYPE_ROWCOEFCHANGED 0x20000000u |
#define SCIP_EVENTTYPE_ROWCONSTCHANGED 0x40000000u |
#define SCIP_EVENTTYPE_ROWSIDECHANGED 0x80000000u |
Definition at line 99 of file type_event.h.
Referenced by applyFixings(), catchEvent(), catchQuadVarEvents(), consdataCatchEvents(), consdataCreate(), consdataDropEvents(), consdataSwitchWatchedvars(), deleteVarSOS1(), deleteVarSOS2(), dropEvent(), dropQuadVarEvents(), handleNewVariableSOS1(), handleNewVariableSOS2(), nlpAddVars(), nlpDelVarPos(), presolRoundConsSOS1(), presolRoundIndicator(), presolRoundSOS2(), SCIP_DECL_CONSDELETE(), SCIP_DECL_CONSTRANS(), SCIP_DECL_EVENTEXEC(), SCIP_DECL_EXPRGRAPHVARADDED(), SCIP_DECL_EXPRGRAPHVARREMOVE(), SCIPeventProcess(), SCIPeventqueueAdd(), and SCIPsetBinaryVarIndicator().
#define SCIP_EVENTTYPE_VARCHANGED |
Value:#define SCIP_EVENTTYPE_OBJCHANGED
#define SCIP_EVENTTYPE_VARFIXED
#define SCIP_EVENTTYPE_IMPLADDED
#define SCIP_EVENTTYPE_DOMCHANGED
#define SCIP_EVENTTYPE_GBDCHANGED
#define SCIP_EVENTTYPE_VARUNLOCKED
#define SCIP_EVENTTYPE_VARDELETED
Definition at line 104 of file type_event.h.
Referenced by SCIPcatchVarEvent(), and SCIPvarCatchEvent().
#define SCIP_EVENTTYPE_NODESOLVED |
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 156 of file type_event.h.
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 164 of file type_event.h.
initialization method of event handler (called after problem was transformed)
input:
- scip : SCIP main data structure
- eventhdlr : the event handler itself
Definition at line 172 of file type_event.h.
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 180 of file type_event.h.
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 191 of file type_event.h.
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 202 of file type_event.h.
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 211 of file type_event.h.
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 226 of file type_event.h.
event handler for a specific events
Definition at line 128 of file type_event.h.
data for variable addition events
Definition at line 131 of file type_event.h.
data for variable deletion events
Definition at line 132 of file type_event.h.
data for variable fixing events
Definition at line 133 of file type_event.h.
data for variable unlocked events
Definition at line 134 of file type_event.h.
data for objective value change events
Definition at line 135 of file type_event.h.
data for implication added events
Definition at line 138 of file type_event.h.
data for row addition to sepastorage events
Definition at line 139 of file type_event.h.
data for row deletion from sepastorage events
Definition at line 140 of file type_event.h.
data for row addition to LP events
Definition at line 141 of file type_event.h.
data for row deletion from LP events
Definition at line 142 of file type_event.h.
data for row coefficient change events
Definition at line 143 of file type_event.h.
data for row constant change events
Definition at line 144 of file type_event.h.
data for row side change events
Definition at line 145 of file type_event.h.
locally defined event specific data
Definition at line 146 of file type_event.h.
event filter to select events to be processed by an event handler
Definition at line 147 of file type_event.h.
event queue to cache events and process them later
Definition at line 148 of file type_event.h.
|