Scippy

SCIP

Solving Constraint Integer Programs

Functions
pub_event.h File Reference
Public Methods

Detailed Description

public methods for managing events

Author
Tobias Achterberg

Definition in file pub_event.h.

#include "scip/def.h"
#include "scip/type_retcode.h"
#include "scip/type_event.h"
#include "scip/type_var.h"
#include "scip/type_sol.h"
#include "scip/type_tree.h"

Go to the source code of this file.

Functions

const char * SCIPeventhdlrGetName (SCIP_EVENTHDLR *eventhdlr)
 
SCIP_EVENTHDLRDATA * SCIPeventhdlrGetData (SCIP_EVENTHDLR *eventhdlr)
 
void SCIPeventhdlrSetData (SCIP_EVENTHDLR *eventhdlr, SCIP_EVENTHDLRDATA *eventhdlrdata)
 
SCIP_Bool SCIPeventhdlrIsInitialized (SCIP_EVENTHDLR *eventhdlr)
 
SCIP_Real SCIPeventhdlrGetSetupTime (SCIP_EVENTHDLR *eventhdlr)
 
SCIP_Real SCIPeventhdlrGetTime (SCIP_EVENTHDLR *eventhdlr)
 
SCIP_EVENTTYPE SCIPeventGetType (SCIP_EVENT *event)
 
SCIP_VAR * SCIPeventGetVar (SCIP_EVENT *event)
 
SCIP_Real SCIPeventGetOldobj (SCIP_EVENT *event)
 
SCIP_Real SCIPeventGetNewobj (SCIP_EVENT *event)
 
SCIP_Real SCIPeventGetOldbound (SCIP_EVENT *event)
 
SCIP_Real SCIPeventGetNewbound (SCIP_EVENT *event)
 
SCIP_NODE * SCIPeventGetNode (SCIP_EVENT *event)
 
SCIP_SOL * SCIPeventGetSol (SCIP_EVENT *event)
 
SCIP_Real SCIPeventGetHoleLeft (SCIP_EVENT *event)
 
SCIP_Real SCIPeventGetHoleRight (SCIP_EVENT *event)
 
SCIP_ROW * SCIPeventGetRow (SCIP_EVENT *event)
 
SCIP_COL * SCIPeventGetRowCol (SCIP_EVENT *event)
 
SCIP_Real SCIPeventGetRowOldCoefVal (SCIP_EVENT *event)
 
SCIP_Real SCIPeventGetRowNewCoefVal (SCIP_EVENT *event)
 
SCIP_Real SCIPeventGetRowOldConstVal (SCIP_EVENT *event)
 
SCIP_Real SCIPeventGetRowNewConstVal (SCIP_EVENT *event)
 
SCIP_SIDETYPE SCIPeventGetRowSide (SCIP_EVENT *event)
 
SCIP_Real SCIPeventGetRowOldSideVal (SCIP_EVENT *event)
 
SCIP_Real SCIPeventGetRowNewSideVal (SCIP_EVENT *event)
 

Function Documentation

const char* SCIPeventhdlrGetName ( SCIP_EVENTHDLR *  eventhdlr)

gets name of event handler

Parameters
eventhdlrevent handler

Definition at line 278 of file event.c.

References SCIP_Eventhdlr::name, and NULL.

Referenced by SCIP_DECL_EVENTEXEC(), SCIPeventhdlrCopyInclude(), and SCIPsetFindEventhdlr().

SCIP_EVENTHDLRDATA* SCIPeventhdlrGetData ( SCIP_EVENTHDLR *  eventhdlr)

gets user data of event handler

Parameters
eventhdlrevent handler

Definition at line 288 of file event.c.

References SCIP_Eventhdlr::eventhdlrdata, and NULL.

