objheur.cpp File Reference

Detailed Description

C++ wrapper for primal heuristics.

Author

Tobias Achterberg

Definition in file objheur.cpp.

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

Go to the source code of this file.

Functions
static	SCIP_DECL_HEURCOPY (heurCopyObj)
static	SCIP_DECL_HEURFREE (heurFreeObj)
static	SCIP_DECL_HEURINIT (heurInitObj)
static	SCIP_DECL_HEUREXIT (heurExitObj)
static	SCIP_DECL_HEURINITSOL (heurInitsolObj)
static	SCIP_DECL_HEUREXITSOL (heurExitsolObj)
static	SCIP_DECL_HEUREXEC (heurExecObj)
SCIP_RETCODE	SCIPincludeObjHeur (SCIP *scip, scip::ObjHeur *objheur, SCIP_Bool deleteobject)
scip::ObjHeur *	SCIPfindObjHeur (SCIP *scip, const char *name)
scip::ObjHeur *	SCIPgetObjHeur (SCIP *scip, SCIP_HEUR *heur)

Function Documentation

SCIP_DECL_HEURCOPY()

SCIP_DECL_HEURCOPY ( heurCopyObj )

static

copy method for primal heuristic plugins (called when SCIP copies plugins)

Definition at line 62 of file objheur.cpp.

References assert(), heurdata, NULL, SCIP_CALL, SCIP_OKAY, SCIPheurGetData(), SCIPincludeObjHeur(), and TRUE.

SCIP_DECL_HEURFREE()

SCIP_DECL_HEURFREE ( heurFreeObj )

static

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

Definition at line 87 of file objheur.cpp.

References assert(), heurdata, NULL, SCIP_CALL, SCIP_OKAY, SCIPheurGetData(), and SCIPheurSetData().

SCIP_DECL_HEURINIT()

SCIP_DECL_HEURINIT ( heurInitObj )

static

initialization method of primal heuristic (called after problem was transformed)

Definition at line 113 of file objheur.cpp.

References assert(), heurdata, NULL, SCIP_CALL, SCIP_OKAY, and SCIPheurGetData().

SCIP_DECL_HEUREXIT()

SCIP_DECL_HEUREXIT ( heurExitObj )

static

deinitialization method of primal heuristic (called before transformed problem is freed)

Definition at line 131 of file objheur.cpp.

References assert(), heurdata, NULL, SCIP_CALL, SCIP_OKAY, and SCIPheurGetData().

SCIP_DECL_HEURINITSOL()

SCIP_DECL_HEURINITSOL ( heurInitsolObj )

static

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

Definition at line 148 of file objheur.cpp.

References assert(), heurdata, NULL, SCIP_CALL, SCIP_OKAY, and SCIPheurGetData().

SCIP_DECL_HEUREXITSOL()

SCIP_DECL_HEUREXITSOL ( heurExitsolObj )

static

solving process deinitialization method of primal heuristic (called before branch and bound process data is freed)

Definition at line 165 of file objheur.cpp.

References assert(), heurdata, NULL, SCIP_CALL, SCIP_OKAY, and SCIPheurGetData().

SCIP_DECL_HEUREXEC()

SCIP_DECL_HEUREXEC ( heurExecObj )

static

execution method of primal heuristic

Definition at line 182 of file objheur.cpp.

References assert(), heurdata, NULL, result, SCIP_CALL, SCIP_OKAY, and SCIPheurGetData().

SCIPincludeObjHeur()

SCIP_RETCODE SCIPincludeObjHeur	(	SCIP *	scip,
		scip::ObjHeur *	objheur,
		SCIP_Bool	deleteobject )

creates the primal heuristic for the given primal heuristic object and includes it in SCIP

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

Parameters

scip	SCIP data structure
objheur	primal heuristic object
deleteobject	should the primal heuristic object be deleted when heuristic is freed?

Definition at line 204 of file objheur.cpp.

References assert(), heurdata, NULL, SCIP_Bool, SCIP_CALL, scip::ObjHeur::scip_desc_, scip::ObjHeur::scip_dispchar_, scip::ObjHeur::scip_freq_, scip::ObjHeur::scip_freqofs_, scip::ObjHeur::scip_maxdepth_, scip::ObjHeur::scip_name_, SCIP_OKAY, scip::ObjHeur::scip_priority_, scip::ObjHeur::scip_timingmask_, scip::ObjHeur::scip_usessubscip_, and SCIPincludeHeur().

Referenced by runSCIP(), and SCIP_DECL_HEURCOPY().

SCIPfindObjHeur()

scip::ObjHeur * SCIPfindObjHeur	(	SCIP *	scip,
		const char *	name )

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

Parameters

scip	SCIP data structure
name	name of primal heuristic

Definition at line 233 of file objheur.cpp.

References assert(), heurdata, NULL, SCIPfindHeur(), and SCIPheurGetData().

SCIPgetObjHeur()

scip::ObjHeur * SCIPgetObjHeur	(	SCIP *	scip,
		SCIP_HEUR *	heur )

returns the heur object for the given primal heuristic

Parameters

scip	SCIP data structure
heur	primal heuristic

Definition at line 252 of file objheur.cpp.

References assert(), heurdata, NULL, and SCIPheurGetData().