Scippy

SCIP

Solving Constraint Integer Programs

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 disp.h
17  * @brief internal methods for displaying runtime statistics
18  * @author Tobias Achterberg
19  */
20 
21 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
22 
23 #ifndef __SCIP_DISP_H__
24 #define __SCIP_DISP_H__
25 
26 
27 #include <stdio.h>
28 
29 #include "scip/def.h"
30 #include "blockmemshell/memory.h"
31 #include "scip/type_retcode.h"
32 #include "scip/type_set.h"
33 #include "scip/type_stat.h"
34 #include "scip/type_disp.h"
35 #include "scip/type_paramset.h"
36 #include "scip/pub_disp.h"
37 
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41 
42 /** parameter change information method to autoselect display columns again */
43 extern
44 SCIP_DECL_PARAMCHGD(SCIPparamChgdDispActive);
45 
46 /** copies the given display to a new scip */
47 extern
48 SCIP_RETCODE SCIPdispCopyInclude(
49  SCIP_DISP* disp, /**< display column */
50  SCIP_SET* set /**< SCIP_SET of SCIP to copy to */
51  );
52 
53 /** creates a display column */
54 extern
55 SCIP_RETCODE SCIPdispCreate(
56  SCIP_DISP** disp, /**< pointer to store display column */
57  SCIP_SET* set, /**< global SCIP settings */
58  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
59  BMS_BLKMEM* blkmem, /**< block memory for parameter settings */
60  const char* name, /**< name of display column */
61  const char* desc, /**< description of display column */
62  const char* header, /**< head line of display column */
63  SCIP_DISPSTATUS dispstatus, /**< display activation status of display column */
64  SCIP_DECL_DISPCOPY ((*dispcopy)), /**< copy method of display column or NULL if you don't want to copy your plugin into sub-SCIPs */
65  SCIP_DECL_DISPFREE ((*dispfree)), /**< destructor of display column */
66  SCIP_DECL_DISPINIT ((*dispinit)), /**< initialize display column */
67  SCIP_DECL_DISPEXIT ((*dispexit)), /**< deinitialize display column */
68  SCIP_DECL_DISPINITSOL ((*dispinitsol)), /**< solving process initialization method of display column */
69  SCIP_DECL_DISPEXITSOL ((*dispexitsol)), /**< solving process deinitialization method of display column */
70  SCIP_DECL_DISPOUTPUT ((*dispoutput)), /**< output method */
71  SCIP_DISPDATA* dispdata, /**< display column data */
72  int width, /**< width of display column (no. of chars used) */
73  int priority, /**< priority of display column */
74  int position, /**< relative position of display column */
75  SCIP_Bool stripline /**< should the column be separated with a line from its right neighbor? */
76  );
77 
78 /** frees memory of display column */
79 extern
80 SCIP_RETCODE SCIPdispFree(
81  SCIP_DISP** disp, /**< pointer to display column data structure */
82  SCIP_SET* set /**< global SCIP settings */
83  );
84 
85 /** initializes display column */
86 extern
87 SCIP_RETCODE SCIPdispInit(
88  SCIP_DISP* disp, /**< display column */
89  SCIP_SET* set /**< global SCIP settings */
90  );
91 
92 /** deinitializes display column */
93 extern
94 SCIP_RETCODE SCIPdispExit(
95  SCIP_DISP* disp, /**< display column */
96  SCIP_SET* set /**< global SCIP settings */
97  );
98 
99 /** informs display column that the branch and bound process is being started */
100 extern
101 SCIP_RETCODE SCIPdispInitsol(
102  SCIP_DISP* disp, /**< display column */
103  SCIP_SET* set /**< global SCIP settings */
104  );
105 
106 /** informs display column that the branch and bound process data is being freed */
107 extern
108 SCIP_RETCODE SCIPdispExitsol(
109  SCIP_DISP* disp, /**< display column */
110  SCIP_SET* set /**< global SCIP settings */
111  );
112 
113 /** output display column to screen */
114 extern
115 SCIP_RETCODE SCIPdispOutput(
116  SCIP_DISP* disp, /**< display column */
117  SCIP_SET* set, /**< global SCIP settings */
118  FILE* file /**< output file (or NULL for standard output) */
119  );
120 
121 /** prints one line of output with the active display columns */
122 extern
123 SCIP_RETCODE SCIPdispPrintLine(
124  SCIP_SET* set, /**< global SCIP settings */
125  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
126  SCIP_STAT* stat, /**< problem statistics data */
127  FILE* file, /**< output file (or NULL for standard output) */
128  SCIP_Bool forcedisplay, /**< should the line be printed without regarding frequency? */
129  SCIP_Bool endline /**< should the line be terminated with a newline symbol? */
130  );
131 
132 /** activates all display lines fitting in the display w.r. to priority */
133 extern
134 SCIP_RETCODE SCIPdispAutoActivate(
135  SCIP_SET* set /**< global SCIP settings */
136  );
137 
138 #ifdef __cplusplus
139 }
140 #endif
141 
142 #endif
143