1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/* */
/* This file is part of the program and library */
/* SCIP --- Solving Constraint Integer Programs */
/* */
/* Copyright 2002-2022 Zuse Institute Berlin */
/* */
/* Licensed under the Apache License, Version 2.0 (the "License"); */
/* you may not use this file except in compliance with the License. */
/* You may obtain a copy of the License at */
/* */
/* http://www.apache.org/licenses/LICENSE-2.0 */
/* */
/* Unless required by applicable law or agreed to in writing, software */
/* distributed under the License is distributed on an "AS IS" BASIS, */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */
/* See the License for the specific language governing permissions and */
/* limitations under the License. */
/* */
/* You should have received a copy of the Apache-2.0 license */
/* along with SCIP; see the file LICENSE. If not visit scipopt.org. */
/* */
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/**@file table.h
* @ingroup INTERNALAPI
* @brief internal methods for displaying statistics tables
* @author Tristan Gally
*/
/*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
#ifndef __SCIP_TABLE_H__
#define __SCIP_TABLE_H__
#include <stdio.h>
#include "scip/def.h"
#include "blockmemshell/memory.h"
#include "scip/type_retcode.h"
#include "scip/type_set.h"
#include "scip/type_table.h"
#include "scip/type_paramset.h"
#include "scip/pub_table.h"
#ifdef __cplusplus
extern "C" {
#endif
/** copies the given statistics table to a new scip */
SCIP_RETCODE SCIPtableCopyInclude(
SCIP_TABLE* table, /**< statistics table */
SCIP_SET* set /**< SCIP_SET of SCIP to copy to */
);
/** creates a statistics table */
SCIP_RETCODE SCIPtableCreate(
SCIP_TABLE** table, /**< pointer to store statistics table */
SCIP_SET* set, /**< global SCIP settings */
SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
BMS_BLKMEM* blkmem, /**< block memory for parameter settings */
const char* name, /**< name of statistics table */
const char* desc, /**< description of statistics table */
SCIP_Bool active, /**< should the table be activated by default? */
SCIP_DECL_TABLECOPY ((*tablecopy)), /**< copy method of statistics table or NULL if you don't want to copy your plugin into sub-SCIPs */
SCIP_DECL_TABLEFREE ((*tablefree)), /**< destructor of statistics table */
SCIP_DECL_TABLEINIT ((*tableinit)), /**< initialize statistics table */
SCIP_DECL_TABLEEXIT ((*tableexit)), /**< deinitialize statistics table */
SCIP_DECL_TABLEINITSOL ((*tableinitsol)), /**< solving process initialization method of statistics table */
SCIP_DECL_TABLEEXITSOL ((*tableexitsol)), /**< solving process deinitialization method of statistics table */
SCIP_DECL_TABLEOUTPUT ((*tableoutput)), /**< output method */
SCIP_TABLEDATA* tabledata, /**< statistics table data */
int position, /**< position of statistics table */
SCIP_STAGE earlieststage /**< output of the statistics table is only printed from this stage onwards */
);
/** frees memory of statistics table */
SCIP_RETCODE SCIPtableFree(
SCIP_TABLE** table, /**< pointer to statistics table data structure */
SCIP_SET* set /**< global SCIP settings */
);
/** initializes statistics table */
SCIP_RETCODE SCIPtableInit(
SCIP_TABLE* table, /**< statistics table */
SCIP_SET* set /**< global SCIP settings */
);
/** deinitializes statistics table */
SCIP_RETCODE SCIPtableExit(
SCIP_TABLE* table, /**< statistics table */
SCIP_SET* set /**< global SCIP settings */
);
/** informs statistics table that the branch and bound process is being started */
SCIP_RETCODE SCIPtableInitsol(
SCIP_TABLE* table, /**< statistics table */
SCIP_SET* set /**< global SCIP settings */
);
/** informs statistics table that the branch and bound process data is being freed */
SCIP_RETCODE SCIPtableExitsol(
SCIP_TABLE* table, /**< statistics table */
SCIP_SET* set /**< global SCIP settings */
);
/** output statistics table to screen */
SCIP_RETCODE SCIPtableOutput(
SCIP_TABLE* table, /**< statistics table */
SCIP_SET* set, /**< global SCIP settings */
FILE* file /**< output file (or NULL for standard output) */
);
#ifdef __cplusplus
}
#endif
#endif