pub_heur.h File Reference

Detailed Description

public methods for primal heuristics

Author

Tobias Achterberg

Definition in file pub_heur.h.

#include "scip/def.h"
#include "scip/type_misc.h"
#include "scip/type_heur.h"

Go to the source code of this file.

Functions
	SCIP_DECL_SORTPTRCOMP (SCIPheurComp)
	SCIP_DECL_SORTPTRCOMP (SCIPheurCompName)
SCIP_HEURDATA *	SCIPheurGetData (SCIP_HEUR *heur)
void	SCIPheurSetData (SCIP_HEUR *heur, SCIP_HEURDATA *heurdata)
const char *	SCIPheurGetName (SCIP_HEUR *heur)
const char *	SCIPheurGetDesc (SCIP_HEUR *heur)
char	SCIPheurGetDispchar (SCIP_HEUR *heur)
SCIP_HEURTIMING	SCIPheurGetTimingmask (SCIP_HEUR *heur)
void	SCIPheurSetTimingmask (SCIP_HEUR *heur, SCIP_HEURTIMING timingmask)
SCIP_Bool	SCIPheurUsesSubscip (SCIP_HEUR *heur)
int	SCIPheurGetPriority (SCIP_HEUR *heur)
int	SCIPheurGetFreq (SCIP_HEUR *heur)
void	SCIPheurSetFreq (SCIP_HEUR *heur, int freq)
int	SCIPheurGetFreqofs (SCIP_HEUR *heur)
int	SCIPheurGetMaxdepth (SCIP_HEUR *heur)
SCIP_Longint	SCIPheurGetNCalls (SCIP_HEUR *heur)
SCIP_Longint	SCIPheurGetNSolsFound (SCIP_HEUR *heur)
SCIP_Longint	SCIPheurGetNBestSolsFound (SCIP_HEUR *heur)
SCIP_Bool	SCIPheurIsInitialized (SCIP_HEUR *heur)
SCIP_Real	SCIPheurGetSetupTime (SCIP_HEUR *heur)
SCIP_Real	SCIPheurGetTime (SCIP_HEUR *heur)

Function Documentation

SCIP_DECL_SORTPTRCOMP

(

SCIPheurComp

)

compares two heuristics w. r. to their priority

SCIP_DECL_SORTPTRCOMP

(

SCIPheurCompName

)

comparison method for sorting heuristics w.r.t. to their name

SCIP_HEURDATA* SCIPheurGetData

(

SCIP_HEUR *

heur

)

gets user data of primal heuristic

Parameters

heur	primal heuristic

void SCIPheurSetData	(	SCIP_HEUR *	heur,
		SCIP_HEURDATA *	heurdata
	)

sets user data of primal heuristic; user has to free old data in advance!

Parameters

heur	primal heuristic
heurdata	new primal heuristic user data

const char* SCIPheurGetName

(

SCIP_HEUR *

heur

)

gets name of primal heuristic

Parameters

heur	primal heuristic

const char* SCIPheurGetDesc

(

SCIP_HEUR *

heur

)

gets description of primal heuristic

Parameters

heur	primal heuristic

char SCIPheurGetDispchar

(

SCIP_HEUR *

heur

)

gets display character of primal heuristic

Parameters

heur	primal heuristic

SCIP_HEURTIMING SCIPheurGetTimingmask

(

SCIP_HEUR *

heur

)

returns the timing mask of the heuristic

Parameters

heur	primal heuristic

void SCIPheurSetTimingmask	(	SCIP_HEUR *	heur,
		SCIP_HEURTIMING	timingmask
	)

sets new timing mask for heuristic

Parameters

heur	primal heuristic
timingmask	new timing mask of heuristic

SCIP_Bool SCIPheurUsesSubscip

(

SCIP_HEUR *

heur

)

does the heuristic use a secondary SCIP instance?

Parameters

heur	primal heuristic

int SCIPheurGetPriority

(

SCIP_HEUR *

heur

)

gets priority of primal heuristic

Parameters

heur	primal heuristic

int SCIPheurGetFreq

(

SCIP_HEUR *

heur

)

gets frequency of primal heuristic

Parameters

heur	primal heuristic

void SCIPheurSetFreq	(	SCIP_HEUR *	heur,
		int	freq
	)

sets frequency of primal heuristic

Parameters

heur	primal heuristic
freq	new frequency of heuristic

int SCIPheurGetFreqofs

(

SCIP_HEUR *

heur

)

gets frequency offset of primal heuristic

Parameters

heur	primal heuristic

int SCIPheurGetMaxdepth

(

SCIP_HEUR *

heur

)

gets maximal depth level for calling primal heuristic (returns -1, if no depth limit exists)

Parameters

heur	primal heuristic

SCIP_Longint SCIPheurGetNCalls

(

SCIP_HEUR *

heur

)

gets the number of times, the heuristic was called and tried to find a solution

Parameters

heur	primal heuristic

SCIP_Longint SCIPheurGetNSolsFound

(

SCIP_HEUR *

heur

)

gets the number of primal feasible solutions found by this heuristic

Parameters

heur	primal heuristic

SCIP_Longint SCIPheurGetNBestSolsFound

(

SCIP_HEUR *

heur

)

gets the number of new best primal feasible solutions found by this heuristic

Parameters

heur	primal heuristic

SCIP_Bool SCIPheurIsInitialized

(

SCIP_HEUR *

heur

)

is primal heuristic initialized?

Parameters

heur	primal heuristic

SCIP_Real SCIPheurGetSetupTime

(

SCIP_HEUR *

heur

)

gets time in seconds used in this heuristic for setting up for next stages

Parameters

heur	primal heuristic

SCIP_Real SCIPheurGetTime

(

SCIP_HEUR *

heur

)

gets time in seconds used in this heuristic

Parameters

heur	primal heuristic