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 2002-2022 Zuse Institute Berlin */
7 /* */
8 /* Licensed under the Apache License, Version 2.0 (the "License"); */
9 /* you may not use this file except in compliance with the License. */
10 /* You may obtain a copy of the License at */
11 /* */
12 /* http://www.apache.org/licenses/LICENSE-2.0 */
13 /* */
14 /* Unless required by applicable law or agreed to in writing, software */
15 /* distributed under the License is distributed on an "AS IS" BASIS, */
16 /* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */
17 /* See the License for the specific language governing permissions and */
18 /* limitations under the License. */
19 /* */
20 /* You should have received a copy of the Apache-2.0 license */
21 /* along with SCIP; see the file LICENSE. If not visit scipopt.org. */
22 /* */
23 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
24 
25 /**@file event_globalbnd.h
26  * @ingroup EVENTS
27  * @brief eventhdlr for storing all global bound changes
28  * @author Leona Gottwald
29  *
30  * the bound changes are stored so that they can be shared with other threads
31  * in a concurrent solve.
32  */
33 
34 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
35 
36 #ifndef __SCIP_EVENT_GLOBALBND_H__
37 #define __SCIP_EVENT_GLOBALBND_H__
38 
39 #include "scip/def.h"
40 #include "scip/type_event.h"
41 #include "scip/type_retcode.h"
42 #include "scip/type_scip.h"
43 #include "scip/type_syncstore.h"
44 
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48 
49 /** creates event handler for global bound event */
50 SCIP_EXPORT
52  SCIP* scip /**< SCIP data structure */
53  );
54 
55 /** gets the global bound changes stored in the eventhandler */
56 SCIP_EXPORT
58  SCIP_EVENTHDLR* eventhdlr /**< the globalbound eventhandler */
59  );
60 
61 /** enables storing of bound changes */
62 SCIP_EXPORT
64  SCIP_EVENTHDLR* eventhdlr /**< the globalbound eventhandler */
65  );
66 
67 /** disables storing of bound changes */
68 SCIP_EXPORT
70  SCIP_EVENTHDLR* eventhdlr /**< the globalbound eventhandler */
71  );
72 
73 /** clears all bound changes stored in the eventhandler */
74 SCIP_EXPORT
76  SCIP_EVENTHDLR* eventhdlr /**< the globalbound eventhandler */
77  );
78 
79 
80 #ifdef __cplusplus
81 }
82 #endif
83 
84 #endif
void SCIPeventGlobalbndDisableBoundStorage(SCIP_EVENTHDLR *eventhdlr)
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:63
type definitions for return codes for SCIP methods
void SCIPeventGlobalbndClearBoundChanges(SCIP_EVENTHDLR *eventhdlr)
SCIP_RETCODE SCIPincludeEventHdlrGlobalbnd(SCIP *scip)
type definitions for SCIP&#39;s main datastructure
SCIP_BOUNDSTORE * SCIPeventGlobalbndGetBoundChanges(SCIP_EVENTHDLR *eventhdlr)
void SCIPeventGlobalbndEnableBoundStorage(SCIP_EVENTHDLR *eventhdlr)
type definitions for managing events
the type definitions for the synchronization store
common defines and data types used in all packages of SCIP