Scippy

SCIP

Solving Constraint Integer Programs

event_globalbnd.h
Go to the documentation of this file.
1 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2 /* */
3 /* This file is part of the program and library */
4 /* SCIP --- Solving Constraint Integer Programs */
5 /* */
6 /* Copyright (C) 2002-2021 Konrad-Zuse-Zentrum */
7 /* fuer Informationstechnik Berlin */
8 /* */
9 /* SCIP is distributed under the terms of the ZIB Academic License. */
10 /* */
11 /* You should have received a copy of the ZIB Academic License */
12 /* along with SCIP; see the file COPYING. If not visit scipopt.org. */
13 /* */
14 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
15 
16 /**@file event_globalbnd.h
17  * @ingroup EVENTS
18  * @brief eventhdlr for storing all global bound changes
19  * @author Leona Gottwald
20  *
21  * the bound changes are stored so that they can be shared with other threads
22  * in a concurrent solve.
23  */
24 
25 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
26 
27 #ifndef __SCIP_EVENT_GLOBALBND_H__
28 #define __SCIP_EVENT_GLOBALBND_H__
29 
30 #include "scip/def.h"
31 #include "scip/type_event.h"
32 #include "scip/type_retcode.h"
33 #include "scip/type_scip.h"
34 #include "scip/type_syncstore.h"
35 
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39 
40 /** creates event handler for global bound event */
43  SCIP* scip /**< SCIP data structure */
44  );
45 
46 /** gets the global bound changes stored in the eventhandler */
49  SCIP_EVENTHDLR* eventhdlr /**< the globalbound eventhandler */
50  );
51 
52 /** enables storing of bound changes */
55  SCIP_EVENTHDLR* eventhdlr /**< the globalbound eventhandler */
56  );
57 
58 /** disables storing of bound changes */
61  SCIP_EVENTHDLR* eventhdlr /**< the globalbound eventhandler */
62  );
63 
64 /** clears all bound changes stored in the eventhandler */
67  SCIP_EVENTHDLR* eventhdlr /**< the globalbound eventhandler */
68  );
69 
70 
71 #ifdef __cplusplus
72 }
73 #endif
74 
75 #endif
SCIP_EXPORT void SCIPeventGlobalbndEnableBoundStorage(SCIP_EVENTHDLR *eventhdlr)
#define SCIP_EXPORT
Definition: def.h:100
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:54
type definitions for return codes for SCIP methods
type definitions for SCIP&#39;s main datastructure
SCIP_EXPORT SCIP_BOUNDSTORE * SCIPeventGlobalbndGetBoundChanges(SCIP_EVENTHDLR *eventhdlr)
type definitions for managing events
SCIP_EXPORT SCIP_RETCODE SCIPincludeEventHdlrGlobalbnd(SCIP *scip)
SCIP_EXPORT void SCIPeventGlobalbndDisableBoundStorage(SCIP_EVENTHDLR *eventhdlr)
the type definitions for the synchronization store
SCIP_EXPORT void SCIPeventGlobalbndClearBoundChanges(SCIP_EVENTHDLR *eventhdlr)
common defines and data types used in all packages of SCIP