Scippy

SCIP

Solving Constraint Integer Programs

relax.c File Reference

Detailed Description

methods and datastructures for relaxation handlers

Author
Tobias Achterberg
Timo Berthold

Definition in file relax.c.

#include <assert.h>
#include <string.h>
#include "scip/def.h"
#include "scip/set.h"
#include "scip/stat.h"
#include "scip/clock.h"
#include "scip/paramset.h"
#include "scip/scip.h"
#include "scip/sol.h"
#include "scip/var.h"
#include "scip/relax.h"
#include "scip/pub_message.h"
#include "scip/pub_misc.h"
#include "scip/struct_relax.h"

Go to the source code of this file.

Functions

 SCIP_DECL_SORTPTRCOMP (SCIPrelaxComp)
 
 SCIP_DECL_SORTPTRCOMP (SCIPrelaxCompName)
 
static SCIP_DECL_PARAMCHGD (paramChgdRelaxPriority)
 
SCIP_RETCODE SCIPrelaxCopyInclude (SCIP_RELAX *relax, SCIP_SET *set)
 
static SCIP_RETCODE doRelaxCreate (SCIP_RELAX **relax, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, BMS_BLKMEM *blkmem, const char *name, const char *desc, int priority, int freq, SCIP_DECL_RELAXCOPY((*relaxcopy)), SCIP_DECL_RELAXFREE((*relaxfree)), SCIP_DECL_RELAXINIT((*relaxinit)), SCIP_DECL_RELAXEXIT((*relaxexit)), SCIP_DECL_RELAXINITSOL((*relaxinitsol)), SCIP_DECL_RELAXEXITSOL((*relaxexitsol)), SCIP_DECL_RELAXEXEC((*relaxexec)), SCIP_RELAXDATA *relaxdata)
 
SCIP_RETCODE SCIPrelaxCreate (SCIP_RELAX **relax, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, BMS_BLKMEM *blkmem, const char *name, const char *desc, int priority, int freq, SCIP_DECL_RELAXCOPY((*relaxcopy)), SCIP_DECL_RELAXFREE((*relaxfree)), SCIP_DECL_RELAXINIT((*relaxinit)), SCIP_DECL_RELAXEXIT((*relaxexit)), SCIP_DECL_RELAXINITSOL((*relaxinitsol)), SCIP_DECL_RELAXEXITSOL((*relaxexitsol)), SCIP_DECL_RELAXEXEC((*relaxexec)), SCIP_RELAXDATA *relaxdata)
 
SCIP_RETCODE SCIPrelaxFree (SCIP_RELAX **relax, SCIP_SET *set)
 
SCIP_RETCODE SCIPrelaxInit (SCIP_RELAX *relax, SCIP_SET *set)
 
SCIP_RETCODE SCIPrelaxExit (SCIP_RELAX *relax, SCIP_SET *set)
 
SCIP_RETCODE SCIPrelaxInitsol (SCIP_RELAX *relax, SCIP_SET *set)
 
SCIP_RETCODE SCIPrelaxExitsol (SCIP_RELAX *relax, SCIP_SET *set)
 
SCIP_RETCODE SCIPrelaxExec (SCIP_RELAX *relax, SCIP_SET *set, SCIP_STAT *stat, int depth, SCIP_Real *lowerbound, SCIP_RESULT *result)
 
SCIP_RELAXDATASCIPrelaxGetData (SCIP_RELAX *relax)
 
void SCIPrelaxSetData (SCIP_RELAX *relax, SCIP_RELAXDATA *relaxdata)
 
void SCIPrelaxSetCopy (SCIP_RELAX *relax, SCIP_DECL_RELAXCOPY((*relaxcopy)))
 
void SCIPrelaxSetFree (SCIP_RELAX *relax, SCIP_DECL_RELAXFREE((*relaxfree)))
 
void SCIPrelaxSetInit (SCIP_RELAX *relax, SCIP_DECL_RELAXINIT((*relaxinit)))
 
void SCIPrelaxSetExit (SCIP_RELAX *relax, SCIP_DECL_RELAXEXIT((*relaxexit)))
 
