Scippy

SCIP

Solving Constraint Integer Programs

tpi_none.c
Go to the documentation of this file.
1 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2 /* */
3 /* This file is part of the program and library */
4 /* SCIP --- Solving Constraint Integer Programs */
5 /* */
6 /* Copyright (C) 2002-2021 Konrad-Zuse-Zentrum */
7 /* fuer Informationstechnik Berlin */
8 /* */
9 /* SCIP is distributed under the terms of the ZIB Academic License. */
10 /* */
11 /* You should have received a copy of the ZIB Academic License */
12 /* along with SCIP; see the file COPYING. If not visit scipopt.org. */
13 /* */
14 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
15 
16 /**@file tpi_none.c
17  * @ingroup TASKINTERFACE
18  * @brief the interface functions for dummy tpi
19  * @author Stephen J. Maher
20  * @author Leona Gottwald
21  */
22 
23 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
24 
25 #include "tpi/tpi.h"
26 
27 /** creates a job for parallel processing */
29  SCIP_JOB** job, /**< pointer to the job that will be created */
30  int jobid, /**< the id for the current job */
31  SCIP_RETCODE (*jobfunc)(void* args),/**< pointer to the job function */
32  void* jobarg /**< the job's argument */
33  )
34 {
35  SCIP_UNUSED( job );
36  SCIP_UNUSED( jobid );
37  SCIP_UNUSED( jobfunc );
38  SCIP_UNUSED( jobarg );
39 
40  return SCIP_ERROR;
41 }
42 
43 /** submit a job for parallel processing; the return value is a globally defined status */
45  SCIP_JOB* job, /**< pointer to the job to be submitted */
46  SCIP_SUBMITSTATUS* status /**< pointer to store the job's submit status */
47  )
48 {
49  SCIP_UNUSED( job );
50  SCIP_UNUSED( status );
51 
52  return SCIP_ERROR;
53 }
54 
55 /** Blocks until all jobs with the given jobid have finished and then returns the smallest SCIP_RETCODE of all the
56  * jobs */
58  int jobid /**< the id of the jobs to collect */
59  )
60 {
61  SCIP_UNUSED( jobid );
62 
63  return SCIP_ERROR;
64 }
65 
66 /** initializes tpi */
68  int nthreads, /**< the number of threads to be used */
69  int queuesize, /**< the size of the queue */
70  SCIP_Bool blockwhenfull /**< should the queue block when full */
71  )
72 {
73  SCIP_UNUSED( nthreads );
74  SCIP_UNUSED( queuesize );
75  SCIP_UNUSED( blockwhenfull );
76 
77  return SCIP_ERROR;
78 }
79 
80 /** deinitializes the tpi */
82  void
83  )
84 {
85  return SCIP_ERROR;
86 }
enum SCIP_Submitstatus SCIP_SUBMITSTATUS
Definition: type_tpi.h:45
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:54
#define SCIP_UNUSED(x)
Definition: def.h:424
SCIP_RETCODE SCIPtpiCollectJobs(int jobid)
Definition: tpi_none.c:57
the type definitions for the SCIP parallel interface
#define SCIP_Bool
Definition: def.h:70
SCIP_RETCODE SCIPtpiInit(int nthreads, int queuesize, SCIP_Bool blockwhenfull)
Definition: tpi_none.c:67
SCIP_RETCODE SCIPtpiSumbitJob(SCIP_JOB *job, SCIP_SUBMITSTATUS *status)
Definition: tpi_none.c:44
SCIP_RETCODE SCIPtpiCreateJob(SCIP_JOB **job, int jobid, SCIP_RETCODE(*jobfunc)(void *args), void *jobarg)
Definition: tpi_none.c:28
SCIP_RETCODE SCIPtpiExit(void)
Definition: tpi_none.c:81