Scippy

SCIP

Solving Constraint Integer Programs

SCIP_Diveset Struct Reference

Detailed Description

common settings for diving heuristics

Definition at line 37 of file struct_heur.h.

#include <struct_heur.h>

Public Member Functions

 SCIP_DECL_DIVESETGETSCORE ((*divesetgetscore))
 

Data Fields

SCIP_HEURheur
 
char * name
 
SCIP_SOLsol
 
BMS_BLKMEMblkmem
 
SCIP_RANDNUMGENrandnumgen
 
SCIP_Real minreldepth
 
SCIP_Real maxreldepth
 
SCIP_Real maxlpiterquot
 
SCIP_Real maxdiveubquot
 
SCIP_Real maxdiveavgquot
 
SCIP_Real maxdiveubquotnosol
 
SCIP_Real maxdiveavgquotnosol
 
SCIP_Real lpresolvedomchgquot
 
SCIP_Longint nlpiterations
 
SCIP_Longint nlps
 
SCIP_Longint totaldepth
 
SCIP_Longint totalsoldepth
 
SCIP_Longint totalnnodes
 
SCIP_Longint totalnbacktracks
 
SCIP_Longint nsolsfound
 
SCIP_Longint nbestsolsfound
 
int maxlpiterofs
 
int mindepth
 
int maxdepth
 
int minsoldepth
 
int maxsoldepth
 
int ncalls
 
int nsolcalls
 
int lpsolvefreq
 
unsigned int initialseed
 
SCIP_Bool backtrack
 
SCIP_Bool onlylpbranchcands
 
SCIP_DIVETYPE divetypemask
 

Member Function Documentation

◆ SCIP_DECL_DIVESETGETSCORE()

SCIP_Diveset::SCIP_DECL_DIVESETGETSCORE ( divesetgetscore)

method for candidate score and rounding direction

Field Documentation

◆ heur

SCIP_HEUR* SCIP_Diveset::heur

the heuristic to which this dive set belongs

Definition at line 39 of file struct_heur.h.

Referenced by heurAddDiveset(), and SCIPdivesetGetHeur().

◆ name

char* SCIP_Diveset::name

name of dive controller, in case that a heuristic has several

Definition at line 40 of file struct_heur.h.

Referenced by SCIPdivesetGetName().

◆ sol

SCIP_SOL* SCIP_Diveset::sol

working solution of this dive set

Definition at line 41 of file struct_heur.h.

Referenced by SCIPdivesetGetWorkSolution(), and SCIPdivesetSetWorkSolution().

◆ blkmem

BMS_BLKMEM* SCIP_Diveset::blkmem

block memory for parameter settings

Definition at line 42 of file struct_heur.h.

Referenced by SCIPdivesetReset().

◆ randnumgen

SCIP_RANDNUMGEN* SCIP_Diveset::randnumgen

random number generator

Definition at line 43 of file struct_heur.h.

Referenced by SCIPdivesetGetRandnumgen(), and SCIPdivesetReset().

◆ minreldepth

SCIP_Real SCIP_Diveset::minreldepth

minimal relative depth to start diving

Definition at line 44 of file struct_heur.h.

Referenced by SCIPdivesetGetMinRelDepth().

◆ maxreldepth

SCIP_Real SCIP_Diveset::maxreldepth

maximal relative depth to start diving

Definition at line 45 of file struct_heur.h.

Referenced by SCIPdivesetGetMaxRelDepth().

◆ maxlpiterquot

SCIP_Real SCIP_Diveset::maxlpiterquot

maximal fraction of diving LP iterations compared to node LP iterations

Definition at line 46 of file struct_heur.h.

Referenced by SCIPdivesetGetMaxLPIterQuot().

◆ maxdiveubquot

SCIP_Real SCIP_Diveset::maxdiveubquot

maximal quotient (curlowerbound - lowerbound)/(cutoffbound - lowerbound) where diving is performed (0.0: no limit)

Definition at line 47 of file struct_heur.h.

Referenced by SCIPdivesetGetUbQuot().

◆ maxdiveavgquot

SCIP_Real SCIP_Diveset::maxdiveavgquot

maximal quotient (curlowerbound - lowerbound)/(avglowerbound - lowerbound) where diving is performed (0.0: no limit)

Definition at line 49 of file struct_heur.h.

Referenced by SCIPdivesetGetAvgQuot().

◆ maxdiveubquotnosol

SCIP_Real SCIP_Diveset::maxdiveubquotnosol

maximal UBQUOT when no solution was found yet (0.0: no limit)

Definition at line 51 of file struct_heur.h.

Referenced by SCIPdivesetGetUbQuotNoSol().

◆ maxdiveavgquotnosol

SCIP_Real SCIP_Diveset::maxdiveavgquotnosol

maximal AVGQUOT when no solution was found yet (0.0: no limit)

Definition at line 52 of file struct_heur.h.

Referenced by SCIPdivesetGetAvgQuotNoSol().

◆ lpresolvedomchgquot

SCIP_Real SCIP_Diveset::lpresolvedomchgquot

percentage of immediate domain changes during probing to trigger LP resolve

Definition at line 53 of file struct_heur.h.

Referenced by SCIPdivesetGetLPResolveDomChgQuot().

◆ nlpiterations

SCIP_Longint SCIP_Diveset::nlpiterations

LP iterations used in this dive set

Definition at line 54 of file struct_heur.h.