void SCIPrelaxSetInitsol (SCIP_RELAX *relax, SCIP_DECL_RELAXINITSOL((*relaxinitsol)))
 
void SCIPrelaxSetExitsol (SCIP_RELAX *relax, SCIP_DECL_RELAXEXITSOL((*relaxexitsol)))
 
const char * SCIPrelaxGetName (SCIP_RELAX *relax)
 
const char * SCIPrelaxGetDesc (SCIP_RELAX *relax)
 
int SCIPrelaxGetPriority (SCIP_RELAX *relax)
 
void SCIPrelaxSetPriority (SCIP_RELAX *relax, SCIP_SET *set, int priority)
 
int SCIPrelaxGetFreq (SCIP_RELAX *relax)
 
SCIP_Real SCIPrelaxGetSetupTime (SCIP_RELAX *relax)
 
void SCIPrelaxEnableOrDisableClocks (SCIP_RELAX *relax, SCIP_Bool enable)
 
SCIP_Real SCIPrelaxGetTime (SCIP_RELAX *relax)
 
SCIP_Longint SCIPrelaxGetNCalls (SCIP_RELAX *relax)
 
SCIP_Bool SCIPrelaxIsInitialized (SCIP_RELAX *relax)
 
SCIP_Bool SCIPrelaxIsSolved (SCIP_RELAX *relax, SCIP_STAT *stat)
 
void SCIPrelaxMarkUnsolved (SCIP_RELAX *relax)
 
SCIP_RETCODE SCIPrelaxationCreate (SCIP_RELAXATION **relaxation, BMS_BLKMEM *blkmem, SCIP_SET *set, SCIP_STAT *stat, SCIP_PRIMAL *primal, SCIP_TREE *tree)
 
SCIP_RETCODE SCIPrelaxationFree (SCIP_RELAXATION **relaxation)
 
void SCIPrelaxationSetSolZero (SCIP_RELAXATION *relaxation, SCIP_Bool iszero)
 
SCIP_Bool SCIPrelaxationIsSolZero (SCIP_RELAXATION *relaxation)
 
void SCIPrelaxationSetSolValid (SCIP_RELAXATION *relaxation, SCIP_Bool isvalid, SCIP_Bool includeslp)
 
SCIP_Bool SCIPrelaxationIsSolValid (SCIP_RELAXATION *relaxation)
 
SCIP_Bool SCIPrelaxationIsLpIncludedForSol (SCIP_RELAXATION *relaxation)
 
void SCIPrelaxationSetSolObj (SCIP_RELAXATION *relaxation, SCIP_Real obj)
 
SCIP_Real SCIPrelaxationGetSolObj (SCIP_RELAXATION *relaxation)
 
void SCIPrelaxationSolObjAdd (SCIP_RELAXATION *relaxation, SCIP_Real val)
 
void SCIPrelaxationUpdateVarObj (SCIP_RELAXATION *relaxation, SCIP_SET *set, SCIP_VAR *var, SCIP_Real oldobj, SCIP_Real newobj)
 

Function Documentation

◆ SCIP_DECL_PARAMCHGD()

static SCIP_DECL_PARAMCHGD ( paramChgdRelaxPriority  )
static

method to call, when the priority of a relaxation handler was changed

Definition at line 57 of file relax.c.

References NULL, SCIP_CALL, SCIP_OKAY, SCIPparamGetData(), SCIPparamGetInt(), and SCIPsetRelaxPriority().

◆ SCIPrelaxCopyInclude()

SCIP_RETCODE SCIPrelaxCopyInclude ( SCIP_RELAX relax,
SCIP_SET set 
)

copies the given relaxation handler to a new scip

Parameters
relaxrelaxation handler
setSCIP_SET of SCIP to copy to

Definition at line 71 of file relax.c.

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

◆ doRelaxCreate()

