Scippy

SCIP

Solving Constraint Integer Programs

Detailed Description

methods for node selector plugin management

Functions

SCIP_EXPORT const char * SCIPnodeselGetName (SCIP_NODESEL *nodesel)
 
SCIP_EXPORT const char * SCIPnodeselGetDesc (SCIP_NODESEL *nodesel)
 
SCIP_EXPORT int SCIPnodeselGetStdPriority (SCIP_NODESEL *nodesel)
 
SCIP_EXPORT int SCIPnodeselGetMemsavePriority (SCIP_NODESEL *nodesel)
 
SCIP_EXPORT SCIP_NODESELDATASCIPnodeselGetData (SCIP_NODESEL *nodesel)
 
SCIP_EXPORT void SCIPnodeselSetData (SCIP_NODESEL *nodesel, SCIP_NODESELDATA *nodeseldata)
 
SCIP_EXPORT SCIP_Bool SCIPnodeselIsInitialized (SCIP_NODESEL *nodesel)
 
SCIP_EXPORT SCIP_Real SCIPnodeselGetSetupTime (SCIP_NODESEL *nodesel)
 
SCIP_EXPORT SCIP_Real SCIPnodeselGetTime (SCIP_NODESEL *nodesel)
 
SCIP_EXPORT SCIP_RETCODE SCIPincludeNodesel (SCIP *scip, const char *name, const char *desc, int stdpriority, int memsavepriority, SCIP_DECL_NODESELCOPY((*nodeselcopy)), SCIP_DECL_NODESELFREE((*nodeselfree)), SCIP_DECL_NODESELINIT((*nodeselinit)), SCIP_DECL_NODESELEXIT((*nodeselexit)), SCIP_DECL_NODESELINITSOL((*nodeselinitsol)), SCIP_DECL_NODESELEXITSOL((*nodeselexitsol)), SCIP_DECL_NODESELSELECT((*nodeselselect)), SCIP_DECL_NODESELCOMP((*nodeselcomp)), SCIP_NODESELDATA *nodeseldata)
 
SCIP_EXPORT SCIP_RETCODE SCIPincludeNodeselBasic (SCIP *scip, SCIP_NODESEL **nodesel, const char *name, const char *desc, int stdpriority, int memsavepriority, SCIP_DECL_NODESELSELECT((*nodeselselect)), SCIP_DECL_NODESELCOMP((*nodeselcomp)), SCIP_NODESELDATA *nodeseldata)
 
SCIP_EXPORT SCIP_RETCODE SCIPsetNodeselCopy (SCIP *scip, SCIP_NODESEL *nodesel, SCIP_DECL_NODESELCOPY((*nodeselcopy)))
 
SCIP_EXPORT SCIP_RETCODE SCIPsetNodeselFree (SCIP *scip, SCIP_NODESEL *nodesel, SCIP_DECL_NODESELFREE((*nodeselfree)))
 
SCIP_EXPORT SCIP_RETCODE SCIPsetNodeselInit (SCIP *scip, SCIP_NODESEL *nodesel, SCIP_DECL_NODESELINIT((*nodeselinit)))
 
SCIP_EXPORT SCIP_RETCODE SCIPsetNodeselExit (SCIP *scip, SCIP_NODESEL *nodesel, SCIP_DECL_NODESELEXIT((*nodeselexit)))
 
SCIP_EXPORT SCIP_RETCODE SCIPsetNodeselInitsol (SCIP *scip, SCIP_NODESEL *nodesel, SCIP_DECL_NODESELINITSOL((*nodeselinitsol)))
 
SCIP_EXPORT SCIP_RETCODE SCIPsetNodeselExitsol (SCIP *scip, SCIP_NODESEL *nodesel, SCIP_DECL_NODESELEXITSOL((*nodeselexitsol)))
 
SCIP_EXPORT SCIP_NODESELSCIPfindNodesel (SCIP *scip, const char *name)
 
SCIP_EXPORT SCIP_NODESEL ** SCIPgetNodesels (SCIP *scip)
 
SCIP_EXPORT int SCIPgetNNodesels (SCIP *scip)
 