Referenced by SCIP_DECL_EVENTCOPY(), SCIP_DECL_EVENTDELETE(), SCIP_DECL_EVENTEXEC(), SCIP_DECL_EVENTEXIT(), SCIP_DECL_EVENTEXITSOL(), SCIP_DECL_EVENTFREE(), SCIP_DECL_EVENTINIT(), SCIP_DECL_EVENTINITSOL(), SCIP_DECL_HEUREXEC(), SCIP_DECL_HEURFREE(), SCIPfindObjEventhdlr(), and SCIPgetObjEventhdlr().

void SCIPeventhdlrSetData ( SCIP_EVENTHDLR *  eventhdlr,
SCIP_EVENTHDLRDATA *  eventhdlrdata 
)

sets user data of event handler; user has to free old data in advance!

Parameters
eventhdlrevent handler
eventhdlrdatanew event handler user data

Definition at line 298 of file event.c.

References SCIP_Eventhdlr::eventhdlrdata, and NULL.

Referenced by SCIP_DECL_EVENTFREE().

SCIP_Bool SCIPeventhdlrIsInitialized ( SCIP_EVENTHDLR *  eventhdlr)

is event handler initialized?

Parameters
eventhdlrevent handler

Definition at line 386 of file event.c.

References SCIP_Eventhdlr::initialized, and NULL.

Referenced by SCIPsetIncludeEventhdlr().

SCIP_Real SCIPeventhdlrGetSetupTime ( SCIP_EVENTHDLR *  eventhdlr)

gets time in seconds used in this event handler for setting up for next stages

Parameters
eventhdlrevent handler

Definition at line 396 of file event.c.

References NULL, SCIPclockGetTime(), and SCIP_Eventhdlr::setuptime.

SCIP_Real SCIPeventhdlrGetTime ( SCIP_EVENTHDLR *  eventhdlr)

gets time in seconds used in this event handler

gets time in seconds used in this event handler, this measurement is currently disabled so this method will return 0, define TIMEEVENTEXEC in the beginning of this file to enable

Parameters
eventhdlrevent handler

Definition at line 408 of file event.c.

References SCIP_Eventhdlr::eventtime, NULL, and SCIPclockGetTime().

SCIP_EVENTTYPE SCIPeventGetType ( SCIP_EVENT *  event)

gets type of event

Parameters
eventevent

Definition at line 905 of file event.c.

References NULL.

Referenced by SCIP_DECL_EVENTEXEC().

SCIP_VAR* SCIPeventGetVar ( SCIP_EVENT *  event)

gets variable for a variable event (var added, var deleted, var fixed, objective value or domain change, domain hole added or removed)

gets variable for a variable event (var added, var deleted, var fixed, objective value or domain change)

Parameters
eventevent

Definition at line 928 of file event.c.

References SCIP_Event::data, SCIP_Event::eventbdchg, SCIP_Event::eventhole, SCIP_Event::eventimpladd, SCIP_Event::eventobjchg, SCIP_Event::eventtype, SCIP_Event::eventvaradded, SCIP_Event::eventvardeleted, SCIP_Event::eventvarfixed, SCIP_Event::eventvarunlocked, NULL, SCIP_EVENTTYPE_GHOLEADDED, SCIP_EVENTTYPE_GHOLEREMOVED, SCIP_EVENTTYPE_GLBCHANGED, SCIP_EVENTTYPE_GUBCHANGED, SCIP_EVENTTYPE_IMPLADDED, SCIP_EVENTTYPE_LBRELAXED, SCIP_EVENTTYPE_LBTIGHTENED, SCIP_EVENTTYPE_LHOLEADDED, SCIP_EVENTTYPE_LHOLEREMOVED, SCIP_EVENTTYPE_OBJCHANGED, SCIP_EVENTTYPE_UBRELAXED, SCIP_EVENTTYPE_UBTIGHTENED, SCIP_EVENTTYPE_VARADDED, SCIP_EVENTTYPE_VARDELETED, SCIP_EVENTTYPE_VARFIXED, SCIP_EVENTTYPE_VARUNLOCKED, SCIPABORT, SCIPerrorMessage, SCIP_EventVarAdded::var, SCIP_EventVarDeleted::var, SCIP_EventVarFixed::var, SCIP_EventVarUnlocked::var, SCIP_EventObjChg::var, SCIP_EventBdChg::var, SCIP_EventHole::var, and SCIP_EventImplAdd::var.

