Scippy

SCIP

Solving Constraint Integer Programs

event_estim.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 event_estim.h
26  * @ingroup EVENTS
27  * @brief event handler for tree size estimation and restarts
28  *
29  * This event handler plugin provides different methods for approximating the current fraction of the search
30  * that has already been completed and for estimating the total tree size at completion.
31  * It can trigger restarts of the current run if the current run seems hopeless.
32  *
33  * For details about the available approximations of search completion, please see
34  *
35  * Anderson, Hendel, Le Bodic, Pfetsch
36  * Estimating The Size of Branch-and-Bound Trees
37  * under preparation
38  *
39  * This code is a largely enriched version of a code that was used for clairvoyant restarts, see
40  *
41  * Anderson, Hendel, Le Bodic, Viernickel
42  * Clairvoyant Restarts in Branch-and-Bound Search Using Online Tree-Size Estimation
43  * AAAI-19: Proceedings of the Thirty-Third AAAI Conference on Artificial Intelligence, 2018
44  *
45  * @author Gregor Hendel
46  */
47 
48 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
49 
50 #ifndef __SCIP_EVENT_ESTIM_H__
51 #define __SCIP_EVENT_ESTIM_H__
52 
53 
54 #include "scip/type_scip.h"
55 #include "scip/def.h"
56 
57 #ifdef __cplusplus
58 extern "C" {
59 #endif
60 
61 /** creates event handler for tree size estimation */
62 SCIP_EXPORT
64  SCIP* scip /**< SCIP data structure */
65  );
66 
67 /* return an estimation of the final tree size */
68 SCIP_EXPORT
70  SCIP* scip /**< SCIP data structure */
71  );
72 
73 #ifdef __cplusplus
74 }
75 #endif
76 
77 #endif
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:63
type definitions for SCIP&#39;s main datastructure
SCIP_Real SCIPgetTreesizeEstimation(SCIP *scip)
Definition: event_estim.c:3021
SCIP_RETCODE SCIPincludeEventHdlrEstim(SCIP *scip)
Definition: event_estim.c:2893
#define SCIP_Real
Definition: def.h:186
common defines and data types used in all packages of SCIP