SCIP_EXPORT SCIP_RETCODE SCIPsetNodeselStdPriority (SCIP *scip, SCIP_NODESEL *nodesel, int priority)
 
SCIP_EXPORT SCIP_RETCODE SCIPsetNodeselMemsavePriority (SCIP *scip, SCIP_NODESEL *nodesel, int priority)
 
SCIP_EXPORT SCIP_NODESELSCIPgetNodesel (SCIP *scip)
 

Function Documentation

◆ SCIPnodeselGetName()

◆ SCIPnodeselGetDesc()

SCIP_EXPORT const char* SCIPnodeselGetDesc ( SCIP_NODESEL nodesel)

gets description of node selector

Parameters
nodeselnode selector

Definition at line 1053 of file nodesel.c.

References SCIP_Nodesel::desc, and NULL.

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

◆ SCIPnodeselGetStdPriority()

SCIP_EXPORT int SCIPnodeselGetStdPriority ( SCIP_NODESEL nodesel)

gets priority of node selector in standard mode

Parameters
nodeselnode selector

Definition at line 1063 of file nodesel.c.

References NULL, and SCIP_Nodesel::stdpriority.

Referenced by SCIP_DECL_DIALOGEXEC(), SCIP_DECL_NODESELINITSOL(), SCIPsetIncludeNodesel(), and turnoffNodeSelector().

◆ SCIPnodeselGetMemsavePriority()

SCIP_EXPORT int SCIPnodeselGetMemsavePriority ( SCIP_NODESEL nodesel)

gets priority of node selector in memory saving mode

Parameters
nodeselnode selector

Definition at line 1087 of file nodesel.c.

References SCIP_Nodesel::memsavepriority, and NULL.

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPnodeselGetData()

◆ SCIPnodeselSetData()

SCIP_EXPORT void SCIPnodeselSetData ( SCIP_NODESEL nodesel,
SCIP_NODESELDATA nodeseldata 
)

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

Parameters
nodeselnode selector
nodeseldatanew node selector user data

Definition at line 1121 of file nodesel.c.

References SCIP_Nodesel::nodeseldata, and NULL.

Referenced by SCIP_DECL_NODESELFREE().

◆ SCIPnodeselIsInitialized()

SCIP_EXPORT SCIP_Bool SCIPnodeselIsInitialized ( SCIP_NODESEL nodesel)

is node selector initialized?

Parameters
nodeselnode selector

Definition at line 1200 of file nodesel.c.

References SCIP_Nodesel::initialized, and NULL.

Referenced by SCIPsetSortComprs().

◆ SCIPnodeselGetSetupTime()

SCIP_EXPORT SCIP_Real SCIPnodeselGetSetupTime ( SCIP_NODESEL nodesel)

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

Parameters
nodeselnode selector

Definition at line 1222 of file nodesel.c.

References NULL, SCIPclockGetTime(), and SCIP_Nodesel::setuptime.

◆ SCIPnodeselGetTime()

SCIP_EXPORT SCIP_Real SCIPnodeselGetTime ( SCIP_NODESEL nodesel)

gets time in seconds used in this node selector

Parameters
nodeselnode selector

Definition at line 1232 of file nodesel.c.

References SCIP_Nodesel::nodeseltime, NULL, and SCIPclockGetTime().

◆ SCIPincludeNodesel()

SCIP_EXPORT SCIP_RETCODE SCIPincludeNodesel ( SCIP scip,
const char *  name,
const char *  desc,
int  stdpriority,
int  memsavepriority,
SCIP_DECL_NODESELCOPY((*nodeselcopy))  ,
SCIP_DECL_NODESELFREE((*nodeselfree))  ,
SCIP_DECL_NODESELINIT((*nodeselinit))  ,
SCIP_DECL_NODESELEXIT((*nodeselexit))  ,
SCIP_DECL_NODESELINITSOL((*nodeselinitsol))  ,
SCIP_DECL_NODESELEXITSOL((*nodeselexitsol))  ,
SCIP_DECL_NODESELSELECT((*nodeselselect))  ,
SCIP_DECL_NODESELCOMP((*nodeselcomp))  ,
SCIP_NODESELDATA nodeseldata 
)

