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