Referenced by SCIPdivesetGetNLPIterations(), SCIPdivesetReset(), and SCIPdivesetUpdateLPStats().

◆ nlps

SCIP_Longint SCIP_Diveset::nlps

the number of LPs solved by this dive set

Definition at line 55 of file struct_heur.h.

Referenced by SCIPdivesetReset(), and SCIPdivesetUpdateLPStats().

◆ totaldepth

SCIP_Longint SCIP_Diveset::totaldepth

the total depth used in this dive set

Definition at line 56 of file struct_heur.h.

Referenced by SCIPdivesetGetAvgDepth(), SCIPdivesetReset(), and SCIPdivesetUpdateStats().

◆ totalsoldepth

SCIP_Longint SCIP_Diveset::totalsoldepth

the sum of depths at which this dive set found solutions

Definition at line 57 of file struct_heur.h.

Referenced by SCIPdivesetGetAvgSolutionDepth(), SCIPdivesetReset(), and SCIPdivesetUpdateStats().

◆ totalnnodes

SCIP_Longint SCIP_Diveset::totalnnodes

the total number of probing nodes explored by this dive set

Definition at line 58 of file struct_heur.h.

Referenced by SCIPdivesetGetNProbingNodes(), SCIPdivesetReset(), and SCIPdivesetUpdateStats().

◆ totalnbacktracks

SCIP_Longint SCIP_Diveset::totalnbacktracks

the total number of backtracks during the execution of this dive set

Definition at line 59 of file struct_heur.h.

Referenced by SCIPdivesetGetNBacktracks(), SCIPdivesetReset(), and SCIPdivesetUpdateStats().

◆ nsolsfound

SCIP_Longint SCIP_Diveset::nsolsfound

the total number of solutions found

Definition at line 60 of file struct_heur.h.

Referenced by SCIPdivesetGetSolSuccess(), SCIPdivesetReset(), and SCIPdivesetUpdateStats().

◆ nbestsolsfound

SCIP_Longint SCIP_Diveset::nbestsolsfound

the total number of best solutions found

Definition at line 61 of file struct_heur.h.

Referenced by SCIPdivesetGetSolSuccess(), SCIPdivesetReset(), and SCIPdivesetUpdateStats().

◆ maxlpiterofs

int SCIP_Diveset::maxlpiterofs

additional number of allowed LP iterations

Definition at line 62 of file struct_heur.h.

Referenced by SCIPdivesetGetMaxLPIterOffset().

◆ mindepth

int SCIP_Diveset::mindepth

the minimum depth reached by all executions of the dive set

Definition at line 63 of file struct_heur.h.

Referenced by SCIPdivesetGetMinDepth(), SCIPdivesetReset(), and SCIPdivesetUpdateStats().

◆ maxdepth

int SCIP_Diveset::maxdepth

the maximum depth reached by an execution of the dive set

Definition at line 64 of file struct_heur.h.

Referenced by SCIPdivesetGetMaxDepth(), SCIPdivesetReset(), and SCIPdivesetUpdateStats().

◆ minsoldepth

int SCIP_Diveset::minsoldepth

the minimum depth at which this dive set found a solution

Definition at line 65 of file struct_heur.h.

Referenced by SCIPdivesetGetMinSolutionDepth(), SCIPdivesetReset(), and SCIPdivesetUpdateStats().

◆ maxsoldepth

int SCIP_Diveset::maxsoldepth

the maximum depth at which this dive set found a solution

Definition at line 66 of file struct_heur.h.

Referenced by SCIPdivesetGetMaxSolutionDepth(), SCIPdivesetReset(), and SCIPdivesetUpdateStats().

◆ ncalls

int SCIP_Diveset::ncalls

the total number of calls of this dive set

Definition at line 67 of file struct_heur.h.

Referenced by SCIPdivesetGetAvgDepth(), SCIPdivesetGetNCalls(), SCIPdivesetReset(), and SCIPdivesetUpdateStats().

◆ nsolcalls

int SCIP_Diveset::nsolcalls

number of calls with a leaf solution

Definition at line 68 of file struct_heur.h.

Referenced by SCIPdivesetGetAvgSolutionDepth(), SCIPdivesetGetNSolutionCalls(), SCIPdivesetReset(), and SCIPdivesetUpdateStats().

◆ lpsolvefreq

int SCIP_Diveset::lpsolvefreq

LP solve frequency for diving heuristics

Definition at line 69 of file struct_heur.h.

Referenced by SCIPdivesetGetLPSolveFreq().

◆ initialseed

unsigned int SCIP_Diveset::initialseed

initial seed for the random number generator

Definition at line 70 of file struct_heur.h.

Referenced by SCIPdivesetReset().

◆ backtrack

SCIP_Bool SCIP_Diveset::backtrack

use one level of backtracking if infeasibility is encountered?

Definition at line 71 of file struct_heur.h.

Referenced by SCIPdivesetUseBacktrack().

◆ onlylpbranchcands

SCIP_Bool SCIP_Diveset::onlylpbranchcands

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

Definition at line 72 of file struct_heur.h.

Referenced by SCIPdivesetUseOnlyLPBranchcands().

◆ divetypemask

SCIP_DIVETYPE SCIP_Diveset::divetypemask

bit mask that represents the supported dive types by this dive set

Definition at line 74 of file struct_heur.h.

Referenced by SCIPdivesetGetScore(), and SCIPdivesetSupportsType().