Scippy

SCIP

Solving Constraint Integer Programs

Macros | Functions
concsolver_scip.c File Reference
Internal API of SCIP » Parallel interface methods

Detailed Description

implementation of concurrent solver interface for SCIP

Author
Robert Lion Gottwald

Definition in file concsolver_scip.c.

#include "scip/concsolver_scip.h"
#include "scip/concsolver.h"
#include "scip/concurrent.h"
#include "scip/syncstore.h"
#include "scip/boundstore.h"
#include <string.h>

Go to the source code of this file.

Macros

#define EVENTHDLR_NAME   "sync"
 
#define EVENTHDLR_DESC   "event handler for synchronization of concurrent scip sovlers"
 

Functions

static SCIP_DECL_EVENTFREE (eventFreeSync)
 
static SCIP_DECL_EVENTINIT (eventInitSync)
 
static SCIP_DECL_EVENTEXIT (eventExitSync)
 
static SCIP_DECL_EVENTEXEC (eventExecSync)
 
static SCIP_RETCODE includeEventHdlrSync (SCIP *scip)
 
static SCIP_RETCODE disableConflictingDualReductions (SCIP *scip)
 
static SCIP_RETCODE setChildSelRule (SCIP_CONCSOLVER *concsolver)
 
static SCIP_RETCODE initConcsolver (SCIP *scip, SCIP_CONCSOLVER *concsolver)
 
static SCIP_DECL_CONCSOLVERCREATEINST (concsolverScipCreateInstance)
 
static SCIP_DECL_CONCSOLVERDESTROYINST (concsolverScipDestroyInstance)
 
static SCIP_DECL_CONCSOLVERTYPEFREEDATA (concsolverTypeScipFreeData)
 
static SCIP_DECL_CONCSOLVERINITSEEDS (concsolverScipInitSeeds)
 
static SCIP_DECL_CONCSOLVERCOPYSOLVINGDATA (concsolverGetSolvingData)
 
static SCIP_DECL_CONCSOLVEREXEC (concsolverScipExec)
 
static SCIP_DECL_CONCSOLVERSTOP (concsolverScipStop)
 
static SCIP_DECL_CONCSOLVERSYNCWRITE (concsolverScipSyncWrite)
 
static SCIP_DECL_CONCSOLVERSYNCREAD (concsolverScipSyncRead)
 
SCIP_RETCODE SCIPincludeConcurrentScipSolvers (SCIP *scip)
 

Macro Definition Documentation

◆ EVENTHDLR_NAME

#define EVENTHDLR_NAME   "sync"

Definition at line 34 of file concsolver_scip.c.

Referenced by includeEventHdlrSync(), SCIP_DECL_EVENTEXEC(), SCIP_DECL_EVENTEXIT(), SCIP_DECL_EVENTFREE(), and SCIP_DECL_EVENTINIT().

◆ EVENTHDLR_DESC

#define EVENTHDLR_DESC   "event handler for synchronization of concurrent scip sovlers"

Definition at line 35 of file concsolver_scip.c.

Referenced by includeEventHdlrSync().

Function Documentation

◆ SCIP_DECL_EVENTFREE()

static SCIP_DECL_EVENTFREE ( eventFreeSync  )
static

destructor of event handler to free user data (called when SCIP is exiting)

Definition at line 53 of file concsolver_scip.c.

References EVENTHDLR_NAME, SCIP_OKAY, SCIPeventhdlrGetData(), SCIPeventhdlrGetName(), SCIPeventhdlrSetData(), and SCIPfreeBlockMemory.

◆ SCIP_DECL_EVENTINIT()

static SCIP_DECL_EVENTINIT ( eventInitSync  )
static

initialization method of event handler (called after problem was transformed)

Definition at line 75 of file concsolver_scip.c.

References EVENTHDLR_NAME, SCIP_CALL, SCIP_EVENTTYPE_SYNC, SCIP_OKAY, SCIPcatchEvent(), SCIPeventhdlrGetData(), SCIPeventhdlrGetName(), SCIPgetSyncstore(), and SCIPsyncstoreIsInitialized().

