SCIP Doxygen Documentation
 
Loading...
Searching...
No Matches

Detailed Description

methods for cut selectors

Functions

const char * SCIPcutselGetName (SCIP_CUTSEL *cutsel)
 
SCIP_CUTSELDATASCIPcutselGetData (SCIP_CUTSEL *cutsel)
 
const char * SCIPcutselGetDesc (SCIP_CUTSEL *cutsel)
 
int SCIPcutselGetPriority (SCIP_CUTSEL *cutsel)
 
void SCIPcutselSetData (SCIP_CUTSEL *cutsel, SCIP_CUTSELDATA *cutseldata)
 
SCIP_Bool SCIPcutselIsInitialized (SCIP_CUTSEL *cutsel)
 
SCIP_Real SCIPcutselGetSetupTime (SCIP_CUTSEL *cutsel)
 
SCIP_Real SCIPcutselGetTime (SCIP_CUTSEL *cutsel)
 
SCIP_Longint SCIPcutselGetNCalls (SCIP_CUTSEL *cutsel)
 
SCIP_Longint SCIPcutselGetNRootCalls (SCIP_CUTSEL *cutsel)
 
SCIP_Longint SCIPcutselGetNRootCuts (SCIP_CUTSEL *cutsel)
 
SCIP_Longint SCIPcutselGetNRootForcedCuts (SCIP_CUTSEL *cutsel)
 
SCIP_Longint SCIPcutselGetNRootCutsFiltered (SCIP_CUTSEL *cutsel)
 
SCIP_Longint SCIPcutselGetNLocalCuts (SCIP_CUTSEL *cutsel)
 
SCIP_Longint SCIPcutselGetNLocalForcedCuts (SCIP_CUTSEL *cutsel)
 
SCIP_Longint SCIPcutselGetNLocalCutsFiltered (SCIP_CUTSEL *cutsel)
 
 SCIP_DECL_SORTPTRCOMP (SCIPcutselComp)
 
SCIP_RETCODE SCIPincludeCutsel (SCIP *scip, const char *name, const char *desc, int priority, SCIP_DECL_CUTSELCOPY((*cutselcopy)), SCIP_DECL_CUTSELFREE((*cutselfree)), SCIP_DECL_CUTSELINIT((*cutselinit)), SCIP_DECL_CUTSELEXIT((*cutselexit)), SCIP_DECL_CUTSELINITSOL((*cutselinitsol)), SCIP_DECL_CUTSELEXITSOL((*cutselexitsol)), SCIP_DECL_CUTSELSELECT((*cutselselect)), SCIP_CUTSELDATA *cutseldata)
 
SCIP_RETCODE SCIPincludeCutselBasic (SCIP *scip, SCIP_CUTSEL **cutsel, const char *name, const char *desc, int priority, SCIP_DECL_CUTSELSELECT((*cutselselect)), SCIP_CUTSELDATA *cutseldata)
 
SCIP_RETCODE SCIPsetCutselCopy (SCIP *scip, SCIP_CUTSEL *cutsel,)
 
SCIP_RETCODE SCIPsetCutselFree (SCIP *scip, SCIP_CUTSEL *cutsel,)
 
SCIP_RETCODE SCIPsetCutselInit (SCIP *scip, SCIP_CUTSEL *cutsel,)
 
SCIP_RETCODE SCIPsetCutselExit (SCIP *scip, SCIP_CUTSEL *cutsel,)
 
SCIP_RETCODE SCIPsetCutselInitsol (SCIP *scip, SCIP_CUTSEL *cutsel,)
 
SCIP_RETCODE SCIPsetCutselExitsol (SCIP *scip, SCIP_CUTSEL *cutsel,)
 
SCIP_CUTSELSCIPfindCutsel (SCIP *scip, const char *name)
 
SCIP_CUTSEL ** SCIPgetCutsels (SCIP *scip)
 
int SCIPgetNCutsels (SCIP *scip)
 
