SCIP Doxygen Documentation
Loading...
Searching...
No Matches
type_event.h File Reference

Detailed Description

type definitions for managing events

Author
Tobias Achterberg
Leona Gottwald

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.

Macros

#define SCIP_EVENTTYPE_DISABLED   UINT64_C(0x000000000)
#define SCIP_EVENTTYPE_VARADDED   UINT64_C(0x000000001)
#define SCIP_EVENTTYPE_VARDELETED   UINT64_C(0x000000002)
#define SCIP_EVENTTYPE_VARFIXED   UINT64_C(0x000000004)
#define SCIP_EVENTTYPE_VARUNLOCKED   UINT64_C(0x000000008)
#define SCIP_EVENTTYPE_OBJCHANGED   UINT64_C(0x000000010)
#define SCIP_EVENTTYPE_GLBCHANGED   UINT64_C(0x000000020)
#define SCIP_EVENTTYPE_GUBCHANGED   UINT64_C(0x000000040)
#define SCIP_EVENTTYPE_LBTIGHTENED   UINT64_C(0x000000080)
#define SCIP_EVENTTYPE_LBRELAXED   UINT64_C(0x000000100)
#define SCIP_EVENTTYPE_UBTIGHTENED   UINT64_C(0x000000200)
#define SCIP_EVENTTYPE_UBRELAXED   UINT64_C(0x000000400)
#define SCIP_EVENTTYPE_GHOLEADDED   UINT64_C(0x000000800)
#define SCIP_EVENTTYPE_GHOLEREMOVED   UINT64_C(0x000001000)
#define SCIP_EVENTTYPE_LHOLEADDED   UINT64_C(0x000002000)
#define SCIP_EVENTTYPE_LHOLEREMOVED   UINT64_C(0x000004000)
#define SCIP_EVENTTYPE_IMPLADDED   UINT64_C(0x000008000)
#define SCIP_EVENTTYPE_TYPECHANGED   UINT64_C(0x000010000)
#define SCIP_EVENTTYPE_PRESOLVEROUND   UINT64_C(0x000020000)
#define SCIP_EVENTTYPE_NODEFOCUSED   UINT64_C(0x000040000)
#define SCIP_EVENTTYPE_NODEFEASIBLE   UINT64_C(0x000080000)
#define SCIP_EVENTTYPE_NODEINFEASIBLE   UINT64_C(0x000100000)
#define SCIP_EVENTTYPE_NODEBRANCHED   UINT64_C(0x000200000)
#define SCIP_EVENTTYPE_NODEDELETE   UINT64_C(0x000400000)
#define SCIP_EVENTTYPE_FIRSTLPSOLVED   UINT64_C(0x000800000)
#define SCIP_EVENTTYPE_LPSOLVED   UINT64_C(0x001000000)
#define SCIP_EVENTTYPE_POORSOLFOUND   UINT64_C(0x002000000)
#define SCIP_EVENTTYPE_BESTSOLFOUND   UINT64_C(0x004000000)
#define SCIP_EVENTTYPE_ROWADDEDSEPA   UINT64_C(0x008000000)
#define SCIP_EVENTTYPE_ROWDELETEDSEPA   UINT64_C(0x010000000)
#define SCIP_EVENTTYPE_ROWADDEDLP   UINT64_C(0x020000000)
#define SCIP_EVENTTYPE_ROWDELETEDLP   UINT64_C(0x040000000)
#define SCIP_EVENTTYPE_ROWCOEFCHANGED   UINT64_C(0x080000000)
#define SCIP_EVENTTYPE_ROWCONSTCHANGED   UINT64_C(0x100000000)
#define SCIP_EVENTTYPE_ROWSIDECHANGED   UINT64_C(0x200000000)
#define SCIP_EVENTTYPE_SYNC   UINT64_C(0x400000000)
#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 | SCIP_EVENTTYPE_TYPECHANGED)
#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_EVENTTYPE_FORMAT   PRIx64
#define SCIP_DECL_EVENTCOPY(x)
#define SCIP_DECL_EVENTFREE(x)
#define SCIP_DECL_EVENTINIT(x)
#define SCIP_DECL_EVENTEXIT(x)
#define SCIP_DECL_EVENTINITSOL(x)
#define SCIP_DECL_EVENTEXITSOL(x)
#define SCIP_DECL_EVENTDELETE(x)
#define SCIP_DECL_EVENTEXEC(x)

