Scippy

SCIP

Solving Constraint Integer Programs

scip_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 scip_table.h
26  * @ingroup PUBLICCOREAPI
27  * @brief public methods for statistics table 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_TABLE_H__
41 #define __SCIP_SCIP_TABLE_H__
42 
43 
44 #include "scip/def.h"
45 #include "scip/type_retcode.h"
46 #include "scip/type_scip.h"
47 #include "scip/type_set.h"
48 #include "scip/type_table.h"
49 
50 #ifdef __cplusplus
51 extern "C" {
52 #endif
53 
54 /**@addtogroup PublicTableMethods
55  *
56  * @{
57  */
58 
59 /** creates a statistics table and includes it in SCIP */
60 SCIP_EXPORT
62  SCIP* scip, /**< SCIP data structure */
63  const char* name, /**< name of statistics table */
64  const char* desc, /**< description of statistics table */
65  SCIP_Bool active, /**< should the table be activated by default? */
66  SCIP_DECL_TABLECOPY ((*tablecopy)), /**< copy method of statistics table or NULL if you don't want to copy your plugin into sub-SCIPs */
67  SCIP_DECL_TABLEFREE ((*tablefree)), /**< destructor of statistics table */
68  SCIP_DECL_TABLEINIT ((*tableinit)), /**< initialize statistics table */
69  SCIP_DECL_TABLEEXIT ((*tableexit)), /**< deinitialize statistics table */
70  SCIP_DECL_TABLEINITSOL ((*tableinitsol)), /**< solving process initialization method of statistics table */
71  SCIP_DECL_TABLEEXITSOL ((*tableexitsol)), /**< solving process deinitialization method of statistics table */
72  SCIP_DECL_TABLEOUTPUT ((*tableoutput)), /**< output method */
73  SCIP_TABLEDATA* tabledata, /**< statistics table data */
74  int position, /**< position of statistics table */
75  SCIP_STAGE earlieststage /**< output of the statistics table is only printed from this stage onwards */
76  );
77 
78 /** returns the statistics table of the given name, or NULL if not existing */
79 SCIP_EXPORT
81  SCIP* scip, /**< SCIP data structure */
82  const char* name /**< name of statistics table */
83  );
84 
85 /** returns the array of currently available statistics tables */
86 SCIP_EXPORT
88  SCIP* scip /**< SCIP data structure */
89  );
90 
91 /** returns the number of currently available statistics tables */
92 SCIP_EXPORT
93 int SCIPgetNTables(
94  SCIP* scip /**< SCIP data structure */
95  );
96 
97 /** @} */
98 
99 #ifdef __cplusplus
100 }
101 #endif
102 
103 #endif
#define SCIP_DECL_TABLEINITSOL(x)
Definition: type_table.h:102
SCIP_RETCODE SCIPincludeTable(SCIP *scip, const char *name, const char *desc, SCIP_Bool active, SCIP_DECL_TABLECOPY((*tablecopy)), SCIP_DECL_TABLEFREE((*tablefree)), SCIP_DECL_TABLEINIT((*tableinit)), SCIP_DECL_TABLEEXIT((*tableexit)), SCIP_DECL_TABLEINITSOL((*tableinitsol)), SCIP_DECL_TABLEEXITSOL((*tableexitsol)), SCIP_DECL_TABLEOUTPUT((*tableoutput)), SCIP_TABLEDATA *tabledata, int position, SCIP_STAGE earlieststage)
Definition: scip_table.c:56
SCIP_TABLE * SCIPfindTable(SCIP *scip, const char *name)
Definition: scip_table.c:94
#define SCIP_DECL_TABLEFREE(x)
Definition: type_table.h:75
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:63
type definitions for global SCIP settings
static GRAPHNODE ** active
type definitions for return codes for SCIP methods
type definitions for SCIP&#39;s main datastructure
#define SCIP_Bool
Definition: def.h:93
#define SCIP_DECL_TABLECOPY(x)
Definition: type_table.h:67
#define SCIP_DECL_TABLEEXIT(x)
Definition: type_table.h:91
#define SCIP_DECL_TABLEINIT(x)
Definition: type_table.h:83
SCIP_TABLE ** SCIPgetTables(SCIP *scip)
Definition: scip_table.c:107
enum SCIP_Stage SCIP_STAGE
Definition: type_set.h:59
common defines and data types used in all packages of SCIP
#define SCIP_DECL_TABLEOUTPUT(x)
Definition: type_table.h:122
#define SCIP_DECL_TABLEEXITSOL(x)
Definition: type_table.h:113
type definitions for displaying statistics tables
int SCIPgetNTables(SCIP *scip)
Definition: scip_table.c:118
struct SCIP_TableData SCIP_TABLEDATA
Definition: type_table.h:58