static SCIP_RETCODE doRelaxCreate ( SCIP_RELAX **  relax,
SCIP_SET set,
SCIP_MESSAGEHDLR messagehdlr,
BMS_BLKMEM blkmem,
const char *  name,
const char *  desc,
int  priority,
int  freq,
SCIP_DECL_RELAXCOPY((*relaxcopy))  ,
SCIP_DECL_RELAXFREE((*relaxfree))  ,
SCIP_DECL_RELAXINIT((*relaxinit))  ,
SCIP_DECL_RELAXEXIT((*relaxexit))  ,
SCIP_DECL_RELAXINITSOL((*relaxinitsol))  ,
SCIP_DECL_RELAXEXITSOL((*relaxexitsol))  ,
SCIP_DECL_RELAXEXEC((*relaxexec))  ,
SCIP_RELAXDATA relaxdata 
)
static

internal method for creating a relaxation handler

Parameters
relaxpointer to relaxation handler data structure
setglobal SCIP settings
messagehdlrmessage handler
blkmemblock memory for parameter settings
namename of relaxation handler
descdescription of relaxation handler
prioritypriority of the relaxation handler (negative: after LP, non-negative: before LP)
freqfrequency for calling relaxation handler
relaxdatarelaxation handler data

Definition at line 90 of file relax.c.

References BMSallocMemory, BMSclearMemory, BMSduplicateMemoryArray, FALSE, NULL, SCIP_ALLOC, SCIP_CALL, SCIP_CLOCKTYPE_DEFAULT, SCIP_MAXSTRLEN, SCIP_MAXTREEDEPTH, SCIP_OKAY, SCIPclockCreate(), SCIPsetAddIntParam(), and SCIPsnprintf().

Referenced by SCIPrelaxCreate().

◆ SCIPrelaxCreate()

SCIP_RETCODE SCIPrelaxCreate ( SCIP_RELAX **  relax,
SCIP_SET set,
SCIP_MESSAGEHDLR messagehdlr,
BMS_BLKMEM blkmem,
const char *  name,
const char *  desc,
int  priority,
int  freq,
SCIP_DECL_RELAXCOPY((*relaxcopy))  ,
SCIP_DECL_RELAXFREE((*relaxfree))  ,
SCIP_DECL_RELAXINIT((*relaxinit))  ,
SCIP_DECL_RELAXEXIT((*relaxexit))  ,
SCIP_DECL_RELAXINITSOL((*relaxinitsol))  ,
SCIP_DECL_RELAXEXITSOL((*relaxexitsol))  ,
SCIP_DECL_RELAXEXEC((*relaxexec))  ,
SCIP_RELAXDATA relaxdata 
)

creates a relaxation handler

Parameters
relaxpointer to relaxation handler data structure
setglobal SCIP settings
messagehdlrmessage handler
blkmemblock memory for parameter settings
namename of relaxation handler
descdescription of relaxation handler
prioritypriority of the relaxation handler (negative: after LP, non-negative: before LP)
freqfrequency for calling relaxation handler
relaxdatarelaxation handler data

Definition at line 154 of file relax.c.

References doRelaxCreate(), NULL, SCIP_CALL_FINALLY, SCIP_OKAY, and SCIPrelaxFree().

Referenced by SCIPincludeRelax(), and SCIPincludeRelaxBasic().

◆ SCIPrelaxFree()

SCIP_RETCODE SCIPrelaxFree ( SCIP_RELAX **  relax,
SCIP_SET set 
)

calls destructor and frees memory of relaxation handler

Parameters
relaxpointer to relaxation handler data structure
setglobal SCIP settings

Definition at line 186 of file relax.c.

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

Referenced by SCIPrelaxCreate().

◆ SCIPrelaxInit()

SCIP_RETCODE SCIPrelaxInit ( SCIP_RELAX relax,
SCIP_SET set 
)

initializes relaxation handler

Parameters
relaxrelaxation handler
setglobal SCIP settings

Definition at line 213 of file relax.c.

References SCIP_Relax::initialized, SCIP_Relax::lastsolvednode, SCIP_Relax::name, SCIP_Relax::ncalls, NULL, SCIP_Relax::relaxclock, SCIP_CALL, SCIP_INVALIDCALL, SCIP_OKAY, SCIPclockReset(), SCIPclockStart(), SCIPclockStop(), SCIPerrorMessage, SCIP_Relax::setuptime, and TRUE.

Referenced by SCIPsetIncludeExternalCode().

◆ SCIPrelaxExit()

SCIP_RETCODE SCIPrelaxExit ( SCIP_RELAX relax,
SCIP_SET set 
)

