Scippy

SCIP

Solving Constraint Integer Programs

struct_prop.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 struct_prop.h
17  * @ingroup INTERNALAPI
18  * @brief datastructures for propagators
19  * @author Tobias Achterberg
20  */
21 
22 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
23 
24 #ifndef __SCIP_STRUCT_PROP_H__
25 #define __SCIP_STRUCT_PROP_H__
26 
27 
28 #include "scip/def.h"
29 #include "scip/type_clock.h"
30 #include "scip/type_prop.h"
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
36 /** propagators data */
37 struct SCIP_Prop
38 {
39  SCIP_Longint ncalls; /**< number of times, this propagator was called */
40  SCIP_Longint nrespropcalls; /**< number of times, the resolve propagation was called */
41  SCIP_Longint ncutoffs; /**< number of cutoffs found so far by this propagator */
42  SCIP_Longint ndomredsfound; /**< number of domain reductions found so far by this propagator */
43  char* name; /**< name of propagator */
44  char* desc; /**< description of propagator */
45  SCIP_DECL_PROPCOPY ((*propcopy)); /**< copy method of propagator or NULL if you don't want to copy your plugin into sub-SCIPs */
46  SCIP_DECL_PROPFREE ((*propfree)); /**< destructor of propagator */
47  SCIP_DECL_PROPINIT ((*propinit)); /**< initialize propagator */
48  SCIP_DECL_PROPEXIT ((*propexit)); /**< deinitialize propagator */
49  SCIP_DECL_PROPINITPRE ((*propinitpre)); /**< presolving initialization method of propagator */
50  SCIP_DECL_PROPEXITPRE ((*propexitpre)); /**< presolving deinitialization method of propagator */
51  SCIP_DECL_PROPINITSOL ((*propinitsol)); /**< solving process initialization method of propagator */
52  SCIP_DECL_PROPEXITSOL ((*propexitsol)); /**< solving process deinitialization method of propagator */
53  SCIP_DECL_PROPPRESOL ((*proppresol)); /**< presolving method of propagator */
54  SCIP_DECL_PROPEXEC ((*propexec)); /**< execution method of propagator */
55  SCIP_DECL_PROPRESPROP ((*propresprop)); /**< propagation conflict resolving method */
56  SCIP_PROPDATA* propdata; /**< propagators local data */
57  SCIP_CLOCK* setuptime; /**< time spend for setting up this propagator for the next stages */
58  SCIP_CLOCK* proptime; /**< time used for propagation of this propagator */
59  SCIP_CLOCK* sbproptime; /**< time used for propagation of this propagator during strong branching */
60  SCIP_CLOCK* resproptime; /**< time used for resolve propagation of this propagator */
61  SCIP_CLOCK* presoltime; /**< time used for presolving of this propagator */
62  int priority; /**< priority of the propagator for propagation */
63  int freq; /**< frequency for calling propagator */
64  SCIP_PROPTIMING timingmask; /**< positions in the node solving loop where propagator should be executed */
65  SCIP_PRESOLTIMING presoltiming; /**< timing mask of the presolving method of the propagator */
66  int presolpriority; /**< priority of the presolving of the propagator */
67  int maxprerounds; /**< maximal number of presolving rounds the constraint handler participates in (-1: no limit) */
68  int lastnfixedvars; /**< number of variables fixed before the last call to the propagator */
69  int lastnaggrvars; /**< number of variables aggregated in presolving before the last call to the propagator */
70  int lastnchgvartypes; /**< number of variable type changes in presolving before the last call to the propagator */
71  int lastnchgbds; /**< number of variable bounds tightened in presolving before the last call to the propagator */
72  int lastnaddholes; /**< number of domain holes added in presolving before the last call to the propagator */
73  int lastndelconss; /**< number of deleted constraints in presolving before the last call to the propagator */
74  int lastnaddconss; /**< number of added constraints in presolving before the last call to the propagator */
75  int lastnupgdconss; /**< number of upgraded constraints in presolving before the last call to the propagator */
76  int lastnchgcoefs; /**< number of changed coefficients in presolving before the last call to the propagator */
77  int lastnchgsides; /**< number of changed left or right hand sides in presolving before the last call to the propagator */
78  int nfixedvars; /**< total number of variables fixed by this propagator in presolving */
79  int naggrvars; /**< total number of variables aggregated by this propagator in presolving */
80  int nchgvartypes; /**< total number of variable type changes by this propagator in presolving */
81  int nchgbds; /**< total number of variable bounds tightened by this propagator in presolving */
82  int naddholes; /**< total number of domain holes added by this propagator in presolving */
83  int ndelconss; /**< total number of deleted constraints by this propagator in presolving */
84  int naddconss; /**< total number of added constraints by this propagator in presolving */
85  int nupgdconss; /**< total number of upgraded constraints by this propagator in presolving */
86  int nchgcoefs; /**< total number of changed coefficients by this propagator in presolving */
87  int nchgsides; /**< total number of changed left or right hand sides by this propagator in presolving */
88  int npresolcalls; /**< number of times the propagator was called in presolving and tried to find reductions */
89  SCIP_Bool delay; /**< should propagator be delayed, if other propagators found reductions? */
90  SCIP_Bool wasdelayed; /**< was the propagator delayed at the last call? */
91  SCIP_Bool initialized; /**< is propagator initialized? */
92 };
93 
94 #ifdef __cplusplus
95 }
96 #endif
97 
98 #endif
int lastndelconss
Definition: struct_prop.h:73
int nfixedvars
Definition: struct_prop.h:78
SCIP_DECL_PROPRESPROP((*propresprop))
SCIP_DECL_PROPINITSOL((*propinitsol))
int lastnaddholes
Definition: struct_prop.h:72
int ndelconss
Definition: struct_prop.h:83
SCIP_DECL_PROPEXEC((*propexec))
char * desc
Definition: struct_prop.h:44
int maxprerounds
Definition: struct_prop.h:67
int naddholes
Definition: struct_prop.h:82
SCIP_CLOCK * presoltime
Definition: struct_prop.h:61
SCIP_DECL_PROPEXITPRE((*propexitpre))
SCIP_CLOCK * proptime
Definition: struct_prop.h:58
int npresolcalls
Definition: struct_prop.h:88
SCIP_Longint ncalls
Definition: struct_prop.h:39
int nupgdconss
Definition: struct_prop.h:85
int nchgbds
Definition: struct_prop.h:81
SCIP_Longint ncutoffs
Definition: struct_prop.h:41
char * name
Definition: struct_prop.h:43
int lastnfixedvars
Definition: struct_prop.h:68
SCIP_DECL_PROPINIT((*propinit))
SCIP_PROPTIMING timingmask
Definition: struct_prop.h:64
SCIP_Longint nrespropcalls
Definition: struct_prop.h:40
SCIP_PRESOLTIMING presoltiming
Definition: struct_prop.h:65
SCIP_Bool delay
Definition: struct_prop.h:89
SCIP_DECL_PROPPRESOL((*proppresol))
int lastnaggrvars
Definition: struct_prop.h:69
int lastnchgcoefs
Definition: struct_prop.h:76
SCIP_DECL_PROPCOPY((*propcopy))
int lastnaddconss
Definition: struct_prop.h:74
SCIP_CLOCK * resproptime
Definition: struct_prop.h:60
int nchgvartypes
Definition: struct_prop.h:80
SCIP_DECL_PROPFREE((*propfree))
unsigned int SCIP_PRESOLTIMING
Definition: type_timing.h:52
SCIP_CLOCK * setuptime
Definition: struct_prop.h:57
int nchgsides
Definition: struct_prop.h:87
SCIP_DECL_PROPEXIT((*propexit))
#define SCIP_Bool
Definition: def.h:70
SCIP_DECL_PROPINITPRE((*propinitpre))
SCIP_Longint ndomredsfound
Definition: struct_prop.h:42
SCIP_CLOCK * sbproptime
Definition: struct_prop.h:59
int nchgcoefs
Definition: struct_prop.h:86
type definitions for clocks and timing issues
int priority
Definition: struct_prop.h:62
type definitions for propagators
int lastnchgbds
Definition: struct_prop.h:71
unsigned int SCIP_PROPTIMING
Definition: type_timing.h:66
SCIP_PROPDATA * propdata
Definition: struct_prop.h:56
SCIP_Bool wasdelayed
Definition: struct_prop.h:90
int lastnchgvartypes
Definition: struct_prop.h:70
struct SCIP_PropData SCIP_PROPDATA
Definition: type_prop.h:43
SCIP_DECL_PROPEXITSOL((*propexitsol))
#define SCIP_Longint
Definition: def.h:148
int lastnchgsides
Definition: struct_prop.h:77
SCIP_Bool initialized
Definition: struct_prop.h:91
int naddconss
Definition: struct_prop.h:84
int presolpriority
Definition: struct_prop.h:66
int naggrvars
Definition: struct_prop.h:79
common defines and data types used in all packages of SCIP
int lastnupgdconss
Definition: struct_prop.h:75