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-2024 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
* @author Marc Pfetsch
31
*/
32
33
/*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
34
35
#ifndef __TYPE_TPI_H__
36
#define __TYPE_TPI_H__
37
38
#ifdef __cplusplus
39
extern
"C"
{
40
#endif
41
42
/** The status after submitting a job */
43
enum
SCIP_Submitstatus
44
{
45
SCIP_SUBMIT_QUEUEFULL
= -3,
46
SCIP_SUBMIT_QUEUECLOSED
= -2,
47
SCIP_SUBMIT_SHUTDOWN
= -1,
48
SCIP_SUBMIT_SUCCESS
= 0
49
};
50
typedef
enum
SCIP_Submitstatus
SCIP_SUBMITSTATUS
;
51
52
/** The job status
53
*
54
* There is more than one job per job id. So the job status will return either SCIP_JOB_DOESNOTEXIST or the lowest level
55
* of execution. For example, if there is a job running and a job in the queue, then the return will be
56
* SCIP_JOB_INQUEUE.
57
*/
58
enum
SCIP_Jobstatus
59
{
60
SCIP_JOB_DOESNOTEXIST
= -1,
61
SCIP_JOB_INQUEUE
= 0,
62
SCIP_JOB_ISRUNNING
= 1,
63
SCIP_JOB_ISFINISHED
= 2
64
};
65
typedef
enum
SCIP_Jobstatus
SCIP_JOBSTATUS
;
66
67
typedef
struct
SCIP_Job
SCIP_JOB
;
/**< a job to be submitted to a separate thread */
68
69
70
typedef
struct
SCIP_Lock
SCIP_LOCK
;
/**< TPI type dependent lock */
71
typedef
struct
SCIP_Condition
SCIP_CONDITION
;
/**< TPI type dependent condition */
72
73
#ifdef __cplusplus
74
}
75
#endif
76
77
#endif
SCIP_Condition
Definition
tpi_openmp.c:62
SCIP_Job
Definition
tpi_openmp.c:72
SCIP_Lock
Definition
tpi_openmp.c:56
SCIP_SUBMITSTATUS
enum SCIP_Submitstatus SCIP_SUBMITSTATUS
Definition
type_tpi.h:50
SCIP_Jobstatus
SCIP_Jobstatus
Definition
type_tpi.h:59
SCIP_JOB_ISFINISHED
@ SCIP_JOB_ISFINISHED
Definition
type_tpi.h:63
SCIP_JOB_DOESNOTEXIST
@ SCIP_JOB_DOESNOTEXIST
Definition
type_tpi.h:60
SCIP_JOB_ISRUNNING
@ SCIP_JOB_ISRUNNING
Definition
type_tpi.h:62
SCIP_JOB_INQUEUE
@ SCIP_JOB_INQUEUE
Definition
type_tpi.h:61
SCIP_JOBSTATUS
enum SCIP_Jobstatus SCIP_JOBSTATUS
Definition
type_tpi.h:65
SCIP_Submitstatus
SCIP_Submitstatus
Definition
type_tpi.h:44
SCIP_SUBMIT_SUCCESS
@ SCIP_SUBMIT_SUCCESS
Definition
type_tpi.h:48
SCIP_SUBMIT_SHUTDOWN
@ SCIP_SUBMIT_SHUTDOWN
Definition
type_tpi.h:47
SCIP_SUBMIT_QUEUEFULL
@ SCIP_SUBMIT_QUEUEFULL
Definition
type_tpi.h:45
SCIP_SUBMIT_QUEUECLOSED
@ SCIP_SUBMIT_QUEUECLOSED
Definition
type_tpi.h:46
tpi
type_tpi.h
© 2002-2024 by Zuse Institute Berlin (ZIB),
Imprint
Generated by
1.12.0