Scippy

SCIP

Solving Constraint Integer Programs

scip_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 scip_disp.h
17  * @ingroup PUBLICCOREAPI
18  * @brief public methods for display handler plugins
19  * @author Tobias Achterberg
20  * @author Timo Berthold
21  * @author Thorsten Koch
22  * @author Alexander Martin
23  * @author Marc Pfetsch
24  * @author Kati Wolter
25  * @author Gregor Hendel
26  * @author Leona Gottwald
27  */
28 
29 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
30 
31 #ifndef __SCIP_SCIP_DISP_H__
32 #define __SCIP_SCIP_DISP_H__
33 
34 
35 #include "scip/def.h"
36 #include "scip/type_disp.h"
37 #include "scip/type_retcode.h"
38 #include "scip/type_scip.h"
39 
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43 
44 /**@addtogroup PublicDisplayMethods
45  *
46  * @{
47  */
48 
49 /** creates a display column and includes it in SCIP */
50 SCIP_EXPORT
52  SCIP* scip, /**< SCIP data structure */
53  const char* name, /**< name of display column */
54  const char* desc, /**< description of display column */
55  const char* header, /**< head line of display column */
56  SCIP_DISPSTATUS dispstatus, /**< display activation status of display column */
57  SCIP_DECL_DISPCOPY ((*dispcopy)), /**< copy method of display column or NULL if you don't want to copy your plugin into sub-SCIPs */
58  SCIP_DECL_DISPFREE ((*dispfree)), /**< destructor of display column */
59  SCIP_DECL_DISPINIT ((*dispinit)), /**< initialize display column */
60  SCIP_DECL_DISPEXIT ((*dispexit)), /**< deinitialize display column */
61  SCIP_DECL_DISPINITSOL ((*dispinitsol)), /**< solving process initialization method of display column */
62  SCIP_DECL_DISPEXITSOL ((*dispexitsol)), /**< solving process deinitialization method of display column */
63  SCIP_DECL_DISPOUTPUT ((*dispoutput)), /**< output method */
64  SCIP_DISPDATA* dispdata, /**< display column data */
65  int width, /**< width of display column (no. of chars used) */
66  int priority, /**< priority of display column */
67  int position, /**< relative position of display column */
68  SCIP_Bool stripline /**< should the column be separated with a line from its right neighbor? */
69  );
70 
71 /** returns the display column of the given name, or NULL if not existing */
72 SCIP_EXPORT
74  SCIP* scip, /**< SCIP data structure */
75  const char* name /**< name of display column */
76  );
77 
78 /** returns the array of currently available display columns */
79 SCIP_EXPORT
81  SCIP* scip /**< SCIP data structure */
82  );
83 
84 /** returns the number of currently available display columns */
85 SCIP_EXPORT
86 int SCIPgetNDisps(
87  SCIP* scip /**< SCIP data structure */
88  );
89 
90 /** automatically selects display columns for being shown w.r.t. the display width parameter */
91 SCIP_EXPORT
93  SCIP* scip /**< SCIP data structure */
94  );
95 
96 /** changes the display column mode */
97 SCIP_EXPORT
98 void SCIPchgDispMode(
99  SCIP_DISP* disp, /**< display column */
100  SCIP_DISPMODE mode /**< the display column mode */
101  );
102 
103 /** @} */
104 
105 #ifdef __cplusplus
106 }
107 #endif
108 
109 #endif
#define SCIP_DECL_DISPINITSOL(x)
Definition: type_disp.h:111
struct SCIP_DispData SCIP_DISPDATA
Definition: type_disp.h:67
enum SCIP_DispMode SCIP_DISPMODE
Definition: type_disp.h:64
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:54
type definitions for return codes for SCIP methods
#define SCIP_DECL_DISPCOPY(x)
Definition: type_disp.h:76
SCIP_DISP * SCIPfindDisp(SCIP *scip, const char *name)
Definition: scip_disp.c:88
#define SCIP_DECL_DISPINIT(x)
Definition: type_disp.h:92
type definitions for SCIP&#39;s main datastructure
int SCIPgetNDisps(SCIP *scip)
Definition: scip_disp.c:112
#define SCIP_Bool
Definition: def.h:84
SCIP_RETCODE SCIPincludeDisp(SCIP *scip, 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: scip_disp.c:46
#define SCIP_DECL_DISPFREE(x)
Definition: type_disp.h:84
SCIP_RETCODE SCIPautoselectDisps(SCIP *scip)
Definition: scip_disp.c:123
void SCIPchgDispMode(SCIP_DISP *disp, SCIP_DISPMODE mode)
Definition: scip_disp.c:136
#define SCIP_DECL_DISPEXITSOL(x)
Definition: type_disp.h:122
#define SCIP_DECL_DISPEXIT(x)
Definition: type_disp.h:100
enum SCIP_DispStatus SCIP_DISPSTATUS
Definition: type_disp.h:55
SCIP_DISP ** SCIPgetDisps(SCIP *scip)
Definition: scip_disp.c:101
common defines and data types used in all packages of SCIP
#define SCIP_DECL_DISPOUTPUT(x)
Definition: type_disp.h:131
type definitions for displaying runtime statistics