Scippy

SCIP

Solving Constraint Integer Programs

pub_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-2019 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 scip.zib.de. */
13 /* */
14 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
15 
16 /**@file pub_disp.h
17  * @ingroup PUBLICCOREAPI
18  * @brief public 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_PUB_DISP_H__
25 #define __SCIP_PUB_DISP_H__
26 
27 
28 #include <stdio.h>
29 
30 #include "scip/def.h"
31 #include "scip/type_retcode.h"
32 #include "scip/type_disp.h"
33 
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37 
38 /**@addtogroup PublicDisplayMethods
39  *
40  * @{
41  */
42 
43 /** gets user data of display column */
44 extern
46  SCIP_DISP* disp /**< display column */
47  );
48 
49 /** sets user data of display column; user has to free old data in advance! */
50 extern
51 void SCIPdispSetData(
52  SCIP_DISP* disp, /**< display column */
53  SCIP_DISPDATA* dispdata /**< new display column user data */
54  );
55 
56 /** gets name of display column */
57 extern
58 const char* SCIPdispGetName(
59  SCIP_DISP* disp /**< display column */
60  );
61 
62 /** gets description of display column */
63 extern
64 const char* SCIPdispGetDesc(
65  SCIP_DISP* disp /**< display column */
66  );
67 
68 /** gets head line of display column */
69 extern
70 const char* SCIPdispGetHeader(
71  SCIP_DISP* disp /**< display column */
72  );
73 
74 /** gets width of display column */
75 extern
77  SCIP_DISP* disp /**< display column */
78  );
79 
80 /** gets priority of display column */
81 extern
83  SCIP_DISP* disp /**< display column */
84  );
85 
86 /** gets position of display column */
87 extern
89  SCIP_DISP* disp /**< display column */
90  );
91 
92 /** gets status of display column */
93 extern
95  SCIP_DISP* disp /**< display column */
96  );
97 
98 /** is display column initialized? */
99 extern
101  SCIP_DISP* disp /**< display column */
102  );
103 
104 /** displays a long integer in decimal form fitting in a given width */
105 extern
106 void SCIPdispLongint(
107  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
108  FILE* file, /**< output stream */
109  SCIP_Longint val, /**< value to display */
110  int width /**< width to fit into */
111  );
112 
113 /** displays an integer in decimal form fitting in a given width */
114 extern
115 void SCIPdispInt(
116  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
117  FILE* file, /**< output stream */
118  int val, /**< value to display */
119  int width /**< width to fit into */
120  );
121 
122 /** displays a time value fitting in a given width */
123 extern
124 void SCIPdispTime(
125  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
126  FILE* file, /**< output stream */
127  SCIP_Real val, /**< value in seconds to display */
128  int width /**< width to fit into */
129  );
130 
131 /* @} */
132 
133 #ifdef __cplusplus
134 }
135 #endif
136 
137 #endif
struct SCIP_DispData SCIP_DISPDATA
Definition: type_disp.h:62
SCIP_DISPSTATUS SCIPdispGetStatus(SCIP_DISP *disp)
Definition: disp.c:385
void SCIPdispLongint(SCIP_MESSAGEHDLR *messagehdlr, FILE *file, SCIP_Longint val, int width)
Definition: disp.c:571
int SCIPdispGetWidth(SCIP_DISP *disp)
Definition: disp.c:355
int SCIPdispGetPriority(SCIP_DISP *disp)
Definition: disp.c:365
const char * SCIPdispGetDesc(SCIP_DISP *disp)
Definition: disp.c:335
type definitions for return codes for SCIP methods
void SCIPdispInt(SCIP_MESSAGEHDLR *messagehdlr, FILE *file, int val, int width)
Definition: disp.c:617
SCIP_Bool SCIPdispIsInitialized(SCIP_DISP *disp)
Definition: disp.c:395
const char * SCIPdispGetHeader(SCIP_DISP *disp)
Definition: disp.c:345
void SCIPdispTime(SCIP_MESSAGEHDLR *messagehdlr, FILE *file, SCIP_Real val, int width)
Definition: disp.c:634
int SCIPdispGetPosition(SCIP_DISP *disp)
Definition: disp.c:375
#define SCIP_Bool
Definition: def.h:69
void SCIPdispSetData(SCIP_DISP *disp, SCIP_DISPDATA *dispdata)
Definition: disp.c:314
enum SCIP_DispStatus SCIP_DISPSTATUS
Definition: type_disp.h:50
#define SCIP_Real
Definition: def.h:157
#define SCIP_Longint
Definition: def.h:142
SCIP_DISPDATA * SCIPdispGetData(SCIP_DISP *disp)
Definition: disp.c:304
common defines and data types used in all packages of SCIP
const char * SCIPdispGetName(SCIP_DISP *disp)
Definition: disp.c:325
type definitions for displaying runtime statistics