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-2023 Zuse Institute Berlin (ZIB) */
7 /* */
8 /* Licensed under the Apache License, Version 2.0 (the "License"); */
9 /* you may not use this file except in compliance with the License. */
10 /* You may obtain a copy of the License at */
11 /* */
12 /* http://www.apache.org/licenses/LICENSE-2.0 */
13 /* */
14 /* Unless required by applicable law or agreed to in writing, software */
15 /* distributed under the License is distributed on an "AS IS" BASIS, */
16 /* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */
17 /* See the License for the specific language governing permissions and */
18 /* limitations under the License. */
19 /* */
20 /* You should have received a copy of the Apache-2.0 license */
21 /* along with SCIP; see the file LICENSE. If not visit scipopt.org. */
22 /* */
23 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
24 
25 /**@file pub_disp.h
26  * @ingroup PUBLICCOREAPI
27  * @brief public methods for displaying runtime statistics
28  * @author Tobias Achterberg
29  */
30 
31 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
32 
33 #ifndef __SCIP_PUB_DISP_H__
34 #define __SCIP_PUB_DISP_H__
35 
36 
37 #include <stdio.h>
38 
39 #include "scip/def.h"
40 #include "scip/type_retcode.h"
41 #include "scip/type_disp.h"
42 
43 #ifdef __cplusplus
44 extern "C" {
45 #endif
46 
47 /**@addtogroup PublicDisplayMethods
48  *
49  * @{
50  */
51 
52 /** gets user data of display column */
53 SCIP_EXPORT
55  SCIP_DISP* disp /**< display column */
56  );
57 
58 /** sets user data of display column; user has to free old data in advance! */
59 SCIP_EXPORT
60 void SCIPdispSetData(
61  SCIP_DISP* disp, /**< display column */
62  SCIP_DISPDATA* dispdata /**< new display column user data */
63  );
64 
65 /** gets name of display column */
66 SCIP_EXPORT
67 const char* SCIPdispGetName(
68  SCIP_DISP* disp /**< display column */
69  );
70 
71 /** gets description of display column */
72 SCIP_EXPORT
73 const char* SCIPdispGetDesc(
74  SCIP_DISP* disp /**< display column */
75  );
76 
77 /** gets head line of display column */
78 SCIP_EXPORT
79 const char* SCIPdispGetHeader(
80  SCIP_DISP* disp /**< display column */
81  );
82 
83 /** gets width of display column */
84 SCIP_EXPORT
86  SCIP_DISP* disp /**< display column */
87  );
88 
89 /** gets priority of display column */
90 SCIP_EXPORT
92  SCIP_DISP* disp /**< display column */
93  );
94 
95 /** gets position of display column */
96 SCIP_EXPORT
98  SCIP_DISP* disp /**< display column */
99  );
100 
101 /** gets status of display column */
102 SCIP_EXPORT
104  SCIP_DISP* disp /**< display column */
105  );
106 
107 /** is display column initialized? */
108 SCIP_EXPORT
110  SCIP_DISP* disp /**< display column */
111  );
112 
113 /** displays a long integer in decimal form fitting in a given width */
114 SCIP_EXPORT
115 void SCIPdispLongint(
116  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
117  FILE* file, /**< output stream */
118  SCIP_Longint val, /**< value to display */
119  int width /**< width to fit into */
120  );
121 
122 /** displays an integer in decimal form fitting in a given width */
123 SCIP_EXPORT
124 void SCIPdispInt(
125  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
126  FILE* file, /**< output stream */
127  int val, /**< value to display */
128  int width /**< width to fit into */
129  );
130 
131 /** displays a time value fitting in a given width */
132 SCIP_EXPORT
133 void SCIPdispTime(
134  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
135  FILE* file, /**< output stream */
136  SCIP_Real val, /**< value in seconds to display */
137  int width /**< width to fit into */
138  );
139 
140 /** @} */
141 
142 #ifdef __cplusplus
143 }
144 #endif
145 
146 #endif
struct SCIP_DispData SCIP_DISPDATA
Definition: type_disp.h:76
SCIP_DISPSTATUS SCIPdispGetStatus(SCIP_DISP *disp)
Definition: disp.c:395
void SCIPdispLongint(SCIP_MESSAGEHDLR *messagehdlr, FILE *file, SCIP_Longint val, int width)
Definition: disp.c:581
int SCIPdispGetWidth(SCIP_DISP *disp)
Definition: disp.c:365
int SCIPdispGetPriority(SCIP_DISP *disp)
Definition: disp.c:375
const char * SCIPdispGetDesc(SCIP_DISP *disp)
Definition: disp.c:345
type definitions for return codes for SCIP methods
void SCIPdispInt(SCIP_MESSAGEHDLR *messagehdlr, FILE *file, int val, int width)
Definition: disp.c:627
SCIP_Bool SCIPdispIsInitialized(SCIP_DISP *disp)
Definition: disp.c:405
const char * SCIPdispGetHeader(SCIP_DISP *disp)
Definition: disp.c:355
void SCIPdispTime(SCIP_MESSAGEHDLR *messagehdlr, FILE *file, SCIP_Real val, int width)
Definition: disp.c:643
int SCIPdispGetPosition(SCIP_DISP *disp)
Definition: disp.c:385
#define SCIP_Bool
Definition: def.h:93
void SCIPdispSetData(SCIP_DISP *disp, SCIP_DISPDATA *dispdata)
Definition: disp.c:324
enum SCIP_DispStatus SCIP_DISPSTATUS
Definition: type_disp.h:64
#define SCIP_Real
Definition: def.h:186
#define SCIP_Longint
Definition: def.h:171
SCIP_DISPDATA * SCIPdispGetData(SCIP_DISP *disp)
Definition: disp.c:314
common defines and data types used in all packages of SCIP
const char * SCIPdispGetName(SCIP_DISP *disp)
Definition: disp.c:335
type definitions for displaying runtime statistics