Scippy

SCIP

Solving Constraint Integer Programs

SCIP_Heur Struct Reference

Detailed Description

primal heuristics data

Definition at line 88 of file struct_heur.h.

#include <struct_heur.h>

Public Member Functions

 SCIP_DECL_HEURCOPY ((*heurcopy))
 
 SCIP_DECL_HEURFREE ((*heurfree))
 
 SCIP_DECL_HEURINIT ((*heurinit))
 
 SCIP_DECL_HEUREXIT ((*heurexit))
 
 SCIP_DECL_HEURINITSOL ((*heurinitsol))
 
 SCIP_DECL_HEUREXITSOL ((*heurexitsol))
 
 SCIP_DECL_HEUREXEC ((*heurexec))
 

Data Fields

SCIP_Longint ncalls
 
SCIP_Longint nsolsfound
 
SCIP_Longint nbestsolsfound
 
char * name
 
char * desc
 
SCIP_HEURDATAheurdata
 
SCIP_DIVESET ** divesets
 
SCIP_CLOCKsetuptime
 
SCIP_CLOCKheurclock
 
int priority
 
int freq
 
int freqofs
 
int maxdepth
 
int delaypos
 
int ndivesets
 
SCIP_HEURTIMING timingmask
 
SCIP_Bool usessubscip
 
SCIP_Bool initialized
 
char dispchar
 

Member Function Documentation

◆ SCIP_DECL_HEURCOPY()

SCIP_Heur::SCIP_DECL_HEURCOPY ( heurcopy)

copy method of primal heuristic or NULL if you don't want to copy your plugin into sub-SCIPs

◆ SCIP_DECL_HEURFREE()

SCIP_Heur::SCIP_DECL_HEURFREE ( heurfree)

destructor of primal heuristic

◆ SCIP_DECL_HEURINIT()

SCIP_Heur::SCIP_DECL_HEURINIT ( heurinit)

initialize primal heuristic

◆ SCIP_DECL_HEUREXIT()

SCIP_Heur::SCIP_DECL_HEUREXIT ( heurexit)

deinitialize primal heuristic

◆ SCIP_DECL_HEURINITSOL()

SCIP_Heur::SCIP_DECL_HEURINITSOL ( heurinitsol)

solving process initialization method of primal heuristic

◆ SCIP_DECL_HEUREXITSOL()

SCIP_Heur::SCIP_DECL_HEUREXITSOL ( heurexitsol)

solving process deinitialization method of primal heuristic

◆ SCIP_DECL_HEUREXEC()

SCIP_Heur::SCIP_DECL_HEUREXEC ( heurexec)

execution method of primal heuristic

Field Documentation

◆ ncalls

SCIP_Longint SCIP_Heur::ncalls

number of times, this heuristic was called

Definition at line 90 of file struct_heur.h.

Referenced by SCIP_DECL_SORTPTRCOMP(), SCIPcopyConcurrentSolvingStats(), SCIPheurExec(), SCIPheurGetNCalls(), and SCIPheurInit().

◆ nsolsfound

SCIP_Longint SCIP_Heur::nsolsfound

number of feasible primal solutions found so far by this heuristic

Definition at line 91 of file struct_heur.h.

Referenced by SCIPcopyConcurrentSolvingStats(), SCIPheurExec(), SCIPheurGetNSolsFound(), and SCIPheurInit().

◆ nbestsolsfound

SCIP_Longint SCIP_Heur::nbestsolsfound

number of new best primal CIP solutions found so far by this heuristic

Definition at line 92 of file struct_heur.h.

Referenced by SCIPcopyConcurrentSolvingStats(), SCIPheurExec(), SCIPheurGetNBestSolsFound(), and SCIPheurInit().

◆ name

char* SCIP_Heur::name

name of primal heuristic

Definition at line 93 of file struct_heur.h.

Referenced by SCIPheurExec(), SCIPheurExit(), SCIPheurGetName(), and SCIPheurInit().

◆ desc

char* SCIP_Heur::desc

description of primal heuristic

Definition at line 94 of file struct_heur.h.