◆ SCIP_DECL_EVENTEXIT()

static SCIP_DECL_EVENTEXIT ( eventExitSync  )
static

deinitialization method of event handler (called before transformed problem is freed)

Definition at line 101 of file concsolver_scip.c.

References EVENTHDLR_NAME, SCIP_CALL, SCIP_EVENTTYPE_SYNC, SCIP_OKAY, SCIPdropEvent(), SCIPeventhdlrGetData(), and SCIPeventhdlrGetName().

◆ SCIP_DECL_EVENTEXEC()

static SCIP_DECL_EVENTEXEC ( eventExecSync  )
static

execution method of event handler

Definition at line 124 of file concsolver_scip.c.

References EVENTHDLR_NAME, SCIP_CALL, SCIP_OKAY, SCIPeventhdlrGetName(), and SCIPsynchronize().

◆ includeEventHdlrSync()

static SCIP_RETCODE includeEventHdlrSync ( SCIP *  scip)
static

includes event handler for synchronization found

Parameters
scipSCIP data structure

Definition at line 139 of file concsolver_scip.c.

References EVENTHDLR_DESC, EVENTHDLR_NAME, SCIP_Bool, SCIP_CALL, SCIP_OKAY, SCIPallocBlockMemory, SCIPincludeEventhdlrBasic(), SCIPsetEventhdlrExit(), SCIPsetEventhdlrFree(), and SCIPsetEventhdlrInit().

Referenced by SCIP_DECL_CONCSOLVERCREATEINST().

◆ disableConflictingDualReductions()

static SCIP_RETCODE disableConflictingDualReductions ( SCIP *  scip)
static

Disable dual reductions that might cut off optimal solutions. Although they keep at least one optimal solution intact, communicating these bounds may cut off all optimal solutions, if different optimal solutions were kept in different concurrent solvers.

Parameters
scipSCIP datastructure

Definition at line 179 of file concsolver_scip.c.

References FALSE, SCIP_Bool, SCIP_CALL, SCIP_OKAY, SCIPgetBoolParam(), and SCIPsetBoolParam().

Referenced by SCIP_DECL_CONCSOLVERCREATEINST().

◆ setChildSelRule()

static SCIP_RETCODE setChildSelRule ( SCIP_CONCSOLVER *  concsolver)
static

sets the child selection rule based on the index of the concurrent solver

Parameters
concsolverthe concurrent solver

Definition at line 196 of file concsolver_scip.c.

References SCIP_CALL, SCIP_OKAY, SCIPconcsolverGetData(), SCIPconcsolverGetIdx(), and SCIPsetCharParam().

Referenced by SCIP_DECL_CONCSOLVERCREATEINST().

◆ initConcsolver()

static SCIP_RETCODE initConcsolver ( SCIP *  scip,
SCIP_CONCSOLVER *  concsolver 
)
static

initialize the concurrent SCIP solver, i.e. setup the copy of the problem and the mapping of the variables

Parameters
scipthe main SCIP instance
concsolverthe concurrent solver to set up

Definition at line 216 of file concsolver_scip.c.

References FALSE, SCIP_Bool, SCIP_CALL, SCIP_OKAY, SCIPallocBlockMemoryArray, SCIPallocBufferArray, SCIPblkmem(), SCIPconcsolverGetData(), SCIPconcsolverGetName(), SCIPcopy(), SCIPcreate(), SCIPcreateConcurrent(), SCIPfreeBufferArray, SCIPgetNVars(), SCIPgetVars(), SCIPhashmapCreate(), SCIPhashmapFree(), SCIPhashmapGetImage(), SCIPvarGetIndex(), and TRUE.

Referenced by SCIP_DECL_CONCSOLVERCREATEINST().

◆ SCIP_DECL_CONCSOLVERCREATEINST()

