Scippy

SCIP

Solving Constraint Integer Programs

Detailed Description

methods for event handlers

Functions

const char * SCIPeventhdlrGetName (SCIP_EVENTHDLR *eventhdlr)
 
SCIP_EVENTHDLRDATASCIPeventhdlrGetData (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_RETCODE SCIPincludeEventhdlr (SCIP *scip, const char *name, const char *desc, SCIP_DECL_EVENTCOPY((*eventcopy)), SCIP_DECL_EVENTFREE((*eventfree)), SCIP_DECL_EVENTINIT((*eventinit)), SCIP_DECL_EVENTEXIT((*eventexit)), SCIP_DECL_EVENTINITSOL((*eventinitsol)), SCIP_DECL_EVENTEXITSOL((*eventexitsol)), SCIP_DECL_EVENTDELETE((*eventdelete)), SCIP_DECL_EVENTEXEC((*eventexec)), SCIP_EVENTHDLRDATA *eventhdlrdata)
 
SCIP_RETCODE SCIPincludeEventhdlrBasic (SCIP *scip, SCIP_EVENTHDLR **eventhdlrptr, const char *name, const char *desc, SCIP_DECL_EVENTEXEC((*eventexec)), SCIP_EVENTHDLRDATA *eventhdlrdata)
 
SCIP_RETCODE SCIPsetEventhdlrCopy (SCIP *scip, SCIP_EVENTHDLR *eventhdlr, SCIP_DECL_EVENTCOPY((*eventcopy)))
 
SCIP_RETCODE SCIPsetEventhdlrFree (SCIP *scip, SCIP_EVENTHDLR *eventhdlr, SCIP_DECL_EVENTFREE((*eventfree)))
 
SCIP_RETCODE SCIPsetEventhdlrInit (SCIP *scip, SCIP_EVENTHDLR *eventhdlr, SCIP_DECL_EVENTINIT((*eventinit)))
 
SCIP_RETCODE SCIPsetEventhdlrExit (SCIP *scip, SCIP_EVENTHDLR *eventhdlr, SCIP_DECL_EVENTEXIT((*eventexit)))
 
SCIP_RETCODE SCIPsetEventhdlrInitsol (SCIP *scip, SCIP_EVENTHDLR *eventhdlr, SCIP_DECL_EVENTINITSOL((*eventinitsol)))
 
SCIP_RETCODE SCIPsetEventhdlrExitsol (SCIP *scip, SCIP_EVENTHDLR *eventhdlr, SCIP_DECL_EVENTEXITSOL((*eventexitsol)))
 
SCIP_RETCODE SCIPsetEventhdlrDelete (SCIP *scip, SCIP_EVENTHDLR *eventhdlr, SCIP_DECL_EVENTDELETE((*eventdelete)))
 
SCIP_EVENTHDLRSCIPfindEventhdlr (SCIP *scip, const char *name)
 
SCIP_EVENTHDLR ** SCIPgetEventhdlrs (SCIP *scip)
 
int SCIPgetNEventhdlrs (SCIP *scip)
 

Function Documentation

◆ SCIPeventhdlrGetName()

◆ SCIPeventhdlrGetData()

◆ SCIPeventhdlrSetData()

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().

◆ SCIPeventhdlrIsInitialized()

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 SCIPsetIncludeCompr().

◆ SCIPeventhdlrGetSetupTime()

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 408 of file event.c.

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

◆ SCIPeventhdlrGetTime()

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 420 of file event.c.

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

◆ SCIPincludeEventhdlr()

SCIP_RETCODE SCIPincludeEventhdlr ( SCIP scip,
const char *  name,
const char *  desc,
SCIP_DECL_EVENTCOPY((*eventcopy))  ,
SCIP_DECL_EVENTFREE((*eventfree))  ,
SCIP_DECL_EVENTINIT((*eventinit))  ,
SCIP_DECL_EVENTEXIT((*eventexit))  ,
SCIP_DECL_EVENTINITSOL((*eventinitsol))  ,
SCIP_DECL_EVENTEXITSOL((*eventexitsol))  ,
SCIP_DECL_EVENTDELETE((*eventdelete))  ,
SCIP_DECL_EVENTEXEC((*eventexec))  ,
SCIP_EVENTHDLRDATA eventhdlrdata 
)

creates an event handler and includes it in SCIP

Note
method has all event handler callbacks as arguments and is thus changed every time a new callback is added in future releases; consider using SCIPincludeEventhdlrBasic() and setter functions if you seek for a method which is less likely to change in future releases
Parameters
scipSCIP data structure
namename of event handler
descdescription of event handler
eventhdlrdataevent handler data

Definition at line 8484 of file scip.c.

References checkStage(), FALSE, NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIPerrorMessage, SCIPeventhdlrCreate(), SCIPfindEventhdlr(), SCIPsetIncludeEventhdlr(), Scip::set, and TRUE.

Referenced by SCIPincludeObjEventhdlr().

◆ SCIPincludeEventhdlrBasic()

SCIP_RETCODE SCIPincludeEventhdlrBasic ( SCIP scip,
SCIP_EVENTHDLR **  eventhdlrptr,
const char *  name,
const char *  desc,
SCIP_DECL_EVENTEXEC((*eventexec))  ,
SCIP_EVENTHDLRDATA eventhdlrdata 
)

creates an event handler and includes it in SCIP with all its non-fundamental callbacks set to NULL; if needed, non-fundamental callbacks can be set afterwards via setter functions SCIPsetEventhdlrCopy(), SCIPsetEventhdlrFree(), SCIPsetEventhdlrInit(), SCIPsetEventhdlrExit(), SCIPsetEventhdlrInitsol(), SCIPsetEventhdlrExitsol(), and SCIPsetEventhdlrDelete()

Note
if you want to set all callbacks with a single method call, consider using SCIPincludeEventhdlr() instead
Parameters
scipSCIP data structure
eventhdlrptrreference to an event handler, or NULL
namename of event handler
descdescription of event handler
eventhdlrdataevent handler data

Definition at line 8526 of file scip.c.

References checkStage(), FALSE, NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIPerrorMessage, SCIPeventhdlrCreate(), SCIPfindEventhdlr(), SCIPsetIncludeEventhdlr(), Scip::set, and TRUE.

Referenced by applyCompletesol(), applyOfins(), includeEventHdlrSync(), SCIP_DECL_HEUREXEC(), SCIPapplyProximity(), SCIPapplyRens(), SCIPapplyZeroobj(), SCIPincludeBranchruleDistribution(), SCIPincludeConshdlrAbspower(), SCIPincludeConshdlrAnd(), SCIPincludeConshdlrBivariate(), SCIPincludeConshdlrBounddisjunction(), SCIPincludeConshdlrCardinality(), SCIPincludeConshdlrCumulative(), SCIPincludeConshdlrIndicator(), SCIPincludeConshdlrLinking(), SCIPincludeConshdlrLogicor(), SCIPincludeConshdlrNonlinear(), SCIPincludeConshdlrOr(), SCIPincludeConshdlrQuadratic(), SCIPincludeConshdlrSOC(), SCIPincludeConshdlrSOS2(), SCIPincludeConshdlrVarbound(), SCIPincludeConshdlrXor(), SCIPincludeEventHdlrBestsol(), SCIPincludeEventHdlrBoundwriting(), SCIPincludeEventHdlrGlobalbnd(), SCIPincludeEventHdlrLPsol(), SCIPincludeEventHdlrSofttimelimit(), SCIPincludeEventHdlrSolvingphase(), SCIPincludeHeurShiftandpropagate(), SCIPincludeHeurSubNlp(), SCIPincludePropVbounds(), SCIPincludeSepaIntobj(), and SCIPprobdataCreate().

◆ SCIPsetEventhdlrCopy()

SCIP_RETCODE SCIPsetEventhdlrCopy ( SCIP scip,
SCIP_EVENTHDLR eventhdlr,
SCIP_DECL_EVENTCOPY((*eventcopy))   
)

sets copy callback of the event handler

Parameters
scipscip instance
eventhdlrevent handler

Definition at line 8558 of file scip.c.

References checkStage(), FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPeventhdlrSetCopy(), and TRUE.

Referenced by SCIPincludeEventHdlrBestsol(), SCIPincludeEventHdlrBoundwriting(), SCIPincludeEventHdlrSofttimelimit(), and SCIPincludeEventHdlrSolvingphase().

◆ SCIPsetEventhdlrFree()

SCIP_RETCODE SCIPsetEventhdlrFree ( SCIP scip,
SCIP_EVENTHDLR eventhdlr,
SCIP_DECL_EVENTFREE((*eventfree))   
)

sets deinitialization callback of the event handler

Parameters
scipscip instance
eventhdlrevent handler

Definition at line 8572 of file scip.c.

References checkStage(), FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPeventhdlrSetFree(), and TRUE.

Referenced by includeEventHdlrSync(), SCIPincludeBranchruleDistribution(), SCIPincludeEventHdlrBoundwriting(), SCIPincludeEventHdlrGlobalbnd(), SCIPincludeEventHdlrSofttimelimit(), and SCIPincludeEventHdlrSolvingphase().

◆ SCIPsetEventhdlrInit()

SCIP_RETCODE SCIPsetEventhdlrInit ( SCIP scip,
SCIP_EVENTHDLR eventhdlr,
SCIP_DECL_EVENTINIT((*eventinit))   
)

◆ SCIPsetEventhdlrExit()

SCIP_RETCODE SCIPsetEventhdlrExit ( SCIP scip,
SCIP_EVENTHDLR eventhdlr,
SCIP_DECL_EVENTEXIT((*eventexit))   
)

◆ SCIPsetEventhdlrInitsol()

SCIP_RETCODE SCIPsetEventhdlrInitsol ( SCIP scip,
SCIP_EVENTHDLR eventhdlr,
SCIP_DECL_EVENTINITSOL((*eventinitsol))   
)

sets solving process initialization callback of the event handler

Parameters
scipscip instance
eventhdlrevent handler

Definition at line 8614 of file scip.c.

References checkStage(), FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPeventhdlrSetInitsol(), and TRUE.

Referenced by SCIPincludeEventHdlrSolvingphase().

◆ SCIPsetEventhdlrExitsol()

SCIP_RETCODE SCIPsetEventhdlrExitsol ( SCIP scip,
SCIP_EVENTHDLR eventhdlr,
SCIP_DECL_EVENTEXITSOL((*eventexitsol))   
)

sets solving process deinitialization callback of the event handler

Parameters
scipscip instance
eventhdlrevent handler

Definition at line 8628 of file scip.c.

References checkStage(), FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPeventhdlrSetExitsol(), and TRUE.

Referenced by SCIPincludeEventHdlrSolvingphase().

◆ SCIPsetEventhdlrDelete()

SCIP_RETCODE SCIPsetEventhdlrDelete ( SCIP scip,
SCIP_EVENTHDLR eventhdlr,
SCIP_DECL_EVENTDELETE((*eventdelete))   
)

sets callback of the event handler to free specific event data

Parameters
scipscip instance
eventhdlrevent handler

Definition at line 8642 of file scip.c.

References checkStage(), FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPeventhdlrSetDelete(), and TRUE.

◆ SCIPfindEventhdlr()

SCIP_EVENTHDLR* SCIPfindEventhdlr ( SCIP scip,
const char *  name 
)

returns the event handler of the given name, or NULL if not existing

Parameters
scipSCIP data structure
namename of event handler

Definition at line 8656 of file scip.c.

References NULL, SCIPsetFindEventhdlr(), and Scip::set.

Referenced by getNNodesBelowIncumbent(), getNRank1Nodes(), SCIP_DECL_CONSEXITSOL(), SCIP_DECL_CONSINITSOL(), SCIP_DECL_PROBEXITSOL(), SCIP_DECL_PROBINITSOL(), SCIPapplyProximity(), SCIPcreateConcurrent(), SCIPfindObjEventhdlr(), SCIPincludeEventhdlr(), SCIPincludeEventhdlrBasic(), and SCIPprobdataCreate().

◆ SCIPgetEventhdlrs()

SCIP_EVENTHDLR** SCIPgetEventhdlrs ( SCIP scip)

returns the array of currently available event handlers

Parameters
scipSCIP data structure

Definition at line 8669 of file scip.c.

References SCIP_Set::eventhdlrs, NULL, and Scip::set.

◆ SCIPgetNEventhdlrs()

int SCIPgetNEventhdlrs ( SCIP scip)

returns the number of currently available event handlers

Parameters
scipSCIP data structure

Definition at line 8680 of file scip.c.

References SCIP_Set::neventhdlrs, NULL, and Scip::set.