Scippy

    SCIP

    Solving Constraint Integer Programs

    Functions
    Event Handler
    Public API of SCIP » Core API » Methods for managing plugins

    Detailed Description

    methods for event handlers

    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_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_EVENTHDLR * SCIPfindEventhdlr (SCIP *scip, const char *name)
     
    SCIP_EVENTHDLR ** SCIPgetEventhdlrs (SCIP *scip)
     
    int SCIPgetNEventhdlrs (SCIP *scip)
     

    Function Documentation

    ◆ SCIPeventhdlrGetName()

    const char * SCIPeventhdlrGetName ( SCIP_EVENTHDLR *  eventhdlr)

    gets name of event handler

    Parameters
    eventhdlrevent handler

    Definition at line 396 of file event.c.

    References SCIP_Eventhdlr::name, 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(), SCIPactivateShadowTree(), SCIPeventGlobalbndClearBoundChanges(), SCIPeventGlobalbndDisableBoundStorage(), SCIPeventGlobalbndEnableBoundStorage(), SCIPeventGlobalbndGetBoundChanges(), SCIPeventhdlrCopyInclude(), and SCIPgetShadowTree().

    ◆ SCIPeventhdlrGetData()

    SCIP_EVENTHDLRDATA * SCIPeventhdlrGetData ( SCIP_EVENTHDLR *  eventhdlr)

    gets user data of event handler

    Parameters
    eventhdlrevent handler

    Definition at line 406 of file event.c.

    References SCIP_Eventhdlr::eventhdlrdata, and NULL.

    Referenced by exitEventhandler(), exitsolEventhandler(), freeEventhandler(), getNNodesBelowIncumbent(), getNRank1Nodes(), initsolEventhandler(), SCIP_DECL_DISPOUTPUT(), 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(), SCIP_DECL_TABLEOUTPUT(), SCIPactivateShadowTree(), SCIPbendersComputeSubproblemLowerbound(), SCIPbendersSolveSubproblemCIP(), SCIPeventGlobalbndClearBoundChanges(), SCIPeventGlobalbndDisableBoundStorage(), SCIPeventGlobalbndEnableBoundStorage(), SCIPeventGlobalbndGetBoundChanges(), SCIPfindObjEventhdlr(), SCIPgetObjEventhdlr(), SCIPgetShadowTree(), SCIPgetShadowTreeEventHandlerExecutionTime(), SCIPgetTreesizeEstimation(), and updateEventhdlrUpperbound().

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

    References SCIP_Eventhdlr::eventhdlrdata, and NULL.

    Referenced by freeEventhandler(), and SCIP_DECL_EVENTFREE().

    ◆ SCIPeventhdlrIsInitialized()

    SCIP_Bool SCIPeventhdlrIsInitialized ( SCIP_EVENTHDLR *  eventhdlr)

    is event handler initialized?

    Parameters
    eventhdlrevent handler

    Definition at line 504 of file event.c.

    References SCIP_Eventhdlr::initialized, and NULL.

    ◆ 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 526 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 538 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

    creates an event handler and includes it in SCIP

    Precondition
    This method can be called if SCIP is in one of the following stages:
    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 66 of file scip_event.c.

    References FALSE, NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIPcheckStage, SCIPerrorMessage, SCIPeventhdlrCreate(), SCIPfindEventhdlr(), SCIPsetIncludeEventhdlr(), and TRUE.

    Referenced by SCIPcreateEventHdlrBestsol(), and 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

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

    Precondition
    This method can be called if SCIP is in one of the following stages:
    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 111 of file scip_event.c.

    References FALSE, NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIPcheckStage, SCIPerrorMessage, SCIPeventhdlrCreate(), SCIPfindEventhdlr(), SCIPsetIncludeEventhdlr(), and TRUE.

    Referenced by createSubproblems(), executeLNSHeuristic(), includeEventHdlrDispsol(), includeEventHdlrSync(), initialiseLPSubproblem(), SCIP_DECL_HEUREXEC(), SCIPapplyProximity(), SCIPbendersActivate(), SCIPcreateProbColoring(), SCIPincludeBranchruleDistribution(), SCIPincludeConshdlrAnd(), SCIPincludeConshdlrBounddisjunction(), SCIPincludeConshdlrCardinality(), SCIPincludeConshdlrCumulative(), SCIPincludeConshdlrExactLinear(), SCIPincludeConshdlrIndicator(), SCIPincludeConshdlrKnapsack(), SCIPincludeConshdlrLinear(), SCIPincludeConshdlrLinking(), SCIPincludeConshdlrLogicor(), SCIPincludeConshdlrNonlinear(), SCIPincludeConshdlrOptcumulative(), SCIPincludeConshdlrOr(), SCIPincludeConshdlrRpa(), SCIPincludeConshdlrSetppc(), SCIPincludeConshdlrSOS1(), SCIPincludeConshdlrSOS2(), SCIPincludeConshdlrVarbound(), SCIPincludeConshdlrXor(), SCIPincludeEventHdlrBestsol(), SCIPincludeEventHdlrBoundwriting(), SCIPincludeEventHdlrEstim(), SCIPincludeEventHdlrGlobalbnd(), SCIPincludeEventHdlrLPsol(), SCIPincludeEventHdlrNewsol(), SCIPincludeEventHdlrShadowTree(), SCIPincludeEventHdlrSofttimelimit(), SCIPincludeEventHdlrSolvingphase(), SCIPincludeHeurDistributiondiving(), SCIPincludeHeurNlpdiving(), SCIPincludeHeurShiftandpropagate(), SCIPincludeHeurSubNlp(), SCIPincludeOrbitalReduction(), SCIPincludeOrbitopalReduction(), SCIPincludePropGenvbounds(), SCIPincludePropPseudoobj(), SCIPincludePropVbounds(), SCIPincludeSepaIntobj(), SCIPprobdataCreate(), setupAndSolve(), setupAndSolveSubscip(), setupAndSolveSubscipCrossover(), setupAndSolveSubscipLocalbranching(), setupAndSolveSubscipTrustregion(), solveSubscipLpface(), wrapperDins(), and wrapperRins().

    ◆ 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 143 of file scip_event.c.

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

    Referenced by SCIPincludeEventHdlrBestsol(), SCIPincludeEventHdlrBoundwriting(), SCIPincludeEventHdlrEstim(), SCIPincludeEventHdlrNewsol(), 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 157 of file scip_event.c.

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

    Referenced by createSubproblems(), includeEventHdlrSync(), initialiseLPSubproblem(), SCIPincludeBranchruleDistribution(), SCIPincludeEventHdlrBoundwriting(), SCIPincludeEventHdlrEstim(), SCIPincludeEventHdlrGlobalbnd(), SCIPincludeEventHdlrShadowTree(), SCIPincludeEventHdlrSofttimelimit(), SCIPincludeEventHdlrSolvingphase(), and SCIPincludeHeurDistributiondiving().

    ◆ SCIPsetEventhdlrInit()

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

    sets initialization callback of the event handler

    Parameters
    scipscip instance
    eventhdlrevent handler

    Definition at line 171 of file scip_event.c.

    References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage, SCIPeventhdlrSetInit(), and TRUE.

    Referenced by includeEventHdlrDispsol(), includeEventHdlrSync(), SCIPincludeEventHdlrBestsol(), SCIPincludeEventHdlrBoundwriting(), SCIPincludeEventHdlrEstim(), SCIPincludeEventHdlrGlobalbnd(), SCIPincludeEventHdlrLPsol(), SCIPincludeEventHdlrNewsol(), SCIPincludeEventHdlrSofttimelimit(), SCIPincludeEventHdlrSolvingphase(), and SCIPincludeSepaIntobj().

    ◆ SCIPsetEventhdlrExit()

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

    sets deinitialization callback of the event handler

    Parameters
    scipscip instance
    eventhdlrevent handler

    Definition at line 185 of file scip_event.c.

    References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage, SCIPeventhdlrSetExit(), and TRUE.

    Referenced by createSubproblems(), includeEventHdlrDispsol(), includeEventHdlrSync(), initialiseLPSubproblem(), SCIPincludeEventHdlrBestsol(), SCIPincludeEventHdlrBoundwriting(), SCIPincludeEventHdlrEstim(), SCIPincludeEventHdlrGlobalbnd(), SCIPincludeEventHdlrLPsol(), SCIPincludeEventHdlrNewsol(), SCIPincludeEventHdlrSofttimelimit(), SCIPincludeEventHdlrSolvingphase(), and SCIPincludeSepaIntobj().

    ◆ 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 199 of file scip_event.c.

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

    Referenced by createSubproblems(), initialiseLPSubproblem(), SCIPbendersActivate(), SCIPincludeEventHdlrEstim(), SCIPincludeEventHdlrShadowTree(), and 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 213 of file scip_event.c.

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

    Referenced by createSubproblems(), initialiseLPSubproblem(), SCIPincludeEventHdlrEstim(), SCIPincludeEventHdlrShadowTree(), and 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 227 of file scip_event.c.

    References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage, 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 241 of file scip_event.c.

    References NULL, and SCIPsetFindEventhdlr().

    Referenced by COLORprobAddVarForStableSet(), getNNodesBelowIncumbent(), getNRank1Nodes(), SCIP_DECL_CONSEXITSOL(), SCIP_DECL_CONSINITLP(), SCIP_DECL_DISPOUTPUT(), SCIP_DECL_PROBEXITSOL(), SCIP_DECL_PROBINITSOL(), SCIP_DECL_TABLEOUTPUT(), SCIPapplyProximity(), SCIPbendersComputeSubproblemLowerbound(), SCIPbendersSolveSubproblemCIP(), SCIPcreateConcurrent(), SCIPfindObjEventhdlr(), SCIPgetTreesizeEstimation(), SCIPincludeEventhdlr(), SCIPincludeEventhdlrBasic(), SCIPincludeOrbitopalReduction(), SCIPprobdataCreate(), and updateEventhdlrUpperbound().

    ◆ SCIPgetEventhdlrs()

    SCIP_EVENTHDLR ** SCIPgetEventhdlrs ( SCIP *  scip)

    returns the array of currently available event handlers

    Parameters
    scipSCIP data structure

    Definition at line 254 of file scip_event.c.

    References NULL.

    ◆ SCIPgetNEventhdlrs()

    int SCIPgetNEventhdlrs ( SCIP *  scip)

    returns the number of currently available event handlers

    Parameters
    scipSCIP data structure

    Definition at line 265 of file scip_event.c.

    References NULL.