static SCIP_DECL_CONCSOLVERCREATEINST ( concsolverScipCreateInstance  )
static

Definition at line 273 of file concsolver_scip.c.

References BMSallocMemory, disableConflictingDualReductions(), FALSE, includeEventHdlrSync(), initConcsolver(), SCIP_ALLOC, SCIP_Bool, SCIP_CALL, SCIP_CLOCKTYPE_WALL, SCIP_MAXSTRLEN, SCIP_OKAY, SCIP_VERBLEVEL_FULL, SCIPallocBufferArray, SCIPconcsolverGetIdx(), SCIPconcsolverGetName(), SCIPconcsolverSetData(), SCIPconcsolverTypeGetData(), SCIPfileExists(), SCIPfixParam(), SCIPfreeBufferArray, SCIPgetBoolParam(), SCIPgetNParams(), SCIPgetParams(), SCIPgetStringParam(), SCIPinfoMessage(), SCIPparamGetName(), SCIPreadParams(), SCIPsetBoolParam(), SCIPsetEmphasis(), SCIPsetIntParam(), SCIPsnprintf(), SCIPunfixParam(), SCIPverbMessage(), setChildSelRule(), and TRUE.

◆ SCIP_DECL_CONCSOLVERDESTROYINST()

static SCIP_DECL_CONCSOLVERDESTROYINST ( concsolverScipDestroyInstance  )
static

destroys an instance of a concurrent SCIP solver

Definition at line 380 of file concsolver_scip.c.

References BMSfreeMemory, SCIP_CALL, SCIP_OKAY, SCIPconcsolverGetData(), SCIPconcsolverSetData(), SCIPfree(), and SCIPfreeBlockMemoryArray.

◆ SCIP_DECL_CONCSOLVERTYPEFREEDATA()

static SCIP_DECL_CONCSOLVERTYPEFREEDATA ( concsolverTypeScipFreeData  )
static

frees the data of a concurrent solver type

Definition at line 403 of file concsolver_scip.c.

References BMSfreeMemory.

◆ SCIP_DECL_CONCSOLVERINITSEEDS()

static SCIP_DECL_CONCSOLVERINITSEEDS ( concsolverScipInitSeeds  )
static

initializes the random and permutation seeds with the given one and enables permutation of constraints and variables

Definition at line 412 of file concsolver_scip.c.

References SCIP_CALL, SCIP_OKAY, SCIPconcsolverGetData(), SCIPconcsolverGetName(), SCIPinfoMessage(), SCIPsetBoolParam(), SCIPsetIntParam(), and TRUE.

◆ SCIP_DECL_CONCSOLVERCOPYSOLVINGDATA()

static SCIP_DECL_CONCSOLVERCOPYSOLVINGDATA ( concsolverGetSolvingData  )
static

installs the solving status of this concurrent solver and the solving statistics into the given SCIP instance

Definition at line 435 of file concsolver_scip.c.

References SCIP_Bool, SCIP_CALL, SCIP_OKAY, SCIP_Real, SCIPaddSolFree(), SCIPallocBufferArray, SCIPconcsolverGetData(), SCIPcopyConcurrentSolvingStats(), SCIPcopySolStats(), SCIPcreateSol(), SCIPfindHeur(), SCIPfreeBufferArray, SCIPgetNSols(), SCIPgetNVars(), SCIPgetSols(), SCIPgetSolVals(), SCIPgetVars(), SCIPheurGetName(), SCIPsetSolVals(), and SCIPsolGetHeur().

◆ SCIP_DECL_CONCSOLVEREXEC()

static SCIP_DECL_CONCSOLVEREXEC ( concsolverScipExec  )
static

start solving the problem until the solving reaches a limit, gets interrupted, or just finished successfully

Definition at line 497 of file concsolver_scip.c.

References nnodes, SCIP_CALL, SCIP_OKAY, SCIPconcsolverGetData(), SCIPconcsolverGetName(), SCIPgetNLPIterations(), SCIPgetNNodes(), SCIPgetSolvingTime(), SCIPinfoMessage(), SCIPprintStatus(), and SCIPsolve().