Macro Definition Documentation

◆ SCIP_EVENTTYPE_DISABLED

#define SCIP_EVENTTYPE_DISABLED   UINT64_C(0x000000000)

◆ SCIP_EVENTTYPE_VARADDED

◆ SCIP_EVENTTYPE_VARDELETED

◆ SCIP_EVENTTYPE_VARFIXED

◆ SCIP_EVENTTYPE_VARUNLOCKED

#define SCIP_EVENTTYPE_VARUNLOCKED   UINT64_C(0x000000008)

the number of rounding locks of a variable was reduced to zero or one

Definition at line 73 of file type_event.h.

Referenced by consCatchEvent(), consDropEvent(), SCIP_DECL_EVENTEXEC(), SCIPeventChgVar(), SCIPeventCreateVarUnlocked(), SCIPeventGetVar(), SCIPeventProcess(), and SCIPeventqueueAdd().

◆ SCIP_EVENTTYPE_OBJCHANGED

◆ SCIP_EVENTTYPE_GLBCHANGED

◆ SCIP_EVENTTYPE_GUBCHANGED

◆ SCIP_EVENTTYPE_LBTIGHTENED

◆ SCIP_EVENTTYPE_LBRELAXED

◆ SCIP_EVENTTYPE_UBTIGHTENED

◆ SCIP_EVENTTYPE_UBRELAXED

◆ SCIP_EVENTTYPE_GHOLEADDED

#define SCIP_EVENTTYPE_GHOLEADDED   UINT64_C(0x000000800)

a global hole has been added to the hole list of a variable's domain

Definition at line 81 of file type_event.h.

Referenced by SCIPeventChgVar(), SCIPeventCreateGholeAdded(), SCIPeventGetVar(), SCIPeventProcess(), SCIPeventqueueAdd(), and varEventGholeAdded().

◆ SCIP_EVENTTYPE_GHOLEREMOVED

#define SCIP_EVENTTYPE_GHOLEREMOVED   UINT64_C(0x000001000)

a global hole has been removed from the hole list of a variable's domain

Definition at line 82 of file type_event.h.

Referenced by SCIPeventChgVar(), SCIPeventCreateGholeRemoved(), SCIPeventGetVar(), SCIPeventProcess(), and SCIPeventqueueAdd().

◆ SCIP_EVENTTYPE_LHOLEADDED

#define SCIP_EVENTTYPE_LHOLEADDED   UINT64_C(0x000002000)

a local hole has been added to the hole list of a variable's domain

Definition at line 83 of file type_event.h.

Referenced by SCIPeventChgVar(), SCIPeventCreateLholeAdded(), SCIPeventGetVar(), SCIPeventProcess(), SCIPeventqueueAdd(), and varProcessAddHoleLocal().

◆ SCIP_EVENTTYPE_LHOLEREMOVED

#define SCIP_EVENTTYPE_LHOLEREMOVED   UINT64_C(0x000004000)

a local hole has been removed from the hole list of a variable's domain

Definition at line 84 of file type_event.h.

Referenced by SCIPeventChgVar(), SCIPeventCreateLholeRemoved(), SCIPeventGetVar(), SCIPeventProcess(), and SCIPeventqueueAdd().

◆ SCIP_EVENTTYPE_IMPLADDED

#define SCIP_EVENTTYPE_IMPLADDED   UINT64_C(0x000008000)

the variable's implication list, variable bound or clique information was extended

Definition at line 85 of file type_event.h.

Referenced by SCIP_DECL_EVENTEXEC(), SCIPeventChgVar(), SCIPeventCreateImplAdded(), SCIPeventGetVar(), SCIPeventProcess(), SCIPeventqueueAdd(), and SCIPeventqueueProcess().

◆ SCIP_EVENTTYPE_TYPECHANGED

#define SCIP_EVENTTYPE_TYPECHANGED   UINT64_C(0x000010000)

◆ SCIP_EVENTTYPE_PRESOLVEROUND

