SCIP Doxygen Documentation
 
Loading...
Searching...
No Matches
type_tpi.h
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-2023 Zuse Institute Berlin (ZIB) */
7/* */
8/* Licensed under the Apache License, Version 2.0 (the "License"); */
9/* you may not use this file except in compliance with the License. */
10/* You may obtain a copy of the License at */
11/* */
12/* http://www.apache.org/licenses/LICENSE-2.0 */
13/* */
14/* Unless required by applicable law or agreed to in writing, software */
15/* distributed under the License is distributed on an "AS IS" BASIS, */
16/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */
17/* See the License for the specific language governing permissions and */
18/* limitations under the License. */
19/* */
20/* You should have received a copy of the Apache-2.0 license */
21/* along with SCIP; see the file LICENSE. If not visit scipopt.org. */
22/* */
23/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
24
25/**@file type_tpi.h
26 * @ingroup TASKINTERFACE
27 * @brief the type definitions for the task processing interface
28 * @author Leona Gottwald
29 * @author Stephen J. Maher
30 */
31
32/*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
33
34#ifndef __TYPE_TPI_H__
35#define __TYPE_TPI_H__
36
37#include "scip/type_retcode.h"
38#include "tpi/type_tpi_openmp.h"
40#include "tpi/type_tpi_none.h"
41
42#ifdef __cplusplus
43extern "C" {
44#endif
45
46/** The status after submitting a job */
55
56/** The job status
57 *
58 * There is more than one job per job id. So the job status will return either SCIP_JOB_DOESNOTEXIST or the lowest level
59 * of execution. For example, if there is a job running and a job in the queue, then the return will be
60 * SCIP_JOB_INQUEUE.
61 */
70
71typedef struct SCIP_Job SCIP_JOB; /**< a job to be submitted to a separate thread */
72
73#ifdef __cplusplus
74}
75#endif
76
77#endif
type definitions for return codes for SCIP methods
enum SCIP_Submitstatus SCIP_SUBMITSTATUS
Definition type_tpi.h:54
SCIP_Jobstatus
Definition type_tpi.h:63
@ SCIP_JOB_ISFINISHED
Definition type_tpi.h:67
@ SCIP_JOB_DOESNOTEXIST
Definition type_tpi.h:64
@ SCIP_JOB_ISRUNNING
Definition type_tpi.h:66
@ SCIP_JOB_INQUEUE
Definition type_tpi.h:65
enum SCIP_Jobstatus SCIP_JOBSTATUS
Definition type_tpi.h:69
SCIP_Submitstatus
Definition type_tpi.h:48
@ SCIP_SUBMIT_SUCCESS
Definition type_tpi.h:52
@ SCIP_SUBMIT_SHUTDOWN
Definition type_tpi.h:51
@ SCIP_SUBMIT_QUEUEFULL
Definition type_tpi.h:49
@ SCIP_SUBMIT_QUEUECLOSED
Definition type_tpi.h:50
the type definitions for the the locks and condition variables for the dummy implementation of the TP...
the type definitions for the the locks and condition variables for the OpenMP implementation of the T...
the type definitions for the the locks and condition variables for the tinycthreads implementation of...