◆ SCIP_DECL_CONCSOLVERSTOP()

static SCIP_DECL_CONCSOLVERSTOP ( concsolverScipStop  )
static

stops the concurrent solver as soon as possible

Definition at line 526 of file concsolver_scip.c.

References SCIP_CALL, SCIP_OKAY, SCIPconcsolverGetData(), and SCIPinterruptSolve().

◆ SCIP_DECL_CONCSOLVERSYNCWRITE()

static SCIP_DECL_CONCSOLVERSYNCWRITE ( concsolverScipSyncWrite  )
static

writes new solutions and global boundchanges to the iven synchronization data

Definition at line 541 of file concsolver_scip.c.

References SCIP_CALL, SCIP_OKAY, SCIP_Real, SCIP_STATUS_UNKNOWN, SCIPconcsolverGetData(), SCIPconcsolverGetIdx(), SCIPconcsolverGetName(), SCIPdebugMessage, SCIPgetConcurrentGlobalBoundChanges(), SCIPgetDualbound(), SCIPgetMemTotal(), SCIPgetNSols(), SCIPgetPrimalbound(), SCIPgetSolOrigObj(), SCIPgetSols(), SCIPgetSolVals(), SCIPgetStatus(), SCIPIsConcurrentSolNew(), SCIPsyncdataAddBoundChanges(), SCIPsyncdataAddMemTotal(), SCIPsyncdataGetSolutionBuffer(), SCIPsyncdataGetStatus(), SCIPsyncdataSetLowerbound(), SCIPsyncdataSetStatus(), and SCIPsyncdataSetUpperbound().

◆ SCIP_DECL_CONCSOLVERSYNCREAD()

static SCIP_DECL_CONCSOLVERSYNCREAD ( concsolverScipSyncRead  )
static

reads the solutions and bounds from the given synchronization data

Definition at line 615 of file concsolver_scip.c.

References SCIP_BOUNDTYPE_LOWER, SCIP_BOUNDTYPE_UPPER, SCIP_CALL, SCIP_OKAY, SCIP_Real, SCIP_VARSTATUS_MULTAGGR, SCIP_VARTYPE_INTEGER, SCIPaddConcurrentBndchg(), SCIPaddConcurrentSol(), SCIPboundstoreGetChgType(), SCIPboundstoreGetChgVal(), SCIPboundstoreGetChgVaridx(), SCIPboundstoreGetNChgs(), SCIPconcsolverGetData(), SCIPconcsolverGetIdx(), SCIPconcsolverGetName(), SCIPcreateOrigSol(), SCIPdebugMessage, SCIPisGE(), SCIPisLE(), SCIPsetSolVals(), SCIPsyncdataGetBoundChgs(), SCIPsyncdataGetSolutions(), SCIPvarGetLbGlobal(), SCIPvarGetProbvarBound(), SCIPvarGetStatus(), SCIPvarGetType(), and SCIPvarGetUbGlobal().

◆ SCIPincludeConcurrentScipSolvers()

SCIP_RETCODE SCIPincludeConcurrentScipSolvers ( SCIP *  scip)

creates the concurrent SCIP solver plugins and includes them in SCIP

Parameters
scipSCIP datastructure

Definition at line 701 of file concsolver_scip.c.

References FALSE, SCIP_CALL, SCIP_OKAY, SCIP_PARAMEMPHASIS_COUNTER, SCIP_PARAMEMPHASIS_CPSOLVER, SCIP_PARAMEMPHASIS_DEFAULT, SCIP_PARAMEMPHASIS_EASYCIP, SCIP_PARAMEMPHASIS_FEASIBILITY, SCIP_PARAMEMPHASIS_HARDLP, SCIP_PARAMEMPHASIS_OPTIMALITY, SCIPallocMemory, SCIPincludeConcsolverType(), and TRUE.

Referenced by SCIPincludeDefaultPlugins().