SCIP_RETCODE SCIPsetCutselPriority (SCIP *scip, SCIP_CUTSEL *cutsel, int priority)
 

Function Documentation

◆ SCIPcutselGetName()

const char * SCIPcutselGetName ( SCIP_CUTSEL * cutsel)

◆ SCIPcutselGetData()

◆ SCIPcutselGetDesc()

const char * SCIPcutselGetDesc ( SCIP_CUTSEL * cutsel)

gets description of cut selector

Parameters
cutselcut selector

Definition at line 245 of file cutsel.c.

References assert(), SCIP_Cutsel::desc, and NULL.

Referenced by SCIP_DECL_DIALOGEXEC(), SCIPincludeDialogDefaultFix(), and SCIPincludeDialogDefaultSet().

◆ SCIPcutselGetPriority()

int SCIPcutselGetPriority ( SCIP_CUTSEL * cutsel)

gets priority of cut selector

Parameters
cutselcut selector

Definition at line 440 of file cutsel.c.

References assert(), NULL, and SCIP_Cutsel::priority.

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPcutselSetData()

void SCIPcutselSetData ( SCIP_CUTSEL * cutsel,
SCIP_CUTSELDATA * cutseldata )

sets user data of cut selector; user has to free old data in advance!

Parameters
cutselcut selector
cutseldatanew cut selector user data

Definition at line 429 of file cutsel.c.

References assert(), SCIP_Cutsel::cutseldata, and NULL.

Referenced by SCIP_DECL_CUTSELFREE(), SCIP_DECL_CUTSELFREE(), SCIP_DECL_CUTSELFREE(), and SCIP_DECL_CUTSELFREE().

◆ SCIPcutselIsInitialized()

SCIP_Bool SCIPcutselIsInitialized ( SCIP_CUTSEL * cutsel)

is cut selector initialized?

Parameters
cutselcut selector

Definition at line 545 of file cutsel.c.

References assert(), SCIP_Cutsel::initialized, NULL, and SCIP_Bool.

◆ SCIPcutselGetSetupTime()

SCIP_Real SCIPcutselGetSetupTime ( SCIP_CUTSEL * cutsel)

gets time in seconds used in this cut selector for setting up for next stages

Parameters
cutselcut selector

Definition at line 555 of file cutsel.c.

References assert(), NULL, SCIP_Real, SCIPclockGetTime(), and SCIP_Cutsel::setuptime.

Referenced by SCIPprintCutselectorStatistics().

◆ SCIPcutselGetTime()

SCIP_Real SCIPcutselGetTime ( SCIP_CUTSEL * cutsel)

gets time in seconds used in this cut selector

Parameters
cutselcut selector

Definition at line 565 of file cutsel.c.

References assert(), SCIP_Cutsel::cutseltime, NULL, SCIP_Real, and SCIPclockGetTime().

Referenced by SCIPprintCutselectorStatistics().

◆ SCIPcutselGetNCalls()

SCIP_Longint SCIPcutselGetNCalls ( SCIP_CUTSEL * cutsel)

get number of times the cutselector was called

Parameters
cutselcut selector

Definition at line 575 of file cutsel.c.

References assert(), SCIP_Cutsel::ncalls, NULL, and SCIP_Longint.

Referenced by SCIPprintCutselectorStatistics().

◆ SCIPcutselGetNRootCalls()

SCIP_Longint SCIPcutselGetNRootCalls ( SCIP_CUTSEL * cutsel)

get number of times the cutselector was called at the root

Parameters
cutselcut selector

Definition at line 585 of file cutsel.c.

References assert(), SCIP_Cutsel::nrootcalls, NULL, and SCIP_Longint.

Referenced by SCIPprintCutselectorStatistics().

◆ SCIPcutselGetNRootCuts()

SCIP_Longint SCIPcutselGetNRootCuts ( SCIP_CUTSEL * cutsel)

