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-2019 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 pub_compr.h
17  * @ingroup PUBLICCOREAPI
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 /**@addtogroup PublicCompressionMethods
37  *
38  * @{
39  */
40 
41 /** compares two compressions w. r. to their priority */
43 SCIP_DECL_SORTPTRCOMP(SCIPcomprComp);
44 
45 /** comparison method for sorting compressions w.r.t. to their name */
47 SCIP_DECL_SORTPTRCOMP(SCIPcomprCompName);
48 
49 /** gets user data of tree compression */
52  SCIP_COMPR* compr /**< tree compression */
53  );
54 
55 /** sets user data of tree compression; user has to free old data in advance! */
57 void SCIPcomprSetData(
58  SCIP_COMPR* compr, /**< tree compression */
59  SCIP_COMPRDATA* comprdata /**< new tree compression user data */
60  );
61 
62 /** gets name of tree compression */
64 const char* SCIPcomprGetName(
65  SCIP_COMPR* heur /**< tree compression */
66  );
67 
68 /** gets description of tree compression */
70 const char* SCIPcomprGetDesc(
71  SCIP_COMPR* compr /**< tree compression */
72  );
73 
74 /** gets priority of tree compression */
77  SCIP_COMPR* compr /**< tree compression */
78  );
79 
80 /** gets minimal number of nodes for calling tree compression (returns -1, if no node threshold exists) */
83  SCIP_COMPR* compr /**< tree compression */
84  );
85 
86 /** gets the number of times, the compression was called and tried to find a compression */
89  SCIP_COMPR* compr /**< tree compression */
90  );
91 
92 /** gets the number of tree compressions found by this compression */
95  SCIP_COMPR* compr /**< tree compression */
96  );
97 
98 /** is tree compression initialized? */
101  SCIP_COMPR* compr /**< tree compression */
102  );
103 
104 /** gets time in seconds used in this compression for setting up for next stages */
107  SCIP_COMPR* compr /**< tree compression */
108  );
109 
110 /** gets time in seconds used in this compression */
113  SCIP_COMPR* compr /**< tree compression */
114  );
115 
116 /* @} */
117 
118 #ifdef __cplusplus
119 }
120 #endif
121 
122 #endif
SCIP_EXPORT SCIP_Real SCIPcomprGetSetupTime(SCIP_COMPR *compr)
Definition: compr.c:530
SCIP_EXPORT int SCIPcomprGetPriority(SCIP_COMPR *compr)
Definition: compr.c:466
type definitions for miscellaneous datastructures
SCIP_EXPORT SCIP_Bool SCIPcomprIsInitialized(SCIP_COMPR *compr)
Definition: compr.c:520
#define SCIP_EXPORT
Definition: def.h:98
SCIP_EXPORT const char * SCIPcomprGetName(SCIP_COMPR *heur)
Definition: compr.c:446
SCIP_EXPORT const char * SCIPcomprGetDesc(SCIP_COMPR *compr)
Definition: compr.c:456
SCIP_EXPORT SCIP_Real SCIPcomprGetTime(SCIP_COMPR *compr)
Definition: compr.c:540
struct SCIP_ComprData SCIP_COMPRDATA
Definition: type_compr.h:40
SCIP_EXPORT SCIP_COMPRDATA * SCIPcomprGetData(SCIP_COMPR *compr)
Definition: compr.c:343
SCIP_EXPORT void SCIPcomprSetData(SCIP_COMPR *compr, SCIP_COMPRDATA *comprdata)
Definition: compr.c:353
#define SCIP_Bool
Definition: def.h:70
SCIP_EXPORT SCIP_Longint SCIPcomprGetNCalls(SCIP_COMPR *compr)
Definition: compr.c:500
SCIP_EXPORT SCIP_Longint SCIPcomprGetNFound(SCIP_COMPR *compr)
Definition: compr.c:510
SCIP_EXPORT int SCIPcomprGetMinNodes(SCIP_COMPR *compr)
Definition: compr.c:490
type definitions for tree compression
#define SCIP_Real
Definition: def.h:164
SCIP_EXPORT SCIP_DECL_SORTPTRCOMP(SCIPcomprComp)
Definition: compr.c:41
#define SCIP_Longint
Definition: def.h:149
common defines and data types used in all packages of SCIP