Detailed Description
type definitions for displaying statistics tables
This file defines the interface for statistics tables implemented in C.
- Instructions for implementing a statistics table
- List of available statistics tables
- C++ wrapper class
Definition in file type_table.h.
Go to the source code of this file.
Macros | |
#define | SCIP_DECL_TABLECOPY(x) SCIP_RETCODE x (SCIP* scip, SCIP_TABLE* table) |
#define | SCIP_DECL_TABLEFREE(x) SCIP_RETCODE x (SCIP* scip, SCIP_TABLE* table) |
#define | SCIP_DECL_TABLEINIT(x) SCIP_RETCODE x (SCIP* scip, SCIP_TABLE* table) |
#define | SCIP_DECL_TABLEEXIT(x) SCIP_RETCODE x (SCIP* scip, SCIP_TABLE* table) |
#define | SCIP_DECL_TABLEINITSOL(x) SCIP_RETCODE x (SCIP* scip, SCIP_TABLE* table) |
#define | SCIP_DECL_TABLEEXITSOL(x) SCIP_RETCODE x (SCIP* scip, SCIP_TABLE* table) |
#define | SCIP_DECL_TABLEOUTPUT(x) SCIP_RETCODE x (SCIP* scip, SCIP_TABLE* table, FILE* file) |
Typedefs | |
typedef struct SCIP_Table | SCIP_TABLE |
typedef struct SCIP_TableData | SCIP_TABLEDATA |
Macro Definition Documentation
◆ SCIP_DECL_TABLECOPY
#define SCIP_DECL_TABLECOPY | ( | x | ) | SCIP_RETCODE x (SCIP* scip, SCIP_TABLE* table) |
copy method for statistics table plugins (called when SCIP copies plugins)
input:
- scip : SCIP main data structure
- table : the statistics table itself
Definition at line 58 of file type_table.h.
◆ SCIP_DECL_TABLEFREE
#define SCIP_DECL_TABLEFREE | ( | x | ) | SCIP_RETCODE x (SCIP* scip, SCIP_TABLE* table) |
destructor of statistics table to free user data (called when SCIP is exiting)
input:
- scip : SCIP main data structure
- table : the statistics table itself
Definition at line 66 of file type_table.h.
◆ SCIP_DECL_TABLEINIT
#define SCIP_DECL_TABLEINIT | ( | x | ) | SCIP_RETCODE x (SCIP* scip, SCIP_TABLE* table) |
initialization method of statistics table (called after problem was transformed)
input:
- scip : SCIP main data structure
- table : the statistics table itself
Definition at line 74 of file type_table.h.
◆ SCIP_DECL_TABLEEXIT
#define SCIP_DECL_TABLEEXIT | ( | x | ) | SCIP_RETCODE x (SCIP* scip, SCIP_TABLE* table) |
deinitialization method of statistics table (called before transformed problem is freed)
input:
- scip : SCIP main data structure
- table : the statistics table itself
Definition at line 82 of file type_table.h.
◆ SCIP_DECL_TABLEINITSOL
#define SCIP_DECL_TABLEINITSOL | ( | x | ) | SCIP_RETCODE x (SCIP* scip, SCIP_TABLE* table) |
solving process initialization method of statistics table (called when branch and bound process is about to begin)
This method is called when the presolving was finished and the branch and bound process is about to begin. The statistics table may use this call to initialize its branch and bound specific data.
input:
- scip : SCIP main data structure
- table : the statistics table itself
Definition at line 93 of file type_table.h.
◆ SCIP_DECL_TABLEEXITSOL
#define SCIP_DECL_TABLEEXITSOL | ( | x | ) | SCIP_RETCODE x (SCIP* scip, SCIP_TABLE* table) |
solving process deinitialization method of statistics table (called before branch and bound process data is freed)
This method is called before the branch and bound process is freed. The statistics table should use this call to clean up its branch and bound data.
input:
- scip : SCIP main data structure
- table : the display column itself
Definition at line 104 of file type_table.h.
◆ SCIP_DECL_TABLEOUTPUT
#define SCIP_DECL_TABLEOUTPUT | ( | x | ) | SCIP_RETCODE x (SCIP* scip, SCIP_TABLE* table, FILE* file) |
output method of statistics table to output file stream 'file'
input:
- scip : SCIP main data structure
- table : the statistics table itself
- file : file stream for output
Definition at line 113 of file type_table.h.
Typedef Documentation
◆ SCIP_TABLE
typedef struct SCIP_Table SCIP_TABLE |
statistics table data structure
Definition at line 48 of file type_table.h.
◆ SCIP_TABLEDATA
typedef struct SCIP_TableData SCIP_TABLEDATA |
statistics table specific data
Definition at line 49 of file type_table.h.