Scippy

SCIP

Solving Constraint Integer Programs

table.c File Reference

Detailed Description

methods and datastructures for displaying statistics tables

Author
Tristan Gally

Definition in file table.c.

#include <stdio.h>
#include <assert.h>
#include <string.h>
#include "scip/def.h"
#include "blockmemshell/memory.h"
#include "scip/set.h"
#include "scip/stat.h"
#include "scip/scip.h"
#include "scip/table.h"
#include "scip/pub_message.h"
#include "scip/pub_misc.h"
#include "scip/syncstore.h"
#include "scip/struct_table.h"

Go to the source code of this file.

Functions

SCIP_RETCODE SCIPtableCopyInclude (SCIP_TABLE *table, SCIP_SET *set)
 
static SCIP_RETCODE doTableCreate (SCIP_TABLE **table, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, BMS_BLKMEM *blkmem, const char *name, const char *desc, SCIP_Bool active, SCIP_DECL_TABLECOPY((*tablecopy)), SCIP_DECL_TABLEFREE((*tablefree)), SCIP_DECL_TABLEINIT((*tableinit)), SCIP_DECL_TABLEEXIT((*tableexit)), SCIP_DECL_TABLEINITSOL((*tableinitsol)), SCIP_DECL_TABLEEXITSOL((*tableexitsol)), SCIP_DECL_TABLEOUTPUT((*tableoutput)), SCIP_TABLEDATA *tabledata, int position, SCIP_STAGE earlieststage)
 
SCIP_RETCODE SCIPtableCreate (SCIP_TABLE **table, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, BMS_BLKMEM *blkmem, const char *name, const char *desc, SCIP_Bool active, SCIP_DECL_TABLECOPY((*tablecopy)), SCIP_DECL_TABLEFREE((*tablefree)), SCIP_DECL_TABLEINIT((*tableinit)), SCIP_DECL_TABLEEXIT((*tableexit)), SCIP_DECL_TABLEINITSOL((*tableinitsol)), SCIP_DECL_TABLEEXITSOL((*tableexitsol)), SCIP_DECL_TABLEOUTPUT((*tableoutput)), SCIP_TABLEDATA *tabledata, int position, SCIP_STAGE earlieststage)
 
SCIP_RETCODE SCIPtableFree (SCIP_TABLE **table, SCIP_SET *set)
 
SCIP_RETCODE SCIPtableInit (SCIP_TABLE *table, SCIP_SET *set)
 
SCIP_RETCODE SCIPtableExit (SCIP_TABLE *table, SCIP_SET *set)
 
SCIP_RETCODE SCIPtableInitsol (SCIP_TABLE *table, SCIP_SET *set)
 
SCIP_RETCODE SCIPtableExitsol (SCIP_TABLE *table, SCIP_SET *set)
 
SCIP_RETCODE SCIPtableOutput (SCIP_TABLE *table, SCIP_SET *set, FILE *file)
 
SCIP_TABLEDATASCIPtableGetData (SCIP_TABLE *table)
 
void SCIPtableSetData (SCIP_TABLE *table, SCIP_TABLEDATA *tabledata)
 
const char * SCIPtableGetName (SCIP_TABLE *table)
 
const char * SCIPtableGetDesc (SCIP_TABLE *table)
 
int SCIPtableGetPosition (SCIP_TABLE *table)
 
SCIP_STAGE SCIPtableGetEarliestStage (SCIP_TABLE *table)
 
SCIP_Bool SCIPtableIsActive (SCIP_TABLE *table)
 
SCIP_Bool SCIPtableIsInitialized (SCIP_TABLE *table)
 

Function Documentation

◆ SCIPtableCopyInclude()

SCIP_RETCODE SCIPtableCopyInclude ( SCIP_TABLE table,
SCIP_SET set 
)

copies the given statistics table to a new scip

Parameters
tablestatistics table
setSCIP_SET of SCIP to copy to

Definition at line 45 of file table.c.

References NULL, SCIP_CALL, SCIP_OKAY, SCIPsetDebugMsg, and SCIPtableGetName().

◆ doTableCreate()

static SCIP_RETCODE doTableCreate ( SCIP_TABLE **  table,
SCIP_SET set,
SCIP_MESSAGEHDLR messagehdlr,
BMS_BLKMEM blkmem,
const char *  name,
const char *  desc,
SCIP_Bool  active,
SCIP_DECL_TABLECOPY((*tablecopy))  ,
SCIP_DECL_TABLEFREE((*tablefree))  ,
SCIP_DECL_TABLEINIT((*tableinit))  ,
SCIP_DECL_TABLEEXIT((*tableexit))  ,
SCIP_DECL_TABLEINITSOL((*tableinitsol))  ,
SCIP_DECL_TABLEEXITSOL((*tableexitsol))  ,
SCIP_DECL_TABLEOUTPUT((*tableoutput))  ,
SCIP_TABLEDATA tabledata,
int  position,
SCIP_STAGE  earlieststage 
)
static