#define SCIP_EVENTTYPE_PRESOLVEROUND   UINT64_C(0x000020000)

a presolving round has been finished

Definition at line 89 of file type_event.h.

Referenced by presolveRound(), SCIPeventProcess(), and SCIPeventqueueAdd().

◆ SCIP_EVENTTYPE_NODEFOCUSED

#define SCIP_EVENTTYPE_NODEFOCUSED   UINT64_C(0x000040000)

◆ SCIP_EVENTTYPE_NODEFEASIBLE

#define SCIP_EVENTTYPE_NODEFEASIBLE   UINT64_C(0x000080000)

the LP/pseudo solution of the node was feasible

Definition at line 93 of file type_event.h.

Referenced by SCIP_DECL_EVENTEXEC(), SCIPeventProcess(), SCIPeventqueueAdd(), SCIPreoptCheckCutoff(), SCIPsolveCIP(), and solveNodeLP().

◆ SCIP_EVENTTYPE_NODEINFEASIBLE

#define SCIP_EVENTTYPE_NODEINFEASIBLE   UINT64_C(0x000100000)

the focus node has been proven to be infeasible or was bounded

Definition at line 94 of file type_event.h.

Referenced by SCIP_DECL_EVENTEXEC(), SCIPeventProcess(), SCIPeventqueueAdd(), SCIPnodeCutoff(), SCIPnodeFocus(), SCIPnodepqBound(), SCIPreoptCheckCutoff(), and SCIPsolveCIP().

◆ SCIP_EVENTTYPE_NODEBRANCHED

◆ SCIP_EVENTTYPE_NODEDELETE

#define SCIP_EVENTTYPE_NODEDELETE   UINT64_C(0x000400000)

◆ SCIP_EVENTTYPE_FIRSTLPSOLVED

#define SCIP_EVENTTYPE_FIRSTLPSOLVED   UINT64_C(0x000800000)

the node's initial LP was solved

Definition at line 100 of file type_event.h.

Referenced by SCIP_DECL_EVENTEXIT(), SCIP_DECL_EVENTINIT(), SCIPeventProcess(), SCIPeventqueueAdd(), and solveNodeInitialLP().

◆ SCIP_EVENTTYPE_LPSOLVED

◆ SCIP_EVENTTYPE_POORSOLFOUND

#define SCIP_EVENTTYPE_POORSOLFOUND   UINT64_C(0x002000000)

a good enough primal feasible (but not new best) solution was found

Definition at line 104 of file type_event.h.

Referenced by primalAddSol(), SCIPeventProcess(), and SCIPeventqueueAdd().

◆ SCIP_EVENTTYPE_BESTSOLFOUND

◆ SCIP_EVENTTYPE_ROWADDEDSEPA

#define SCIP_EVENTTYPE_ROWADDEDSEPA   UINT64_C(0x008000000)

a row has been added to SCIP's separation storage

Definition at line 108 of file type_event.h.

Referenced by SCIPeventCreateRowAddedSepa(), SCIPeventGetRow(), SCIPeventProcess(), SCIPeventqueueAdd(), and SCIPsepastoreAddCut().

◆ SCIP_EVENTTYPE_ROWDELETEDSEPA

#define SCIP_EVENTTYPE_ROWDELETEDSEPA   UINT64_C(0x010000000)

a row has been removed from SCIP's separation storage

Definition at line 109 of file type_event.h.

Referenced by SCIPeventCreateRowDeletedSepa(), SCIPeventGetRow(), SCIPeventProcess(), SCIPeventqueueAdd(), SCIPsepastoreAddCut(), SCIPsepastoreClearCuts(), and sepastoreDelCut().

◆ SCIP_EVENTTYPE_ROWADDEDLP

#define SCIP_EVENTTYPE_ROWADDEDLP   UINT64_C(0x020000000)

a row has been added to the LP

Definition at line 110 of file type_event.h.

Referenced by SCIPeventCreateRowAddedLP(), SCIPeventGetRow(), SCIPeventProcess(), SCIPeventqueueAdd(), and SCIPlpAddRow().

◆ SCIP_EVENTTYPE_ROWDELETEDLP

#define SCIP_EVENTTYPE_ROWDELETEDLP   UINT64_C(0x040000000)

