Scippy

SCIP

Solving Constraint Integer Programs

struct_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 struct_disp.h
26  * @ingroup INTERNALAPI
27  * @brief data structures 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_STRUCT_DISP_H__
34 #define __SCIP_STRUCT_DISP_H__
35 
36 
37 #include "scip/def.h"
38 #include "scip/type_disp.h"
39 
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43 
44 /** display column */
45 struct SCIP_Disp
46 {
47  char* name; /**< name of display column */
48  char* desc; /**< description of display column */
49  char* header; /**< head line of display column */
50  SCIP_DECL_DISPCOPY ((*dispcopy)); /**< copy method of display column or NULL if you don't want to copy your plugin into sub-SCIPs */
51  SCIP_DECL_DISPFREE ((*dispfree)); /**< destructor of display column */
52  SCIP_DECL_DISPINIT ((*dispinit)); /**< initialize display column */
53  SCIP_DECL_DISPEXIT ((*dispexit)); /**< deinitialize display column */
54  SCIP_DECL_DISPINITSOL ((*dispinitsol)); /**< solving process initialization method of display column */
55  SCIP_DECL_DISPEXITSOL ((*dispexitsol)); /**< solving process deinitialization method of display column */
56  SCIP_DECL_DISPOUTPUT ((*dispoutput)); /**< output method */
57  SCIP_DISPDATA* dispdata; /**< display column data */
58  int width; /**< width of display column (no. of chars used) */
59  int priority; /**< priority of display column */
60  int position; /**< relative position of display column */
61  SCIP_DISPSTATUS dispstatus; /**< display activation status of display column */
62  SCIP_Bool stripline; /**< should the column be separated with a line from its right neighbor? */
63  SCIP_Bool initialized; /**< is display column initialized? */
64  SCIP_Bool active; /**< should column be displayed to the screen? */
65  SCIP_DISPMODE mode; /**< mode in which the display column is activated */
66 };
67 
68 #ifdef __cplusplus
69 }
70 #endif
71 
72 #endif
char * name
Definition: struct_disp.h:47
SCIP_DECL_DISPINITSOL((*dispinitsol))
SCIP_Bool initialized
Definition: struct_disp.h:63
struct SCIP_DispData SCIP_DISPDATA
Definition: type_disp.h:76
SCIP_DECL_DISPEXIT((*dispexit))
char * header
Definition: struct_disp.h:49
enum SCIP_DispMode SCIP_DISPMODE
Definition: type_disp.h:73
int position
Definition: struct_disp.h:60
char * desc
Definition: struct_disp.h:48
SCIP_DISPMODE mode
Definition: struct_disp.h:65
int priority
Definition: struct_disp.h:59
SCIP_Bool active
Definition: struct_disp.h:64
#define SCIP_Bool
Definition: def.h:93
SCIP_DECL_DISPFREE((*dispfree))
SCIP_Bool stripline
Definition: struct_disp.h:62
SCIP_DISPDATA * dispdata
Definition: struct_disp.h:57
SCIP_DECL_DISPOUTPUT((*dispoutput))
SCIP_DECL_DISPEXITSOL((*dispexitsol))
SCIP_DECL_DISPINIT((*dispinit))
SCIP_DISPSTATUS dispstatus
Definition: struct_disp.h:61
enum SCIP_DispStatus SCIP_DISPSTATUS
Definition: type_disp.h:64
SCIP_DECL_DISPCOPY((*dispcopy))
common defines and data types used in all packages of SCIP
type definitions for displaying runtime statistics