calls exit method of relaxation handler

Parameters
relaxrelaxation handler
setglobal SCIP settings

Definition at line 251 of file relax.c.

References FALSE, SCIP_Relax::initialized, SCIP_Relax::name, NULL, SCIP_CALL, SCIP_INVALIDCALL, SCIP_OKAY, SCIPclockStart(), SCIPclockStop(), SCIPerrorMessage, and SCIP_Relax::setuptime.

Referenced by SCIPsetInitPlugins().

◆ SCIPrelaxInitsol()

SCIP_RETCODE SCIPrelaxInitsol ( SCIP_RELAX relax,
SCIP_SET set 
)

informs relaxation handler that the branch and bound process is being started

Parameters
relaxrelaxation handler
setglobal SCIP settings

Definition at line 281 of file relax.c.

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

Referenced by SCIPsetExitprePlugins().

◆ SCIPrelaxExitsol()

SCIP_RETCODE SCIPrelaxExitsol ( SCIP_RELAX relax,
SCIP_SET set 
)

informs relaxation handler that the branch and bound process data is being freed

Parameters
relaxrelaxation handler
setglobal SCIP settings

Definition at line 305 of file relax.c.

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

Referenced by SCIPsetInitsolPlugins().

◆ SCIPrelaxExec()

SCIP_RETCODE SCIPrelaxExec ( SCIP_RELAX relax,
SCIP_SET set,
SCIP_STAT stat,
int  depth,
SCIP_Real lowerbound,
SCIP_RESULT result 
)

calls execution method of relaxation handler

Parameters
relaxrelaxation handler
setglobal SCIP settings
statdynamic problem statistics
depthdepth of current node
lowerboundpointer to lower bound computed by the relaxation handler
resultpointer to store the result of the callback method

Definition at line 329 of file relax.c.

References SCIP_Relax::freq, SCIP_Relax::lastsolvednode, SCIP_Relax::name, SCIP_Relax::ncalls, SCIP_Stat::ntotalnodes, NULL, SCIP_Relax::relaxclock, SCIP_Stat::relaxcount, SCIP_CALL, SCIP_CONSADDED, SCIP_CUTOFF, SCIP_DIDNOTRUN, SCIP_INVALIDRESULT, SCIP_OKAY, SCIP_REDUCEDDOM, SCIP_SEPARATED, SCIP_SUCCESS, SCIP_SUSPENDED, SCIPclockStart(), SCIPclockStop(), SCIPerrorMessage, SCIPinProbing(), SCIPrelaxMarkUnsolved(), and SCIPsetDebugMsg.

Referenced by SCIPsolveProbingRelax(), and solveNodeRelax().

◆ SCIPrelaxSetCopy()

void SCIPrelaxSetCopy ( SCIP_RELAX relax,
SCIP_DECL_RELAXCOPY((*relaxcopy))   
)

set copy method of relaxation handler

Parameters
relaxrelaxation handler

Definition at line 414 of file relax.c.

References NULL.

Referenced by SCIPsetRelaxCopy().

◆ SCIPrelaxSetFree()

void SCIPrelaxSetFree ( SCIP_RELAX relax,
SCIP_DECL_RELAXFREE((*relaxfree))   
)

set destructor of relaxation handler

Parameters
relaxrelaxation handler

Definition at line 425 of file relax.c.

References NULL.

Referenced by SCIPsetRelaxFree().

◆ SCIPrelaxSetInit()

void SCIPrelaxSetInit ( SCIP_RELAX relax,
SCIP_DECL_RELAXINIT((*relaxinit))   
)

set initialization method of relaxation handler

Parameters
relaxrelaxation handler

Definition at line 436 of file relax.c.

References NULL.

Referenced by SCIPsetRelaxInit().

◆ SCIPrelaxSetExit()

void SCIPrelaxSetExit ( SCIP_RELAX relax,
SCIP_DECL_RELAXEXIT((*relaxexit))   
)

set deinitialization method of relaxation handler

Parameters
relaxrelaxation handler

Definition at line 447 of file relax.c.

References NULL.

Referenced by SCIPsetRelaxExit().

