SCIP_SyncStore Struct Reference

Detailed Description

Definition at line 48 of file struct_syncstore.h.

#include <struct_syncstore.h>

Data Fields
int	nuses
SCIP_PARALLELMODE	mode
SCIP_Bool	initialized
int	ninitvars
SCIP_SYNCDATA *	syncdata
SCIP_SYNCDATA *	lastsync
SCIP *	mainscip
SCIP_Real	limit_gap
SCIP_Real	limit_absgap
SCIP_Bool	stopped
SCIP_LOCK *	lock
int	nsyncdata
SCIP_Real	minsyncdelay
int	maxnsyncdelay
SCIP_Real	syncfreqinit
SCIP_Real	syncfreqmax
int	maxnsols
int	nsolvers

Field Documentation

nuses

int SCIP_SyncStore::nuses

number of uses of the synchronization store

Definition at line 50 of file struct_syncstore.h.

Referenced by SCIPsyncstoreCapture().

mode

SCIP_PARALLELMODE SCIP_SyncStore::mode

the mode for the parallel solving

Definition at line 51 of file struct_syncstore.h.

Referenced by SCIPsyncstoreGetMode(), and SCIPsyncstoreInit().

initialized

SCIP_Bool SCIP_SyncStore::initialized

flag to indicate whether the syncstore has been initialized

Definition at line 52 of file struct_syncstore.h.

Referenced by SCIPsyncdataAddBoundChanges(), SCIPsyncdataGetSolutionBuffer(), SCIPsyncdataSetSyncFreq(), SCIPsyncstoreEnsureAllSynced(), SCIPsyncstoreExit(), SCIPsyncstoreFinishSync(), SCIPsyncstoreGetLastLowerbound(), SCIPsyncstoreGetLastMemTotal(), SCIPsyncstoreGetLastNBounds(), SCIPsyncstoreGetLastNSols(), SCIPsyncstoreGetLastSyncfreq(), SCIPsyncstoreGetLastUpperbound(), SCIPsyncstoreGetNextSyncdata(), SCIPsyncstoreGetNSolvers(), SCIPsyncstoreGetSyncdata(), SCIPsyncstoreGetWinner(), SCIPsyncstoreInit(), SCIPsyncstoreIsInitialized(), and SCIPsyncstoreStartSync().

ninitvars

int SCIP_SyncStore::ninitvars

number of variables it has been initialized for

Definition at line 53 of file struct_syncstore.h.

Referenced by SCIPsyncstoreExit(), and SCIPsyncstoreInit().

syncdata

SCIP_SYNCDATA* SCIP_SyncStore::syncdata

array of size nsyncdata, containing the synchronization data for each active synchroization

Definition at line 54 of file struct_syncstore.h.

Referenced by SCIPsyncstoreExit(), SCIPsyncstoreGetNextSyncdata(), SCIPsyncstoreGetSyncdata(), SCIPsyncstoreInit(), and SCIPsyncstoreStartSync().

lastsync

SCIP_SYNCDATA* SCIP_SyncStore::lastsync

pointer to the last synchronization data that has been synchronized by all threads

Definition at line 56 of file struct_syncstore.h.

Referenced by SCIPsyncstoreFinishSync(), SCIPsyncstoreGetLastLowerbound(), SCIPsyncstoreGetLastMemTotal(), SCIPsyncstoreGetLastNBounds(), SCIPsyncstoreGetLastNSols(), SCIPsyncstoreGetLastSyncfreq(), SCIPsyncstoreGetLastUpperbound(), SCIPsyncstoreGetWinner(), and SCIPsyncstoreInit().

mainscip

SCIP* SCIP_SyncStore::mainscip

the SCIP instance that was used for initializing the syncstore

Definition at line 59 of file struct_syncstore.h.

Referenced by SCIPsyncdataAddBoundChanges(), SCIPsyncstoreExit(), SCIPsyncstoreFinishSync(), SCIPsyncstoreGetLastLowerbound(), SCIPsyncstoreGetLastUpperbound(), SCIPsyncstoreInit(), and SCIPsyncstoreStartSync().

limit_gap

SCIP_Real SCIP_SyncStore::limit_gap

relative gap limit in main SCIP

Definition at line 60 of file struct_syncstore.h.

Referenced by SCIPsyncstoreFinishSync(), and SCIPsyncstoreInit().

limit_absgap

SCIP_Real SCIP_SyncStore::limit_absgap

absolute gap limit in main SCIP

Definition at line 61 of file struct_syncstore.h.

Referenced by SCIPsyncstoreFinishSync(), and SCIPsyncstoreInit().

stopped

SCIP_Bool SCIP_SyncStore::stopped

flag to indicate if the solving is stopped

Definition at line 62 of file struct_syncstore.h.

Referenced by SCIPsyncstoreExit(), SCIPsyncstoreInit(), SCIPsyncstoreSetSolveIsStopped(), and SCIPsyncstoreSolveIsStopped().

lock

SCIP_LOCK* SCIP_SyncStore::lock

lock to protect the syncstore data structure from data races

Definition at line 63 of file struct_syncstore.h.

Referenced by SCIPsyncstoreCapture(), SCIPsyncstoreSetSolveIsStopped(), and SCIPsyncstoreSolveIsStopped().

nsyncdata

int SCIP_SyncStore::nsyncdata

the size of the synchronization data array

Definition at line 66 of file struct_syncstore.h.

Referenced by SCIPsyncstoreExit(), SCIPsyncstoreGetNextSyncdata(), SCIPsyncstoreGetSyncdata(), SCIPsyncstoreInit(), and SCIPsyncstoreStartSync().

minsyncdelay

SCIP_Real SCIP_SyncStore::minsyncdelay

the minimum delay before a synchronization data may be read

Definition at line 67 of file struct_syncstore.h.

Referenced by SCIPsyncstoreInit().

maxnsyncdelay

int SCIP_SyncStore::maxnsyncdelay

maximum number of synchronizations before the reading of the next synchronization data is enforced regardless of the minimal synchroization delay

Definition at line 68 of file struct_syncstore.h.

Referenced by SCIPsyncstoreGetNextSyncdata(), and SCIPsyncstoreInit().

syncfreqinit

SCIP_Real SCIP_SyncStore::syncfreqinit

the initial synchronization frequency which is read from the settings of the main SCIP when the syncstore is initialized

Definition at line 71 of file struct_syncstore.h.

Referenced by SCIPsyncstoreInit().

syncfreqmax

SCIP_Real SCIP_SyncStore::syncfreqmax

the maximum synchronization frequency

Definition at line 73 of file struct_syncstore.h.

Referenced by SCIPsyncdataSetSyncFreq(), and SCIPsyncstoreInit().

maxnsols

int SCIP_SyncStore::maxnsols

maximum number of solutions that can be shared in one synchronization

Definition at line 74 of file struct_syncstore.h.

Referenced by SCIPsyncdataGetSolutionBuffer(), SCIPsyncstoreExit(), and SCIPsyncstoreInit().

nsolvers

int SCIP_SyncStore::nsolvers

number of solvers synchronizing with this syncstore

Definition at line 75 of file struct_syncstore.h.

Referenced by SCIPsyncstoreEnsureAllSynced(), SCIPsyncstoreFinishSync(), SCIPsyncstoreGetNSolvers(), and SCIPsyncstoreInit().