Detailed Description
type definitions for displaying runtime statistics
This file defines the interface for display columns implemented in C.
Definition in file type_disp.h.
Go to the source code of this file.
Macros | |
#define | SCIP_DECL_DISPCOPY(x) SCIP_RETCODE x (SCIP* scip, SCIP_DISP* disp) |
#define | SCIP_DECL_DISPFREE(x) SCIP_RETCODE x (SCIP* scip, SCIP_DISP* disp) |
#define | SCIP_DECL_DISPINIT(x) SCIP_RETCODE x (SCIP* scip, SCIP_DISP* disp) |
#define | SCIP_DECL_DISPEXIT(x) SCIP_RETCODE x (SCIP* scip, SCIP_DISP* disp) |
#define | SCIP_DECL_DISPINITSOL(x) SCIP_RETCODE x (SCIP* scip, SCIP_DISP* disp) |
#define | SCIP_DECL_DISPEXITSOL(x) SCIP_RETCODE x (SCIP* scip, SCIP_DISP* disp) |
#define | SCIP_DECL_DISPOUTPUT(x) SCIP_RETCODE x (SCIP* scip, SCIP_DISP* disp, FILE* file) |
Typedefs | |
typedef enum SCIP_DispStatus | SCIP_DISPSTATUS |
typedef enum SCIP_DispMode | SCIP_DISPMODE |
typedef struct SCIP_Disp | SCIP_DISP |
typedef struct SCIP_DispData | SCIP_DISPDATA |
Enumerations | |
enum | SCIP_DispStatus { SCIP_DISPSTATUS_OFF = 0, SCIP_DISPSTATUS_AUTO = 1, SCIP_DISPSTATUS_ON = 2 } |
enum | SCIP_DispMode { SCIP_DISPMODE_DEFAULT = 0x00000001u, SCIP_DISPMODE_CONCURRENT = 0x00000002u, SCIP_DISPMODE_ALL = 0x00000003u } |
Macro Definition Documentation
◆ SCIP_DECL_DISPCOPY
#define SCIP_DECL_DISPCOPY | ( | x | ) | SCIP_RETCODE x (SCIP* scip, SCIP_DISP* disp) |
copy method for display plugins (called when SCIP copies plugins)
input:
- scip : SCIP main data structure
- disp : the display column itself
Definition at line 85 of file type_disp.h.
◆ SCIP_DECL_DISPFREE
#define SCIP_DECL_DISPFREE | ( | x | ) | SCIP_RETCODE x (SCIP* scip, SCIP_DISP* disp) |
destructor of display column to free user data (called when SCIP is exiting)
input:
- scip : SCIP main data structure
- disp : the display column itself
Definition at line 93 of file type_disp.h.
◆ SCIP_DECL_DISPINIT
#define SCIP_DECL_DISPINIT | ( | x | ) | SCIP_RETCODE x (SCIP* scip, SCIP_DISP* disp) |
initialization method of display column (called after problem was transformed)
input:
- scip : SCIP main data structure
- disp : the display column itself
Definition at line 101 of file type_disp.h.
◆ SCIP_DECL_DISPEXIT
#define SCIP_DECL_DISPEXIT | ( | x | ) | SCIP_RETCODE x (SCIP* scip, SCIP_DISP* disp) |
deinitialization method of display column (called before transformed problem is freed)
input:
- scip : SCIP main data structure
- disp : the display column itself
Definition at line 109 of file type_disp.h.
◆ SCIP_DECL_DISPINITSOL
#define SCIP_DECL_DISPINITSOL | ( | x | ) | SCIP_RETCODE x (SCIP* scip, SCIP_DISP* disp) |
solving process initialization method of display column (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 display column may use this call to initialize its branch and bound specific data.
input:
- scip : SCIP main data structure
- disp : the display column itself
Definition at line 120 of file type_disp.h.
◆ SCIP_DECL_DISPEXITSOL
#define SCIP_DECL_DISPEXITSOL | ( | x | ) | SCIP_RETCODE x (SCIP* scip, SCIP_DISP* disp) |
solving process deinitialization method of display column (called before branch and bound process data is freed)
This method is called before the branch and bound process is freed. The display column should use this call to clean up its branch and bound data.
input:
- scip : SCIP main data structure
- disp : the display column itself
Definition at line 131 of file type_disp.h.
◆ SCIP_DECL_DISPOUTPUT
#define SCIP_DECL_DISPOUTPUT | ( | x | ) | SCIP_RETCODE x (SCIP* scip, SCIP_DISP* disp, FILE* file) |
output method of display column to output file stream 'file'
input:
- scip : SCIP main data structure
- disp : the display column itself
- file : file stream for output
Definition at line 140 of file type_disp.h.
Typedef Documentation
◆ SCIP_DISPSTATUS
typedef enum SCIP_DispStatus SCIP_DISPSTATUS |
Definition at line 64 of file type_disp.h.
◆ SCIP_DISPMODE
typedef enum SCIP_DispMode SCIP_DISPMODE |
Definition at line 73 of file type_disp.h.
◆ SCIP_DISP
display column data structure
Definition at line 75 of file type_disp.h.
◆ SCIP_DISPDATA
typedef struct SCIP_DispData SCIP_DISPDATA |
display column specific data
Definition at line 76 of file type_disp.h.
Enumeration Type Documentation
◆ SCIP_DispStatus
enum SCIP_DispStatus |
display activation status of display column
Enumerator | |
---|---|
SCIP_DISPSTATUS_OFF | display column is not displayed |
SCIP_DISPSTATUS_AUTO | display column is switched on and off automatically |
SCIP_DISPSTATUS_ON | display column is displayed |
Definition at line 58 of file type_disp.h.
◆ SCIP_DispMode
enum SCIP_DispMode |
display activation status of display column
Definition at line 67 of file type_disp.h.