CoDiPack  2.2.0
A Code Differentiation Package
SciComp TU Kaiserslautern
Loading...
Searching...
No Matches
mutexInterface.hpp
1/*
2 * CoDiPack, a Code Differentiation Package
3 *
4 * Copyright (C) 2015-2024 Chair for Scientific Computing (SciComp), University of Kaiserslautern-Landau
5 * Homepage: http://scicomp.rptu.de
6 * Contact: Prof. Nicolas R. Gauger (codi@scicomp.uni-kl.de)
7 *
8 * Lead developers: Max Sagebaum, Johannes Blühdorn (SciComp, University of Kaiserslautern-Landau)
9 *
10 * This file is part of CoDiPack (http://scicomp.rptu.de/software/codi).
11 *
12 * CoDiPack is free software: you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation, either version 3 of the
15 * License, or (at your option) any later version.
16 *
17 * CoDiPack is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty
19 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
20 *
21 * See the GNU General Public License for more details.
22 * You should have received a copy of the GNU
23 * General Public License along with CoDiPack.
24 * If not, see <http://www.gnu.org/licenses/>.
25 *
26 * For other licensing options please contact us.
27 *
28 * Authors:
29 * - SciComp, University of Kaiserslautern-Landau:
30 * - Max Sagebaum
31 * - Johannes Blühdorn
32 * - Former members:
33 * - Tim Albring
34 */
35#pragma once
36
37#include "../../misc/macros.hpp"
38
40namespace codi {
41
48 public:
51
54
57 };
58
64 template<typename T_Mutex>
65 struct Lock {
66 public:
67 using Mutex = CODI_DD(T_Mutex, MutexInterface);
68
69 private:
70 Mutex& mutex;
71
72 public:
75 Lock(Mutex& mutex) : mutex(mutex) {
76 mutex.lock();
77 }
78
81 mutex.unlock();
82 }
83 };
84}
#define CODI_INLINE
See codi::Config::ForcedInlines.
Definition config.h:457
#define CODI_DD(Type, Default)
Abbreviation for CODI_DECLARE_DEFAULT.
Definition macros.hpp:94
CoDiPack - Code Differentiation Package.
Definition codi.hpp:90
RAII mutex locking.
Definition mutexInterface.hpp:65
~Lock()
Destructor. Unlocks the mutex.
Definition mutexInterface.hpp:80
Lock(Mutex &mutex)
Definition mutexInterface.hpp:75
T_Mutex Mutex
See Lock.
Definition mutexInterface.hpp:67
Abstracts a mutex.
Definition mutexInterface.hpp:47
void initialize()
Initialize the mutex.
void unlock()
Unlock the mutex.
void finalize()
Finalize the mutex.
~MutexInterface()
Destructor.
Definition mutexInterface.hpp:50
MutexInterface()
Constructor.
Definition mutexInterface.hpp:49
void lock()
Lock the mutex.