objheur.h File Reference

Detailed Description

C++ wrapper for primal heuristics.

Author

Tobias Achterberg

Definition in file objheur.h.

#include <cstring>
#include "scip/scip.h"
#include "objscip/objcloneable.h"

Go to the source code of this file.

Functions
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_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

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

1. The user is resposible 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?

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

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