Referenced by SCIPheurGetDesc().

◆ heurdata

SCIP_HEURDATA* SCIP_Heur::heurdata

primal heuristics local data

Definition at line 102 of file struct_heur.h.

Referenced by SCIPheurGetData(), and SCIPheurSetData().

◆ divesets

SCIP_DIVESET** SCIP_Heur::divesets

array of diving controllers of this heuristic

Definition at line 103 of file struct_heur.h.

Referenced by heurAddDiveset(), SCIPheurGetDivesets(), and SCIPheurInit().

◆ setuptime

SCIP_CLOCK* SCIP_Heur::setuptime

time spend for setting up this heuristic for the next stages

Definition at line 104 of file struct_heur.h.

Referenced by SCIPcopyConcurrentSolvingStats(), SCIPheurEnableOrDisableClocks(), SCIPheurExit(), SCIPheurExitsol(), SCIPheurGetSetupTime(), SCIPheurInit(), and SCIPheurInitsol().

◆ heurclock

SCIP_CLOCK* SCIP_Heur::heurclock

heuristic execution time

Definition at line 105 of file struct_heur.h.

Referenced by SCIPcopyConcurrentSolvingStats(), SCIPheurEnableOrDisableClocks(), SCIPheurExec(), SCIPheurGetTime(), and SCIPheurInit().

◆ priority

int SCIP_Heur::priority

priority of the primal heuristic

Definition at line 106 of file struct_heur.h.

Referenced by SCIP_DECL_SORTPTRCOMP(), SCIPheurGetPriority(), and SCIPheurSetPriority().

◆ freq

int SCIP_Heur::freq

frequency for calling primal heuristic

Definition at line 107 of file struct_heur.h.

Referenced by SCIP_DECL_SORTPTRCOMP(), SCIPheurExec(), SCIPheurGetFreq(), SCIPheurSetFreq(), and SCIPheurShouldBeExecuted().

◆ freqofs

int SCIP_Heur::freqofs

frequency offset for calling primal heuristic

Definition at line 108 of file struct_heur.h.

Referenced by SCIPheurExec(), SCIPheurGetFreqofs(), and SCIPheurShouldBeExecuted().

◆ maxdepth

int SCIP_Heur::maxdepth

maximal depth level to call heuristic at (-1: no limit)

Definition at line 109 of file struct_heur.h.

Referenced by SCIPheurExec(), SCIPheurGetMaxdepth(), and SCIPheurShouldBeExecuted().

◆ delaypos

int SCIP_Heur::delaypos

position in the delayed heuristics queue, or -1 if not delayed

Definition at line 110 of file struct_heur.h.

Referenced by SCIP_DECL_SORTPTRCOMP(), SCIPheurExec(), SCIPheurInit(), SCIPheurInitsol(), and SCIPheurShouldBeExecuted().

◆ ndivesets

int SCIP_Heur::ndivesets

number of diving controllers of this heuristic

Definition at line 111 of file struct_heur.h.

Referenced by heurAddDiveset(), SCIPheurGetNDivesets(), and SCIPheurInit().

◆ timingmask

SCIP_HEURTIMING SCIP_Heur::timingmask

positions in the node solving loop where heuristic should be executed

Definition at line 112 of file struct_heur.h.

Referenced by SCIPheurGetTimingmask(), SCIPheurSetTimingmask(), and SCIPheurShouldBeExecuted().

◆ usessubscip

SCIP_Bool SCIP_Heur::usessubscip

does the heuristic use a secondary SCIP instance?

Definition at line 113 of file struct_heur.h.

Referenced by SCIPheurUsesSubscip().

◆ initialized

SCIP_Bool SCIP_Heur::initialized

is primal heuristic initialized?

Definition at line 114 of file struct_heur.h.

Referenced by SCIPheurExit(), SCIPheurInit(), and SCIPheurIsInitialized().

◆ dispchar

char SCIP_Heur::dispchar

display character of primal heuristic

Definition at line 115 of file struct_heur.h.

Referenced by SCIPheurGetDispchar().