get total number of cuts that were selected at the root

Parameters
cutselcut selector

Definition at line 595 of file cutsel.c.

References assert(), SCIP_Cutsel::nrootcutsselected, NULL, and SCIP_Longint.

Referenced by SCIPprintCutselectorStatistics().

◆ SCIPcutselGetNRootForcedCuts()

SCIP_Longint SCIPcutselGetNRootForcedCuts ( SCIP_CUTSEL * cutsel)

get total number of forced cuts that were selected at the root

Parameters
cutselcut selector

Definition at line 605 of file cutsel.c.

References assert(), SCIP_Cutsel::nrootcutsforced, NULL, and SCIP_Longint.

Referenced by SCIPprintCutselectorStatistics().

◆ SCIPcutselGetNRootCutsFiltered()

SCIP_Longint SCIPcutselGetNRootCutsFiltered ( SCIP_CUTSEL * cutsel)

get total number of root cuts that were filtered

Parameters
cutselcut selector

Definition at line 615 of file cutsel.c.

References assert(), SCIP_Cutsel::nrootcutsfiltered, NULL, and SCIP_Longint.

Referenced by SCIPprintCutselectorStatistics().

◆ SCIPcutselGetNLocalCuts()

SCIP_Longint SCIPcutselGetNLocalCuts ( SCIP_CUTSEL * cutsel)

get total number of local cuts that were selected

Parameters
cutselcut selector

Definition at line 625 of file cutsel.c.

References assert(), SCIP_Cutsel::nlocalcutsselected, NULL, and SCIP_Longint.

Referenced by SCIPprintCutselectorStatistics().

◆ SCIPcutselGetNLocalForcedCuts()

SCIP_Longint SCIPcutselGetNLocalForcedCuts ( SCIP_CUTSEL * cutsel)

get total number of forced local cuts that were selected

Parameters
cutselcut selector

Definition at line 635 of file cutsel.c.

References assert(), SCIP_Cutsel::nlocalcutsforced, NULL, and SCIP_Longint.

Referenced by SCIPprintCutselectorStatistics().

◆ SCIPcutselGetNLocalCutsFiltered()

SCIP_Longint SCIPcutselGetNLocalCutsFiltered ( SCIP_CUTSEL * cutsel)

get total number of local cuts that were filtered

Parameters
cutselcut selector

Definition at line 645 of file cutsel.c.

References assert(), SCIP_Cutsel::nlocalcutsfiltered, NULL, and SCIP_Longint.

Referenced by SCIPprintCutselectorStatistics().

◆ SCIP_DECL_SORTPTRCOMP()

SCIP_DECL_SORTPTRCOMP ( SCIPcutselComp )

compares two cut selectors w. r. to their priority

Definition at line 655 of file cutsel.c.

◆ SCIPincludeCutsel()

SCIP_RETCODE SCIPincludeCutsel ( SCIP * scip,
const char * name,
const char * desc,
int priority,
SCIP_DECL_CUTSELCOPY((*cutselcopy)) ,
SCIP_DECL_CUTSELFREE((*cutselfree)) ,
SCIP_DECL_CUTSELINIT((*cutselinit)) ,
SCIP_DECL_CUTSELEXIT((*cutselexit)) ,
SCIP_DECL_CUTSELINITSOL((*cutselinitsol)) ,
SCIP_DECL_CUTSELEXITSOL((*cutselexitsol)) ,
SCIP_DECL_CUTSELSELECT((*cutselselect)) ,
SCIP_CUTSELDATA * cutseldata )

creates a cut selector and includes it in SCIP

Note
this method has all cut selector callbacks as arguments and is thus changed every time a new callback is added in future releases; consider using SCIPincludeCutselBasic() and setter functions if you seek for a method which is less likely to change in future releases
Parameters
scipSCIP data structure
namename of cut selector
descdescription of cut selector
prioritypriority of the cut selector
cutseldatacut selector data

