Scippy

SCIP

Solving Constraint Integer Programs

struct_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-2024 Zuse Institute Berlin (ZIB) */
7 /* */
8 /* Licensed under the Apache License, Version 2.0 (the "License"); */
9 /* you may not use this file except in compliance with the License. */
10 /* You may obtain a copy of the License at */
11 /* */
12 /* http://www.apache.org/licenses/LICENSE-2.0 */
13 /* */
14 /* Unless required by applicable law or agreed to in writing, software */
15 /* distributed under the License is distributed on an "AS IS" BASIS, */
16 /* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */
17 /* See the License for the specific language governing permissions and */
18 /* limitations under the License. */
19 /* */
20 /* You should have received a copy of the Apache-2.0 license */
21 /* along with SCIP; see the file LICENSE. If not visit scipopt.org. */
22 /* */
23 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
24 
25 /**@file struct_compr.h
26  * @ingroup INTERNALAPI
27  * @brief datastructures for tree compression techniques
28  * @author Jakob Witzig
29  */
30 
31 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
32 
33 #ifndef __SCIP_STRUCT_COMPR_H__
34 #define __SCIP_STRUCT_COMPR_H__
35 
36 
37 #include "scip/def.h"
38 #include "scip/type_clock.h"
39 #include "scip/type_compr.h"
40 
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44 
45 /** tree compression data */
46 struct SCIP_Compr
47 {
48  SCIP_Longint ncalls; /**< number of times, this compression was called */
49  SCIP_Longint nfound; /**< number of compressions found so far by this method */
50  SCIP_Real rate; /**< rate of the last compression */
51  SCIP_Real loi; /**< loss of information of the last compression */
52  char* name; /**< name of tree compression */
53  char* desc; /**< description of tree compression */
54  SCIP_DECL_COMPRCOPY ((*comprcopy)); /**< copy method of tree compression or NULL if you don't want to copy your plugin into sub-SCIPs */
55  SCIP_DECL_COMPRFREE ((*comprfree)); /**< destructor of tree compression */
56  SCIP_DECL_COMPRINIT ((*comprinit)); /**< initialize tree compression */
57  SCIP_DECL_COMPREXIT ((*comprexit)); /**< deinitialize tree compression */
58  SCIP_DECL_COMPRINITSOL ((*comprinitsol)); /**< solving process initialization method of tree compression */
59  SCIP_DECL_COMPREXITSOL ((*comprexitsol)); /**< solving process deinitialization method of tree compression */
60  SCIP_DECL_COMPREXEC ((*comprexec)); /**< execution method of tree compression */
61  SCIP_COMPRDATA* comprdata; /**< tree compression local data */
62  SCIP_CLOCK* setuptime; /**< time spend for setting up this compression for the next stages */
63  SCIP_CLOCK* comprclock; /**< compression execution time */
64  int priority; /**< priority of the tree compression */
65  int minnnodes; /**< minimal number of nodes for calling compression, -1 if no threshold exists */
66  int nnodes; /**< number of nodes of the last compression */
67  SCIP_Bool initialized; /**< is tree compression initialized? */
68 };
69 
70 #ifdef __cplusplus
71 }
72 #endif
73 
74 #endif
SCIP_DECL_COMPRFREE((*comprfree))
SCIP_DECL_COMPREXEC((*comprexec))
SCIP_CLOCK * comprclock
Definition: struct_compr.h:63
SCIP_Longint nfound
Definition: struct_compr.h:49
char * desc
Definition: struct_compr.h:53
SCIP_COMPRDATA * comprdata
Definition: struct_compr.h:61
SCIP_Real loi
Definition: struct_compr.h:51
SCIP_CLOCK * setuptime
Definition: struct_compr.h:62
SCIP_Real rate
Definition: struct_compr.h:50
SCIP_Longint ncalls
Definition: struct_compr.h:48
SCIP_DECL_COMPRINITSOL((*comprinitsol))
SCIP_DECL_COMPRCOPY((*comprcopy))
struct SCIP_ComprData SCIP_COMPRDATA
Definition: type_compr.h:49
#define SCIP_Bool
Definition: def.h:91
type definitions for clocks and timing issues
SCIP_DECL_COMPREXITSOL((*comprexitsol))
SCIP_DECL_COMPREXIT((*comprexit))
type definitions for tree compression
SCIP_Bool initialized
Definition: struct_compr.h:67
#define SCIP_Real
Definition: def.h:173
SCIP_DECL_COMPRINIT((*comprinit))
#define SCIP_Longint
Definition: def.h:158
char * name
Definition: struct_compr.h:52
common defines and data types used in all packages of SCIP