Tables

Detailed Description

methods for the inclusion and access of statistics tables

Functions
SCIP_EXPORT SCIP_TABLEDATA *	SCIPtableGetData (SCIP_TABLE *table)
SCIP_EXPORT void	SCIPtableSetData (SCIP_TABLE *table, SCIP_TABLEDATA *tabledata)
SCIP_EXPORT const char *	SCIPtableGetName (SCIP_TABLE *table)
SCIP_EXPORT const char *	SCIPtableGetDesc (SCIP_TABLE *table)
SCIP_EXPORT int	SCIPtableGetPosition (SCIP_TABLE *table)
SCIP_EXPORT SCIP_STAGE	SCIPtableGetEarliestStage (SCIP_TABLE *table)
SCIP_EXPORT SCIP_Bool	SCIPtableIsActive (SCIP_TABLE *table)
SCIP_EXPORT SCIP_Bool	SCIPtableIsInitialized (SCIP_TABLE *table)
SCIP_EXPORT 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_EXPORT SCIP_TABLE *	SCIPfindTable (SCIP *scip, const char *name)
SCIP_EXPORT SCIP_TABLE **	SCIPgetTables (SCIP *scip)
SCIP_EXPORT int	SCIPgetNTables (SCIP *scip)

Function Documentation

SCIPtableGetData()

SCIP_EXPORT SCIP_TABLEDATA* SCIPtableGetData

(

SCIP_TABLE *

table

)

gets user data of statistics table

Parameters

table

statistics 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()

SCIP_EXPORT 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 288 of file table.c.

References NULL, and SCIP_Table::tabledata.

Referenced by SCIP_DECL_TABLEFREE().

SCIPtableGetName()

SCIP_EXPORT const char* SCIPtableGetName

(

SCIP_TABLE *

table

)

gets name of statistics table

Parameters

table

statistics table

Definition at line 299 of file table.c.

References SCIP_Table::name, and NULL.

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

SCIPtableGetDesc()

SCIP_EXPORT const char* SCIPtableGetDesc

(

SCIP_TABLE *

table

)

gets description of statistics table

Parameters

table

statistics table

Definition at line 309 of file table.c.

References SCIP_Table::desc, and NULL.

SCIPtableGetPosition()

SCIP_EXPORT int SCIPtableGetPosition

(

SCIP_TABLE *

table

)

gets position of statistics table

Parameters

table

statistics table

Definition at line 319 of file table.c.

References NULL, and SCIP_Table::position.

Referenced by SCIP_DECL_SORTPTRCOMP().

SCIPtableGetEarliestStage()

SCIP_EXPORT SCIP_STAGE SCIPtableGetEarliestStage

(

SCIP_TABLE *

table

)

gets earliest stage of statistics table

Parameters

table

statistics table

Definition at line 329 of file table.c.

References SCIP_Table::earlieststage, and NULL.

Referenced by SCIPprintStatistics().

SCIPtableIsActive()

SCIP_EXPORT SCIP_Bool SCIPtableIsActive

(

SCIP_TABLE *

table

)

is statistics table currently active?

Parameters

table

statistics table

Definition at line 339 of file table.c.

References SCIP_Table::active, and NULL.

Referenced by SCIPprintStatistics().

SCIPtableIsInitialized()

SCIP_EXPORT SCIP_Bool SCIPtableIsInitialized

(

SCIP_TABLE *

table

)

is statistics table initialized?

Parameters

table

statistics table

Definition at line 349 of file table.c.

References SCIP_Table::initialized, and NULL.

Referenced by SCIPsetSortBranchrules().

SCIPincludeTable()

SCIP_EXPORT 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

scip	SCIP data structure
name	name of statistics table
desc	description of statistics table
active	should the table be activated by default?
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 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_EXPORT 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 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_EXPORT SCIP_TABLE** SCIPgetTables

(

SCIP *

scip

)

returns the array of currently available statistics tables

Parameters

scip	SCIP data structure

Definition at line 97 of file scip_table.c.

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

Referenced by SCIPprintStatistics().

SCIPgetNTables()

SCIP_EXPORT int SCIPgetNTables

(

SCIP *

scip

)

returns the number of currently available statistics tables

Parameters

scip	SCIP data structure

Definition at line 108 of file scip_table.c.

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

Referenced by SCIPprintStatistics().