Scippy

SCIP

Solving Constraint Integer Programs

prop_sync.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-2023 Zuse Institute Berlin (ZIB) */
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 prop_sync.h
26  * @ingroup PROPAGATORS
27  * @brief propagator for applying global bound changes that were communicated by other
28  * concurrent solvers
29  * @author Leona Gottwald
30  */
31 
32 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
33 
34 #ifndef __SCIP_PROP_SYNC_H__
35 #define __SCIP_PROP_SYNC_H__
36 
37 #include "scip/def.h"
38 #include "scip/type_lp.h"
39 #include "scip/type_prop.h"
40 #include "scip/type_retcode.h"
41 #include "scip/type_scip.h"
42 #include "scip/type_var.h"
43 
44 #ifdef __cplusplus
45 extern "C" {
46 #endif
47 
48 /** creates the sync propagator and includes it in SCIP
49  *
50  * @ingroup PropagatorIncludes
51  */
52 SCIP_EXPORT
54  SCIP* scip /**< SCIP data structure */
55  );
56 
57 /**@addtogroup PROPAGATORS
58  *
59  * @{
60  */
61 
62 /** adds a boundchange to the sync propagator */
63 SCIP_EXPORT
65  SCIP* scip, /**< SCIP data structure */
66  SCIP_PROP* prop, /**< sync propagator */
67  SCIP_VAR* var, /**< variable for bound */
68  SCIP_Real val, /**< value of bound */
69  SCIP_BOUNDTYPE bndtype /**< type of bound */
70  );
71 
72 /** gives the total number of tightened bounds found by the sync propagator */
73 SCIP_EXPORT
75  SCIP_PROP* prop /**< sync propagator */
76  );
77 
78 /** gives the total number of tightened bounds for integer variables found by the sync propagator */
79 SCIP_EXPORT
81  SCIP_PROP* prop /**< sync propagator */
82  );
83 
84 /** @} */
85 
86 #ifdef __cplusplus
87 }
88 #endif
89 
90 #endif
enum SCIP_BoundType SCIP_BOUNDTYPE
Definition: type_lp.h:59
SCIP_Longint SCIPpropSyncGetNTightenedBnds(SCIP_PROP *prop)
Definition: prop_sync.c:363
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:63
type definitions for return codes for SCIP methods
type definitions for LP management
type definitions for SCIP&#39;s main datastructure
SCIP_RETCODE SCIPincludePropSync(SCIP *scip)
Definition: prop_sync.c:288
SCIP_RETCODE SCIPpropSyncAddBndchg(SCIP *scip, SCIP_PROP *prop, SCIP_VAR *var, SCIP_Real val, SCIP_BOUNDTYPE bndtype)
Definition: prop_sync.c:323
type definitions for problem variables
type definitions for propagators
SCIP_Longint SCIPpropSyncGetNTightenedIntBnds(SCIP_PROP *prop)
Definition: prop_sync.c:378
#define SCIP_Real
Definition: def.h:186
#define SCIP_Longint
Definition: def.h:171
common defines and data types used in all packages of SCIP