Scippy

GCG

Branch-and-Price & Column Generation for Everyone

DEC_Detector Struct Reference

Detailed Description

detector data structure

Definition at line 46 of file struct_detector.h.

#include <struct_detector.h>

Public Member Functions

 DEC_DECL_FREEDETECTOR ((*freeDetector))
 
 DEC_DECL_INITDETECTOR ((*initDetector))
 
 DEC_DECL_EXITDETECTOR ((*exitDetector))
 
 DEC_DECL_EXITDETECTOR ((*exitDetection))
 
 DEC_DECL_PROPAGATEPARTIALDEC ((*propagatePartialdec))
 
 DEC_DECL_FINISHPARTIALDEC ((*finishPartialdec))
 
 DEC_DECL_POSTPROCESSPARTIALDEC ((*postprocessPartialdec))
 
 DEC_DECL_SETPARAMAGGRESSIVE ((*setParamAggressive))
 
 DEC_DECL_SETPARAMDEFAULT ((*setParamDefault))
 
 DEC_DECL_SETPARAMFAST ((*setParamFast))
 

Data Fields

const char * name
 
DEC_DETECTORDATAdecdata
 
char decchar
 
const char * description
 
int freqCallRound
 
int maxCallRound
 
int minCallRound
 
int freqCallRoundOriginal
 
int maxCallRoundOriginal
 
int minCallRoundOriginal
 
int priority
 
SCIP_Bool enabled
 
SCIP_Bool enabledFinishing
 
SCIP_Bool enabledPostprocessing
 
SCIP_Bool skip
 
SCIP_Bool usefulRecall
 
SCIP_Bool overruleemphasis
 
int ndecomps
 
int ncompletedecomps
 
SCIP_Real dectime
 

Member Function Documentation

◆ DEC_DECL_FREEDETECTOR()

DEC_Detector::DEC_DECL_FREEDETECTOR ( freeDetector)

destructor of detector

◆ DEC_DECL_INITDETECTOR()

DEC_Detector::DEC_DECL_INITDETECTOR ( initDetector)

initialization method of detector

◆ DEC_DECL_EXITDETECTOR() [1/2]

DEC_Detector::DEC_DECL_EXITDETECTOR ( exitDetector)

deinitialization method of detector

◆ DEC_DECL_EXITDETECTOR() [2/2]

DEC_Detector::DEC_DECL_EXITDETECTOR ( exitDetection)

deinitialization method of detector

◆ DEC_DECL_PROPAGATEPARTIALDEC()

DEC_Detector::DEC_DECL_PROPAGATEPARTIALDEC ( propagatePartialdec)

propagation method of detector (or NULL)

◆ DEC_DECL_FINISHPARTIALDEC()

DEC_Detector::DEC_DECL_FINISHPARTIALDEC ( finishPartialdec)

finish method of detector (or NULL)

◆ DEC_DECL_POSTPROCESSPARTIALDEC()

DEC_Detector::DEC_DECL_POSTPROCESSPARTIALDEC ( postprocessPartialdec)

postprocess method of detector (or NULL)

◆ DEC_DECL_SETPARAMAGGRESSIVE()

DEC_Detector::DEC_DECL_SETPARAMAGGRESSIVE ( setParamAggressive)

set method for aggressive parameters of detector (or NULL)

◆ DEC_DECL_SETPARAMDEFAULT()

DEC_Detector::DEC_DECL_SETPARAMDEFAULT ( setParamDefault)

set method for default parameters of detector (or NULL)

◆ DEC_DECL_SETPARAMFAST()

DEC_Detector::DEC_DECL_SETPARAMFAST ( setParamFast)

set method for fast parameters of detector (or NULL)

Field Documentation

◆ name

const char* DEC_Detector::name

◆ decdata

DEC_DETECTORDATA* DEC_Detector::decdata

custom data structure of the detectors

Definition at line 48 of file struct_detector.h.

