type_detector.h File Reference

Detailed Description

type definitions for detectors in GCG projects

Author
Martin Bergner
Christian Puchert

Definition in file type_detector.h.

#include "scip/type_retcode.h"
#include "scip/type_scip.h"
#include "scip/type_result.h"
#include "type_decomp.h"

Go to the source code of this file.

Macros

#define DEC_DECL_FREEDETECTOR(x)   SCIP_RETCODE x (SCIP* scip, DEC_DETECTOR* detector)
 
#define DEC_DECL_INITDETECTOR(x)   SCIP_RETCODE x (SCIP* scip, DEC_DETECTOR* detector)
 
#define DEC_DECL_EXITDETECTOR(x)   SCIP_RETCODE x (SCIP* scip, DEC_DETECTOR* detector)
 
#define DEC_DECL_DETECTSTRUCTURE(x)   SCIP_RETCODE x (SCIP* scip, DEC_DETECTORDATA* detectordata, DEC_DECOMP*** decdecomps, int* ndecdecomps, SCIP_RESULT* result)
 
#define DEC_DECL_PROPAGATESEEED(x)   SCIP_RETCODE x (SCIP* scip, DEC_DETECTOR* detector, SEEED_PROPAGATION_DATA* seeedPropagationData, SCIP_RESULT* result)
 
#define DEC_DECL_PROPAGATEFROMTOOLBOX(x)   SCIP_RETCODE x (SCIP* scip, DEC_DETECTOR* detector, SEEED_PROPAGATION_DATA* seeedPropagationData, SCIP_RESULT* result, SCIP_DIALOGHDLR* dialoghdlr,SCIP_DIALOG* dialog )
 
#define DEC_DECL_FINISHFROMTOOLBOX(x)   SCIP_RETCODE x (SCIP* scip, DEC_DETECTOR* detector, SEEED_PROPAGATION_DATA* seeedPropagationData, SCIP_RESULT* result, SCIP_DIALOGHDLR* dialoghdlr,SCIP_DIALOG* dialog )
 
#define DEC_DECL_FINISHSEEED(x)   SCIP_RETCODE x (SCIP* scip, DEC_DETECTOR* detector, SEEED_PROPAGATION_DATA* seeedPropagationData, SCIP_RESULT* result)
 
#define DEC_DECL_POSTPROCESSSEEED(x)   SCIP_RETCODE x (SCIP* scip, DEC_DETECTOR* detector, SEEED_PROPAGATION_DATA* seeedPropagationData, SCIP_RESULT* result)
 
#define DEC_DECL_SETPARAMFAST(x)   SCIP_RETCODE x (SCIP* scip, DEC_DETECTOR* detector, SCIP_RESULT* result)
 
#define DEC_DECL_SETPARAMAGGRESSIVE(x)   SCIP_RETCODE x (SCIP* scip, DEC_DETECTOR* detector, SCIP_RESULT* result)
 
#define DEC_DECL_SETPARAMDEFAULT(x)   SCIP_RETCODE x (SCIP* scip, DEC_DETECTOR* detector, SCIP_RESULT* result)
 

Typedefs

typedef struct DEC_Detector DEC_DETECTOR
 
typedef struct DEC_DetectorData DEC_DETECTORDATA
 
typedef struct Seeed_Propagation_Data SEEED_PROPAGATION_DATA
 

Macro Definition Documentation

#define DEC_DECL_DETECTSTRUCTURE (   x)    SCIP_RETCODE x (SCIP* scip, DEC_DETECTORDATA* detectordata, DEC_DECOMP*** decdecomps, int* ndecdecomps, SCIP_RESULT* result)

detector structure detection method, tries to detect a structure in the problem. This mandatory method is called when the detector should detect the structure.

input:

  • scip : SCIP data structure
  • detectordata : detector data data structure
  • decdecomps : a pointer to an array where detected decompositions should be saved. The array needs to be created in this method.
  • ndecdecomps : pointer where the number of detected decompositions is stored
  • result : pointer where to store the result

possible return values for result:

  • SCIP_SUCCESS : the method completed and found decompositions
  • SCIP_DIDNOTFIND : the method completed without finding a decomposition
  • SCIP_DIDNOTRUN : the method did not run

Definition at line 101 of file type_detector.h.

#define DEC_DECL_EXITDETECTOR (   x)    SCIP_RETCODE x (SCIP* scip, DEC_DETECTOR* detector)

detector deinitialization method (called before the transformed problem is freed) It can be used to clean up the data created in DEC_DECL_INITDETECTOR. The implementation is optional.

input:

  • scip : SCIP data structure
  • detector : detector data structure

Definition at line 80 of file type_detector.h.

Referenced by DEC_DECL_FREEDETECTOR().

#define DEC_DECL_FINISHFROMTOOLBOX (   x)    SCIP_RETCODE x (SCIP* scip, DEC_DETECTOR* detector, SEEED_PROPAGATION_DATA* seeedPropagationData, SCIP_RESULT* result, SCIP_DIALOGHDLR* dialoghdlr,SCIP_DIALOG* dialog )

Definition at line 131 of file type_detector.h.

#define DEC_DECL_FINISHSEEED (   x)    SCIP_RETCODE x (SCIP* scip, DEC_DETECTOR* detector, SEEED_PROPAGATION_DATA* seeedPropagationData, SCIP_RESULT* result)

