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   type_timing.h
17  * @brief  timing definitions for SCIP
18  * @author Timo Berthold
19  * @author Matthias Miltenberger
20  * @author Michael Winkler
21  */
22 
23 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
24 
25 #ifndef __SCIP_TYPE_TIMING_H__
26 #define __SCIP_TYPE_TIMING_H__
27 
28 #include "scip/def.h"
29 #include "scip/type_result.h"
30 #include "scip/type_scip.h"
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
36 
37 /** presolving execution timing flags
38  *
39  *  @note: in contrast to other timings, these timings need to start from 0x0002u in order to avoid confusion with
40  *         the now obsolete '(presol)delay' boolean flag used until SCIP version 3.1.1
41  */
42 #define SCIP_PRESOLTIMING_NONE            0x002u  /**< presolving disabled */
43 #define SCIP_PRESOLTIMING_FAST            0x004u  /**< timing for fast presolving methods */
44 #define SCIP_PRESOLTIMING_MEDIUM          0x008u  /**< timing for more expensive presolving methods */
45 #define SCIP_PRESOLTIMING_EXHAUSTIVE      0x010u  /**< timing for most expensive presolving methods */
46 #define SCIP_PRESOLTIMING_FINAL           0x020u  /**< timing for final presolving methods */
47 
48 /** call presolver in every timing */
49 #define SCIP_PRESOLTIMING_ALWAYS (SCIP_PRESOLTIMING_FAST | SCIP_PRESOLTIMING_MEDIUM | SCIP_PRESOLTIMING_EXHAUSTIVE )
50 #define SCIP_PRESOLTIMING_MAX    (SCIP_PRESOLTIMING_FAST | SCIP_PRESOLTIMING_MEDIUM | SCIP_PRESOLTIMING_EXHAUSTIVE | SCIP_PRESOLTIMING_FINAL)
51 
52 typedef unsigned int SCIP_PRESOLTIMING;
53 
54 
55 /** propagation execution timing flags */
56 #define SCIP_PROPTIMING_BEFORELP          0x001u  /**< call propagator before LP is solved */
57 #define SCIP_PROPTIMING_DURINGLPLOOP      0x002u  /**< call propagator after each LP solving during cut-and-price loop */
58 #define SCIP_PROPTIMING_AFTERLPLOOP       0x004u  /**< call propagator after the cut-and-price loop was finished */
59 #define SCIP_PROPTIMING_AFTERLPNODE       0x008u  /**< call propagator after the processing of a node with solved LP was
60                                                    *   finished */
61 
62 /** call propagator regardless of current status */
63 #define SCIP_PROPTIMING_ALWAYS (SCIP_PROPTIMING_BEFORELP | SCIP_PROPTIMING_DURINGLPLOOP | SCIP_PROPTIMING_AFTERLPLOOP | SCIP_PROPTIMING_AFTERLPNODE )
64 
65 typedef unsigned int SCIP_PROPTIMING;
66 
67 
68 /** heuristics execution timing flags */
69 #define SCIP_HEURTIMING_BEFORENODE        0x001u  /**< call heuristic before the processing of the node starts */
70 #define SCIP_HEURTIMING_DURINGLPLOOP      0x002u  /**< call heuristic after each LP solving during cut-and-price loop */
71 #define SCIP_HEURTIMING_AFTERLPLOOP       0x004u  /**< call heuristic after the cut-and-price loop was finished */
72 #define SCIP_HEURTIMING_AFTERLPNODE       0x008u  /**< call heuristic after the processing of a node with solved LP was
73                                                    *   finished */
74 #define SCIP_HEURTIMING_AFTERPSEUDONODE   0x010u  /**< call heuristic after the processing of a node without solved LP was
75                                                    *   finished */
76 #define SCIP_HEURTIMING_AFTERLPPLUNGE     0x020u  /**< call heuristic after the processing of the last node in the current
77                                                    *   plunge was finished, and only if the LP was solved for this node */
78 #define SCIP_HEURTIMING_AFTERPSEUDOPLUNGE 0x040u  /**< call heuristic after the processing of the last node in the current
79                                                    *   plunge was finished, and only if the LP was not solved for this node */
80 #define SCIP_HEURTIMING_DURINGPRICINGLOOP 0x080u  /**< call heuristic during pricing loop */
81 #define SCIP_HEURTIMING_BEFOREPRESOL      0x100u  /**< call heuristic before presolving */
82 #define SCIP_HEURTIMING_DURINGPRESOLLOOP  0x200u  /**< call heuristic during presolving loop */
83 #define SCIP_HEURTIMING_AFTERPROPLOOP     0x400u  /**< call heuristic after propagation which is performed before solving the LP */
84 /* it turned out that a heuristic timing DURINGPROPLOOP causes severe troubles with the resolving of propagations */
85 
86 /** call heuristic after the processing of a node was finished */
87 #define SCIP_HEURTIMING_AFTERNODE (SCIP_HEURTIMING_AFTERLPNODE | SCIP_HEURTIMING_AFTERPSEUDONODE)
88 
89 /** call heuristic after the processing of the last node in the current plunge was finished */
90 #define SCIP_HEURTIMING_AFTERPLUNGE (SCIP_HEURTIMING_AFTERLPPLUNGE | SCIP_HEURTIMING_AFTERPSEUDOPLUNGE)
91 
92 typedef unsigned int SCIP_HEURTIMING;
93 
94 #ifdef __cplusplus
95 }
96 #endif
97 
98 #endif
99