/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ /* */ /* This file is part of the program and library */ /* SCIP --- Solving Constraint Integer Programs */ /* */ /* Copyright 2002-2022 Zuse Institute Berlin */ /* */ /* Licensed under the Apache License, Version 2.0 (the "License"); */ /* you may not use this file except in compliance with the License. */ /* You may obtain a copy of the License at */ /* */ /* http://www.apache.org/licenses/LICENSE-2.0 */ /* */ /* Unless required by applicable law or agreed to in writing, software */ /* distributed under the License is distributed on an "AS IS" BASIS, */ /* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */ /* See the License for the specific language governing permissions and */ /* limitations under the License. */ /* */ /* You should have received a copy of the Apache-2.0 license */ /* along with SCIP; see the file LICENSE. If not visit scipopt.org. */ /* */ /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ /**@file scip_event.h * @ingroup PUBLICCOREAPI * @brief public methods for event handler plugins and event handlers * @author Tobias Achterberg * @author Timo Berthold * @author Thorsten Koch * @author Alexander Martin * @author Marc Pfetsch * @author Kati Wolter * @author Gregor Hendel * @author Leona Gottwald */ /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/ #ifndef __SCIP_SCIP_EVENT_H__ #define __SCIP_SCIP_EVENT_H__ #include "scip/def.h" #include "scip/type_event.h" #include "scip/type_lp.h" #include "scip/type_retcode.h" #include "scip/type_scip.h" #include "scip/type_var.h" #ifdef __cplusplus extern "C" { #endif /**@addtogroup PublicEventHandlerMethods * * @{ */ /** 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 */ SCIP_EXPORT SCIP_RETCODE SCIPincludeEventhdlr( SCIP* scip, /**< SCIP data structure */ const char* name, /**< name of event handler */ const char* desc, /**< description of event handler */ SCIP_DECL_EVENTCOPY ((*eventcopy)), /**< copy method of event handler or NULL if you don't want to copy your plugin into sub-SCIPs */ SCIP_DECL_EVENTFREE ((*eventfree)), /**< destructor of event handler */ SCIP_DECL_EVENTINIT ((*eventinit)), /**< initialize event handler */ SCIP_DECL_EVENTEXIT ((*eventexit)), /**< deinitialize event handler */ SCIP_DECL_EVENTINITSOL((*eventinitsol)), /**< solving process initialization method of event handler */ SCIP_DECL_EVENTEXITSOL((*eventexitsol)), /**< solving process deinitialization method of event handler */ SCIP_DECL_EVENTDELETE ((*eventdelete)), /**< free specific event data */ SCIP_DECL_EVENTEXEC ((*eventexec)), /**< execute event handler */ SCIP_EVENTHDLRDATA* eventhdlrdata /**< event handler data */ ); /** 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 */ SCIP_EXPORT SCIP_RETCODE SCIPincludeEventhdlrBasic( SCIP* scip, /**< SCIP data structure */ SCIP_EVENTHDLR** eventhdlrptr, /**< reference to an event handler, or NULL */ const char* name, /**< name of event handler */ const char* desc, /**< description of event handler */ SCIP_DECL_EVENTEXEC ((*eventexec)), /**< execute event handler */ SCIP_EVENTHDLRDATA* eventhdlrdata /**< event handler data */ ); /** sets copy callback of the event handler */ SCIP_EXPORT SCIP_RETCODE SCIPsetEventhdlrCopy( SCIP* scip, /**< scip instance */ SCIP_EVENTHDLR* eventhdlr, /**< event handler */ SCIP_DECL_EVENTCOPY ((*eventcopy)) /**< copy callback of the event handler */ ); /** sets deinitialization callback of the event handler */ SCIP_EXPORT SCIP_RETCODE SCIPsetEventhdlrFree( SCIP* scip, /**< scip instance */ SCIP_EVENTHDLR* eventhdlr, /**< event handler */ SCIP_DECL_EVENTFREE ((*eventfree)) /**< deinitialization callback of the event handler */ ); /** sets initialization callback of the event handler */ SCIP_EXPORT SCIP_RETCODE SCIPsetEventhdlrInit( SCIP* scip, /**< scip instance */ SCIP_EVENTHDLR* eventhdlr, /**< event handler */ SCIP_DECL_EVENTINIT ((*eventinit)) /**< initialize event handler */ ); /** sets deinitialization callback of the event handler */ SCIP_EXPORT SCIP_RETCODE SCIPsetEventhdlrExit( SCIP* scip, /**< scip instance */ SCIP_EVENTHDLR* eventhdlr, /**< event handler */ SCIP_DECL_EVENTEXIT ((*eventexit)) /**< deinitialize event handler */ ); /** sets solving process initialization callback of the event handler */ SCIP_EXPORT SCIP_RETCODE SCIPsetEventhdlrInitsol( SCIP* scip, /**< scip instance */ SCIP_EVENTHDLR* eventhdlr, /**< event handler */ SCIP_DECL_EVENTINITSOL((*eventinitsol)) /**< solving process initialization callback of event handler */ ); /** sets solving process deinitialization callback of the event handler */ SCIP_EXPORT SCIP_RETCODE SCIPsetEventhdlrExitsol( SCIP* scip, /**< scip instance */ SCIP_EVENTHDLR* eventhdlr, /**< event handler */ SCIP_DECL_EVENTEXITSOL((*eventexitsol)) /**< solving process deinitialization callback of event handler */ ); /** sets callback of the event handler to free specific event data */ SCIP_EXPORT SCIP_RETCODE SCIPsetEventhdlrDelete( SCIP* scip, /**< scip instance */ SCIP_EVENTHDLR* eventhdlr, /**< event handler */ SCIP_DECL_EVENTDELETE ((*eventdelete)) /**< free specific event data */ ); /** returns the event handler of the given name, or NULL if not existing */ SCIP_EXPORT SCIP_EVENTHDLR* SCIPfindEventhdlr( SCIP* scip, /**< SCIP data structure */ const char* name /**< name of event handler */ ); /** returns the array of currently available event handlers */ SCIP_EXPORT SCIP_EVENTHDLR** SCIPgetEventhdlrs( SCIP* scip /**< SCIP data structure */ ); /** returns the number of currently available event handlers */ SCIP_EXPORT int SCIPgetNEventhdlrs( SCIP* scip /**< SCIP data structure */ ); /** @} */ /**@addtogroup PublicEventMethods * * @{ */ /** catches a global (not variable or row dependent) event * * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes. * * @pre This method can be called if @p scip is in one of the following stages: * - \ref SCIP_STAGE_TRANSFORMING * - \ref SCIP_STAGE_TRANSFORMED * - \ref SCIP_STAGE_INITPRESOLVE * - \ref SCIP_STAGE_PRESOLVING * - \ref SCIP_STAGE_EXITPRESOLVE * - \ref SCIP_STAGE_PRESOLVED * - \ref SCIP_STAGE_INITSOLVE * - \ref SCIP_STAGE_SOLVING * - \ref SCIP_STAGE_SOLVED * - \ref SCIP_STAGE_EXITSOLVE * - \ref SCIP_STAGE_FREETRANS */ SCIP_EXPORT SCIP_RETCODE SCIPcatchEvent( SCIP* scip, /**< SCIP data structure */ SCIP_EVENTTYPE eventtype, /**< event type mask to select events to catch */ SCIP_EVENTHDLR* eventhdlr, /**< event handler to process events with */ SCIP_EVENTDATA* eventdata, /**< event data to pass to the event handler when processing this event */ int* filterpos /**< pointer to store position of event filter entry, or NULL */ ); /** drops a global event (stops to track event) * * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes. * * @pre This method can be called if @p scip is in one of the following stages: * - \ref SCIP_STAGE_TRANSFORMING * - \ref SCIP_STAGE_TRANSFORMED * - \ref SCIP_STAGE_INITPRESOLVE * - \ref SCIP_STAGE_PRESOLVING * - \ref SCIP_STAGE_EXITPRESOLVE * - \ref SCIP_STAGE_PRESOLVED * - \ref SCIP_STAGE_INITSOLVE * - \ref SCIP_STAGE_SOLVING * - \ref SCIP_STAGE_SOLVED * - \ref SCIP_STAGE_EXITSOLVE * - \ref SCIP_STAGE_FREETRANS */ SCIP_EXPORT SCIP_RETCODE SCIPdropEvent( SCIP* scip, /**< SCIP data structure */ SCIP_EVENTTYPE eventtype, /**< event type mask of dropped event */ SCIP_EVENTHDLR* eventhdlr, /**< event handler to process events with */ SCIP_EVENTDATA* eventdata, /**< event data to pass to the event handler when processing this event */ int filterpos /**< position of event filter entry returned by SCIPcatchEvent(), or -1 */ ); /** catches an objective value or domain change event on the given transformed variable * * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes. * * @pre This method can be called if @p scip is in one of the following stages: * - \ref SCIP_STAGE_TRANSFORMING * - \ref SCIP_STAGE_TRANSFORMED * - \ref SCIP_STAGE_INITPRESOLVE * - \ref SCIP_STAGE_PRESOLVING * - \ref SCIP_STAGE_EXITPRESOLVE * - \ref SCIP_STAGE_PRESOLVED * - \ref SCIP_STAGE_INITSOLVE * - \ref SCIP_STAGE_SOLVING * - \ref SCIP_STAGE_SOLVED * - \ref SCIP_STAGE_EXITSOLVE * - \ref SCIP_STAGE_FREETRANS */ SCIP_EXPORT SCIP_RETCODE SCIPcatchVarEvent( SCIP* scip, /**< SCIP data structure */ SCIP_VAR* var, /**< transformed variable to catch event for */ SCIP_EVENTTYPE eventtype, /**< event type mask to select events to catch */ SCIP_EVENTHDLR* eventhdlr, /**< event handler to process events with */ SCIP_EVENTDATA* eventdata, /**< event data to pass to the event handler when processing this event */ int* filterpos /**< pointer to store position of event filter entry, or NULL */ ); /** drops an objective value or domain change event (stops to track event) on the given transformed variable * * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes. * * @pre This method can be called if @p scip is in one of the following stages: * - \ref SCIP_STAGE_TRANSFORMING * - \ref SCIP_STAGE_TRANSFORMED * - \ref SCIP_STAGE_INITPRESOLVE * - \ref SCIP_STAGE_PRESOLVING * - \ref SCIP_STAGE_EXITPRESOLVE * - \ref SCIP_STAGE_PRESOLVED * - \ref SCIP_STAGE_INITSOLVE * - \ref SCIP_STAGE_SOLVING * - \ref SCIP_STAGE_SOLVED * - \ref SCIP_STAGE_EXITSOLVE * - \ref SCIP_STAGE_FREETRANS */ SCIP_EXPORT SCIP_RETCODE SCIPdropVarEvent( SCIP* scip, /**< SCIP data structure */ SCIP_VAR* var, /**< transformed variable to drop event for */ SCIP_EVENTTYPE eventtype, /**< event type mask of dropped event */ SCIP_EVENTHDLR* eventhdlr, /**< event handler to process events with */ SCIP_EVENTDATA* eventdata, /**< event data to pass to the event handler when processing this event */ int filterpos /**< position of event filter entry returned by SCIPcatchVarEvent(), or -1 */ ); /** catches a row coefficient, constant, or side change event on the given row * * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes. * * @pre This method can be called if @p scip is in one of the following stages: * - \ref SCIP_STAGE_TRANSFORMING * - \ref SCIP_STAGE_TRANSFORMED * - \ref SCIP_STAGE_INITPRESOLVE * - \ref SCIP_STAGE_PRESOLVING * - \ref SCIP_STAGE_EXITPRESOLVE * - \ref SCIP_STAGE_PRESOLVED * - \ref SCIP_STAGE_INITSOLVE * - \ref SCIP_STAGE_SOLVING * - \ref SCIP_STAGE_SOLVED * - \ref SCIP_STAGE_EXITSOLVE * - \ref SCIP_STAGE_FREETRANS */ SCIP_EXPORT SCIP_RETCODE SCIPcatchRowEvent( SCIP* scip, /**< SCIP data structure */ SCIP_ROW* row, /**< linear row to catch event for */ SCIP_EVENTTYPE eventtype, /**< event type mask to select events to catch */ SCIP_EVENTHDLR* eventhdlr, /**< event handler to process events with */ SCIP_EVENTDATA* eventdata, /**< event data to pass to the event handler when processing this event */ int* filterpos /**< pointer to store position of event filter entry, or NULL */ ); /** drops a row coefficient, constant, or side change event (stops to track event) on the given row * * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes. * * @pre This method can be called if @p scip is in one of the following stages: * - \ref SCIP_STAGE_TRANSFORMING * - \ref SCIP_STAGE_TRANSFORMED * - \ref SCIP_STAGE_INITPRESOLVE * - \ref SCIP_STAGE_PRESOLVING * - \ref SCIP_STAGE_EXITPRESOLVE * - \ref SCIP_STAGE_PRESOLVED * - \ref SCIP_STAGE_INITSOLVE * - \ref SCIP_STAGE_SOLVING * - \ref SCIP_STAGE_SOLVED * - \ref SCIP_STAGE_EXITSOLVE * - \ref SCIP_STAGE_FREETRANS */ SCIP_EXPORT SCIP_RETCODE SCIPdropRowEvent( SCIP* scip, /**< SCIP data structure */ SCIP_ROW* row, /**< linear row to drop event for */ SCIP_EVENTTYPE eventtype, /**< event type mask of dropped event */ SCIP_EVENTHDLR* eventhdlr, /**< event handler to process events with */ SCIP_EVENTDATA* eventdata, /**< event data to pass to the event handler when processing this event */ int filterpos /**< position of event filter entry returned by SCIPcatchVarEvent(), or -1 */ ); /**@} */ #ifdef __cplusplus } #endif #endif