type definitions for concurrent solvers
This file defines the interface for concurrent solvers.
Definition in file type_concsolver.h.
#include "scip/def.h"
#include "scip/type_scip.h"
#include "scip/type_stat.h"
#include "scip/type_lp.h"
#include "scip/type_syncstore.h"
Go to the source code of this file.
Macros | |
#define | SCIP_DECL_CONCSOLVERCREATEINST(x) |
#define | SCIP_DECL_CONCSOLVERDESTROYINST(x) |
#define | SCIP_DECL_CONCSOLVERTYPEFREEDATA(x) |
#define | SCIP_DECL_CONCSOLVERINITSEEDS(x) |
#define | SCIP_DECL_CONCSOLVERSYNCWRITE(x) |
#define | SCIP_DECL_CONCSOLVERSYNCREAD(x) |
#define | SCIP_DECL_CONCSOLVEREXEC(x) |
#define | SCIP_DECL_CONCSOLVERSTOP(x) |
#define | SCIP_DECL_CONCSOLVERCOPYSOLVINGDATA(x) |
#define SCIP_DECL_CONCSOLVERCREATEINST | ( | x | ) |
creates a concurrent solver instance
input:
returns SCIP_OKAY if everything worked, otherwise, a suitable error code
Definition at line 63 of file type_concsolver.h.
Referenced by doConcsolverTypeCreate(), SCIPconcsolverTypeCreate(), and SCIPincludeConcsolverType().
#define SCIP_DECL_CONCSOLVERDESTROYINST | ( | x | ) |
destroys a concurrent solver instance
input:
returns SCIP_OKAY if everything worked, otherwise, a suitable error code
Definition at line 73 of file type_concsolver.h.
Referenced by doConcsolverTypeCreate(), SCIPconcsolverTypeCreate(), and SCIPincludeConcsolverType().
#define SCIP_DECL_CONCSOLVERTYPEFREEDATA | ( | x | ) |
frees data of a concurrent solver type
input:
returns SCIP_OKAY if everything worked, otherwise, a suitable error code
Definition at line 83 of file type_concsolver.h.
Referenced by doConcsolverTypeCreate(), SCIPconcsolverTypeCreate(), and SCIPincludeConcsolverType().
#define SCIP_DECL_CONCSOLVERINITSEEDS | ( | x | ) |
initialize random seeds of a concurrent solver
input:
returns SCIP_OKAY if everything worked, otherwise, a suitable error code
Definition at line 93 of file type_concsolver.h.
Referenced by doConcsolverTypeCreate(), SCIPconcsolverTypeCreate(), and SCIPincludeConcsolverType().
#define SCIP_DECL_CONCSOLVERSYNCWRITE | ( | x | ) |
synchronization method of concurrent solver for writing data
Syncronizes with other solvers. The concurrent solver should pass new solutions and bounds to the syncstore. For the solutions, no more than maxcandsols of the best solution should be considered for sharing. Additionally a maximum if maxsharedsols should be passed to the syncstore.
input:
returns SCIP_OKAY if everything worked, otherwise, a suitable error code
Definition at line 111 of file type_concsolver.h.
Referenced by doConcsolverTypeCreate(), SCIPconcsolverTypeCreate(), and SCIPincludeConcsolverType().
#define SCIP_DECL_CONCSOLVERSYNCREAD | ( | x | ) |
synchronization method of concurrent solver for reading data
the concurrent solver should read the solutions and bounds stored in the given synchronization data
input:
returns SCIP_OKAY if everything worked, otherwise, a suitable error code
Definition at line 125 of file type_concsolver.h.
Referenced by doConcsolverTypeCreate(), SCIPconcsolverTypeCreate(), and SCIPincludeConcsolverType().
#define SCIP_DECL_CONCSOLVEREXEC | ( | x | ) |
execution method of concurrent solver
start solving of the problem given during initialization
input:
returns SCIP_OKAY if everything worked, otherwise, a suitable error code
Definition at line 136 of file type_concsolver.h.
Referenced by doConcsolverTypeCreate(), SCIPconcsolverTypeCreate(), and SCIPincludeConcsolverType().
#define SCIP_DECL_CONCSOLVERSTOP | ( | x | ) |
stop the solving as soon as possible
input:
returns SCIP_OKAY if everything worked, otherwise, a suitable error code
Definition at line 145 of file type_concsolver.h.
Referenced by doConcsolverTypeCreate(), SCIPconcsolverTypeCreate(), and SCIPincludeConcsolverType().
#define SCIP_DECL_CONCSOLVERCOPYSOLVINGDATA | ( | x | ) |
extract the solving data from the concurrent solver and store it into the SCIP datastructure, so that this SCIP instance has the optimal solution and reports the correct status and statistics.
input:
returns SCIP_OKAY if everything worked, otherwise, a suitable error code
Definition at line 156 of file type_concsolver.h.
Referenced by doConcsolverTypeCreate(), SCIPconcsolverTypeCreate(), and SCIPincludeConcsolverType().
typedef struct SCIP_ConcSolverType SCIP_CONCSOLVERTYPE |
the struct defining a concurrent solver class
Definition at line 49 of file type_concsolver.h.
typedef struct SCIP_ConcSolverTypeData SCIP_CONCSOLVERTYPEDATA |
concurrent solver class user data
Definition at line 50 of file type_concsolver.h.
typedef struct SCIP_ConcSolver SCIP_CONCSOLVER |
struct for an instance of a concurrent solver
Definition at line 51 of file type_concsolver.h.
typedef struct SCIP_ConcSolverData SCIP_CONCSOLVERDATA |
concurrent solver user data
Definition at line 52 of file type_concsolver.h.