creates a node selector and includes it in SCIP.

Note
method has all node selector callbacks as arguments and is thus changed every time a new callback is added in future releases; consider using SCIPincludeNodeselBasic() and setter functions if you seek for a method which is less likely to change in future releases
Parameters
scipSCIP data structure
namename of node selector
descdescription of node selector
stdprioritypriority of the node selector in standard mode
memsaveprioritypriority of the node selector in memory saving mode
nodeseldatanode selector data

Definition at line 51 of file scip_nodesel.c.

References FALSE, Scip::mem, Scip::messagehdlr, NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIPcheckStage(), SCIPerrorMessage, SCIPfindNodesel(), SCIPnodeselCreate(), SCIPsetIncludeNodesel(), Scip::set, SCIP_Mem::setmem, and TRUE.

Referenced by SCIPincludeObjNodesel().

◆ SCIPincludeNodeselBasic()

SCIP_EXPORT SCIP_RETCODE SCIPincludeNodeselBasic ( SCIP scip,
SCIP_NODESEL **  nodesel,
const char *  name,
const char *  desc,
int  stdpriority,
int  memsavepriority,
SCIP_DECL_NODESELSELECT((*nodeselselect))  ,
SCIP_DECL_NODESELCOMP((*nodeselcomp))  ,
SCIP_NODESELDATA nodeseldata 
)

Creates a node 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 SCIPsetNodeselCopy(), SCIPsetNodeselFree(), SCIPsetNodeselInit(), SCIPsetNodeselExit(), SCIPsetNodeselInitsol(), and SCIPsetNodeselExitsol()

Note
if you want to set all callbacks with a single method call, consider using SCIPincludeNodesel() instead
Parameters
scipSCIP data structure
nodeselreference to a node selector, or NULL
namename of node selector
descdescription of node selector
stdprioritypriority of the node selector in standard mode
memsaveprioritypriority of the node selector in memory saving mode
nodeseldatanode selector data

Definition at line 94 of file scip_nodesel.c.

References FALSE, Scip::mem, Scip::messagehdlr, NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIPcheckStage(), SCIPerrorMessage, SCIPfindNodesel(), SCIPnodeselCreate(), SCIPsetIncludeNodesel(), Scip::set, SCIP_Mem::setmem, and TRUE.

Referenced by SCIPincludeNodeselBfs(), SCIPincludeNodeselBreadthfirst(), SCIPincludeNodeselDfs(), SCIPincludeNodeselEstimate(), SCIPincludeNodeselHybridestim(), SCIPincludeNodeselRestartdfs(), and SCIPincludeNodeselUct().

◆ SCIPsetNodeselCopy()

SCIP_EXPORT SCIP_RETCODE SCIPsetNodeselCopy ( SCIP scip,
SCIP_NODESEL nodesel,
SCIP_DECL_NODESELCOPY((*nodeselcopy))   
)

◆ SCIPsetNodeselFree()

SCIP_EXPORT SCIP_RETCODE SCIPsetNodeselFree ( SCIP scip,
SCIP_NODESEL nodesel,
SCIP_DECL_NODESELFREE((*nodeselfree))   
)

sets destructor method of node selector

Parameters
scipSCIP data structure
nodeselnode selector

Definition at line 145 of file scip_nodesel.c.

References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPnodeselSetFree(), and TRUE.

Referenced by SCIPincludeNodeselBfs(), SCIPincludeNodeselEstimate(), SCIPincludeNodeselHybridestim(), SCIPincludeNodeselRestartdfs(), and SCIPincludeNodeselUct().

◆ SCIPsetNodeselInit()

SCIP_EXPORT SCIP_RETCODE SCIPsetNodeselInit ( SCIP scip,
SCIP_NODESEL nodesel,
SCIP_DECL_NODESELINIT((*nodeselinit))   
)

sets initialization method of node selector

Parameters
scipSCIP data structure
nodeselnode selector

Definition at line 161 of file scip_nodesel.c.

