Scippy

SCIP

Solving Constraint Integer Programs

benderscut.h File Reference

Detailed Description

internal methods for Benders' decomposition cuts

Author
Stephen J. Maher

Definition in file benderscut.h.

Go to the source code of this file.

Functions

SCIP_RETCODE SCIPbenderscutCopyInclude (SCIP_BENDERS *benders, SCIP_BENDERSCUT *benderscut, SCIP_SET *set)
 
SCIP_RETCODE SCIPbenderscutCreate (SCIP_BENDERS *benders, SCIP_BENDERSCUT **benderscut, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, BMS_BLKMEM *blkmem, const char *name, const char *desc, int priority, SCIP_Bool islpcut, SCIP_DECL_BENDERSCUTCOPY((*benderscutcopy)), SCIP_DECL_BENDERSCUTFREE((*benderscutfree)), SCIP_DECL_BENDERSCUTINIT((*benderscutinit)), SCIP_DECL_BENDERSCUTEXIT((*benderscutexit)), SCIP_DECL_BENDERSCUTINITSOL((*benderscutinitsol)), SCIP_DECL_BENDERSCUTEXITSOL((*benderscutexitsol)), SCIP_DECL_BENDERSCUTEXEC((*benderscutexec)), SCIP_BENDERSCUTDATA *benderscutdata)
 
SCIP_RETCODE SCIPbenderscutFree (SCIP_BENDERSCUT **benderscut, SCIP_SET *set)
 
SCIP_RETCODE SCIPbenderscutInit (SCIP_BENDERSCUT *benderscut, SCIP_SET *set)
 
SCIP_RETCODE SCIPbenderscutExit (SCIP_BENDERSCUT *benderscut, SCIP_SET *set)
 
SCIP_RETCODE SCIPbenderscutInitsol (SCIP_BENDERSCUT *benderscut, SCIP_SET *set)
 
SCIP_RETCODE SCIPbenderscutExitsol (SCIP_BENDERSCUT *benderscut, SCIP_SET *set)
 
SCIP_RETCODE SCIPbenderscutExec (SCIP_BENDERSCUT *benderscut, SCIP_SET *set, SCIP_BENDERS *benders, SCIP_SOL *sol, int probnumber, SCIP_BENDERSENFOTYPE type, SCIP_RESULT *result)
 
void SCIPbenderscutSetPriority (SCIP_BENDERSCUT *benderscut, int priority)
 
void SCIPbenderscutSetCopy (SCIP_BENDERSCUT *benderscut, SCIP_DECL_BENDERSCUTCOPY((*benderscutcopy)))
 
void SCIPbenderscutSetFree (SCIP_BENDERSCUT *benderscut, SCIP_DECL_BENDERSCUTFREE((*benderscutfree)))
 
void SCIPbenderscutSetInit (SCIP_BENDERSCUT *benderscut, SCIP_DECL_BENDERSCUTINIT((*benderscutinit)))
 
void SCIPbenderscutSetExit (SCIP_BENDERSCUT *benderscut, SCIP_DECL_BENDERSCUTEXIT((*benderscutexit)))
 
void SCIPbenderscutSetInitsol (SCIP_BENDERSCUT *benderscut, SCIP_DECL_BENDERSCUTINITSOL((*benderscutinitsol)))
 
void SCIPbenderscutSetExitsol (SCIP_BENDERSCUT *benderscut, SCIP_DECL_BENDERSCUTEXITSOL((*benderscutexitsol)))
 
SCIP_RETCODE SCIPbenderscutStoreCut (SCIP_BENDERSCUT *benderscut, SCIP_SET *set, SCIP_VAR **vars, SCIP_Real *vals, SCIP_Real lhs, SCIP_Real rhs, int nvars)
 

Function Documentation

◆ SCIPbenderscutCopyInclude()

SCIP_RETCODE SCIPbenderscutCopyInclude ( SCIP_BENDERS benders,
SCIP_BENDERSCUT benderscut,
SCIP_SET set 
)

copies the given Benders' decomposition cut to a new scip

Parameters
bendersthe Benders' decomposition that the cuts are copied to
benderscutBenders' decomposition cut
setSCIP_SET of SCIP to copy to

Definition at line 78 of file benderscut.c.

References NULL, SCIP_CALL, SCIP_OKAY, SCIPbenderscutGetName(), and SCIPsetDebugMsg.

Referenced by SCIPbendersCopyInclude().

◆ SCIPbenderscutCreate()

