objpresol.cpp File Reference

Detailed Description

C++ wrapper for presolvers.

Author

Tobias Achterberg

Definition in file objpresol.cpp.

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

Go to the source code of this file.

Functions
static	SCIP_DECL_PRESOLCOPY (presolCopyObj)
static	SCIP_DECL_PRESOLFREE (presolFreeObj)
static	SCIP_DECL_PRESOLINIT (presolInitObj)
static	SCIP_DECL_PRESOLEXIT (presolExitObj)
static	SCIP_DECL_PRESOLINITPRE (presolInitpreObj)
static	SCIP_DECL_PRESOLEXITPRE (presolExitpreObj)
static	SCIP_DECL_PRESOLEXEC (presolExecObj)
SCIP_RETCODE	SCIPincludeObjPresol (SCIP *scip, scip::ObjPresol *objpresol, SCIP_Bool deleteobject)
scip::ObjPresol *	SCIPfindObjPresol (SCIP *scip, const char *name)
scip::ObjPresol *	SCIPgetObjPresol (SCIP *scip, SCIP_PRESOL *presol)

Function Documentation

SCIP_DECL_PRESOLCOPY()

SCIP_DECL_PRESOLCOPY ( presolCopyObj )

static

copy method for presolver plugins (called when SCIP copies plugins)

Definition at line 62 of file objpresol.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, SCIPincludeObjPresol(), SCIPpresolGetData(), and TRUE.

SCIP_DECL_PRESOLFREE()

SCIP_DECL_PRESOLFREE ( presolFreeObj )

static

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

Definition at line 87 of file objpresol.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, SCIPpresolGetData(), and SCIPpresolSetData().

SCIP_DECL_PRESOLINIT()

SCIP_DECL_PRESOLINIT ( presolInitObj )

static

initialization method of presolver (called after problem was transformed)

Definition at line 113 of file objpresol.cpp.

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

SCIP_DECL_PRESOLEXIT()

SCIP_DECL_PRESOLEXIT ( presolExitObj )

static

deinitialization method of presolver (called before transformed problem is freed)

Definition at line 131 of file objpresol.cpp.

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

SCIP_DECL_PRESOLINITPRE()

SCIP_DECL_PRESOLINITPRE ( presolInitpreObj )

static

presolving initialization method of presolver (called when presolving is about to begin)

Definition at line 148 of file objpresol.cpp.

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

SCIP_DECL_PRESOLEXITPRE()

SCIP_DECL_PRESOLEXITPRE ( presolExitpreObj )

static

presolving deinitialization method of presolver (called after presolving has been finished)

Definition at line 165 of file objpresol.cpp.

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

SCIP_DECL_PRESOLEXEC()

SCIP_DECL_PRESOLEXEC ( presolExecObj )

static

execution method of presolver

Definition at line 182 of file objpresol.cpp.

References assert(), NULL, result, SCIP_CALL, SCIP_OKAY, and SCIPpresolGetData().

SCIPincludeObjPresol()

SCIP_RETCODE SCIPincludeObjPresol	(	SCIP *	scip,
		scip::ObjPresol *	objpresol,
		SCIP_Bool	deleteobject )

creates the presolver for the given presolver object and includes it in SCIP

creates the presolver for the given presolver 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) ); ... MyPresol* mypresol = new MyPresol(...); SCIP_CALL( SCIPincludeObjPresol(scip, &mypresol, FALSE) ); ... SCIP_CALL( SCIPfree(&scip) ); delete mypresol; // delete presol AFTER SCIPfree() !
2. The object pointer is passed to SCIP and deleted by SCIP in the SCIPfree() call: SCIP_CALL( SCIPcreate(&scip) ); ... SCIP_CALL( SCIPincludeObjPresol(scip, new MyPresol(...), TRUE) ); ... SCIP_CALL( SCIPfree(&scip) ); // destructor of MyPresol is called here

Parameters

scip	SCIP data structure
objpresol	presolver object
deleteobject	should the presolver object be deleted when presolver is freed?

Definition at line 208 of file objpresol.cpp.

References assert(), NULL, SCIP_Bool, SCIP_CALL, scip::ObjPresol::scip_desc_, scip::ObjPresol::scip_maxrounds_, scip::ObjPresol::scip_name_, SCIP_OKAY, scip::ObjPresol::scip_priority_, scip::ObjPresol::scip_timing_, and SCIPincludePresol().

Referenced by SCIP_DECL_PRESOLCOPY().

SCIPfindObjPresol()

scip::ObjPresol * SCIPfindObjPresol	(	SCIP *	scip,
		const char *	name )

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

Parameters

scip	SCIP data structure
name	name of presolver

Definition at line 235 of file objpresol.cpp.

References assert(), NULL, SCIPfindPresol(), and SCIPpresolGetData().

SCIPgetObjPresol()

scip::ObjPresol * SCIPgetObjPresol	(	SCIP *	scip,
		SCIP_PRESOL *	presol )

returns the presol object for the given presolver

Parameters

scip	SCIP data structure
presol	presolver

Definition at line 254 of file objpresol.cpp.

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