Scippy

SCIP

Solving Constraint Integer Programs

tpi_openmp.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 tpi_openmp.h
26  * @ingroup TASKINTERFACE
27  * @brief the tpi_openmp redefines the lock functionality and some condition functionality as macros
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 #ifdef TPI_OMP
35 
36 #ifndef _TPI_OPENMP_H_
37 #define _TPI_OPENMP_H_
38 
39 /* define locks and some condition functionality as macros */
40 
41 /* lock */
42 #define SCIPtpiInitLock(lock) (omp_init_lock(lock), SCIP_OKAY)
43 #define SCIPtpiDestroyLock(lock) (omp_destroy_lock(lock))
44 #define SCIPtpiAcquireLock(lock) (omp_set_lock(lock), SCIP_OKAY)
45 #define SCIPtpiReleaseLock(lock) (omp_unset_lock(lock), SCIP_OKAY)
46 
47 /* condition */
48 #define SCIPtpiInitCondition(condition) ( omp_init_lock(&(condition)->_lock), \
49  (condition)->_waiters = 0, (condition)->_waitnum = 0, (condition)->_signals = 0, SCIP_OKAY )
50 #define SCIPtpiDestroyCondition(condition) do { assert((condition)->_waiters == 0); assert((condition)->_waitnum == 0); assert((condition)->_signals == 0); omp_destroy_lock(&(condition)->_lock); } while(0)
51 #endif
52 
53 #endif