internal method for creating a statistics table

Parameters
tablepointer to store statistics table
setglobal SCIP settings
messagehdlrmessage handler
blkmemblock memory for parameter settings
namename of statistics table
descdescription of statistics table
activeshould the table be activated by default?
tabledatadisplay statistics table
positionposition of statistics table
earlieststageoutput of the statistics table is only printed from this stage onwards

Definition at line 64 of file table.c.

References active, BMSallocMemory, BMSclearMemory, BMSduplicateMemoryArray, FALSE, NULL, SCIP_ALLOC, SCIP_CALL, SCIP_MAXSTRLEN, SCIP_OKAY, SCIPsetAddBoolParam(), and SCIPsnprintf().

Referenced by SCIPtableCreate().

◆ SCIPtableCreate()

SCIP_RETCODE SCIPtableCreate ( SCIP_TABLE **  table,
SCIP_SET set,
SCIP_MESSAGEHDLR messagehdlr,
BMS_BLKMEM blkmem,
const char *  name,
const char *  desc,
SCIP_Bool  active,
SCIP_DECL_TABLECOPY((*tablecopy))  ,
SCIP_DECL_TABLEFREE((*tablefree))  ,
SCIP_DECL_TABLEINIT((*tableinit))  ,
SCIP_DECL_TABLEEXIT((*tableexit))  ,
SCIP_DECL_TABLEINITSOL((*tableinitsol))  ,
SCIP_DECL_TABLEEXITSOL((*tableexitsol))  ,
SCIP_DECL_TABLEOUTPUT((*tableoutput))  ,
SCIP_TABLEDATA tabledata,
int  position,
SCIP_STAGE  earlieststage 
)

creates a statistics table

Parameters
tablepointer to store statistics table
setglobal SCIP settings
messagehdlrmessage handler
blkmemblock memory for parameter settings
namename of statistics table
descdescription of statistics table
activeshould the table be activated by default?
tabledatadisplay statistics table
positionposition of statistics table
earlieststageoutput of the statistics table is only printed from this stage onwards

Definition at line 120 of file table.c.

References doTableCreate(), NULL, SCIP_CALL_FINALLY, SCIP_OKAY, and SCIPtableFree().

Referenced by SCIPincludeTable().

◆ SCIPtableFree()

SCIP_RETCODE SCIPtableFree ( SCIP_TABLE **  table,
SCIP_SET set 
)

frees memory of statistics table

Parameters
tablepointer to statistics table data structure
setglobal SCIP settings

Definition at line 153 of file table.c.

References BMSfreeMemory, BMSfreeMemoryArrayNull, NULL, SCIP_CALL, and SCIP_OKAY.

Referenced by SCIPsetFree(), and SCIPtableCreate().

◆ SCIPtableInit()

SCIP_RETCODE SCIPtableInit ( SCIP_TABLE table,
SCIP_SET set 
)

initializes statistics table

Parameters
tablestatistics table
setglobal SCIP settings

Definition at line 178 of file table.c.

References SCIP_Table::initialized, SCIP_Table::name, NULL, SCIP_CALL, SCIP_INVALIDCALL, SCIP_OKAY, SCIPerrorMessage, and TRUE.

Referenced by SCIPsetInitPlugins().

◆ SCIPtableExit()

SCIP_RETCODE SCIPtableExit ( SCIP_TABLE table,
SCIP_SET set 
)

deinitializes statistics table

Parameters
tablestatistics table
setglobal SCIP settings

Definition at line 202 of file table.c.

References FALSE, SCIP_Table::initialized, SCIP_Table::name, NULL, SCIP_CALL, SCIP_INVALIDCALL, SCIP_OKAY, and SCIPerrorMessage.

Referenced by SCIPsetExitPlugins().

◆ SCIPtableInitsol()

SCIP_RETCODE SCIPtableInitsol ( SCIP_TABLE table,
SCIP_SET set 
)

informs statistics table that the branch and bound process is being started

Parameters
tablestatistics table
setglobal SCIP settings

Definition at line 226 of file table.c.

References NULL, SCIP_CALL, and SCIP_OKAY.

Referenced by SCIPsetInitsolPlugins().

◆ SCIPtableExitsol()

SCIP_RETCODE SCIPtableExitsol ( SCIP_TABLE table,
SCIP_SET set 
)

informs statistics table that the branch and bound process data is being freed

Parameters
tablestatistics table
setglobal SCIP settings

Definition at line 244 of file table.c.

References NULL, SCIP_CALL, and SCIP_OKAY.

◆ SCIPtableOutput()

SCIP_RETCODE SCIPtableOutput ( SCIP_TABLE table,
SCIP_SET set,
FILE *  file 
)

output statistics table to screen

Parameters
tablestatistics table
setglobal SCIP settings
fileoutput file (or NULL for standard output)

Definition at line 262 of file table.c.

References NULL, SCIP_CALL, and SCIP_OKAY.

Referenced by SCIPprintStatistics().