SCIP Doxygen Documentation
Loading...
Searching...
No Matches
objtable.cpp File Reference

Detailed Description

C++ wrapper for statistics tables.

Author
Tristan Gally

Definition in file objtable.cpp.

#include <cassert>
#include "objtable.h"

Go to the source code of this file.

Namespaces

namespace  scip

Functions

 scip::SCIP_DECL_TABLEOUTPUT (ObjTable::scip_output)
static SCIP_DECL_TABLECOPY (tableCopyObj)
static SCIP_DECL_TABLEFREE (tableFreeObj)
static SCIP_DECL_TABLEINIT (tableInitObj)
static SCIP_DECL_TABLEEXIT (tableExitObj)
static SCIP_DECL_TABLEINITSOL (tableInitsolObj)
static SCIP_DECL_TABLEEXITSOL (tableExitsolObj)
static SCIP_DECL_TABLEOUTPUT (tableOutputObj)
static SCIP_DECL_TABLECOLLECT (tableCollectObj)
SCIP_RETCODE SCIPincludeObjTable (SCIP *scip, scip::ObjTable *objtable, SCIP_Bool deleteobject)
scip::ObjTable * SCIPfindObjTable (SCIP *scip, const char *name)
scip::ObjTable * SCIPgetObjTable (SCIP *scip, SCIP_TABLE *table)

Function Documentation

◆ SCIP_DECL_TABLECOPY()

SCIP_DECL_TABLECOPY ( tableCopyObj )
static

copy method for statistics table plugins (called when SCIP copies plugins)

Definition at line 80 of file objtable.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, SCIPincludeObjTable(), SCIPtableGetData(), and TRUE.

◆ SCIP_DECL_TABLEFREE()

SCIP_DECL_TABLEFREE ( tableFreeObj )
static

destructor of statistics table to free user data (called when SCIP is exiting)

Definition at line 105 of file objtable.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, SCIPtableGetData(), and SCIPtableSetData().

◆ SCIP_DECL_TABLEINIT()

SCIP_DECL_TABLEINIT ( tableInitObj )
static

initialization method of statistics table (called after problem was transformed)

Definition at line 131 of file objtable.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPtableGetData().

◆ SCIP_DECL_TABLEEXIT()

SCIP_DECL_TABLEEXIT ( tableExitObj )
static

deinitialization method of statistics table (called before transformed problem is freed)

Definition at line 149 of file objtable.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPtableGetData().

◆ SCIP_DECL_TABLEINITSOL()

SCIP_DECL_TABLEINITSOL ( tableInitsolObj )
static

solving process initialization method of statistics table (called when branch and bound process is about to begin)

Definition at line 166 of file objtable.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPtableGetData().

◆ SCIP_DECL_TABLEEXITSOL()

SCIP_DECL_TABLEEXITSOL ( tableExitsolObj )
static

solving process deinitialization method of statistics table (called before branch and bound process data is freed)

Definition at line 183 of file objtable.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPtableGetData().

◆ SCIP_DECL_TABLEOUTPUT()

SCIP_DECL_TABLEOUTPUT ( tableOutputObj )
static

output method of statistics table to output file stream 'file'

Definition at line 200 of file objtable.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPtableGetData().

◆ SCIP_DECL_TABLECOLLECT()

SCIP_DECL_TABLECOLLECT ( tableCollectObj )
static

data collection method

Definition at line 216 of file objtable.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPtableGetData().

◆ SCIPincludeObjTable()

SCIP_RETCODE SCIPincludeObjTable ( SCIP * scip,
scip::ObjTable * objtable,
SCIP_Bool deleteobject )

creates the statistics table for the given statistics table object and includes it in SCIP

creates the statistics table for the given statistics table object and includes it in SCIP

The method should be called in one of the following ways:

  1. The user is responsible of deleting the object: SCIP_CALL( SCIPcreate(&scip) ); ... MyTable* mytable = new MyTable(...); SCIP_CALL( SCIPincludeObjTable(scip, &mytable, FALSE) ); ... SCIP_CALL( SCIPfree(&scip) ); delete mytable; // delete table AFTER SCIPfree() !
  2. The object pointer is passed to SCIP and deleted by SCIP in the SCIPfree() call: SCIP_CALL( SCIPcreate(&scip) ); ... SCIP_CALL( SCIPincludeObjTable(scip, new MyTable(...), TRUE) ); ... SCIP_CALL( SCIPfree(&scip) ); // destructor of MyTable is called here
Parameters
scipSCIP data structure
objtablestatistics table object
deleteobjectshould the statistics table object be deleted when statistics table is freed?

Definition at line 239 of file objtable.cpp.

References assert(), NULL, SCIP_Bool, SCIP_CALL, scip::ObjTable::scip_desc_, scip::ObjTable::scip_earlieststage_, scip::ObjTable::scip_name_, SCIP_OKAY, scip::ObjTable::scip_position_, SCIPincludeTable(), and TRUE.

Referenced by SCIP_DECL_TABLECOPY().

◆ SCIPfindObjTable()

scip::ObjTable * SCIPfindObjTable ( SCIP * scip,
const char * name )

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

Parameters
scipSCIP data structure
namename of statistics table

Definition at line 264 of file objtable.cpp.

References assert(), NULL, SCIPfindTable(), and SCIPtableGetData().

◆ SCIPgetObjTable()

scip::ObjTable * SCIPgetObjTable ( SCIP * scip,
SCIP_TABLE * table )

returns the statistics table object for the given statistics table

Parameters
scipSCIP data structure
tablestatistics table

Definition at line 283 of file objtable.cpp.

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