Scippy

SCIP

Solving Constraint Integer Programs

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