Detailed Description
type definitions for detectors in GCG projects
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_PROPAGATEPARTIALDEC(x) SCIP_RETCODE x (SCIP* scip, DEC_DETECTOR* detector, PARTIALDEC_DETECTION_DATA* partialdecdetectiondata, SCIP_RESULT* result) |
#define | DEC_DECL_FINISHPARTIALDEC(x) SCIP_RETCODE x (SCIP* scip, DEC_DETECTOR* detector, PARTIALDEC_DETECTION_DATA* partialdecdetectiondata, SCIP_RESULT* result) |
#define | DEC_DECL_POSTPROCESSPARTIALDEC(x) SCIP_RETCODE x (SCIP* scip, DEC_DETECTOR* detector, PARTIALDEC_DETECTION_DATA* partialdecdetectiondata, 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 Partialdec_Detection_Data | PARTIALDEC_DETECTION_DATA |
Macro Definition Documentation
◆ DEC_DECL_FREEDETECTOR
#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.
◆ DEC_DECL_INITDETECTOR
#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.
◆ DEC_DECL_EXITDETECTOR
#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.
◆ DEC_DECL_PROPAGATEPARTIALDEC
#define DEC_DECL_PROPAGATEPARTIALDEC | ( | x | ) | SCIP_RETCODE x (SCIP* scip, DEC_DETECTOR* detector, PARTIALDEC_DETECTION_DATA* partialdecdetectiondata, SCIP_RESULT* result) |
given a partialdec (incomplete decomposition) the detector tries to find refined partialdec and stores it
input:
- scip : SCIP data structure
- detector : pointer to detector
- partialdecdetectiondata : pointer to partialdec propagation data structure
- 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 98 of file type_detector.h.
◆ DEC_DECL_FINISHPARTIALDEC
#define DEC_DECL_FINISHPARTIALDEC | ( | x | ) | SCIP_RETCODE x (SCIP* scip, DEC_DETECTOR* detector, PARTIALDEC_DETECTION_DATA* partialdecdetectiondata, SCIP_RESULT* result) |
given a partialdec (incomplete decomposition) the detector tries to find finished partialdecs and stores them
input:
- scip : SCIP data structure
- detector : pointer to detector
- partialdecdetectiondata : pointer to partialdec propagation data structure
- 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 116 of file type_detector.h.
◆ DEC_DECL_POSTPROCESSPARTIALDEC
#define DEC_DECL_POSTPROCESSPARTIALDEC | ( | x | ) | SCIP_RETCODE x (SCIP* scip, DEC_DETECTOR* detector, PARTIALDEC_DETECTION_DATA* partialdecdetectiondata, SCIP_RESULT* result) |
given a complete partialdec (complete decomposition) the detector postprocess the partialdec in order to find a different yet promising partialdec
input:
- scip : SCIP data structure
- detector : pointer to detector
- partialdecdetectiondata : pointer to partialdec propagation data structure
- 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 133 of file type_detector.h.
◆ DEC_DECL_SETPARAMFAST
#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
- detector : pointer to detector
- 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 146 of file type_detector.h.
◆ DEC_DECL_SETPARAMAGGRESSIVE
#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
- detector : pointer to detector
- 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 159 of file type_detector.h.
◆ DEC_DECL_SETPARAMDEFAULT
#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
- detector : pointer to detector
- 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 172 of file type_detector.h.
Typedef Documentation
◆ DEC_DETECTOR
typedef struct DEC_Detector DEC_DETECTOR |
Definition at line 46 of file type_detector.h.
◆ DEC_DETECTORDATA
typedef struct DEC_DetectorData DEC_DETECTORDATA |
Definition at line 47 of file type_detector.h.
◆ PARTIALDEC_DETECTION_DATA
typedef struct Partialdec_Detection_Data PARTIALDEC_DETECTION_DATA |
Definition at line 51 of file type_detector.h.