Scippy

SCIP

Solving Constraint Integer Programs

Detailed Description

methods for the inclusion and access of statistics tables

Functions

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)
 
SCIP_RETCODE SCIPincludeTable (SCIP *scip, 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_TABLESCIPfindTable (SCIP *scip, const char *name)
 
SCIP_TABLE ** SCIPgetTables (SCIP *scip)
 
int SCIPgetNTables (SCIP *scip)
 

Function Documentation

◆ SCIPtableGetData()

SCIP_TABLEDATA* SCIPtableGetData ( SCIP_TABLE table)

gets user data of statistics table

Parameters
tablestatistics table

Definition at line 278 of file table.c.

References NULL, and SCIP_Table::tabledata.

Referenced by SCIP_DECL_TABLECOPY(), SCIP_DECL_TABLEEXIT(), SCIP_DECL_TABLEEXITSOL(), SCIP_DECL_TABLEFREE(), SCIP_DECL_TABLEINIT(), SCIP_DECL_TABLEINITSOL(), SCIP_DECL_TABLEOUTPUT(), SCIPfindObjTable(), and SCIPgetObjTable().

◆ SCIPtableSetData()

void SCIPtableSetData ( SCIP_TABLE table,
SCIP_TABLEDATA tabledata 
)

sets user data of statistics table; user has to free old data in advance!

Parameters
tablestatistics table
tabledatanew statistics table user data

Definition at line 288 of file table.c.

References NULL, and SCIP_Table::tabledata.

Referenced by SCIP_DECL_TABLEFREE().

◆ SCIPtableGetName()

const char* SCIPtableGetName ( SCIP_TABLE table)

gets name of statistics table

Parameters
tablestatistics table

Definition at line 299 of file table.c.

References SCIP_Table::name, and NULL.

Referenced by SCIP_DECL_TABLECOPY(), SCIPsetIncludeDisp(), and SCIPtableCopyInclude().

◆ SCIPtableGetDesc()

const char* SCIPtableGetDesc ( SCIP_TABLE table)

gets description of statistics table

Parameters
tablestatistics table

Definition at line 309 of file table.c.

References SCIP_Table::desc, and NULL.

◆ SCIPtableGetPosition()

int SCIPtableGetPosition ( SCIP_TABLE table)

gets position of statistics table

Parameters
tablestatistics table

Definition at line 319 of file table.c.

References NULL, and SCIP_Table::position.

Referenced by SCIP_DECL_SORTPTRCOMP().

◆ SCIPtableGetEarliestStage()

SCIP_STAGE SCIPtableGetEarliestStage ( SCIP_TABLE table)

gets earliest stage of statistics table

Parameters
tablestatistics table

Definition at line 329 of file table.c.

References SCIP_Table::earlieststage, and NULL.

Referenced by SCIPprintStatistics().

◆ SCIPtableIsActive()

SCIP_Bool SCIPtableIsActive ( SCIP_TABLE table)

is statistics table currently active?

Parameters
tablestatistics table

Definition at line 339 of file table.c.

References SCIP_Table::active, and NULL.

Referenced by SCIPprintStatistics().

◆ SCIPtableIsInitialized()

SCIP_Bool SCIPtableIsInitialized ( SCIP_TABLE table)

is statistics table initialized?

Parameters
tablestatistics table

Definition at line 349 of file table.c.

References SCIP_Table::initialized, and NULL.

Referenced by SCIPsetSortBranchrules().

◆ SCIPincludeTable()

SCIP_RETCODE SCIPincludeTable ( SCIP scip,
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 and includes it in SCIP

Parameters
scipSCIP data structure
namename of statistics table
descdescription of statistics table
activeshould the table be activated by default?
tabledatastatistics table data
positionposition of statistics table
earlieststageoutput of the statistics table is only printed from this stage onwards

Definition at line 46 of file scip_table.c.

References FALSE, Scip::mem, Scip::messagehdlr, NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIPcheckStage(), SCIPerrorMessage, SCIPfindTable(), SCIPsetIncludeTable(), SCIPtableCreate(), Scip::set, SCIP_Mem::setmem, and TRUE.

Referenced by SCIPincludeHeurAlns(), SCIPincludeObjTable(), SCIPincludePropOrbitalfixing(), SCIPincludeTableDefault(), and SCIPprobdataCreate().

◆ SCIPfindTable()

SCIP_TABLE* SCIPfindTable ( SCIP scip,
const char *  name 
)

returns the statistics table of the given name, or NULL if not existing

Parameters
scipSCIP data structure
namename of statistics table

Definition at line 84 of file scip_table.c.

References NULL, SCIPsetFindTable(), and Scip::set.

Referenced by SCIP_DECL_TABLECOPY(), SCIPfindObjTable(), SCIPincludeHeurAlns(), SCIPincludeTable(), SCIPincludeTableDefault(), and SCIPprobdataCreate().

◆ SCIPgetTables()

SCIP_TABLE** SCIPgetTables ( SCIP scip)

returns the array of currently available statistics tables

Parameters
scipSCIP data structure

Definition at line 97 of file scip_table.c.

References NULL, Scip::set, and SCIP_Set::tables.

Referenced by SCIPprintStatistics().

◆ SCIPgetNTables()

int SCIPgetNTables ( SCIP scip)

returns the number of currently available statistics tables

Parameters
scipSCIP data structure

Definition at line 108 of file scip_table.c.

References SCIP_Set::ntables, NULL, and Scip::set.

Referenced by SCIPprintStatistics().