a row has been removed from the LP

Definition at line 111 of file type_event.h.

Referenced by lpDelRowset(), SCIPeventCreateRowDeletedLP(), SCIPeventGetRow(), SCIPeventProcess(), SCIPeventqueueAdd(), and SCIPlpShrinkRows().

◆ SCIP_EVENTTYPE_ROWCOEFCHANGED

#define SCIP_EVENTTYPE_ROWCOEFCHANGED   UINT64_C(0x080000000)

◆ SCIP_EVENTTYPE_ROWCONSTCHANGED

#define SCIP_EVENTTYPE_ROWCONSTCHANGED   UINT64_C(0x100000000)

the constant of a row has been changed (row specific event)

Definition at line 113 of file type_event.h.

Referenced by rowEventConstantChanged(), SCIPeventCreateRowConstChanged(), SCIPeventGetRow(), SCIPeventGetRowNewConstVal(), SCIPeventGetRowOldConstVal(), SCIPeventProcess(), and SCIPeventqueueAdd().

◆ SCIP_EVENTTYPE_ROWSIDECHANGED

#define SCIP_EVENTTYPE_ROWSIDECHANGED   UINT64_C(0x200000000)

◆ SCIP_EVENTTYPE_SYNC

#define SCIP_EVENTTYPE_SYNC   UINT64_C(0x400000000)

synchronization event

Definition at line 117 of file type_event.h.

Referenced by SCIP_DECL_EVENTEXIT(), SCIP_DECL_EVENTINIT(), SCIPeventCreateSync(), SCIPeventProcess(), and SCIPeventqueueAdd().

◆ SCIP_EVENTTYPE_GBDCHANGED

◆ SCIP_EVENTTYPE_LBCHANGED

#define SCIP_EVENTTYPE_LBCHANGED   (SCIP_EVENTTYPE_LBTIGHTENED | SCIP_EVENTTYPE_LBRELAXED)

◆ SCIP_EVENTTYPE_UBCHANGED

#define SCIP_EVENTTYPE_UBCHANGED   (SCIP_EVENTTYPE_UBTIGHTENED | SCIP_EVENTTYPE_UBRELAXED)

Definition at line 122 of file type_event.h.

Referenced by SCIP_DECL_EVENTEXEC(), SCIPeventqueueProcess(), and varEventUbChanged().

◆ SCIP_EVENTTYPE_BOUNDTIGHTENED

◆ SCIP_EVENTTYPE_BOUNDRELAXED

◆ SCIP_EVENTTYPE_BOUNDCHANGED

◆ SCIP_EVENTTYPE_GHOLECHANGED

#define SCIP_EVENTTYPE_GHOLECHANGED   (SCIP_EVENTTYPE_GHOLEADDED | SCIP_EVENTTYPE_GHOLEREMOVED)

Definition at line 126 of file type_event.h.

◆ SCIP_EVENTTYPE_LHOLECHANGED

#define SCIP_EVENTTYPE_LHOLECHANGED   (SCIP_EVENTTYPE_LHOLEADDED | SCIP_EVENTTYPE_LHOLEREMOVED)

Definition at line 127 of file type_event.h.

◆ SCIP_EVENTTYPE_HOLECHANGED

#define SCIP_EVENTTYPE_HOLECHANGED   (SCIP_EVENTTYPE_GHOLECHANGED | SCIP_EVENTTYPE_LHOLECHANGED)

Definition at line 128 of file type_event.h.

Referenced by SCIPeventGetHoleLeft(), and SCIPeventGetHoleRight().

◆ SCIP_EVENTTYPE_DOMCHANGED

#define SCIP_EVENTTYPE_DOMCHANGED   (SCIP_EVENTTYPE_BOUNDCHANGED | SCIP_EVENTTYPE_HOLECHANGED)

Definition at line 129 of file type_event.h.

◆ SCIP_EVENTTYPE_VARCHANGED

