aGrUM
3.2.0
a C++ library for (probabilistic) graphical models
Toggle main menu visibility
threadsSTL.h
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
47
48
#ifndef GUM_THREADS_STL_H
49
#define GUM_THREADS_STL_H
50
51
52
#include <thread>
53
#include <utility>
54
#include <vector>
55
56
#include <
agrum/agrum.h
>
57
58
namespace
gum
{
59
60
namespace
threadsSTL
{
61
74
GUM_SHARED_PUBLIC
unsigned
int
getMaxNumberOfThreads
();
75
88
GUM_SHARED_PUBLIC
unsigned
int
getNumberOfThreads
();
89
95
GUM_SHARED_PUBLIC
unsigned
int
getNumberOfLogicalProcessors
();
96
106
void
setNumberOfThreads
(
unsigned
int
number);
107
108
}
// namespace threadsSTL
109
110
}
/* namespace gum */
111
112
// include the inlined functions if necessary
113
#ifndef GUM_NO_INLINE
114
# include <
agrum/base/core/threads/threadsSTL_inl.h
>
115
#endif
/* GUM_NO_INLINE */
116
117
118
#endif
/* GUM_THREADS_STL */
agrum.h
gum::threadsSTL::setNumberOfThreads
void setNumberOfThreads(unsigned int number)
Set the max number of threads to be used when entering the next parallel region.
Definition
threadsSTL.cpp:73
gum::threadsSTL::getNumberOfLogicalProcessors
GUM_SHARED_PUBLIC unsigned int getNumberOfLogicalProcessors()
Get the number of logical processors.
Definition
threadsSTL_inl.h:66
gum::threadsSTL::getMaxNumberOfThreads
GUM_SHARED_PUBLIC unsigned int getMaxNumberOfThreads()
Returns the maximum number of threads you should use at any time.
Definition
threadsSTL_inl.h:61
gum::threadsSTL
Definition
threadExecutorSTL.h:58
gum::threadsSTL::getNumberOfThreads
unsigned int getNumberOfThreads()
returns the max number of threads used by default when entering the next parallel region
Definition
threadsSTL.cpp:70
gum
gum is the global namespace for all aGrUM entities
Definition
agrum.h:46
threadsSTL_inl.h
C++17 STL threads convenience utilities for agrum.
aGrUM
3.2.0
© PHW&CG&others - 2022
DoXyGeN 1.18.0