Scippy

SCIP

Solving Constraint Integer Programs

type_disp.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-2014 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 email to scip@zib.de. */
13 /* */
14 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
15 
16 /**@file type_disp.h
17  * @ingroup TYPEDEFINITIONS
18  * @brief type definitions for displaying runtime statistics
19  * @author Tobias Achterberg
20  *
21  * This file defines the interface for display columns implemented in C.
22  *
23  * - \ref DISP "Instructions for implementing a display column"
24  * - \ref DISPLAYS "List of available display columns"
25  * - \ref scip::ObjDisp "C++ wrapper class
26  */
27 
28 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
29 
30 #ifndef __SCIP_TYPE_DISP_H__
31 #define __SCIP_TYPE_DISP_H__
32 
33 #include <stdio.h>
34 
35 #include "scip/def.h"
36 #include "scip/type_retcode.h"
37 #include "scip/type_scip.h"
38 
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42 
43 /** display activation status of display column */
45 {
46  SCIP_DISPSTATUS_OFF = 0, /**< display column is not displayed */
47  SCIP_DISPSTATUS_AUTO = 1, /**< display column is switched on and off automatically */
48  SCIP_DISPSTATUS_ON = 2 /**< display column is displayed */
49 };
51 
52 typedef struct SCIP_Disp SCIP_DISP; /**< display column data structure */
53 typedef struct SCIP_DispData SCIP_DISPDATA; /**< display column specific data */
54 
55 
56 /** copy method for display plugins (called when SCIP copies plugins)
57  *
58  * input:
59  * - scip : SCIP main data structure
60  * - disp : the display column itself
61  */
62 #define SCIP_DECL_DISPCOPY(x) SCIP_RETCODE x (SCIP* scip, SCIP_DISP* disp)
63 
64 /** destructor of display column to free user data (called when SCIP is exiting)
65  *
66  * input:
67  * - scip : SCIP main data structure
68  * - disp : the display column itself
69  */
70 #define SCIP_DECL_DISPFREE(x) SCIP_RETCODE x (SCIP* scip, SCIP_DISP* disp)
71 
72 /** initialization method of display column (called after problem was transformed)
73  *
74  * input:
75  * - scip : SCIP main data structure
76  * - disp : the display column itself
77  */
78 #define SCIP_DECL_DISPINIT(x) SCIP_RETCODE x (SCIP* scip, SCIP_DISP* disp)
79 
80 /** deinitialization method of display column (called before transformed problem is freed)
81  *
82  * input:
83  * - scip : SCIP main data structure
84  * - disp : the display column itself
85  */
86 #define SCIP_DECL_DISPEXIT(x) SCIP_RETCODE x (SCIP* scip, SCIP_DISP* disp)
87 
88 /** solving process initialization method of display column (called when branch and bound process is about to begin)
89  *
90  * This method is called when the presolving was finished and the branch and bound process is about to begin.
91  * The display column may use this call to initialize its branch and bound specific data.
92  *
93  * input:
94  * - scip : SCIP main data structure
95  * - disp : the display column itself
96  */
97 #define SCIP_DECL_DISPINITSOL(x) SCIP_RETCODE x (SCIP* scip, SCIP_DISP* disp)
98 
99 /** solving process deinitialization method of display column (called before branch and bound process data is freed)
100  *
101  * This method is called before the branch and bound process is freed.
102  * The display column should use this call to clean up its branch and bound data.
103  *
104  * input:
105  * - scip : SCIP main data structure
106  * - disp : the display column itself
107  */
108 #define SCIP_DECL_DISPEXITSOL(x) SCIP_RETCODE x (SCIP* scip, SCIP_DISP* disp)
109 
110 /** output method of display column to output file stream 'file'
111  *
112  * input:
113  * - scip : SCIP main data structure
114  * - disp : the display column itself
115  * - file : file stream for output
116  */
117 #define SCIP_DECL_DISPOUTPUT(x) SCIP_RETCODE x (SCIP* scip, SCIP_DISP* disp, FILE* file)
118 
119 #ifdef __cplusplus
120 }
121 #endif
122 
123 #endif
struct SCIP_DispData SCIP_DISPDATA
Definition: type_disp.h:53
SCIP_DispStatus
Definition: type_disp.h:44
struct SCIP_Disp SCIP_DISP
Definition: type_disp.h:52
type definitions for return codes for SCIP methods
type definitions for SCIP's main datastructure
enum SCIP_DispStatus SCIP_DISPSTATUS
Definition: type_disp.h:50
common defines and data types used in all packages of SCIP