Definition at line 50 of file scip_cutsel.c.

References FALSE, NULL, SCIP_CALL, SCIP_DECL_CUTSELCOPY, SCIP_DECL_CUTSELEXIT, SCIP_DECL_CUTSELFREE, SCIP_DECL_CUTSELINIT, SCIP_INVALIDDATA, SCIP_OKAY, SCIPcheckStage(), SCIPcutselCreate(), SCIPerrorMessage, SCIPfindCutsel(), SCIPsetIncludeCutsel(), and TRUE.

Referenced by SCIPincludeObjCutsel().

◆ SCIPincludeCutselBasic()

SCIP_RETCODE SCIPincludeCutselBasic ( SCIP * scip,
SCIP_CUTSEL ** cutsel,
const char * name,
const char * desc,
int priority,
SCIP_DECL_CUTSELSELECT((*cutselselect)) ,
SCIP_CUTSELDATA * cutseldata )

Creates a cut selector and includes it in SCIP with its most fundamental callbacks.

All non-fundamental (or optional) callbacks as, e.g., init and exit callbacks, will be set to NULL. Optional callbacks can be set via specific setter functions, see SCIPsetCutselCopy(), SCIPsetCutselFree(), SCIPsetCutselInit(), SCIPsetCutselExit(), SCIPsetCutselInitsol(), and SCIPsetCutselExitsol()

Note
if you want to set all callbacks with a single method call, consider using SCIPincludeCutsel() instead
Parameters
scipSCIP data structure
cutselreference to a cut selector, or NULL
namename of cut selector
descdescription of cut selector
prioritypriority of the cut selector in standard mode
cutseldatacut selector data

Definition at line 92 of file scip_cutsel.c.

References FALSE, NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIPcheckStage(), SCIPcutselCreate(), SCIPerrorMessage, SCIPfindCutsel(), SCIPsetIncludeCutsel(), and TRUE.

Referenced by SCIPincludeCutselDynamic(), SCIPincludeCutselEnsemble(), and SCIPincludeCutselHybrid().

◆ SCIPsetCutselCopy()

SCIP_RETCODE SCIPsetCutselCopy ( SCIP * scip,
SCIP_CUTSEL * cutsel )

sets copy method of cut selector

Parameters
scipSCIP data structure
cutselcut selector copy method of cut selector or NULL if you don't want to copy your plugin into sub-SCIPs

Definition at line 125 of file scip_cutsel.c.

References assert(), FALSE, NULL, SCIP_CALL, SCIP_DECL_CUTSELCOPY, SCIP_OKAY, SCIPcheckStage(), SCIPcutselSetCopy(), and TRUE.

Referenced by SCIPincludeCutselDynamic(), SCIPincludeCutselEnsemble(), and SCIPincludeCutselHybrid().

◆ SCIPsetCutselFree()

SCIP_RETCODE SCIPsetCutselFree ( SCIP * scip,
SCIP_CUTSEL * cutsel )

sets destructor method of cut selector

Parameters
scipSCIP data structure
cutselcut selector destructor of cut selector

Definition at line 141 of file scip_cutsel.c.

References assert(), FALSE, NULL, SCIP_CALL, SCIP_DECL_CUTSELFREE, SCIP_OKAY, SCIPcheckStage(), SCIPcutselSetFree(), and TRUE.

Referenced by SCIPincludeCutselDynamic(), SCIPincludeCutselEnsemble(), and SCIPincludeCutselHybrid().

◆ SCIPsetCutselInit()

SCIP_RETCODE SCIPsetCutselInit ( SCIP * scip,
SCIP_CUTSEL * cutsel )

sets initialization method of cut selector

Parameters
scipSCIP data structure
cutselcut selector initialize cut selector

Definition at line 157 of file scip_cutsel.c.

References assert(), FALSE, NULL, SCIP_CALL, SCIP_DECL_CUTSELINIT, SCIP_OKAY, SCIPcheckStage(), SCIPcutselSetInit(), and TRUE.