#define SCIP_EVENTTYPE_VARCHANGED
Value:
#define SCIP_EVENTTYPE_VARUNLOCKED
Definition type_event.h:73
#define SCIP_EVENTTYPE_TYPECHANGED
Definition type_event.h:86
#define SCIP_EVENTTYPE_GBDCHANGED
Definition type_event.h:120
#define SCIP_EVENTTYPE_OBJCHANGED
Definition type_event.h:74
#define SCIP_EVENTTYPE_VARFIXED
Definition type_event.h:72
#define SCIP_EVENTTYPE_VARDELETED
Definition type_event.h:71
#define SCIP_EVENTTYPE_IMPLADDED
Definition type_event.h:85
#define SCIP_EVENTTYPE_DOMCHANGED
Definition type_event.h:129

Definition at line 130 of file type_event.h.

Referenced by SCIPcatchVarEvent(), and SCIPvarCatchEvent().

◆ SCIP_EVENTTYPE_VAREVENT

Definition at line 133 of file type_event.h.

◆ SCIP_EVENTTYPE_NODESOLVED

◆ SCIP_EVENTTYPE_NODEEVENT

#define SCIP_EVENTTYPE_NODEEVENT   (SCIP_EVENTTYPE_NODEFOCUSED | SCIP_EVENTTYPE_NODESOLVED)

Definition at line 138 of file type_event.h.

Referenced by SCIPeventChgNode(), and SCIPeventGetNode().

◆ SCIP_EVENTTYPE_LPEVENT

#define SCIP_EVENTTYPE_LPEVENT   (SCIP_EVENTTYPE_FIRSTLPSOLVED | SCIP_EVENTTYPE_LPSOLVED)

Definition at line 141 of file type_event.h.

Referenced by SCIPeventChgNode(), and SCIPeventGetNode().

◆ SCIP_EVENTTYPE_SOLFOUND

◆ SCIP_EVENTTYPE_SOLEVENT

#define SCIP_EVENTTYPE_SOLEVENT   (SCIP_EVENTTYPE_SOLFOUND)

Definition at line 145 of file type_event.h.

Referenced by SCIPeventChgSol(), and SCIPeventGetSol().

◆ SCIP_EVENTTYPE_ROWCHANGED

Definition at line 148 of file type_event.h.

Referenced by SCIPcatchRowEvent(), and SCIProwCatchEvent().

◆ SCIP_EVENTTYPE_ROWEVENT

◆ SCIP_EVENTTYPE_FORMAT

◆ SCIP_DECL_EVENTCOPY

#define SCIP_DECL_EVENTCOPY ( x)
Value:
SCIP_VAR ** x
struct SCIP_Eventhdlr SCIP_EVENTHDLR
Definition type_event.h:154
enum SCIP_Retcode SCIP_RETCODE
struct Scip SCIP
Definition type_scip.h:39

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 183 of file type_event.h.

Referenced by doEventhdlrCreate(), SCIPeventhdlrCreate(), SCIPeventhdlrSetCopy(), SCIPincludeEventhdlr(), and SCIPsetEventhdlrCopy().

◆ SCIP_DECL_EVENTFREE

#define SCIP_DECL_EVENTFREE ( x)
Value:

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 191 of file type_event.h.

Referenced by doEventhdlrCreate(), SCIPeventhdlrCreate(), SCIPeventhdlrSetFree(), SCIPincludeEventhdlr(), and SCIPsetEventhdlrFree().

◆ SCIP_DECL_EVENTINIT

#define SCIP_DECL_EVENTINIT ( x)
Value:

initialization method of event handler (called after problem was transformed)

input:

  • scip : SCIP main data structure
  • eventhdlr : the event handler itself

Definition at line 199 of file type_event.h.

Referenced by doEventhdlrCreate(), SCIPeventhdlrCreate(), SCIPeventhdlrSetInit(), SCIPincludeEventhdlr(), and SCIPsetEventhdlrInit().

◆ SCIP_DECL_EVENTEXIT

#define SCIP_DECL_EVENTEXIT ( x)
Value:

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 207 of file type_event.h.

Referenced by doEventhdlrCreate(), SCIPeventhdlrCreate(), SCIPeventhdlrSetExit(), SCIPincludeEventhdlr(), and SCIPsetEventhdlrExit().

◆ SCIP_DECL_EVENTINITSOL

#define SCIP_DECL_EVENTINITSOL ( x)
Value:

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 218 of file type_event.h.

◆ SCIP_DECL_EVENTEXITSOL

