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