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-2016 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 pub_disp.h
17  * @ingroup PUBLICMETHODS
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 /** gets user data of display column */
39 extern
41  SCIP_DISP* disp /**< display column */
42  );
43 
44 /** sets user data of display column; user has to free old data in advance! */
45 extern
46 void SCIPdispSetData(
47  SCIP_DISP* disp, /**< display column */
48  SCIP_DISPDATA* dispdata /**< new display column user data */
49  );
50 
51 /** gets name of display column */
52 extern
53 const char* SCIPdispGetName(
54  SCIP_DISP* disp /**< display column */
55  );
56 
57 /** gets description of display column */
58 extern
59 const char* SCIPdispGetDesc(
60  SCIP_DISP* disp /**< display column */
61  );
62 
63 /** gets head line of display column */
64 extern
65 const char* SCIPdispGetHeader(
66  SCIP_DISP* disp /**< display column */
67  );
68 
69 /** gets width of display column */
70 extern
72  SCIP_DISP* disp /**< display column */
73  );
74 
75 /** gets priority of display column */
76 extern
78  SCIP_DISP* disp /**< display column */
79  );
80 
81 /** gets position of display column */
82 extern
84  SCIP_DISP* disp /**< display column */
85  );
86 
87 /** gets status of display column */
88 extern
90  SCIP_DISP* disp /**< display column */
91  );
92 
93 /** is display column initialized? */
94 extern
96  SCIP_DISP* disp /**< display column */
97  );
98 
99 /** displays a long integer in decimal form fitting in a given width */
100 extern
101 void SCIPdispLongint(
102  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
103  FILE* file, /**< output stream */
104  SCIP_Longint val, /**< value to display */
105  int width /**< width to fit into */
106  );
107 
108 /** displays an integer in decimal form fitting in a given width */
109 extern
110 void SCIPdispInt(
111  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
112  FILE* file, /**< output stream */
113  int val, /**< value to display */
114  int width /**< width to fit into */
115  );
116 
117 /** displays a time value fitting in a given width */
118 extern
119 void SCIPdispTime(
120  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
121  FILE* file, /**< output stream */
122  SCIP_Real val, /**< value in seconds to display */
123  int width /**< width to fit into */
124  );
125 
126 #ifdef __cplusplus
127 }
128 #endif
129 
130 #endif
struct SCIP_DispData SCIP_DISPDATA
Definition: type_disp.h:53
SCIP_DISPSTATUS SCIPdispGetStatus(SCIP_DISP *disp)
Definition: disp.c:342
void SCIPdispSetData(SCIP_DISP *disp, SCIP_DISPDATA *dispdata)
Definition: disp.c:271
SCIP_DISPDATA * SCIPdispGetData(SCIP_DISP *disp)
Definition: disp.c:261
const char * SCIPdispGetHeader(SCIP_DISP *disp)
Definition: disp.c:302
type definitions for return codes for SCIP methods
void SCIPdispLongint(SCIP_MESSAGEHDLR *messagehdlr, FILE *file, SCIP_Longint val, int width)
Definition: disp.c:509
int SCIPdispGetWidth(SCIP_DISP *disp)
Definition: disp.c:312
void SCIPdispInt(SCIP_MESSAGEHDLR *messagehdlr, FILE *file, int val, int width)
Definition: disp.c:555
const char * SCIPdispGetDesc(SCIP_DISP *disp)
Definition: disp.c:292
#define SCIP_Bool
Definition: def.h:53
int SCIPdispGetPosition(SCIP_DISP *disp)
Definition: disp.c:332
SCIP_Bool SCIPdispIsInitialized(SCIP_DISP *disp)
Definition: disp.c:352
int SCIPdispGetPriority(SCIP_DISP *disp)
Definition: disp.c:322
const char * SCIPdispGetName(SCIP_DISP *disp)
Definition: disp.c:282
enum SCIP_DispStatus SCIP_DISPSTATUS
Definition: type_disp.h:50
#define SCIP_Real
Definition: def.h:127
#define SCIP_Longint
Definition: def.h:112
common defines and data types used in all packages of SCIP
void SCIPdispTime(SCIP_MESSAGEHDLR *messagehdlr, FILE *file, SCIP_Real val, int width)
Definition: disp.c:572
type definitions for displaying runtime statistics