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-2017 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 email to scip@zib.de. */
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 <stdio.h>
29 
30 #include "scip/def.h"
31 #include "scip/type_retcode.h"
32 #include "scip/type_table.h"
33 
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37 
38 /**@addtogroup PublicTableMethods
39  *
40  * @{
41  */
42 
43 /** gets user data of statistics table */
44 extern
46  SCIP_TABLE* table /**< statistics table */
47  );
48 
49 /** sets user data of statistics table; user has to free old data in advance! */
50 extern
51 void SCIPtableSetData(
52  SCIP_TABLE* table, /**< statistics table */
53  SCIP_TABLEDATA* tabledata /**< new statistics table user data */
54  );
55 
56 /** gets name of statistics table */
57 extern
58 const char* SCIPtableGetName(
59  SCIP_TABLE* table /**< statistics table */
60  );
61 
62 /** gets description of statistics table */
63 extern
64 const char* SCIPtableGetDesc(
65  SCIP_TABLE* table /**< statistics table */
66  );
67 
68 /** gets position of statistics table */
69 extern
71  SCIP_TABLE* table /**< statistics table */
72  );
73 
74 /** gets earliest stage of statistics table */
75 extern
77  SCIP_TABLE* table /**< statistics table */
78  );
79 
80 /** is statistics table currently active? */
81 extern
83  SCIP_TABLE* table /**< statistics table */
84  );
85 
86 /** is statistics table initialized? */
87 extern
89  SCIP_TABLE* table /**< statistics table */
90  );
91 
92 /* @} */
93 
94 #ifdef __cplusplus
95 }
96 #endif
97 
98 #endif
SCIP_Bool SCIPtableIsActive(SCIP_TABLE *table)
Definition: table.c:302
const char * SCIPtableGetName(SCIP_TABLE *table)
Definition: table.c:262
type definitions for return codes for SCIP methods
SCIP_STAGE SCIPtableGetEarliestStage(SCIP_TABLE *table)
Definition: table.c:292
int SCIPtableGetPosition(SCIP_TABLE *table)
Definition: table.c:282
SCIP_Bool SCIPtableIsInitialized(SCIP_TABLE *table)
Definition: table.c:312
const char * SCIPtableGetDesc(SCIP_TABLE *table)
Definition: table.c:272
#define SCIP_Bool
Definition: def.h:61
void SCIPtableSetData(SCIP_TABLE *table, SCIP_TABLEDATA *tabledata)
Definition: table.c:251
enum SCIP_Stage SCIP_STAGE
Definition: type_set.h:50
SCIP_TABLEDATA * SCIPtableGetData(SCIP_TABLE *table)
Definition: table.c:241
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:44