Scippy

SCIP

Solving Constraint Integer Programs

heur_indicator.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-2021 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_indicator.h
17  * @ingroup PRIMALHEURISTICS
18  * @brief handle partial solutions for linear problems with indicators and otherwise continuous variables
19  * @author Marc Pfetsch
20  *
21  * For linear problems with indicators and otherwise continuous variables, the indicator constraint handler can produce
22  * partial solutions, i.e., values for the indicator variables. This partial solution can be passed to this heuristic,
23  * which then fixes these values and solves an LP. Additionally a local search for a better solution is added.
24  */
25 
26 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
27 
28 #ifndef __SCIP_HEUR_INDICATOR_H__
29 #define __SCIP_HEUR_INDICATOR_H__
30 
31 #include "scip/def.h"
32 #include "scip/type_cons.h"
33 #include "scip/type_heur.h"
34 #include "scip/type_retcode.h"
35 #include "scip/type_scip.h"
36 
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40 
41 /** creates the indicator primal heuristic and includes it in SCIP
42  *
43  * @ingroup PrimalHeuristicIncludes
44  */
47  SCIP* scip /**< SCIP data structure */
48  );
49 
50 /**@addtogroup PRIMALHEURISTICS
51  *
52  * @{
53  */
54 
55 /** pass partial solution for indicator variables to heuristic */
58  SCIP* scip, /**< SCIP data structure */
59  SCIP_HEUR* heur, /**< indicator heuristic */
60  int nindconss, /**< number of indicator constraints */
61  SCIP_CONS** indconss, /**< indicator constraints */
62  SCIP_Bool* solcand, /**< values for indicator variables in partial solution */
63  SCIP_Real obj /**< objective of solution */
64  );
65 
66 /** @} */
67 
68 #ifdef __cplusplus
69 }
70 #endif
71 
72 #endif
#define SCIP_EXPORT
Definition: def.h:100
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:54
type definitions for return codes for SCIP methods
SCIP_EXPORT SCIP_RETCODE SCIPincludeHeurIndicator(SCIP *scip)
type definitions for primal heuristics
type definitions for SCIP&#39;s main datastructure
#define SCIP_Bool
Definition: def.h:70
#define SCIP_Real
Definition: def.h:163
SCIP_EXPORT SCIP_RETCODE SCIPheurPassIndicator(SCIP *scip, SCIP_HEUR *heur, int nindconss, SCIP_CONS **indconss, SCIP_Bool *solcand, SCIP_Real obj)
common defines and data types used in all packages of SCIP
type definitions for constraints and constraint handlers