Scippy

SCIP

Solving Constraint Integer Programs

heur_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-2020 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 heur_sync.h
17  * @ingroup PRIMALHEURISTICS
18  * @brief primal heuristic that adds given solutions
19  * @author Leona Gottwald
20  *
21  * This heuristic takes solutions from somewhere else via the function SCIPheurSyncPassSol(). It
22  * then tries to commit this solution. It is used by the concurrent solvers, when solutions are
23  * communicated between solvers, but cannot directly submitted because SCIP might be in a stage where
24  * this is not allowed.
25  * If multiple solutions are passed it will keep the best N solutions depending on the parameter setting
26  * "concsolvers/sync/maxnsols"
27  */
28 
29 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
30 
31 #ifndef __SCIP_HEUR_SYNC_H__
32 #define __SCIP_HEUR_SYNC_H__
33 
34 #include "scip/def.h"
35 #include "scip/type_sol.h"
36 #include "scip/type_scip.h"
37 #include "scip/type_heur.h"
38 
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42 
43 /** creates the sync primal heuristic and includes it in SCIP
44  *
45  * @ingroup PrimalHeuristicIncludes
46  */
49  SCIP* scip /**< SCIP data structure */
50  );
51 
52 /**@addtogroup PRIMALHEURISTICS
53  *
54  * @{
55  */
56 
57 /** pass solution to sync heuristic */
60  SCIP* scip, /**< SCIP data structure */
61  SCIP_HEUR* heur, /**< sync heuristic */
62  SCIP_SOL* sol /**< solution to be passed */
63  );
64 
65 /** @} */
66 
67 #ifdef __cplusplus
68 }
69 #endif
70 
71 #endif
#define SCIP_EXPORT
Definition: def.h:100
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:54
SCIP_EXPORT SCIP_RETCODE SCIPincludeHeurSync(SCIP *scip)
Definition: heur_sync.c:152
type definitions for primal heuristics
type definitions for SCIP&#39;s main datastructure
SCIP_EXPORT SCIP_RETCODE SCIPheurSyncPassSol(SCIP *scip, SCIP_HEUR *heur, SCIP_SOL *sol)
Definition: heur_sync.c:181
type definitions for storing primal CIP solutions
common defines and data types used in all packages of SCIP