◆ SCIPrelaxSetInitsol()

void SCIPrelaxSetInitsol ( SCIP_RELAX relax,
SCIP_DECL_RELAXINITSOL((*relaxinitsol))   
)

set solving process initialization method of relaxation handler

Parameters
relaxrelaxation handler

Definition at line 458 of file relax.c.

References NULL.

Referenced by SCIPsetRelaxInitsol().

◆ SCIPrelaxSetExitsol()

void SCIPrelaxSetExitsol ( SCIP_RELAX relax,
SCIP_DECL_RELAXEXITSOL((*relaxexitsol))   
)

set solving process deinitialization method of relaxation handler

Parameters
relaxrelaxation handler

Definition at line 469 of file relax.c.

References NULL.

Referenced by SCIPsetRelaxExitsol().

◆ SCIPrelaxSetPriority()

void SCIPrelaxSetPriority ( SCIP_RELAX relax,
SCIP_SET set,
int  priority 
)

sets priority of relaxation handler

Parameters
relaxrelaxation handler
setglobal SCIP settings
prioritynew priority of the relaxation handler

Definition at line 510 of file relax.c.

References FALSE, NULL, and SCIP_Relax::priority.

Referenced by SCIPsetRelaxPriority().

◆ SCIPrelaxEnableOrDisableClocks()

void SCIPrelaxEnableOrDisableClocks ( SCIP_RELAX relax,
SCIP_Bool  enable 
)

enables or disables all clocks of relax, depending on the value of the flag

Parameters
relaxthe relaxation handler for which all clocks should be enabled or disabled
enableshould the clocks of the relaxation handler be enabled?

Definition at line 544 of file relax.c.

References NULL, SCIP_Relax::relaxclock, SCIPclockEnableOrDisable(), and SCIP_Relax::setuptime.

◆ SCIPrelaxIsSolved()

SCIP_Bool SCIPrelaxIsSolved ( SCIP_RELAX relax,
SCIP_STAT stat 
)

returns whether the relaxation was completely solved at the current node

Parameters
relaxrelaxation handler
statdynamic problem statistics

Definition at line 586 of file relax.c.

References SCIP_Relax::lastsolvednode, SCIP_Stat::ntotalnodes, and NULL.

Referenced by updateLoopStatus().

◆ SCIPrelaxationCreate()

SCIP_RETCODE SCIPrelaxationCreate ( SCIP_RELAXATION **  relaxation,
BMS_BLKMEM blkmem,
SCIP_SET set,
SCIP_STAT stat,
SCIP_PRIMAL primal,
SCIP_TREE tree 
)

creates global relaxation data

Parameters
relaxationglobal relaxation data
blkmemblock memory
setglobal SCIP settings
statproblem statistics data
primalprimal data
treebranch and bound tree

Definition at line 612 of file relax.c.

References BMSallocMemory, FALSE, NULL, SCIP_ALLOC, SCIP_OKAY, and TRUE.

Referenced by prepareReoptimization(), and SCIPtransformProb().

◆ SCIPrelaxationFree()

SCIP_RETCODE SCIPrelaxationFree ( SCIP_RELAXATION **  relaxation)

frees global relaxation data

Parameters
relaxationglobal relaxation data

Definition at line 639 of file relax.c.

References BMSfreeMemory, NULL, and SCIP_OKAY.

Referenced by freeReoptSolve(), and freeTransform().

◆ SCIPrelaxationSetSolZero()

void SCIPrelaxationSetSolZero ( SCIP_RELAXATION relaxation,
SCIP_Bool  iszero 
)

sets the relaxsolzero flag in the relaxation data to the given value

Parameters
relaxationglobal relaxation data
iszeroare all values of the relaxation solution set to zero?

Definition at line 651 of file relax.c.

References NULL, and SCIP_Relaxation::relaxsolzero.

Referenced by SCIPclearRelaxSolVals(), SCIPsetRelaxSolVal(), SCIPsetRelaxSolVals(), and SCIPsetRelaxSolValsSol().

◆ SCIPrelaxationIsSolZero()

SCIP_Bool SCIPrelaxationIsSolZero ( SCIP_RELAXATION relaxation)

