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"

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)

SCIP_DIVESET **	SCIPheurGetDivesets (SCIP_HEUR *heur)

int	SCIPheurGetNDivesets (SCIP_HEUR *heur)

SCIP_HEUR *	SCIPdivesetGetHeur (SCIP_DIVESET *diveset)

SCIP_SOL *	SCIPdivesetGetWorkSolution (SCIP_DIVESET *diveset)

void	SCIPdivesetSetWorkSolution (SCIP_DIVESET diveset, SCIP_SOL sol)

const char *	SCIPdivesetGetName (SCIP_DIVESET *diveset)

SCIP_Real	SCIPdivesetGetMinRelDepth (SCIP_DIVESET *diveset)

SCIP_Real	SCIPdivesetGetMaxRelDepth (SCIP_DIVESET *diveset)

SCIP_Longint	SCIPdivesetGetSolSuccess (SCIP_DIVESET *diveset)

int	SCIPdivesetGetNCalls (SCIP_DIVESET *diveset)

int	SCIPdivesetGetNSolutionCalls (SCIP_DIVESET *diveset)

int	SCIPdivesetGetMinDepth (SCIP_DIVESET *diveset)

int	SCIPdivesetGetMaxDepth (SCIP_DIVESET *diveset)

SCIP_Real	SCIPdivesetGetAvgDepth (SCIP_DIVESET *diveset)

int	SCIPdivesetGetMinSolutionDepth (SCIP_DIVESET *diveset)

int	SCIPdivesetGetMaxSolutionDepth (SCIP_DIVESET *diveset)

SCIP_Real	SCIPdivesetGetAvgSolutionDepth (SCIP_DIVESET *diveset)

SCIP_Longint	SCIPdivesetGetNLPIterations (SCIP_DIVESET *diveset)

SCIP_Longint	SCIPdivesetGetNProbingNodes (SCIP_DIVESET *diveset)

SCIP_Longint	SCIPdivesetGetNBacktracks (SCIP_DIVESET *diveset)

SCIP_Real	SCIPdivesetGetMaxLPIterQuot (SCIP_DIVESET *diveset)

int	SCIPdivesetGetMaxLPIterOffset (SCIP_DIVESET *diveset)

SCIP_Real	SCIPdivesetGetUbQuotNoSol (SCIP_DIVESET *diveset)

SCIP_Real	SCIPdivesetGetAvgQuotNoSol (SCIP_DIVESET *diveset)

SCIP_Real	SCIPdivesetGetUbQuot (SCIP_DIVESET *diveset)

SCIP_Real	SCIPdivesetGetAvgQuot (SCIP_DIVESET *diveset)

SCIP_Bool	SCIPdivesetUseBacktrack (SCIP_DIVESET *diveset)

int	SCIPdivesetGetLPSolveFreq (SCIP_DIVESET *diveset)

SCIP_Real	SCIPdivesetGetLPResolveDomChgQuot (SCIP_DIVESET *diveset)

SCIP_Bool	SCIPdivesetUseOnlyLPBranchcands (SCIP_DIVESET *diveset)

SCIP_Bool	SCIPdivesetSupportsType (SCIP_DIVESET *diveset, SCIP_DIVETYPE divetype)

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

SCIP_DIVESET** SCIPheurGetDivesets ( SCIP_HEUR * heur )

returns array of divesets of this primal heuristic, or NULL if it has no divesets

Parameters

heur	primal heuristic

int SCIPheurGetNDivesets ( SCIP_HEUR * heur )

returns the number of divesets of this primal heuristic

Parameters

heur	primal heuristic

SCIP_HEUR* SCIPdivesetGetHeur ( SCIP_DIVESET * diveset )

get the heuristic to which this diving setting belongs

Parameters

diveset diving settings

SCIP_SOL* SCIPdivesetGetWorkSolution ( SCIP_DIVESET * diveset )

get the working solution of this dive set

Parameters

diveset diving settings

void SCIPdivesetSetWorkSolution	(	SCIP_DIVESET *	diveset,
		SCIP_SOL *	sol
	)

set the working solution for this dive set

Parameters

diveset	diving settings
sol	new working solution for this dive set, or NULL

const char* SCIPdivesetGetName ( SCIP_DIVESET * diveset )

get the name of the dive set

Parameters

diveset diving settings

SCIP_Real SCIPdivesetGetMinRelDepth ( SCIP_DIVESET * diveset )

get the minimum relative depth of the diving settings

Parameters

diveset diving settings

SCIP_Real SCIPdivesetGetMaxRelDepth ( SCIP_DIVESET * diveset )

