Detailed Description

functions for the inclusion and access of statistics tables

Functions
SCIP_TABLEDATA *	SCIPtableGetData (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_DECL_TABLECOLLECT((tablecollect)), SCIP_TABLEDATA tabledata, int position, SCIP_STAGE earlieststage)
SCIP_TABLE *	SCIPfindTable (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

table statistics table

Definition at line 326 of file table.c.

References assert(), NULL, and SCIP_Table::tabledata.

Referenced by SCIP_DECL_TABLECOLLECT(), SCIP_DECL_TABLECOLLECT(), SCIP_DECL_TABLECOPY(), SCIP_DECL_TABLEEXIT(), SCIP_DECL_TABLEEXITSOL(), SCIP_DECL_TABLEFREE(), SCIP_DECL_TABLEFREE(), SCIP_DECL_TABLEINIT(), SCIP_DECL_TABLEINITSOL(), SCIP_DECL_TABLEOUTPUT(), 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

table	statistics table
tabledata	new statistics table user data

Definition at line 336 of file table.c.

References assert(), NULL, and SCIP_Table::tabledata.

Referenced by SCIP_DECL_TABLEFREE().

◆ SCIPtableGetName()

const char * SCIPtableGetName ( SCIP_TABLE * table )

gets name of statistics table

Parameters

table statistics table

Definition at line 347 of file table.c.

References assert(), SCIP_Table::name, and NULL.

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

◆ SCIPtableGetDesc()

const char * SCIPtableGetDesc ( SCIP_TABLE * table )

gets description of statistics table

Parameters

table statistics table

Definition at line 357 of file table.c.

References assert(), SCIP_Table::desc, and NULL.

◆ SCIPtableGetPosition()

int SCIPtableGetPosition ( SCIP_TABLE * table )

gets position of statistics table

Parameters

table statistics table

Definition at line 367 of file table.c.

References assert(), NULL, and SCIP_Table::position.

Referenced by SCIP_DECL_SORTPTRCOMP().

◆ SCIPtableGetEarliestStage()

SCIP_STAGE SCIPtableGetEarliestStage ( SCIP_TABLE * table )

gets earliest stage of statistics table

Parameters

table statistics table

Definition at line 377 of file table.c.

References assert(), SCIP_Table::earlieststage, and NULL.

Referenced by SCIPprintStatistics(), and SCIPprintStatisticsJson().

◆ SCIPtableIsActive()

SCIP_Bool SCIPtableIsActive ( SCIP_TABLE * table )

is statistics table currently active?

Parameters

table statistics table

Definition at line 387 of file table.c.

References SCIP_Table::active, assert(), NULL, and SCIP_Bool.

Referenced by SCIPprintStatistics(), and SCIPprintStatisticsJson().

◆ SCIPtableIsInitialized()

SCIP_Bool SCIPtableIsInitialized ( SCIP_TABLE * table )

is statistics table initialized?

Parameters

table statistics table

Definition at line 397 of file table.c.

References assert(), SCIP_Table::initialized, NULL, and SCIP_Bool.

◆ 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_DECL_TABLECOLLECT((*tablecollect))	,
		SCIP_TABLEDATA *	tabledata,
		int	position,
		SCIP_STAGE	earlieststage )

creates a statistics table and includes it in SCIP

Precondition

This method can be called if SCIP is in one of the following stages:

Parameters

scip	SCIP data structure
name	name of statistics table
desc	description of statistics table
active	should the table be activated by default?
-	copy method of statistics table or NULL if you don't want to copy your plugin into sub-SCIPs
-	destructor of statistics table
-	initialize statistics table
-	deinitialize statistics table
-	solving process initialization method of statistics table
-	solving process deinitialization method of statistics table
-	output method
-	data collection method
tabledata	statistics table data
position	position of statistics table
earlieststage	output of the statistics table is only printed from this stage onwards

Definition at line 62 of file scip_table.c.

References active, FALSE, NULL, SCIP_Bool, SCIP_CALL, SCIP_DECL_TABLECOPY, SCIP_DECL_TABLEEXIT, SCIP_DECL_TABLEEXITSOL, SCIP_DECL_TABLEFREE, SCIP_DECL_TABLEINIT, SCIP_DECL_TABLEINITSOL, SCIP_DECL_TABLEOUTPUT, SCIP_INVALIDDATA, SCIP_OKAY, SCIPcheckStage, SCIPerrorMessage, SCIPfindTable(), SCIPsetIncludeTable(), SCIPtableCreate(), and TRUE.

Referenced by SCIPincludeConshdlrNonlinear(), SCIPincludeEventHdlrEstim(), SCIPincludeHeurAlns(), SCIPincludeHeurScheduler(), SCIPincludeNlhdlrBilinear(), SCIPincludeNlhdlrQuadratic(), SCIPincludeObjTable(), SCIPincludePropSymmetry(), 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

scip	SCIP data structure
name	name of statistics table

Definition at line 101 of file scip_table.c.

References assert(), NULL, and SCIPsetFindTable().

Referenced by SCIP_DECL_TABLECOPY(), SCIPfindObjTable(), SCIPincludeConshdlrNonlinear(), SCIPincludeHeurAlns(), SCIPincludeHeurScheduler(), SCIPincludeNlhdlrBilinear(), SCIPincludeNlhdlrQuadratic(), SCIPincludeTable(), SCIPincludeTableDefault(), and SCIPprobdataCreate().

◆ SCIPgetTables()

SCIP_TABLE ** SCIPgetTables ( SCIP * scip )

returns the array of currently available statistics tables

Parameters

scip	SCIP data structure

Definition at line 114 of file scip_table.c.

References assert(), and NULL.

Referenced by SCIPprintStatistics(), and SCIPprintStatisticsJson().

◆ SCIPgetNTables()

int SCIPgetNTables ( SCIP * scip )

returns the number of currently available statistics tables

Parameters

scip	SCIP data structure

Definition at line 125 of file scip_table.c.

References assert(), and NULL.

Referenced by SCIPprintStatistics(), and SCIPprintStatisticsJson().

Detailed Description

Functions

Function Documentation

◆ SCIPtableGetData()

◆ SCIPtableSetData()

◆ SCIPtableGetName()

◆ SCIPtableGetDesc()

◆ SCIPtableGetPosition()

◆ SCIPtableGetEarliestStage()

◆ SCIPtableIsActive()

◆ SCIPtableIsInitialized()

◆ SCIPincludeTable()

◆ SCIPfindTable()

◆ SCIPgetTables()

◆ SCIPgetNTables()