Scippy

SCIP

Solving Constraint Integer Programs

heur_local.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-2018 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 scip.zib.de. */
13 /* */
14 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
15 
16 /**@file heur_local.h
17  * @brief Improvement heuristic for Steiner problems
18  * @author Daniel Rehfeldt
19  *
20  * This file implements three local search heuristics, namely vertex insertion, key-path exchange and key-vertex elimination,
21  * see "Fast Local Search for Steiner Trees in Graphs" by Uchoa and Werneck. Furthermore, it includes several non-published local
22  * search heuristics for prize-collecting Steiner problem tree variants.
23  *
24  */
25 
26 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
27 
28 #ifndef __SCIP_HEUR_LOCAL_H__
29 #define __SCIP_HEUR_LOCAL_H__
30 
31 
32 #include "scip/scip.h"
33 #include "grph.h"
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37 
38 /** creates the local primal heuristic and includes it in SCIP */
39 extern
41  SCIP* scip /**< SCIP data structure */
42  );
43 
44 /** perform local heuristics on a given Steiner tree */
45 extern
47  SCIP* scip, /**< SCIP data structure */
48  GRAPH* graph, /**< graph data structure */
49  const SCIP_Real* cost, /**< arc cost array */
50  int* best_result /**< array indicating whether an arc is part of the solution (CONNECTED/UNKNOWN) */
51  );
52 
53 
54 
55 /** greedy extension local heuristic for (R)PC and MW */
56 extern
58  SCIP* scip, /**< SCIP data structure */
59  GRAPH* graph, /**< graph data structure */
60  const SCIP_Real* cost, /**< edge cost array*/
61  PATH* path, /**< shortest data structure array */
62  int* stedge, /**< initialized array to indicate whether an edge is part of the Steiner tree */
63  STP_Bool* stvertex, /**< uninitialized array to indicate whether a vertex is part of the Steiner tree */
64  SCIP_Bool* extensions /**< pointer to store whether extensions have been made */
65 );
66 
67 #ifdef __cplusplus
68 }
69 #endif
70 
71 #endif
Definition: grph.h:57
SCIP_RETCODE SCIPStpIncludeHeurLocal(SCIP *scip)
Definition: heur_local.c:2273
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:53
SCIP_RETCODE SCIPStpHeurLocalExtendPcMw(SCIP *scip, GRAPH *graph, const SCIP_Real *cost, PATH *path, int *stedge, STP_Bool *stvertex, SCIP_Bool *extensions)
Definition: heur_local.c:1693
unsigned char STP_Bool
Definition: grph.h:52
#define SCIP_Bool
Definition: def.h:62
includes various files containing graph methods used for Steiner tree problems
SCIP_RETCODE SCIPStpHeurLocalRun(SCIP *scip, GRAPH *graph, const SCIP_Real *cost, int *best_result)
Definition: heur_local.c:208
#define SCIP_Real
Definition: def.h:150
SCIP callable library.