Scippy

SCIP

Solving Constraint Integer Programs

pub_compr.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-2016 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 pub_compr.h
17  * @ingroup PUBLICMETHODS
18  * @brief public methods for tree compressions
19  * @author Jakob Witzig
20  */
21 
22 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
23 
24 #ifndef __SCIP_PUB_COMPR_H__
25 #define __SCIP_PUB_COMPR_H__
26 
27 
28 #include "scip/def.h"
29 #include "scip/type_misc.h"
30 #include "scip/type_compr.h"
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
36 /** compares two compressions w. r. to their priority */
37 extern
38 SCIP_DECL_SORTPTRCOMP(SCIPcomprComp);
39 
40 /** comparison method for sorting compressions w.r.t. to their name */
41 extern
42 SCIP_DECL_SORTPTRCOMP(SCIPcomprCompName);
43 
44 /** gets user data of tree compression */
45 extern
47  SCIP_COMPR* compr /**< tree compression */
48  );
49 
50 /** sets user data of tree compression; user has to free old data in advance! */
51 extern
52 void SCIPcomprSetData(
53  SCIP_COMPR* compr, /**< tree compression */
54  SCIP_COMPRDATA* comprdata /**< new tree compression user data */
55  );
56 
57 /** gets name of tree compression */
58 extern
59 const char* SCIPcomprGetName(
60  SCIP_COMPR* heur /**< tree compression */
61  );
62 
63 /** gets description of tree compression */
64 extern
65 const char* SCIPcomprGetDesc(
66  SCIP_COMPR* compr /**< tree compression */
67  );
68 
69 /** gets priority of tree compression */
70 extern
72  SCIP_COMPR* compr /**< tree compression */
73  );
74 
75 /** gets minimal number of nodes for calling tree compression (returns -1, if no node threshold exists) */
76 extern
78  SCIP_COMPR* compr /**< tree compression */
79  );
80 
81 /** gets the number of times, the compression was called and tried to find a compression */
82 extern
84  SCIP_COMPR* compr /**< tree compression */
85  );
86 
87 /** gets the number of tree compressions found by this compression */
88 extern
90  SCIP_COMPR* compr /**< tree compression */
91  );
92 
93 /** is tree compression initialized? */
94 extern
96  SCIP_COMPR* compr /**< tree compression */
97  );
98 
99 /** gets time in seconds used in this compression for setting up for next stages */
100 extern
102  SCIP_COMPR* compr /**< tree compression */
103  );
104 
105 /** gets time in seconds used in this compression */
106 extern
108  SCIP_COMPR* compr /**< tree compression */
109  );
110 
111 #ifdef __cplusplus
112 }
113 #endif
114 
115 #endif
int SCIPcomprGetPriority(SCIP_COMPR *compr)
Definition: compr.c:429
type definitions for miscellaneous datastructures
SCIP_Longint SCIPcomprGetNCalls(SCIP_COMPR *compr)
Definition: compr.c:463
SCIP_DECL_SORTPTRCOMP(SCIPcomprComp)
Definition: compr.c:41
void SCIPcomprSetData(SCIP_COMPR *compr, SCIP_COMPRDATA *comprdata)
Definition: compr.c:316
int SCIPcomprGetMinNodes(SCIP_COMPR *compr)
Definition: compr.c:453
SCIP_Bool SCIPcomprIsInitialized(SCIP_COMPR *compr)
Definition: compr.c:483
const char * SCIPcomprGetDesc(SCIP_COMPR *compr)
Definition: compr.c:419
const char * SCIPcomprGetName(SCIP_COMPR *heur)
Definition: compr.c:409
SCIP_Real SCIPcomprGetSetupTime(SCIP_COMPR *compr)
Definition: compr.c:493
struct SCIP_ComprData SCIP_COMPRDATA
Definition: type_compr.h:40
#define SCIP_Bool
Definition: def.h:53
type definitions for tree compression
#define SCIP_Real
Definition: def.h:127
SCIP_COMPRDATA * SCIPcomprGetData(SCIP_COMPR *compr)
Definition: compr.c:306
SCIP_Real SCIPcomprGetTime(SCIP_COMPR *compr)
Definition: compr.c:503
#define SCIP_Longint
Definition: def.h:112
common defines and data types used in all packages of SCIP
SCIP_Longint SCIPcomprGetNFound(SCIP_COMPR *compr)
Definition: compr.c:473