given a seeed (incomplete decomposition) the detector tries to find finished seeeds and stores them

input:

  • scip : SCIP data structure
  • detectordata : detector data structure
  • decdecomps : a pointer to an array where detected decompositions should be saved. The array needs to be created in this method.
  • ndecdecomps : pointer where the number of detected decompositions is stored
  • result : pointer where to store the result

possible return values for result:

  • SCIP_SUCCESS : the method completed and found decompositions
  • SCIP_DIDNOTFIND : the method completed without finding a decomposition
  • SCIP_DIDNOTRUN : the method did not run

Definition at line 153 of file type_detector.h.

#define DEC_DECL_FREEDETECTOR (   x)    SCIP_RETCODE x (SCIP* scip, DEC_DETECTOR* detector)

destructor of detector to free user data (called when GCG is exiting)

input:

  • scip : SCIP main data structure
  • detector : detector data structure

Definition at line 60 of file type_detector.h.

#define DEC_DECL_INITDETECTOR (   x)    SCIP_RETCODE x (SCIP* scip, DEC_DETECTOR* detector)

detector initialization method (called after problem was transformed) It can be used to fill the detector data with needed information. The implementation is optional.

input:

  • scip : SCIP data structure
  • detector : detector data structure

Definition at line 70 of file type_detector.h.

#define DEC_DECL_POSTPROCESSSEEED (   x)    SCIP_RETCODE x (SCIP* scip, DEC_DETECTOR* detector, SEEED_PROPAGATION_DATA* seeedPropagationData, SCIP_RESULT* result)

given a complete seeed (complete decomposition) the detector postprocess the seeed in order to find a different yet promising seeed

input:

  • scip : SCIP data structure
  • detectordata : detector data structure
  • decdecomps : a pointer to an array where detected decompositions should be saved. The array needs to be created in this method.
  • ndecdecomps : pointer where the number of detected decompositions is stored
  • result : pointer where to store the result

possible return values for result:

  • SCIP_SUCCESS : the method completed and found decompositions
  • SCIP_DIDNOTFIND : the method completed without finding a decomposition
  • SCIP_DIDNOTRUN : the method did not run

Definition at line 175 of file type_detector.h.

#define DEC_DECL_PROPAGATEFROMTOOLBOX (   x)    SCIP_RETCODE x (SCIP* scip, DEC_DETECTOR* detector, SEEED_PROPAGATION_DATA* seeedPropagationData, SCIP_RESULT* result, SCIP_DIALOGHDLR* dialoghdlr,SCIP_DIALOG* dialog )

Definition at line 129 of file type_detector.h.

#define DEC_DECL_PROPAGATESEEED (   x)    SCIP_RETCODE x (SCIP* scip, DEC_DETECTOR* detector, SEEED_PROPAGATION_DATA* seeedPropagationData, SCIP_RESULT* result)

given a seeed (incomplete decomposition) the detector tries to find refined seeed and stores the

input:

  • scip : SCIP data structure
  • detectordata : detector data structure
  • decdecomps : a pointer to an array where detected decompositions should be saved. The array needs to be created in this method.
  • ndecdecomps : pointer where the number of detected decompositions is stored
  • result : pointer where to store the result

possible return values for result:

  • SCIP_SUCCESS : the method completed and found decompositions
  • SCIP_DIDNOTFIND : the method completed without finding a decomposition
  • SCIP_DIDNOTRUN : the method did not run

Definition at line 126 of file type_detector.h.

#define DEC_DECL_SETPARAMAGGRESSIVE (   x)    SCIP_RETCODE x (SCIP* scip, DEC_DETECTOR* detector, SCIP_RESULT* result)

set the parameter of a detector to values according to aggressive emphasis and size of the instance input:

  • scip : SCIP data structure
  • detectordata : detector data structure
  • result : pointer where to store the result

possible return values for result:

  • SCIP_SUCCESS : the method completed
  • SCIP_DIDNOTRUN : the method did not run

Definition at line 206 of file type_detector.h.

#define DEC_DECL_SETPARAMDEFAULT (   x)    SCIP_RETCODE x (SCIP* scip, DEC_DETECTOR* detector, SCIP_RESULT* result)

set the parameter of a detector to values according to default emphasis and size of the instance input:

  • scip : SCIP data structure
  • detectordata : detector data structure
  • result : pointer where to store the result

possible return values for result:

  • SCIP_SUCCESS : the method completed
  • SCIP_DIDNOTRUN : the method did not run

Definition at line 220 of file type_detector.h.

#define DEC_DECL_SETPARAMFAST (   x)    SCIP_RETCODE x (SCIP* scip, DEC_DETECTOR* detector, SCIP_RESULT* result)

set the parameter of a detector to values according to fast emphasis and size of the instance input:

  • scip : SCIP data structure
  • detectordata : detector data structure
  • result : pointer where to store the result

possible return values for result:

  • SCIP_SUCCESS : the method completed
  • SCIP_DIDNOTRUN : the method did not run

Definition at line 192 of file type_detector.h.

Typedef Documentation

typedef struct DEC_Detector DEC_DETECTOR

Definition at line 46 of file type_detector.h.

Definition at line 47 of file type_detector.h.

Definition at line 51 of file type_detector.h.