Scippy

SCIP

Solving Constraint Integer Programs

struct_table.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_table.h
26  * @ingroup INTERNALAPI
27  * @brief data structures for displaying statistics tables
28  * @author Tristan Gally
29  */
30 
31 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
32 
33 #ifndef __SCIP_STRUCT_TABLE_H__
34 #define __SCIP_STRUCT_TABLE_H__
35 
36 
37 #include "scip/def.h"
38 #include "scip/type_table.h"
39 
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43 
44 /** statistics table */
45 struct SCIP_Table
46 {
47  char* name; /**< name of statistics table */
48  char* desc; /**< description of statistics table */
49  SCIP_DECL_TABLECOPY ((*tablecopy)); /**< copy method of statistics table or NULL if you don't want to copy your plugin into sub-SCIPs */
50  SCIP_DECL_TABLEFREE ((*tablefree)); /**< destructor of statistics table */
51  SCIP_DECL_TABLEINIT ((*tableinit)); /**< initialize statistics table */
52  SCIP_DECL_TABLEEXIT ((*tableexit)); /**< deinitialize statistics table */
53  SCIP_DECL_TABLEINITSOL ((*tableinitsol)); /**< solving process initialization method of statistics table */
54  SCIP_DECL_TABLEEXITSOL ((*tableexitsol)); /**< solving process deinitialization method of statistics table */
55  SCIP_DECL_TABLEOUTPUT ((*tableoutput)); /**< output method */
56  SCIP_TABLEDATA* tabledata; /**< statistics table data */
57  int position; /**< relative position of statistics table */
58  SCIP_STAGE earlieststage; /**< output of the statistics table is only printed from this stage onwards */
59  SCIP_Bool initialized; /**< is statistics table initialized? */
60  SCIP_Bool active; /**< should statistics table be displayed to the screen? */
61 };
62 
63 #ifdef __cplusplus
64 }
65 #endif
66 
67 #endif
char * name
Definition: struct_table.h:47
SCIP_Bool active
Definition: struct_table.h:60
SCIP_TABLEDATA * tabledata
Definition: struct_table.h:56
SCIP_DECL_TABLEOUTPUT((*tableoutput))
SCIP_DECL_TABLEINIT((*tableinit))
SCIP_STAGE earlieststage
Definition: struct_table.h:58
SCIP_DECL_TABLEINITSOL((*tableinitsol))
SCIP_DECL_TABLEEXITSOL((*tableexitsol))
char * desc
Definition: struct_table.h:48
SCIP_DECL_TABLEEXIT((*tableexit))
SCIP_DECL_TABLEFREE((*tablefree))
#define SCIP_Bool
Definition: def.h:93
enum SCIP_Stage SCIP_STAGE
Definition: type_set.h:59
SCIP_Bool initialized
Definition: struct_table.h:59
SCIP_DECL_TABLECOPY((*tablecopy))
common defines and data types used in all packages of SCIP
type definitions for displaying statistics tables
struct SCIP_TableData SCIP_TABLEDATA
Definition: type_table.h:58