Scippy

SCIP

Solving Constraint Integer Programs

heur_zeroobj.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_zeroobj.h
17  * @ingroup PRIMALHEURISTICS
18  * @brief heuristic that tries to solve the problem without objective. In Gurobi, this heuristic is known as "Hail Mary"
19  * @author Timo Berthold
20  */
21 
22 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
23 
24 #ifndef __SCIP_HEUR_ZEROOBJ_H__
25 #define __SCIP_HEUR_ZEROOBJ_H__
26 
27 #include "scip/def.h"
28 #include "scip/type_heur.h"
29 #include "scip/type_result.h"
30 #include "scip/type_retcode.h"
31 #include "scip/type_scip.h"
32 
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36 
37 /** creates the zeroobj primal heuristic and includes it in SCIP
38  *
39  * @ingroup PrimalHeuristicIncludes
40  */
43  SCIP* scip /**< SCIP data structure */
44  );
45 
46 /**@addtogroup PRIMALHEURISTICS
47  *
48  * @{
49  */
50 
51 /** main procedure of the zeroobj heuristic, creates and solves a sub-SCIP */
54  SCIP* scip, /**< original SCIP data structure */
55  SCIP_HEUR* heur, /**< heuristic data structure */
56  SCIP_RESULT* result, /**< result data structure */
57  SCIP_Real minimprove, /**< factor by which zeroobj should at least improve the incumbent */
58  SCIP_Longint nnodes /**< node limit for the subproblem */
59  );
60 
61 /** @} */
62 
63 #ifdef __cplusplus
64 }
65 #endif
66 
67 #endif
enum SCIP_Result SCIP_RESULT
Definition: type_result.h:52
#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
type definitions for primal heuristics
type definitions for SCIP&#39;s main datastructure
SCIP_EXPORT SCIP_RETCODE SCIPapplyZeroobj(SCIP *scip, SCIP_HEUR *heur, SCIP_RESULT *result, SCIP_Real minimprove, SCIP_Longint nnodes)
Definition: heur_zeroobj.c:506
#define SCIP_Real
Definition: def.h:163
result codes for SCIP callback methods
#define SCIP_Longint
Definition: def.h:148
SCIP_EXPORT SCIP_RETCODE SCIPincludeHeurZeroobj(SCIP *scip)
Definition: heur_zeroobj.c:560
#define nnodes
Definition: gastrans.c:65
common defines and data types used in all packages of SCIP