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-2018 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 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 Robert Lion 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 /* In debug mode, we include the SCIP's structure in scip.c, such that no one can access
41  * this structure except the interface methods in scip.c.
42  * In optimized mode, the structure is included in scip.h, because some of the methods
43  * are implemented as defines for performance reasons (e.g. the numerical comparisons).
44  * Additionally, the internal "set.h" is included, such that the defines in set.h are
45  * available in optimized mode.
46  */
47 #ifdef NDEBUG
48 #include "scip/struct_scip.h"
49 #include "scip/struct_stat.h"
50 #include "scip/set.h"
51 #include "scip/tree.h"
52 #include "scip/misc.h"
53 #include "scip/var.h"
54 #include "scip/cons.h"
55 #include "scip/solve.h"
56 #include "scip/debug.h"
57 #endif
58 
59 #ifdef __cplusplus
60 extern "C" {
61 #endif
62 
63 /**@addtogroup PublicDisplayMethods
64  *
65  * @{
66  */
67 
68 /** creates a display column and includes it in SCIP */
69 extern
71  SCIP* scip, /**< SCIP data structure */
72  const char* name, /**< name of display column */
73  const char* desc, /**< description of display column */
74  const char* header, /**< head line of display column */
75  SCIP_DISPSTATUS dispstatus, /**< display activation status of display column */
76  SCIP_DECL_DISPCOPY ((*dispcopy)), /**< copy method of display column or NULL if you don't want to copy your plugin into sub-SCIPs */
77  SCIP_DECL_DISPFREE ((*dispfree)), /**< destructor of display column */
78  SCIP_DECL_DISPINIT ((*dispinit)), /**< initialize display column */
79  SCIP_DECL_DISPEXIT ((*dispexit)), /**< deinitialize display column */
80  SCIP_DECL_DISPINITSOL ((*dispinitsol)), /**< solving process initialization method of display column */
81  SCIP_DECL_DISPEXITSOL ((*dispexitsol)), /**< solving process deinitialization method of display column */
82  SCIP_DECL_DISPOUTPUT ((*dispoutput)), /**< output method */
83  SCIP_DISPDATA* dispdata, /**< display column data */
84  int width, /**< width of display column (no. of chars used) */
85  int priority, /**< priority of display column */
86  int position, /**< relative position of display column */
87  SCIP_Bool stripline /**< should the column be separated with a line from its right neighbor? */
88  );
89 
90 /** returns the display column of the given name, or NULL if not existing */
91 extern
93  SCIP* scip, /**< SCIP data structure */
94  const char* name /**< name of display column */
95  );
96 
97 /** returns the array of currently available display columns */
98 extern
100  SCIP* scip /**< SCIP data structure */
101  );
102 
103 /** returns the number of currently available display columns */
104 extern
105 int SCIPgetNDisps(
106  SCIP* scip /**< SCIP data structure */
107  );
108 
109 /** automatically selects display columns for being shown w.r.t. the display width parameter */
110 extern
112  SCIP* scip /**< SCIP data structure */
113  );
114 
115 /** changes the display column mode */
116 extern
117 void SCIPchgDispMode(
118  SCIP_DISP* disp, /**< display column */
119  SCIP_DISPMODE mode /**< the display column mode */
120  );
121 
122 /* @} */
123 
124 #ifdef __cplusplus
125 }
126 #endif
127 
128 #endif
#define SCIP_DECL_DISPINITSOL(x)
Definition: type_disp.h:106
struct SCIP_DispData SCIP_DISPDATA
Definition: type_disp.h:62
internal methods for branch and bound tree
enum SCIP_DispMode SCIP_DISPMODE
Definition: type_disp.h:59
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:53
type definitions for return codes for SCIP methods
#define SCIP_DECL_DISPCOPY(x)
Definition: type_disp.h:71
SCIP_DISP * SCIPfindDisp(SCIP *scip, const char *name)
Definition: scip_disp.c:167
#define SCIP_DECL_DISPINIT(x)
Definition: type_disp.h:87
type definitions for SCIP&#39;s main datastructure
int SCIPgetNDisps(SCIP *scip)
Definition: scip_disp.c:191
internal miscellaneous methods
internal methods for global SCIP settings
SCIP main data structure.
internal methods for problem variables
#define SCIP_Bool
Definition: def.h:62
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:125
#define SCIP_DECL_DISPFREE(x)
Definition: type_disp.h:79
SCIP_RETCODE SCIPautoselectDisps(SCIP *scip)
Definition: scip_disp.c:202
methods for debugging
datastructures for problem statistics
void SCIPchgDispMode(SCIP_DISP *disp, SCIP_DISPMODE mode)
Definition: scip_disp.c:215
#define SCIP_DECL_DISPEXITSOL(x)
Definition: type_disp.h:117
internal methods for main solving loop and node processing
#define SCIP_DECL_DISPEXIT(x)
Definition: type_disp.h:95
enum SCIP_DispStatus SCIP_DISPSTATUS
Definition: type_disp.h:50
internal methods for constraints and constraint handlers
SCIP_DISP ** SCIPgetDisps(SCIP *scip)
Definition: scip_disp.c:180
common defines and data types used in all packages of SCIP
#define SCIP_DECL_DISPOUTPUT(x)
Definition: type_disp.h:126
type definitions for displaying runtime statistics