get the maximum relative depth of the diving settings

Parameters

diveset diving settings

SCIP_Longint SCIPdivesetGetSolSuccess ( SCIP_DIVESET * diveset )

get the number of successful runs of the diving settings

Parameters

diveset diving settings

int SCIPdivesetGetNCalls ( SCIP_DIVESET * diveset )

get the number of calls to this dive set

Parameters

diveset diving settings

int SCIPdivesetGetNSolutionCalls ( SCIP_DIVESET * diveset )

get the number of calls successfully terminated at a feasible leaf node

Parameters

diveset diving settings

int SCIPdivesetGetMinDepth ( SCIP_DIVESET * diveset )

get the minimum depth reached by this dive set

Parameters

diveset diving settings

int SCIPdivesetGetMaxDepth ( SCIP_DIVESET * diveset )

get the maximum depth reached by this dive set

Parameters

diveset diving settings

SCIP_Real SCIPdivesetGetAvgDepth ( SCIP_DIVESET * diveset )

get the average depth this dive set reached during execution

Parameters

diveset diving settings

int SCIPdivesetGetMinSolutionDepth ( SCIP_DIVESET * diveset )

get the minimum depth at which this dive set found a solution

Parameters

diveset diving settings

int SCIPdivesetGetMaxSolutionDepth ( SCIP_DIVESET * diveset )

get the maximum depth at which this dive set found a solution

Parameters

diveset diving settings

SCIP_Real SCIPdivesetGetAvgSolutionDepth ( SCIP_DIVESET * diveset )

get the average depth at which this dive set found a solution

Parameters

diveset diving settings

SCIP_Longint SCIPdivesetGetNLPIterations ( SCIP_DIVESET * diveset )

get the total number of LP iterations used by this dive set

Parameters

diveset diving settings

SCIP_Longint SCIPdivesetGetNProbingNodes ( SCIP_DIVESET * diveset )

get the total number of probing nodes used by this dive set

Parameters

diveset diving settings

SCIP_Longint SCIPdivesetGetNBacktracks ( SCIP_DIVESET * diveset )

get the total number of backtracks performed by this dive set

Parameters

diveset diving settings

SCIP_Real SCIPdivesetGetMaxLPIterQuot ( SCIP_DIVESET * diveset )

get the maximum LP iterations quotient of the diving settings

Parameters

diveset diving settings

int SCIPdivesetGetMaxLPIterOffset ( SCIP_DIVESET * diveset )

get the maximum LP iterations offset of the diving settings

Parameters

diveset diving settings

SCIP_Real SCIPdivesetGetUbQuotNoSol ( SCIP_DIVESET * diveset )

get the maximum upper bound quotient parameter of the diving settings if no solution is available

Parameters

diveset diving settings

SCIP_Real SCIPdivesetGetAvgQuotNoSol ( SCIP_DIVESET * diveset )

get the average quotient parameter of the diving settings if no solution is available

Parameters

diveset diving settings

SCIP_Real SCIPdivesetGetUbQuot ( SCIP_DIVESET * diveset )

get the maximum upper bound quotient parameter of the diving settings if an incumbent solution exists

Parameters

diveset diving settings

SCIP_Real SCIPdivesetGetAvgQuot ( SCIP_DIVESET * diveset )

get the average upper bound quotient parameter of the diving settings if an incumbent solution exists

Parameters

diveset diving settings

SCIP_Bool SCIPdivesetUseBacktrack ( SCIP_DIVESET * diveset )

should backtracking be applied?

Parameters

diveset diving settings

int SCIPdivesetGetLPSolveFreq ( SCIP_DIVESET * diveset )

returns the LP solve frequency for diving LPs (0: dynamically based on number of intermediate domain reductions)

Parameters

diveset diving settings

SCIP_Real SCIPdivesetGetLPResolveDomChgQuot ( SCIP_DIVESET * diveset )

returns the domain reduction quotient for triggering an immediate resolve of the diving LP (0.0: always resolve)

Parameters

diveset diving settings

SCIP_Bool SCIPdivesetUseOnlyLPBranchcands ( SCIP_DIVESET * diveset )

should only LP branching candidates be considered instead of the slower but more general constraint handler diving variable selection?

Parameters

diveset diving settings

SCIP_Bool SCIPdivesetSupportsType	(	SCIP_DIVESET *	diveset,
		SCIP_DIVETYPE	divetype
	)

returns TRUE if dive set supports diving of the specified type

Parameters

diveset	diving settings
divetype	bit mask that represents the supported dive types by this dive set

SCIP

Detailed Description

Functions

Function Documentation