Scippy

SCIP

Solving Constraint Integer Programs

pub_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-2021 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 scipopt.org. */
13 /* */
14 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
15 
16 /**@file pub_table.h
17  * @ingroup PUBLICCOREAPI
18  * @brief public methods for displaying statistic tables
19  * @author Tristan Gally
20  */
21 
22 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
23 
24 #ifndef __SCIP_PUB_TABLE_H__
25 #define __SCIP_PUB_TABLE_H__
26 
27 
28 #include "scip/def.h"
29 #include "scip/type_set.h"
30 #include "scip/type_table.h"
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
36 /**@addtogroup PublicTableMethods
37  *
38  * @{
39  */
40 
41 /** gets user data of statistics table */
44  SCIP_TABLE* table /**< statistics table */
45  );
46 
47 /** sets user data of statistics table; user has to free old data in advance! */
49 void SCIPtableSetData(
50  SCIP_TABLE* table, /**< statistics table */
51  SCIP_TABLEDATA* tabledata /**< new statistics table user data */
52  );
53 
54 /** gets name of statistics table */
56 const char* SCIPtableGetName(
57  SCIP_TABLE* table /**< statistics table */
58  );
59 
60 /** gets description of statistics table */
62 const char* SCIPtableGetDesc(
63  SCIP_TABLE* table /**< statistics table */
64  );
65 
66 /** gets position of statistics table */
69  SCIP_TABLE* table /**< statistics table */
70  );
71 
72 /** gets earliest stage of statistics table */
75  SCIP_TABLE* table /**< statistics table */
76  );
77 
78 /** is statistics table currently active? */
81  SCIP_TABLE* table /**< statistics table */
82  );
83 
84 /** is statistics table initialized? */
87  SCIP_TABLE* table /**< statistics table */
88  );
89 
90 /** @} */
91 
92 #ifdef __cplusplus
93 }
94 #endif
95 
96 #endif
SCIP_EXPORT const char * SCIPtableGetDesc(SCIP_TABLE *table)
Definition: table.c:310
SCIP_EXPORT SCIP_Bool SCIPtableIsActive(SCIP_TABLE *table)
Definition: table.c:340
SCIP_EXPORT SCIP_Bool SCIPtableIsInitialized(SCIP_TABLE *table)
Definition: table.c:350
#define SCIP_EXPORT
Definition: def.h:100
type definitions for global SCIP settings
SCIP_EXPORT SCIP_STAGE SCIPtableGetEarliestStage(SCIP_TABLE *table)
Definition: table.c:330
SCIP_EXPORT int SCIPtableGetPosition(SCIP_TABLE *table)
Definition: table.c:320
#define SCIP_Bool
Definition: def.h:70
SCIP_EXPORT const char * SCIPtableGetName(SCIP_TABLE *table)
Definition: table.c:300
SCIP_EXPORT SCIP_TABLEDATA * SCIPtableGetData(SCIP_TABLE *table)
Definition: table.c:279
enum SCIP_Stage SCIP_STAGE
Definition: type_set.h:50
common defines and data types used in all packages of SCIP
SCIP_EXPORT void SCIPtableSetData(SCIP_TABLE *table, SCIP_TABLEDATA *tabledata)
Definition: table.c:289
type definitions for displaying statistics tables
struct SCIP_TableData SCIP_TABLEDATA
Definition: type_table.h:49