SCIP_RETCODE SCIPbenderscutCreate ( SCIP_BENDERS benders,
SCIP_BENDERSCUT **  benderscut,
SCIP_SET set,
SCIP_MESSAGEHDLR messagehdlr,
BMS_BLKMEM blkmem,
const char *  name,
const char *  desc,
int  priority,
SCIP_Bool  islpcut,
SCIP_DECL_BENDERSCUTCOPY((*benderscutcopy))  ,
SCIP_DECL_BENDERSCUTFREE((*benderscutfree))  ,
SCIP_DECL_BENDERSCUTINIT((*benderscutinit))  ,
SCIP_DECL_BENDERSCUTEXIT((*benderscutexit))  ,
SCIP_DECL_BENDERSCUTINITSOL((*benderscutinitsol))  ,
SCIP_DECL_BENDERSCUTEXITSOL((*benderscutexitsol))  ,
SCIP_DECL_BENDERSCUTEXEC((*benderscutexec))  ,
SCIP_BENDERSCUTDATA benderscutdata 
)

creates a Benders' decomposition cut

Parameters
bendersBenders' decomposition
benderscutpointer to the Benders' decomposition cut data structure
setglobal SCIP settings
messagehdlrmessage handler
blkmemblock memory for parameter settings
namename of the Benders' decomposition cut
descdescription of the Benders' decomposition cut
prioritypriority of the the Benders' decomposition cut
islpcutindicates whether the cut is generated from the LP solution
benderscutdataBenders' decomposition cut data

Definition at line 165 of file benderscut.c.

References doBenderscutCreate(), NULL, SCIP_CALL_FINALLY, SCIP_OKAY, and SCIPbenderscutFree().

Referenced by SCIPincludeBenderscut(), and SCIPincludeBenderscutBasic().

◆ SCIPbenderscutFree()

SCIP_RETCODE SCIPbenderscutFree ( SCIP_BENDERSCUT **  benderscut,
SCIP_SET set 
)

calls destructor and frees memory of the Benders' decomposition cut

Parameters
benderscutpointer to the Benders' decomposition cut data structure
setglobal SCIP settings

Definition at line 198 of file benderscut.c.

References BMSfreeMemory, BMSfreeMemoryArray, NULL, SCIP_CALL, SCIP_OKAY, and SCIPclockFree().

Referenced by SCIPbenderscutCreate(), and SCIPbendersFree().

◆ SCIPbenderscutInit()

◆ SCIPbenderscutExit()

◆ SCIPbenderscutInitsol()

SCIP_RETCODE SCIPbenderscutInitsol ( SCIP_BENDERSCUT benderscut,
SCIP_SET set 
)

informs the Benders' decomposition cut that the branch and bound process is being started

informs Benders' cut that the branch and bound process is being started

Parameters
benderscutBenders' decomposition cut
setglobal SCIP settings

Definition at line 314 of file benderscut.c.

References NULL, SCIP_CALL, SCIP_OKAY, SCIPclockStart(), SCIPclockStop(), and SCIP_Benderscut::setuptime.

Referenced by SCIPbendersInitsol().

◆ SCIPbenderscutExitsol()

SCIP_RETCODE SCIPbenderscutExitsol ( SCIP_BENDERSCUT benderscut,
SCIP_SET set 
)

informs the Benders' decomposition cut that the branch and bound process data is being freed

informs Benders' decomposition that the branch and bound process data is being freed

Parameters
benderscutBenders' decomposition
setglobal SCIP settings

Definition at line 338 of file benderscut.c.

References NULL, SCIP_CALL, SCIP_OKAY, SCIPclockStart(), SCIPclockStop(), and SCIP_Benderscut::setuptime.

Referenced by SCIPbendersExitsol().

◆ SCIPbenderscutExec()

SCIP_RETCODE SCIPbenderscutExec ( SCIP_BENDERSCUT benderscut,
SCIP_SET set,
SCIP_BENDERS benders,
SCIP_SOL sol,
int  probnumber,
SCIP_BENDERSENFOTYPE  type,
SCIP_RESULT result 
)

calls execution method of the Benders' decomposition cut

Parameters
benderscutBenders' decomposition cut
setglobal SCIP settings
bendersBenders' decomposition
solprimal CIP solution
probnumberthe number of the subproblem for which the cut is generated
typethe enforcement type calling this function
resultpointer to store the result of the callback method

Definition at line 362 of file benderscut.c.

References SCIP_Benderscut::benderscutclock, SCIP_Benderscut::enabled, SCIP_Benderscut::name, SCIP_Benderscut::ncalls, SCIP_Benderscut::nfound, NULL, SCIP_CALL, SCIP_CONSADDED, SCIP_DIDNOTFIND, SCIP_DIDNOTRUN, SCIP_FEASIBLE, SCIP_INVALIDRESULT, SCIP_OKAY, SCIP_SEPARATED, SCIPclockStart(), SCIPclockStop(), SCIPerrorMessage, and SCIPsetDebugMsg.