Referenced by SCIP_DECL_EVENTEXEC().

SCIP_Real SCIPeventGetOldobj ( SCIP_EVENT *  event)

gets old objective value for an objective value change event

Parameters
eventevent

Definition at line 1050 of file event.c.

References SCIP_Event::eventtype, NULL, SCIP_EVENTTYPE_OBJCHANGED, SCIP_INVALID, SCIPABORT, and SCIPerrorMessage.

Referenced by SCIP_DECL_EVENTEXEC().

SCIP_Real SCIPeventGetNewobj ( SCIP_EVENT *  event)

gets new objective value for an objective value change event

Parameters
eventevent

Definition at line 1067 of file event.c.

References SCIP_Event::eventtype, NULL, SCIP_EVENTTYPE_OBJCHANGED, SCIP_INVALID, SCIPABORT, and SCIPerrorMessage.

Referenced by SCIP_DECL_EVENTEXEC().

SCIP_Real SCIPeventGetOldbound ( SCIP_EVENT *  event)

gets old bound for a bound change event

Parameters
eventevent

Definition at line 1084 of file event.c.

References SCIP_Event::eventtype, NULL, SCIP_EVENTTYPE_GLBCHANGED, SCIP_EVENTTYPE_GUBCHANGED, SCIP_EVENTTYPE_LBRELAXED, SCIP_EVENTTYPE_LBTIGHTENED, SCIP_EVENTTYPE_UBRELAXED, SCIP_EVENTTYPE_UBTIGHTENED, SCIPABORT, and SCIPerrorMessage.

Referenced by SCIP_DECL_EVENTEXEC().

SCIP_Real SCIPeventGetNewbound ( SCIP_EVENT *  event)

gets new bound for a bound change event

Parameters
eventevent

Definition at line 1108 of file event.c.

References SCIP_Event::eventtype, NULL, SCIP_EVENTTYPE_GLBCHANGED, SCIP_EVENTTYPE_GUBCHANGED, SCIP_EVENTTYPE_LBRELAXED, SCIP_EVENTTYPE_LBTIGHTENED, SCIP_EVENTTYPE_UBRELAXED, SCIP_EVENTTYPE_UBTIGHTENED, SCIPABORT, and SCIPerrorMessage.

Referenced by SCIP_DECL_EVENTEXEC().

SCIP_NODE* SCIPeventGetNode ( SCIP_EVENT *  event)

gets node for a node or LP event

Parameters
eventevent

Definition at line 1132 of file event.c.

References SCIP_Event::eventtype, NULL, SCIP_EVENTTYPE_LPEVENT, SCIP_EVENTTYPE_NODEEVENT, SCIPABORT, and SCIPerrorMessage.

SCIP_SOL* SCIPeventGetSol ( SCIP_EVENT *  event)

gets solution for a primal solution event

Parameters
eventevent

Definition at line 1169 of file event.c.

References SCIP_Event::eventtype, NULL, SCIP_EVENTTYPE_SOLEVENT, SCIPABORT, and SCIPerrorMessage.

Referenced by SCIP_DECL_EVENTEXEC().

SCIP_Real SCIPeventGetHoleLeft ( SCIP_EVENT *  event)

gets the left bound of open interval in the hole

Parameters
eventevent

Definition at line 1206 of file event.c.

References SCIP_Event::eventtype, NULL, SCIP_EVENTTYPE_HOLECHANGED, SCIP_INVALID, SCIPABORT, and SCIPerrorMessage.

SCIP_Real SCIPeventGetHoleRight ( SCIP_EVENT *  event)

gets the right bound of open interval in the hole

Parameters
eventevent

Definition at line 1223 of file event.c.

