Scippy

SCIP

Solving Constraint Integer Programs

type_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-2019 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 type_table.h
17  * @ingroup TYPEDEFINITIONS
18  * @brief type definitions for displaying statistics tables
19  * @author Tristan Gally
20  *
21  * This file defines the interface for statistics tables implemented in C.
22  *
23  * - \ref TABLE "Instructions for implementing a statistics table"
24  * - \ref TABLES "List of available statistics tables"
25  * - \ref scip::ObjTable "C++ wrapper class
26  */
27 
28 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
29 
30 #ifndef __SCIP_TYPE_TABLE_H__
31 #define __SCIP_TYPE_TABLE_H__
32 
33 #include <stdio.h>
34 
35 #include "scip/def.h"
36 #include "scip/type_retcode.h"
37 #include "scip/type_scip.h"
38 
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42 
43 typedef struct SCIP_Table SCIP_TABLE; /**< statistics table data structure */
44 typedef struct SCIP_TableData SCIP_TABLEDATA; /**< statistics table specific data */
45 
46 
47 /** copy method for statistics table plugins (called when SCIP copies plugins)
48  *
49  * input:
50  * - scip : SCIP main data structure
51  * - table : the statistics table itself
52  */
53 #define SCIP_DECL_TABLECOPY(x) SCIP_RETCODE x (SCIP* scip, SCIP_TABLE* table)
54 
55 /** destructor of statistics table to free user data (called when SCIP is exiting)
56  *
57  * input:
58  * - scip : SCIP main data structure
59  * - table : the statistics table itself
60  */
61 #define SCIP_DECL_TABLEFREE(x) SCIP_RETCODE x (SCIP* scip, SCIP_TABLE* table)
62 
63 /** initialization method of statistics table (called after problem was transformed)
64  *
65  * input:
66  * - scip : SCIP main data structure
67  * - table : the statistics table itself
68  */
69 #define SCIP_DECL_TABLEINIT(x) SCIP_RETCODE x (SCIP* scip, SCIP_TABLE* table)
70 
71 /** deinitialization method of statistics table (called before transformed problem is freed)
72  *
73  * input:
74  * - scip : SCIP main data structure
75  * - table : the statistics table itself
76  */
77 #define SCIP_DECL_TABLEEXIT(x) SCIP_RETCODE x (SCIP* scip, SCIP_TABLE* table)
78 
79 /** solving process initialization method of statistics table (called when branch and bound process is about to begin)
80  *
81  * This method is called when the presolving was finished and the branch and bound process is about to begin.
82  * The statistics table may use this call to initialize its branch and bound specific data.
83  *
84  * input:
85  * - scip : SCIP main data structure
86  * - table : the statistics table itself
87  */
88 #define SCIP_DECL_TABLEINITSOL(x) SCIP_RETCODE x (SCIP* scip, SCIP_TABLE* table)
89 
90 /** solving process deinitialization method of statistics table (called before branch and bound process data is freed)
91  *
92  * This method is called before the branch and bound process is freed.
93  * The statistics table should use this call to clean up its branch and bound data.
94  *
95  * input:
96  * - scip : SCIP main data structure
97  * - table : the display column itself
98  */
99 #define SCIP_DECL_TABLEEXITSOL(x) SCIP_RETCODE x (SCIP* scip, SCIP_TABLE* table)
100 
101 /** output method of statistics table to output file stream 'file'
102  *
103  * input:
104  * - scip : SCIP main data structure
105  * - table : the statistics table itself
106  * - file : file stream for output
107  */
108 #define SCIP_DECL_TABLEOUTPUT(x) SCIP_RETCODE x (SCIP* scip, SCIP_TABLE* table, FILE* file)
109 
110 #ifdef __cplusplus
111 }
112 #endif
113 
114 #endif
type definitions for return codes for SCIP methods
type definitions for SCIP&#39;s main datastructure
common defines and data types used in all packages of SCIP
struct SCIP_TableData SCIP_TABLEDATA
Definition: type_table.h:44