Referenced by SCIPincludeCutselDynamic(), SCIPincludeCutselEnsemble(), and SCIPincludeCutselHybrid().

◆ SCIPsetCutselExit()

SCIP_RETCODE SCIPsetCutselExit ( SCIP * scip,
SCIP_CUTSEL * cutsel )

sets deinitialization method of cut selector

Parameters
scipSCIP data structure
cutselcut selector deinitialize cut selector

Definition at line 173 of file scip_cutsel.c.

References assert(), FALSE, NULL, SCIP_CALL, SCIP_DECL_CUTSELEXIT, SCIP_OKAY, SCIPcheckStage(), SCIPcutselSetExit(), and TRUE.

Referenced by SCIPincludeCutselDynamic(), SCIPincludeCutselEnsemble(), and SCIPincludeCutselHybrid().

◆ SCIPsetCutselInitsol()

SCIP_RETCODE SCIPsetCutselInitsol ( SCIP * scip,
SCIP_CUTSEL * cutsel )

sets solving process initialization method of cut selector

Parameters
scipSCIP data structure
cutselcut selector solving process initialization method of cut selector

Definition at line 189 of file scip_cutsel.c.

References assert(), FALSE, NULL, SCIP_CALL, SCIP_DECL_CUTSELINITSOL, SCIP_OKAY, SCIPcheckStage(), SCIPcutselSetInitsol(), and TRUE.

◆ SCIPsetCutselExitsol()

SCIP_RETCODE SCIPsetCutselExitsol ( SCIP * scip,
SCIP_CUTSEL * cutsel )

sets solving process deinitialization method of cut selector

Parameters
scipSCIP data structure
cutselcut selector solving process deinitialization method of cut selector

Definition at line 205 of file scip_cutsel.c.

References assert(), FALSE, NULL, SCIP_CALL, SCIP_DECL_CUTSELEXITSOL, SCIP_OKAY, SCIPcheckStage(), SCIPcutselSetExitsol(), and TRUE.

◆ SCIPfindCutsel()

SCIP_CUTSEL * SCIPfindCutsel ( SCIP * scip,
const char * name )

returns the cut selector of the given name, or NULL if not existing

Parameters
scipSCIP data structure
namename of cut selector

Definition at line 221 of file scip_cutsel.c.

References assert(), NULL, and SCIPsetFindCutsel().

Referenced by SCIPfindObjCutsel(), SCIPincludeCutsel(), and SCIPincludeCutselBasic().

◆ SCIPgetCutsels()

SCIP_CUTSEL ** SCIPgetCutsels ( SCIP * scip)

returns the array of currently available cut selectors

Parameters
scipSCIP data structure

Definition at line 234 of file scip_cutsel.c.

References assert(), NULL, and SCIPsetSortCutsels().

Referenced by SCIP_DECL_DIALOGEXEC(), SCIPincludeDialogDefaultFix(), and SCIPincludeDialogDefaultSet().

◆ SCIPgetNCutsels()

int SCIPgetNCutsels ( SCIP * scip)

returns the number of currently available cut selectors

Parameters
scipSCIP data structure

Definition at line 247 of file scip_cutsel.c.

References assert(), and NULL.

Referenced by SCIP_DECL_DIALOGEXEC(), SCIPincludeDialogDefaultFix(), and SCIPincludeDialogDefaultSet().

◆ SCIPsetCutselPriority()

SCIP_RETCODE SCIPsetCutselPriority ( SCIP * scip,
SCIP_CUTSEL * cutsel,
int priority )

sets the priority of a cut selector

Parameters
scipSCIP data structure
cutselcut selector
prioritynew priority of the separator

Definition at line 258 of file scip_cutsel.c.

References assert(), NULL, SCIP_OKAY, and SCIPcutselSetPriority().

Referenced by SCIP_DECL_PARAMCHGD().