References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPnodeselSetInit(), and TRUE.

◆ SCIPsetNodeselExit()

SCIP_EXPORT SCIP_RETCODE SCIPsetNodeselExit ( SCIP scip,
SCIP_NODESEL nodesel,
SCIP_DECL_NODESELEXIT((*nodeselexit))   
)

sets deinitialization method of node selector

Parameters
scipSCIP data structure
nodeselnode selector

Definition at line 177 of file scip_nodesel.c.

References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPnodeselSetExit(), and TRUE.

◆ SCIPsetNodeselInitsol()

SCIP_EXPORT SCIP_RETCODE SCIPsetNodeselInitsol ( SCIP scip,
SCIP_NODESEL nodesel,
SCIP_DECL_NODESELINITSOL((*nodeselinitsol))   
)

sets solving process initialization method of node selector

Parameters
scipSCIP data structure
nodeselnode selector

Definition at line 193 of file scip_nodesel.c.

References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPnodeselSetInitsol(), and TRUE.

Referenced by SCIPincludeNodeselRestartdfs(), and SCIPincludeNodeselUct().

◆ SCIPsetNodeselExitsol()

SCIP_EXPORT SCIP_RETCODE SCIPsetNodeselExitsol ( SCIP scip,
SCIP_NODESEL nodesel,
SCIP_DECL_NODESELEXITSOL((*nodeselexitsol))   
)

sets solving process deinitialization method of node selector

Parameters
scipSCIP data structure
nodeselnode selector

Definition at line 209 of file scip_nodesel.c.

References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPnodeselSetExitsol(), and TRUE.

Referenced by SCIPincludeNodeselUct().

◆ SCIPfindNodesel()

SCIP_EXPORT SCIP_NODESEL* SCIPfindNodesel ( SCIP scip,
const char *  name 
)

◆ SCIPgetNodesels()

SCIP_EXPORT SCIP_NODESEL** SCIPgetNodesels ( SCIP scip)

returns the array of currently available node selectors

Parameters
scipSCIP data structure

Definition at line 238 of file scip_nodesel.c.

References SCIP_Set::nodesels, NULL, and Scip::set.

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

◆ SCIPgetNNodesels()

SCIP_EXPORT int SCIPgetNNodesels ( SCIP scip)

returns the number of currently available node selectors

Parameters
scipSCIP data structure

Definition at line 249 of file scip_nodesel.c.

References SCIP_Set::nnodesels, NULL, and Scip::set.

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

◆ SCIPsetNodeselStdPriority()

SCIP_EXPORT SCIP_RETCODE SCIPsetNodeselStdPriority ( SCIP scip,
SCIP_NODESEL nodesel,
int  priority 
)

sets the priority of a node selector in standard mode

Parameters
scipSCIP data structure
nodeselnode selector
prioritynew standard priority of the node selector

Definition at line 260 of file scip_nodesel.c.

References NULL, SCIP_OKAY, SCIPnodeselSetStdPriority(), and Scip::set.

Referenced by SCIP_DECL_NODESELEXITSOL(), SCIP_DECL_PARAMCHGD(), and turnoffNodeSelector().

◆ SCIPsetNodeselMemsavePriority()

SCIP_EXPORT SCIP_RETCODE SCIPsetNodeselMemsavePriority ( SCIP scip,
SCIP_NODESEL nodesel,
int  priority 
)

sets the priority of a node selector in memory saving mode

Parameters
scipSCIP data structure
nodeselnode selector
prioritynew memory saving priority of the node selector

Definition at line 275 of file scip_nodesel.c.

References NULL, SCIP_OKAY, SCIPnodeselSetMemsavePriority(), and Scip::set.

Referenced by SCIP_DECL_PARAMCHGD().

◆ SCIPgetNodesel()

SCIP_EXPORT SCIP_NODESEL* SCIPgetNodesel ( SCIP scip)

returns the currently used node selector

Parameters
scipSCIP data structure

Definition at line 290 of file scip_nodesel.c.

References NULL, SCIPsetGetNodesel(), Scip::set, and Scip::stat.