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