Scippy

SCIP

Solving Constraint Integer Programs

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::ObjHeurSCIPfindObjHeur (SCIP *scip, const char *name)
 
scip::ObjHeurSCIPgetObjHeur (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
scipSCIP data structure
objheurprimal heuristic object
deleteobjectshould the primal heuristic object be deleted when heuristic is freed?

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

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

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

Parameters
scipSCIP data structure
namename of primal heuristic

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

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

returns the heur object for the given primal heuristic

Parameters
scipSCIP data structure
heurprimal heuristic

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