#define SCIP_DECL_EVENTEXITSOL ( x)
Value:

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 229 of file type_event.h.

◆ SCIP_DECL_EVENTDELETE

#define SCIP_DECL_EVENTDELETE ( x)
Value:
SCIP_RETCODE x (SCIP* scip, SCIP_EVENTHDLR* eventhdlr, SCIP_EVENTDATA** eventdata)
struct SCIP_EventData SCIP_EVENTDATA
Definition type_event.h:173

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 238 of file type_event.h.

Referenced by doEventhdlrCreate(), SCIPeventhdlrCreate(), SCIPeventhdlrSetDelete(), SCIPincludeEventhdlr(), and SCIPsetEventhdlrDelete().

◆ SCIP_DECL_EVENTEXEC

#define SCIP_DECL_EVENTEXEC ( x)
Value:
SCIP_RETCODE x (SCIP* scip, SCIP_EVENTHDLR* eventhdlr, SCIP_EVENT* event, SCIP_EVENTDATA* eventdata)
struct SCIP_Event SCIP_EVENT
Definition type_event.h:156

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 253 of file type_event.h.

Referenced by doEventhdlrCreate(), SCIPeventhdlrCreate(), SCIPincludeEventhdlr(), and SCIPincludeEventhdlrBasic().

Typedef Documentation

◆ SCIP_EVENTTYPE

typedef uint64_t SCIP_EVENTTYPE

type of event (bit field)

Definition at line 151 of file type_event.h.

◆ SCIP_EVENTHDLR

event handler for a specific events

Definition at line 154 of file type_event.h.

◆ SCIP_EVENTHDLRDATA

typedef struct SCIP_EventhdlrData SCIP_EVENTHDLRDATA

event handler data

Definition at line 155 of file type_event.h.

◆ SCIP_EVENT

typedef struct SCIP_Event SCIP_EVENT

event data structure

Definition at line 156 of file type_event.h.

◆ SCIP_EVENTVARADDED

data for variable addition events

Definition at line 157 of file type_event.h.

◆ SCIP_EVENTVARDELETED

data for variable deletion events

Definition at line 158 of file type_event.h.

◆ SCIP_EVENTVARFIXED

data for variable fixing events

Definition at line 159 of file type_event.h.

◆ SCIP_EVENTVARUNLOCKED

data for variable unlocked events

Definition at line 160 of file type_event.h.

◆ SCIP_EVENTOBJCHG

data for objective value change events

Definition at line 161 of file type_event.h.

◆ SCIP_EVENTBDCHG

data for bound change events

Definition at line 162 of file type_event.h.

◆ SCIP_EVENTHOLE

data for domain hole events

Definition at line 163 of file type_event.h.

◆ SCIP_EVENTIMPLADD

data for implication added events

Definition at line 164 of file type_event.h.

◆ SCIP_EVENTTYPECHG

data for variable type change events

Definition at line 165 of file type_event.h.

◆ SCIP_EVENTROWADDEDSEPA

data for row addition to sepastorage events

Definition at line 166 of file type_event.h.

◆ SCIP_EVENTROWDELETEDSEPA

data for row deletion from sepastorage events

Definition at line 167 of file type_event.h.

◆ SCIP_EVENTROWADDEDLP

data for row addition to LP events

Definition at line 168 of file type_event.h.

◆ SCIP_EVENTROWDELETEDLP

data for row deletion from LP events

Definition at line 169 of file type_event.h.

◆ SCIP_EVENTROWCOEFCHANGED

data for row coefficient change events

Definition at line 170 of file type_event.h.

◆ SCIP_EVENTROWCONSTCHANGED

data for row constant change events

Definition at line 171 of file type_event.h.

◆ SCIP_EVENTROWSIDECHANGED

data for row side change events

Definition at line 172 of file type_event.h.

◆ SCIP_EVENTDATA

typedef struct SCIP_EventData SCIP_EVENTDATA

locally defined event specific data

Definition at line 173 of file type_event.h.

◆ SCIP_EVENTFILTER

event filter to select events to be processed by an event handler

Definition at line 174 of file type_event.h.

◆ SCIP_EVENTQUEUE

event queue to cache events and process them later

Definition at line 175 of file type_event.h.