aGrUM
3.3.2
a C++ library for (probabilistic) graphical models
Toggle main menu visibility
threadsOMP.cpp
Go to the documentation of this file.
1
/****************************************************************************
2
* This file is part of the aGrUM/pyAgrum library. *
3
* *
4
* Copyright (c) 2005-2026 by *
5
* - Pierre-Henri WUILLEMIN(_at_LIP6) *
6
* - Christophe GONZALES(_at_AMU) *
7
* *
8
* The aGrUM/pyAgrum library is free software; you can redistribute it *
9
* and/or modify it under the terms of either : *
10
* *
11
* - the GNU Lesser General Public License as published by *
12
* the Free Software Foundation, either version 3 of the License, *
13
* or (at your option) any later version, *
14
* - the MIT license (MIT), *
15
* - or both in dual license, as here. *
16
* *
17
* (see https://agrum.gitlab.io/articles/dual-licenses-lgplv3mit.html) *
18
* *
19
* This aGrUM/pyAgrum library is distributed in the hope that it will be *
20
* useful, but WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, *
21
* INCLUDING BUT NOT LIMITED TO THE WARRANTIES MERCHANTABILITY or FITNESS *
22
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *
23
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
24
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, *
25
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR *
26
* OTHER DEALINGS IN THE SOFTWARE. *
27
* *
28
* See LICENCES for more details. *
29
* *
30
* SPDX-FileCopyrightText: Copyright 2005-2026 *
31
* - Pierre-Henri WUILLEMIN(_at_LIP6) *
32
* - Christophe GONZALES(_at_AMU) *
33
* SPDX-License-Identifier: LGPL-3.0-or-later OR MIT *
34
* *
35
* Contact : info_at_agrum_dot_org *
36
* homepage : http://agrum.gitlab.io *
37
* gitlab : https://gitlab.com/agrumery/agrum *
38
* *
39
****************************************************************************/
40
41
48
#include <atomic>
49
50
#include <
agrum/agrum.h
>
51
52
#include <
agrum/base/core/threads/threadsOMP.h
>
53
54
// include the inlined functions if necessary
55
#ifdef GUM_NO_INLINE
56
# include <
agrum/base/core/threads/threadsOMP_inl.h
>
57
#endif
/* GUM_NO_INLINE */
58
59
namespace
gum
{
60
61
namespace
threadsOMP
{
62
63
namespace
{
64
// the number of threads used the next time we enter into a parallel region.
65
// Function-local static: the configuration may set it while the library is being loaded,
66
// whatever the order of initialization of the static variables. Atomic: it may be changed
67
// while it is read by other threads.
68
std::atomic< unsigned int >& _nb_threads_() {
69
static
std::atomic< unsigned int > nb{
getMaxNumberOfThreads
()};
70
return
nb;
71
}
72
}
// namespace
73
74
// returns the max number of threads used by default when entering the
75
// next parallel region
76
unsigned
int
getNumberOfThreads
() {
return
_nb_threads_(); }
77
78
// Set the max number of threads to be used.
79
void
setNumberOfThreads
(
unsigned
int
number) {
80
if
(number == 0) number = 1;
81
#ifdef _OPENMP
82
omp_set_num_threads(number);
83
_nb_threads_() = number;
84
#else
85
if
(number != 1) {
86
GUM_ERROR
(
OperationNotAllowed
,
87
"openMP was not enabled at compilation (or "
88
"you asked for 0 threads !)"
);
89
}
90
#endif
91
}
92
93
}
// namespace threadsOMP
94
95
}
// namespace gum
agrum.h
OperationNotAllowed
Exception : operation not allowed.
GUM_ERROR
#define GUM_ERROR(type, msg)
Definition
exceptions.h:76
gum::threadsOMP::getMaxNumberOfThreads
GUM_SHARED_PUBLIC unsigned int getMaxNumberOfThreads()
Returns the maximum number of threads that should be used at any time.
Definition
threadsOMP_inl.h:67
gum::threadsOMP::setNumberOfThreads
void setNumberOfThreads(unsigned int number)
Set the number of threads to be used when entering the next parallel region.
Definition
threadsOMP.cpp:79
gum::threadsOMP
Definition
threadExecutorOMP.h:63
gum::threadsOMP::getNumberOfThreads
unsigned int getNumberOfThreads()
returns the max number of threads used by default when entering the next parallel region
Definition
threadsOMP.cpp:76
gum
gum is the global namespace for all aGrUM entities
Definition
agrum.h:46
threadsOMP.h
Wrappers for OpenMP.
threadsOMP_inl.h
OpenMP wrappers implementation.
aGrUM
3.3.2
© PHW&CG&others - 2022
DoXyGeN 1.18.0