Scippy

SCIP

Solving Constraint Integer Programs

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

static SCIP_DECL_HEURCOPY ( heurCopyObj )

static

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

Definition at line 53 of file objheur.cpp.

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

◆ SCIP_DECL_HEURFREE()

static SCIP_DECL_HEURFREE ( heurFreeObj )

static

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

Definition at line 78 of file objheur.cpp.

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

◆ SCIP_DECL_HEURINIT()

static SCIP_DECL_HEURINIT ( heurInitObj )

static

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

Definition at line 104 of file objheur.cpp.

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

◆ SCIP_DECL_HEUREXIT()

static SCIP_DECL_HEUREXIT ( heurExitObj )

static

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

Definition at line 122 of file objheur.cpp.

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

◆ SCIP_DECL_HEURINITSOL()

static 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 139 of file objheur.cpp.

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

◆ SCIP_DECL_HEUREXITSOL()

static SCIP_DECL_HEUREXITSOL ( heurExitsolObj )

static

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

Definition at line 156 of file objheur.cpp.

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

◆ SCIP_DECL_HEUREXEC()

static SCIP_DECL_HEUREXEC ( heurExecObj )

static

execution method of primal heuristic

Definition at line 173 of file objheur.cpp.

References NULL, 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

Parameters

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

Definition at line 195 of file objheur.cpp.

References NULL, 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(), SCIP_DECL_HEURCOPY(), and scip::ObjHeur::SCIP_DECL_HEUREXITSOL().

◆ 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 224 of file objheur.cpp.

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

Referenced by scip::ObjHeur::SCIP_DECL_HEUREXITSOL().

◆ 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 243 of file objheur.cpp.

References NULL, and SCIPheurGetData().

Referenced by scip::ObjHeur::SCIP_DECL_HEUREXITSOL().