returns whether the global relaxation solution is cleared and all values are set to zero

Parameters
relaxationglobal relaxation data

Definition at line 662 of file relax.c.

References NULL, and SCIP_Relaxation::relaxsolzero.

Referenced by SCIPclearRelaxSolVals().

◆ SCIPrelaxationSetSolValid()

void SCIPrelaxationSetSolValid ( SCIP_RELAXATION relaxation,
SCIP_Bool  isvalid,
SCIP_Bool  includeslp 
)

sets the relaxsolvalid and includeslp flags in the relaxation data to the given values

Parameters
relaxationglobal relaxation data
isvalidis the stored solution valid?
includeslpdoes the relaxator contain all cuts in the LP?

Definition at line 672 of file relax.c.

References NULL, SCIP_Relaxation::relaxsolincludeslp, and SCIP_Relaxation::relaxsolvalid.

Referenced by markRelaxsUnsolved(), SCIPmarkRelaxSolInvalid(), SCIPmarkRelaxSolValid(), SCIPsetRelaxSolVal(), SCIPsetRelaxSolVals(), SCIPsetRelaxSolValsSol(), SCIPtreeRestoreRelaxSol(), and solveNode().

◆ SCIPrelaxationIsSolValid()

SCIP_Bool SCIPrelaxationIsSolValid ( SCIP_RELAXATION relaxation)

◆ SCIPrelaxationIsLpIncludedForSol()

SCIP_Bool SCIPrelaxationIsLpIncludedForSol ( SCIP_RELAXATION relaxation)

returns whether the global relaxation solution was computed by a relaxator which included all LP cuts

Parameters
relaxationglobal relaxation data

Definition at line 695 of file relax.c.

References NULL, and SCIP_Relaxation::relaxsolincludeslp.

Referenced by addCurrentSolution(), enforceConstraints(), SCIPsolveCIP(), SCIPtreeStoreRelaxSol(), and solveNode().

◆ SCIPrelaxationSetSolObj()

void SCIPrelaxationSetSolObj ( SCIP_RELAXATION relaxation,
SCIP_Real  obj 
)

sets the objective value of the global relaxation solution

Parameters
relaxationglobal relaxation data
objobjective value

Definition at line 705 of file relax.c.

References NULL, and SCIP_Relaxation::relaxsolobjval.

Referenced by SCIPclearRelaxSolVals(), and SCIPsetRelaxSolValsSol().

◆ SCIPrelaxationGetSolObj()

SCIP_Real SCIPrelaxationGetSolObj ( SCIP_RELAXATION relaxation)

returns the objective value of the global relaxation solution w.r.t. the transformed problem

Parameters
relaxationglobal relaxation data

Definition at line 716 of file relax.c.

References NULL, and SCIP_Relaxation::relaxsolobjval.

Referenced by addCurrentSolution(), enforceConstraints(), SCIPgetRelaxSolObj(), SCIPsolLinkRelaxSol(), SCIPsolveCIP(), and solveNode().

◆ SCIPrelaxationSolObjAdd()

void SCIPrelaxationSolObjAdd ( SCIP_RELAXATION relaxation,
SCIP_Real  val 
)

adds the given value to the global relaxation solution's objective value

Parameters
relaxationglobal relaxation data
valvalue to add to the objective value

Definition at line 726 of file relax.c.

References NULL, and SCIP_Relaxation::relaxsolobjval.

Referenced by SCIPvarSetRelaxSol().

◆ SCIPrelaxationUpdateVarObj()

void SCIPrelaxationUpdateVarObj ( SCIP_RELAXATION relaxation,
SCIP_SET set,
SCIP_VAR var,
SCIP_Real  oldobj,
SCIP_Real  newobj 
)

updates objective value of current relaxation solution after change of objective coefficient

Parameters
relaxationglobal relaxation data
setglobal SCIP settings
varvariable with changed objective coefficient
oldobjold objective coefficient
newobjnew objective coefficient

Definition at line 737 of file relax.c.

References NULL, SCIP_Relaxation::relaxsolobjval, SCIP_Real, SCIP_VARSTATUS_COLUMN, SCIPvarGetRelaxSol(), and SCIPvarGetStatus().