aGrUM 2.3.2
a C++ library for (probabilistic) graphical models
threadExecutorSTL.h
Go to the documentation of this file.
1/****************************************************************************
2 * This file is part of the aGrUM/pyAgrum library. *
3 * *
4 * Copyright (c) 2005-2025 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-2025 *
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_THREAD_EXECUTOR_STL_H
49#define GUM_THREAD_EXECUTOR_STL_H
50
51#include <agrum/agrum.h>
52
55
56namespace gum {
57
58 namespace threadsSTL {
59
84
86 template < typename FUNCTION, typename... ARGS >
87 static void execute(std::size_t nb_threads, FUNCTION exec_func, ARGS&&... func_args);
88
89
91 template < typename FUNC1, typename FUNC2, typename... ARGS >
92 static void executeOrUndo(std::size_t nb_threads,
93 FUNC1 exec_func,
94 FUNC2 undo_func,
95 ARGS&&... func_args);
96 };
97
98 } /* namespace threadsSTL */
99
100} /* namespace gum */
101
104
105#endif /* GUM_THREAD_EXECUTOR_STL_H */
Set the max number of threads to be used.
static int nbRunningThreadsExecutors()
indicates how many threadExecutors are currently running
gum is the global namespace for all aGrUM entities
Definition agrum.h:46
static void execute(std::size_t nb_threads, FUNCTION exec_func, ARGS &&... func_args)
executes a function using several threads
static void executeOrUndo(std::size_t nb_threads, FUNC1 exec_func, FUNC2 undo_func, ARGS &&... func_args)
executes in parallel a function and undoes it if execptions are raised
The base class used by all thread executors.
A class to execute several threads by exploiting std::thread.
C++17 STL threads convenience utilities for aGrUM.