Referenced by DECdetectorGetData(), and DECincludeDetector().

◆ decchar

char DEC_Detector::decchar

display character of detector

Definition at line 49 of file struct_detector.h.

Referenced by DECdetectorGetChar(), and DECincludeDetector().

◆ description

const char* DEC_Detector::description

description of the detector

Definition at line 50 of file struct_detector.h.

Referenced by DECincludeDetector(), and SCIP_DECL_CONSFREE().

◆ freqCallRound

int DEC_Detector::freqCallRound

Definition at line 51 of file struct_detector.h.

Referenced by DECincludeDetector().

◆ maxCallRound

int DEC_Detector::maxCallRound

frequency the detector gets called in detection loop ,ie it is called in round r if and only if minCallRound <= r <= maxCallRound AND (r - minCallRound) mod freqCallRound == 0

Definition at line 52 of file struct_detector.h.

Referenced by DECincludeDetector().

◆ minCallRound

int DEC_Detector::minCallRound

last round the detector gets called

Definition at line 53 of file struct_detector.h.

Referenced by DECincludeDetector().

◆ freqCallRoundOriginal

int DEC_Detector::freqCallRoundOriginal

first round the detector gets called (offset in detection loop)

Definition at line 54 of file struct_detector.h.

Referenced by DECincludeDetector().

◆ maxCallRoundOriginal

int DEC_Detector::maxCallRoundOriginal

frequency the detector gets called in detection loop while detecting the original problem

Definition at line 55 of file struct_detector.h.

Referenced by DECincludeDetector().

◆ minCallRoundOriginal

int DEC_Detector::minCallRoundOriginal

last round the detector gets called while detecting the original problem

Definition at line 56 of file struct_detector.h.

Referenced by DECincludeDetector().

◆ priority

int DEC_Detector::priority

first round the detector gets calles (offset in detection loop) while detecting the original problem detector priority

Definition at line 57 of file struct_detector.h.

Referenced by DECincludeDetector().

◆ enabled

SCIP_Bool DEC_Detector::enabled

flag to indicate whether detector is enabled

Definition at line 58 of file struct_detector.h.

Referenced by DECincludeDetector(), and detect().

◆ enabledFinishing

SCIP_Bool DEC_Detector::enabledFinishing

flag to indicate whether finishing is enabled

Definition at line 59 of file struct_detector.h.

Referenced by DECincludeDetector(), and detect().

◆ enabledPostprocessing

SCIP_Bool DEC_Detector::enabledPostprocessing

flag to indicate whether finishing is enabled

Definition at line 60 of file struct_detector.h.

Referenced by DECincludeDetector(), and detect().

◆ skip

SCIP_Bool DEC_Detector::skip

should detector be skipped if other detectors found decompositions

Definition at line 61 of file struct_detector.h.

Referenced by DECincludeDetector().

◆ usefulRecall

SCIP_Bool DEC_Detector::usefulRecall

Definition at line 62 of file struct_detector.h.

Referenced by DECincludeDetector(), and detect().

◆ overruleemphasis

SCIP_Bool DEC_Detector::overruleemphasis

is it useful to call this detector on a descendant of the propagated partialdec should the emphasis settings be overruled

Definition at line 63 of file struct_detector.h.

Referenced by DECincludeDetector().

◆ ndecomps

int DEC_Detector::ndecomps

number of decompositions the detector has worked on

Definition at line 64 of file struct_detector.h.

Referenced by DECincludeDetector().

◆ ncompletedecomps

int DEC_Detector::ncompletedecomps

number of complete decompositions the detector has worked on (including decompositions that were finished by other detectors)

Definition at line 65 of file struct_detector.h.

Referenced by DECincludeDetector().

◆ dectime

SCIP_Real DEC_Detector::dectime

time the detector took to find decompositions

Definition at line 66 of file struct_detector.h.

Referenced by DECincludeDetector(), detect(), and SCIP_DECL_CONSINIT().