References SCIP_Event::eventtype, NULL, SCIP_EVENTTYPE_HOLECHANGED, SCIP_INVALID, SCIPABORT, and SCIPerrorMessage.

SCIP_ROW* SCIPeventGetRow ( SCIP_EVENT *  event)

gets row for a row event

Parameters
eventevent

Definition at line 1240 of file event.c.

References SCIP_Event::eventtype, NULL, SCIP_EVENTTYPE_ROWADDEDLP, SCIP_EVENTTYPE_ROWADDEDSEPA, SCIP_EVENTTYPE_ROWCOEFCHANGED, SCIP_EVENTTYPE_ROWCONSTCHANGED, SCIP_EVENTTYPE_ROWDELETEDLP, SCIP_EVENTTYPE_ROWDELETEDSEPA, SCIP_EVENTTYPE_ROWSIDECHANGED, SCIPABORT, and SCIPerrorMessage.

SCIP_COL* SCIPeventGetRowCol ( SCIP_EVENT *  event)

gets column for a row change coefficient event

Parameters
eventevent

Definition at line 1270 of file event.c.

References SCIP_Event::eventtype, NULL, SCIP_EVENTTYPE_ROWCOEFCHANGED, SCIPABORT, and SCIPerrorMessage.

SCIP_Real SCIPeventGetRowOldCoefVal ( SCIP_EVENT *  event)

gets old coefficient value for a row change coefficient event

Parameters
eventevent

Definition at line 1287 of file event.c.

References SCIP_Event::eventtype, NULL, SCIP_EVENTTYPE_ROWCOEFCHANGED, SCIP_INVALID, SCIPABORT, and SCIPerrorMessage.

SCIP_Real SCIPeventGetRowNewCoefVal ( SCIP_EVENT *  event)

gets new coefficient value for a row change coefficient event

Parameters
eventevent

Definition at line 1304 of file event.c.

References SCIP_Event::eventtype, NULL, SCIP_EVENTTYPE_ROWCOEFCHANGED, SCIP_INVALID, SCIPABORT, and SCIPerrorMessage.

SCIP_Real SCIPeventGetRowOldConstVal ( SCIP_EVENT *  event)

gets old constant value for a row change constant event

Parameters
eventevent

Definition at line 1321 of file event.c.

References SCIP_Event::eventtype, NULL, SCIP_EVENTTYPE_ROWCONSTCHANGED, SCIP_INVALID, SCIPABORT, and SCIPerrorMessage.

SCIP_Real SCIPeventGetRowNewConstVal ( SCIP_EVENT *  event)

gets new constant value for a row change constant event

Parameters
eventevent

Definition at line 1338 of file event.c.

References SCIP_Event::eventtype, NULL, SCIP_EVENTTYPE_ROWCONSTCHANGED, SCIP_INVALID, SCIPABORT, and SCIPerrorMessage.

SCIP_SIDETYPE SCIPeventGetRowSide ( SCIP_EVENT *  event)

gets side for a row change side event

Parameters
eventevent

Definition at line 1355 of file event.c.

References SCIP_Event::eventtype, NULL, SCIP_EVENTTYPE_ROWSIDECHANGED, SCIP_SIDETYPE_LEFT, SCIPABORT, and SCIPerrorMessage.

SCIP_Real SCIPeventGetRowOldSideVal ( SCIP_EVENT *  event)

gets old side value for a row change side event

Parameters
eventevent

Definition at line 1372 of file event.c.

References SCIP_Event::eventtype, NULL, SCIP_EVENTTYPE_ROWSIDECHANGED, SCIP_INVALID, SCIPABORT, and SCIPerrorMessage.

SCIP_Real SCIPeventGetRowNewSideVal ( SCIP_EVENT *  event)

gets new side value for a row change side event

Parameters
eventevent

Definition at line 1389 of file event.c.

References SCIP_Event::eventtype, NULL, SCIP_EVENTTYPE_ROWSIDECHANGED, SCIP_INVALID, SCIPABORT, and SCIPerrorMessage.