Referenced by generateBendersCuts().

◆ SCIPbenderscutSetPriority()

void SCIPbenderscutSetPriority ( SCIP_BENDERSCUT benderscut,
int  priority 
)

sets priority of the Benders' decomposition cut

Parameters
benderscutBenders' decomposition cut
prioritynew priority of the Benders' decomposition cut

Definition at line 538 of file benderscut.c.

References NULL, and SCIP_Benderscut::priority.

Referenced by SCIPsetBenderscutPriority().

◆ SCIPbenderscutSetCopy()

void SCIPbenderscutSetCopy ( SCIP_BENDERSCUT benderscut,
SCIP_DECL_BENDERSCUTCOPY((*benderscutcopy))   
)

sets copy callback of the Benders' decomposition cut

Parameters
benderscutBenders' decomposition cut

Definition at line 442 of file benderscut.c.

References NULL.

Referenced by SCIPsetBenderscutCopy().

◆ SCIPbenderscutSetFree()

void SCIPbenderscutSetFree ( SCIP_BENDERSCUT benderscut,
SCIP_DECL_BENDERSCUTFREE((*benderscutfree))   
)

sets destructor callback of the Benders' decomposition cut

Parameters
benderscutBenders' decomposition cut

Definition at line 453 of file benderscut.c.

References NULL.

Referenced by SCIPsetBenderscutFree().

◆ SCIPbenderscutSetInit()

void SCIPbenderscutSetInit ( SCIP_BENDERSCUT benderscut,
SCIP_DECL_BENDERSCUTINIT((*benderscutinit))   
)

sets initialization callback of the Benders' decomposition cut

Parameters
benderscutBenders' decomposition cut

Definition at line 464 of file benderscut.c.

References NULL.

Referenced by SCIPsetBenderscutInit().

◆ SCIPbenderscutSetExit()

void SCIPbenderscutSetExit ( SCIP_BENDERSCUT benderscut,
SCIP_DECL_BENDERSCUTEXIT((*benderscutexit))   
)

sets deinitialization callback of the Benders' decomposition cut

Parameters
benderscutBenders' decomposition cut

Definition at line 475 of file benderscut.c.

References NULL.

Referenced by SCIPsetBenderscutExit().

◆ SCIPbenderscutSetInitsol()

void SCIPbenderscutSetInitsol ( SCIP_BENDERSCUT benderscut,
SCIP_DECL_BENDERSCUTINITSOL((*benderscutinitsol))   
)

sets solving process initialization callback of the Benders' decomposition cut

Parameters
benderscutBenders' decomposition cut

Definition at line 486 of file benderscut.c.

References NULL.

Referenced by SCIPsetBenderscutInitsol().

◆ SCIPbenderscutSetExitsol()

void SCIPbenderscutSetExitsol ( SCIP_BENDERSCUT benderscut,
SCIP_DECL_BENDERSCUTEXITSOL((*benderscutexitsol))   
)

sets solving process deinitialization callback of the Benders' decomposition cut

sets solving process deinitialization callback of Benders' decomposition cut

Parameters
benderscutBenders' decomposition cut

Definition at line 497 of file benderscut.c.

References NULL.

Referenced by SCIPsetBenderscutExitsol().

◆ SCIPbenderscutStoreCut()

SCIP_RETCODE SCIPbenderscutStoreCut ( SCIP_BENDERSCUT benderscut,
SCIP_SET set,
SCIP_VAR **  vars,
SCIP_Real vals,
SCIP_Real  lhs,
SCIP_Real  rhs,
int  nvars 
)

adds the data for the generated cuts to the Benders' cut storage

Parameters
benderscutBenders' decomposition cut
setglobal SCIP settings
varsthe variables that have non-zero coefficients in the cut
valsthe coefficients of the variables in the cut
lhsthe left hand side of the cut
rhsthe right hand side of the cut
nvarsthe number of variables with non-zero coefficients in the cut

Definition at line 637 of file benderscut.c.

References SCIP_Benderscut::addedcuts, SCIP_Benderscut::addedcutssize, BMSreallocBlockMemoryArray, SCIP_BenderscutCut::lhs, SCIP_Benderscut::naddedcuts, NULL, SCIP_BenderscutCut::nvars, SCIP_BenderscutCut::rhs, SCIP_ALLOC, SCIP_CALL, SCIP_OKAY, SCIPallocBlockMemory, SCIPblkmem(), SCIPduplicateBlockMemoryArray, SCIPsetCalcMemGrowSize(), SCIP_BenderscutCut::vals, and SCIP_BenderscutCut::vars.

Referenced by SCIPstoreBenderscutCut().