Detailed Description
methods for event handlers
Function Documentation
◆ SCIPeventhdlrGetName()
SCIP_EXPORT const char* SCIPeventhdlrGetName | ( | SCIP_EVENTHDLR * | eventhdlr | ) |
gets name of event handler
- Parameters
-
eventhdlr event handler
Definition at line 315 of file event.c.
References SCIP_Eventhdlr::name, and NULL.
Referenced by SCIP_DECL_CONSGETNVARS(), SCIP_DECL_EVENTCOPY(), SCIP_DECL_EVENTEXEC(), SCIP_DECL_EVENTEXIT(), SCIP_DECL_EVENTEXITSOL(), SCIP_DECL_EVENTFREE(), SCIP_DECL_EVENTINIT(), SCIP_DECL_EVENTINITSOL(), SCIPeventGlobalbndClearBoundChanges(), SCIPeventGlobalbndDisableBoundStorage(), SCIPeventGlobalbndEnableBoundStorage(), SCIPeventGlobalbndGetBoundChanges(), SCIPeventhdlrCopyInclude(), SCIPsetFindCompr(), and testCriteria().
◆ SCIPeventhdlrGetData()
SCIP_EXPORT SCIP_EVENTHDLRDATA* SCIPeventhdlrGetData | ( | SCIP_EVENTHDLR * | eventhdlr | ) |
gets user data of event handler
- Parameters
-
eventhdlr event handler
Definition at line 325 of file event.c.
References SCIP_Eventhdlr::eventhdlrdata, and NULL.
Referenced by exitEventhandler(), exitsolEventhandler(), freeEventhandler(), getNNodesBelowIncumbent(), getNRank1Nodes(), initsolEventhandler(), 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(), SCIPbendersComputeSubproblemLowerbound(), SCIPbendersSolveSubproblemCIP(), SCIPeventGlobalbndClearBoundChanges(), SCIPeventGlobalbndDisableBoundStorage(), SCIPeventGlobalbndEnableBoundStorage(), SCIPeventGlobalbndGetBoundChanges(), SCIPfindObjEventhdlr(), SCIPgetObjEventhdlr(), and updateEventhdlrUpperbound().
◆ SCIPeventhdlrSetData()
SCIP_EXPORT void SCIPeventhdlrSetData | ( | SCIP_EVENTHDLR * | eventhdlr, |
SCIP_EVENTHDLRDATA * | eventhdlrdata | ||
) |
sets user data of event handler; user has to free old data in advance!
- Parameters
-
eventhdlr event handler eventhdlrdata new event handler user data
Definition at line 335 of file event.c.
References SCIP_Eventhdlr::eventhdlrdata, and NULL.
Referenced by freeEventhandler(), and SCIP_DECL_EVENTFREE().
◆ SCIPeventhdlrIsInitialized()
SCIP_EXPORT SCIP_Bool SCIPeventhdlrIsInitialized | ( | SCIP_EVENTHDLR * | eventhdlr | ) |
is event handler initialized?
- Parameters
-
eventhdlr event handler
Definition at line 423 of file event.c.
References SCIP_Eventhdlr::initialized, and NULL.
Referenced by SCIPsetIncludeCompr().
◆ SCIPeventhdlrGetSetupTime()
SCIP_EXPORT SCIP_Real SCIPeventhdlrGetSetupTime | ( | SCIP_EVENTHDLR * | eventhdlr | ) |
gets time in seconds used in this event handler for setting up for next stages
- Parameters
-
eventhdlr event handler
Definition at line 445 of file event.c.
References NULL, SCIPclockGetTime(), and SCIP_Eventhdlr::setuptime.
◆ SCIPeventhdlrGetTime()
SCIP_EXPORT 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
-
eventhdlr event handler
Definition at line 457 of file event.c.
References SCIP_Eventhdlr::eventtime, NULL, and SCIPclockGetTime().
◆ SCIPincludeEventhdlr()
SCIP_EXPORT 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
-
scip SCIP data structure name name of event handler desc description of event handler eventhdlrdata event handler data
Definition at line 54 of file scip_event.c.
References FALSE, NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIPcheckStage(), SCIPerrorMessage, SCIPeventhdlrCreate(), SCIPfindEventhdlr(), SCIPsetIncludeEventhdlr(), Scip::set, and TRUE.
Referenced by SCIPincludeObjEventhdlr().
◆ SCIPincludeEventhdlrBasic()
SCIP_EXPORT 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
-
scip SCIP data structure eventhdlrptr reference to an event handler, or NULL name name of event handler desc description of event handler eventhdlrdata event handler data
Definition at line 95 of file scip_event.c.
References FALSE, NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIPcheckStage(), SCIPerrorMessage, SCIPeventhdlrCreate(), SCIPfindEventhdlr(), SCIPsetIncludeEventhdlr(), Scip::set, and TRUE.
Referenced by createSubproblems(), includeEventHdlrDispsol(), includeEventHdlrSync(), initialiseLPSubproblem(), SCIP_DECL_HEUREXEC(), SCIP_DECL_NONLINCONSUPGD(), SCIPapplyProximity(), SCIPbendersActivate(), SCIPcreateProbColoring(), SCIPincludeBranchruleDistribution(), SCIPincludeConshdlrAbspower(), SCIPincludeConshdlrAnd(), SCIPincludeConshdlrBivariate(), SCIPincludeConshdlrBounddisjunction(), SCIPincludeConshdlrCardinality(), SCIPincludeConshdlrCumulative(), SCIPincludeConshdlrIndicator(), SCIPincludeConshdlrLinking(), SCIPincludeConshdlrLogicor(), SCIPincludeConshdlrNonlinear(), SCIPincludeConshdlrOptcumulative(), SCIPincludeConshdlrOr(), SCIPincludeConshdlrQuadratic(), SCIPincludeConshdlrRpa(), SCIPincludeConshdlrSOC(), SCIPincludeConshdlrSOS2(), SCIPincludeConshdlrVarbound(), SCIPincludeConshdlrXor(), SCIPincludeEventHdlrBestsol(), SCIPincludeEventHdlrBoundwriting(), SCIPincludeEventHdlrGlobalbnd(), SCIPincludeEventHdlrLPsol(), SCIPincludeEventHdlrNewsol(), SCIPincludeEventHdlrSofttimelimit(), SCIPincludeEventHdlrSolvingphase(), SCIPincludeHeurShiftandpropagate(), SCIPincludeHeurSubNlp(), SCIPincludePropSymmetry(), SCIPincludePropVbounds(), SCIPincludeSepaIntobj(), SCIPprobdataCreate(), setupAndSolve(), setupAndSolveSubscip(), setupAndSolveSubscipCrossover(), setupAndSolveSubscipLocalbranching(), setupAndSolveSubscipTrustregion(), solveSubscipLpface(), wrapperDins(), and wrapperRins().
◆ SCIPsetEventhdlrCopy()
SCIP_EXPORT SCIP_RETCODE SCIPsetEventhdlrCopy | ( | SCIP * | scip, |
SCIP_EVENTHDLR * | eventhdlr, | ||
SCIP_DECL_EVENTCOPY((*eventcopy)) | |||
) |
sets copy callback of the event handler
- Parameters
-
scip scip instance eventhdlr event handler
Definition at line 127 of file scip_event.c.
References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPeventhdlrSetCopy(), and TRUE.
Referenced by SCIPincludeEventHdlrBestsol(), SCIPincludeEventHdlrBoundwriting(), SCIPincludeEventHdlrNewsol(), SCIPincludeEventHdlrSofttimelimit(), and SCIPincludeEventHdlrSolvingphase().
◆ SCIPsetEventhdlrFree()
SCIP_EXPORT SCIP_RETCODE SCIPsetEventhdlrFree | ( | SCIP * | scip, |
SCIP_EVENTHDLR * | eventhdlr, | ||
SCIP_DECL_EVENTFREE((*eventfree)) | |||
) |
sets deinitialization callback of the event handler
- Parameters
-
scip scip instance eventhdlr event handler
Definition at line 141 of file scip_event.c.
References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPeventhdlrSetFree(), and TRUE.
Referenced by createSubproblems(), includeEventHdlrSync(), initialiseLPSubproblem(), SCIPincludeBranchruleDistribution(), SCIPincludeEventHdlrBoundwriting(), SCIPincludeEventHdlrGlobalbnd(), SCIPincludeEventHdlrSofttimelimit(), and SCIPincludeEventHdlrSolvingphase().
◆ SCIPsetEventhdlrInit()
SCIP_EXPORT SCIP_RETCODE SCIPsetEventhdlrInit | ( | SCIP * | scip, |
SCIP_EVENTHDLR * | eventhdlr, | ||
SCIP_DECL_EVENTINIT((*eventinit)) | |||
) |
sets initialization callback of the event handler
- Parameters
-
scip scip instance eventhdlr event handler
Definition at line 155 of file scip_event.c.
References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPeventhdlrSetInit(), and TRUE.
Referenced by includeEventHdlrDispsol(), includeEventHdlrSync(), SCIPincludeEventHdlrBestsol(), SCIPincludeEventHdlrBoundwriting(), SCIPincludeEventHdlrGlobalbnd(), SCIPincludeEventHdlrLPsol(), SCIPincludeEventHdlrNewsol(), SCIPincludeEventHdlrSofttimelimit(), SCIPincludeEventHdlrSolvingphase(), and SCIPincludeSepaIntobj().
◆ SCIPsetEventhdlrExit()
SCIP_EXPORT SCIP_RETCODE SCIPsetEventhdlrExit | ( | SCIP * | scip, |
SCIP_EVENTHDLR * | eventhdlr, | ||
SCIP_DECL_EVENTEXIT((*eventexit)) | |||
) |
sets deinitialization callback of the event handler
- Parameters
-
scip scip instance eventhdlr event handler
Definition at line 169 of file scip_event.c.
References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPeventhdlrSetExit(), and TRUE.
Referenced by createSubproblems(), includeEventHdlrDispsol(), includeEventHdlrSync(), initialiseLPSubproblem(), SCIPincludeEventHdlrBestsol(), SCIPincludeEventHdlrBoundwriting(), SCIPincludeEventHdlrGlobalbnd(), SCIPincludeEventHdlrLPsol(), SCIPincludeEventHdlrNewsol(), SCIPincludeEventHdlrSofttimelimit(), SCIPincludeEventHdlrSolvingphase(), and SCIPincludeSepaIntobj().
◆ SCIPsetEventhdlrInitsol()
SCIP_EXPORT SCIP_RETCODE SCIPsetEventhdlrInitsol | ( | SCIP * | scip, |
SCIP_EVENTHDLR * | eventhdlr, | ||
SCIP_DECL_EVENTINITSOL((*eventinitsol)) | |||
) |
sets solving process initialization callback of the event handler
- Parameters
-
scip scip instance eventhdlr event handler
Definition at line 183 of file scip_event.c.
References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPeventhdlrSetInitsol(), and TRUE.
Referenced by createSubproblems(), initialiseLPSubproblem(), SCIPbendersActivate(), and SCIPincludeEventHdlrSolvingphase().
◆ SCIPsetEventhdlrExitsol()
SCIP_EXPORT SCIP_RETCODE SCIPsetEventhdlrExitsol | ( | SCIP * | scip, |
SCIP_EVENTHDLR * | eventhdlr, | ||
SCIP_DECL_EVENTEXITSOL((*eventexitsol)) | |||
) |
sets solving process deinitialization callback of the event handler
- Parameters
-
scip scip instance eventhdlr event handler
Definition at line 197 of file scip_event.c.
References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPeventhdlrSetExitsol(), and TRUE.
Referenced by createSubproblems(), initialiseLPSubproblem(), and SCIPincludeEventHdlrSolvingphase().
◆ SCIPsetEventhdlrDelete()
SCIP_EXPORT SCIP_RETCODE SCIPsetEventhdlrDelete | ( | SCIP * | scip, |
SCIP_EVENTHDLR * | eventhdlr, | ||
SCIP_DECL_EVENTDELETE((*eventdelete)) | |||
) |
sets callback of the event handler to free specific event data
- Parameters
-
scip scip instance eventhdlr event handler
Definition at line 211 of file scip_event.c.
References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPeventhdlrSetDelete(), and TRUE.
◆ SCIPfindEventhdlr()
SCIP_EXPORT SCIP_EVENTHDLR* SCIPfindEventhdlr | ( | SCIP * | scip, |
const char * | name | ||
) |
returns the event handler of the given name, or NULL if not existing
- Parameters
-
scip SCIP data structure name name of event handler
Definition at line 225 of file scip_event.c.
References NULL, SCIPsetFindEventhdlr(), and Scip::set.
Referenced by COLORprobAddVarForStableSet(), getNNodesBelowIncumbent(), getNRank1Nodes(), SCIP_DECL_CONSEXITSOL(), SCIP_DECL_CONSINITSOL(), SCIP_DECL_PROBEXITSOL(), SCIP_DECL_PROBINITSOL(), SCIPapplyProximity(), SCIPbendersComputeSubproblemLowerbound(), SCIPbendersSolveSubproblemCIP(), SCIPcreateConcurrent(), SCIPfindObjEventhdlr(), SCIPincludeEventhdlr(), SCIPincludeEventhdlrBasic(), SCIPprobdataCreate(), and updateEventhdlrUpperbound().
◆ SCIPgetEventhdlrs()
SCIP_EXPORT SCIP_EVENTHDLR** SCIPgetEventhdlrs | ( | SCIP * | scip | ) |
returns the array of currently available event handlers
- Parameters
-
scip SCIP data structure
Definition at line 238 of file scip_event.c.
References SCIP_Set::eventhdlrs, NULL, and Scip::set.
◆ SCIPgetNEventhdlrs()
SCIP_EXPORT int SCIPgetNEventhdlrs | ( | SCIP * | scip | ) |
returns the number of currently available event handlers
- Parameters
-
scip SCIP data structure
Definition at line 249 of file scip_event.c.
References SCIP_Set::neventhdlrs, NULL, and Scip::set.