Scippy

SCIP

Solving Constraint Integer Programs

heur_trysol.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-2015 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 email to scip@zib.de. */
13 /* */
14 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
15 
16 /**@file heur_trysol.h
17  * @ingroup PRIMALHEURISTICS
18  * @brief primal heuristic that tries a given solution
19  * @author Marc Pfetsch
20  *
21  * This heuristic takes a solution from somewhere else via the function SCIPheurPassSolTrySol(). It
22  * then tries to commit this solution. It is mainly used by cons_indicator, which tries to correct a
23  * given solution, but cannot directly submit this solution, because it is a constraint handler and
24  * not a heuristic.
25  */
26 
27 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
28 
29 #ifndef __SCIP_HEUR_TRYSOL_H__
30 #define __SCIP_HEUR_TRYSOL_H__
31 
32 
33 #include "scip/scip.h"
34 
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38 
39 /** creates the trysol primal heuristic and includes it in SCIP */
40 extern
42  SCIP* scip /**< SCIP data structure */
43  );
44 
45 /** pass solution to trysol heuristic */
46 extern
48  SCIP* scip, /**< SCIP data structure */
49  SCIP_HEUR* heur, /**< trysol heuristic */
50  SCIP_SOL* sol /**< solution to be passed */
51  );
52 
53 /** pass solution to trysol heuristic which just gets added (without checking feasibility */
54 extern
56  SCIP* scip, /**< SCIP data structure */
57  SCIP_HEUR* heur, /**< trysol heuristic */
58  SCIP_SOL* sol /**< solution to be passed */
59  );
60 
61 #ifdef __cplusplus
62 }
63 #endif
64 
65 #endif
struct SCIP_Heur SCIP_HEUR
Definition: type_heur.h:50
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:53
SCIP_RETCODE SCIPheurPassSolTrySol(SCIP *scip, SCIP_HEUR *heur, SCIP_SOL *sol)
struct Scip SCIP
Definition: type_scip.h:30
struct SCIP_Sol SCIP_SOL
Definition: type_sol.h:45
SCIP_RETCODE SCIPheurPassSolAddSol(SCIP *scip, SCIP_HEUR *heur, SCIP_SOL *sol)
SCIP_RETCODE SCIPincludeHeurTrySol(SCIP *scip)
SCIP callable library.