scip::ObjTable Class Reference

Detailed Description

C++ wrapper for statistics tables.

This class defines the interface for statistics tables implemented in C++. Note that there is a pure virtual function (this function has to be implemented). This function is: scip_output().

• Instructions for implementing a statistics table
• List of available statistics tables
• Corresponding C interface

Definition at line 43 of file objtable.h.

C++ wrapper for statistics tables. More...

#include <objtable.h>

Public Member Functions
	ObjTable (SCIP *scip, const char *name, const char *desc, int position, SCIP_STAGE earlieststage)
virtual	~ObjTable ()
virtual	SCIP_DECL_TABLEFREE (scip_free)
virtual	SCIP_DECL_TABLEINIT (scip_init)
virtual	SCIP_DECL_TABLEEXIT (scip_exit)
virtual	SCIP_DECL_TABLEINITSOL (scip_initsol)
virtual	SCIP_DECL_TABLEEXITSOL (scip_exitsol)
virtual	SCIP_DECL_TABLEOUTPUT (scip_output)=0
Public Member Functions inherited from scip::ObjCloneable
virtual	~ObjCloneable ()
virtual	SCIP_DECL_OBJCLONEABLECLONE (ObjCloneable *clone)
virtual	SCIP_DECL_OBJCLONEABLEISCLONEABLE (iscloneable)

Data Fields
SCIP *	scip_
char *	scip_name_
char *	scip_desc_
const int	scip_position_
SCIP_STAGE	scip_earlieststage_

Constructor & Destructor Documentation

ObjTable()

scip::ObjTable::ObjTable ( SCIP *  scip, const char *  name, const char *  desc, int  position, SCIP_STAGE  earlieststage  )

inline

default constructor

Parameters

scip	SCIP data structure
name	name of statistics table
desc	description of statistics table
position	position of statistics table
earlieststage	output of the statistics table is only printed from this stage onwards

Definition at line 64 of file objtable.h.

References SCIP_CALL_ABORT, and SCIPduplicateMemoryArray.

~ObjTable()

virtual scip::ObjTable::~ObjTable ( )

inlinevirtual

destructor

Definition at line 83 of file objtable.h.

References SCIPfreeMemoryArray.

Member Function Documentation

SCIP_DECL_TABLEFREE()

virtual scip::ObjTable::SCIP_DECL_TABLEFREE ( scip_free  )

inlinevirtual

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

See also

SCIP_DECL_TABLEFREE(x) in type_disp.h

Definition at line 95 of file objtable.h.

References SCIP_OKAY.

SCIP_DECL_TABLEINIT()

virtual scip::ObjTable::SCIP_DECL_TABLEINIT ( scip_init  )

inlinevirtual

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

See also

SCIP_DECL_TABLEINIT(x) in type_table.h

Definition at line 104 of file objtable.h.

References SCIP_OKAY.

SCIP_DECL_TABLEEXIT()

virtual scip::ObjTable::SCIP_DECL_TABLEEXIT ( scip_exit  )

inlinevirtual

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

See also

SCIP_DECL_TABLEEXIT(x) in type_table.h

Definition at line 113 of file objtable.h.

References SCIP_OKAY.

SCIP_DECL_TABLEINITSOL()

virtual scip::ObjTable::SCIP_DECL_TABLEINITSOL ( scip_initsol  )

inlinevirtual

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

See also

SCIP_DECL_TABLEINITSOL(x) in type_table.h

Definition at line 122 of file objtable.h.

References SCIP_OKAY.

SCIP_DECL_TABLEEXITSOL()

virtual scip::ObjTable::SCIP_DECL_TABLEEXITSOL ( scip_exitsol  )

inlinevirtual

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

See also

SCIP_DECL_TABLEEXITSOL(x) in type_table.h

Definition at line 131 of file objtable.h.

References SCIP_Bool, SCIP_DECL_TABLEOUTPUT(), SCIP_EXPORT, SCIP_OKAY, SCIPfindObjTable(), SCIPgetObjTable(), and SCIPincludeObjTable().

SCIP_DECL_TABLEOUTPUT()

virtual scip::ObjTable::SCIP_DECL_TABLEOUTPUT ( scip_output  )

pure virtual

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

See also

SCIP_DECL_TABLEOUTPUT(x) in type_table.h

Referenced by SCIP_DECL_TABLEEXITSOL().

Field Documentation

scip_

SCIP* scip::ObjTable::scip_

SCIP data structure

Definition at line 49 of file objtable.h.

scip_name_

char* scip::ObjTable::scip_name_

name of the statistics tables

Definition at line 52 of file objtable.h.

Referenced by SCIPincludeObjTable().

scip_desc_

char* scip::ObjTable::scip_desc_

description of the statistics table

Definition at line 55 of file objtable.h.

Referenced by SCIPincludeObjTable().

scip_position_

const int scip::ObjTable::scip_position_

position of the statistics table

Definition at line 58 of file objtable.h.

Referenced by SCIPincludeObjTable().

scip_earlieststage_

SCIP_STAGE scip::ObjTable::scip_earlieststage_

output of the statistics table is only printed from this stage onwards

Definition at line 61 of file objtable.h.

Referenced by SCIPincludeObjTable().