Software Open Access
A C++17 Thread Pool for High-Performance Scientific Computing
Shoshany, Barak
v3.3.0 (2022-08-03)
BS_thread_pool.hpp:- The public member variable
pausedofBS::thread_poolhas been made private for future-proofing (in case future versions implement a more involved pausing mechanism) and better encapsulation. It is now accessible only via thepause(),unpause(), andis_paused()member functions. In other words:- Replace
pool.paused = truewithpool.pause(). - Replace
pool.paused = falsewithpool.unpause(). - Replace
if (pool.paused)(or similar) withif (pool.is_paused()).
- Replace
- The public member variable
fofBS::multi_futurehas been renamed tofuturesfor clarity, and has been made private for encapsulation and simplification purposes. Instead of operating on the vectorfuturesitself, you can now use the[]operator of theBS::multi_futureto access the future at a specific index directly, or thepush_back()member function to append a new future to the list. Thesize()member function tells you how many futures are currently stored in the object. - The explicit casts of
std::endlandstd::flush, added in v3.2.0 to enable flushing aBS::synced_stream, caused ODR (One Definition Rule) violations ifBS_thread_pool.hppwas included in two different translation units, since they were mistakenly not defined asinline. To fix this, I decided to make them static members ofBS::synced_streaminstead of global variables, which also makes the code better organized in my opinion. These objects can now be accessed asBS::synced_stream::endlandBS::synced_stream::flush. I also added an example for how to use them inREADME.md. See #64.
- The public member variable
BS_thread_pool_light.hpp:- This package started out as a very lightweight thread pool, but over time has expanded to include many additional features, and at the time of writing it has a total of 340 lines of code, including all the helper classes. Therefore, I have decided to bundle a light version of the thread pool in a separate and stand-alone header file,
BS_thread_pool_light.hpp, with only 170 lines of code (half the size of the full package). This file does not contain any of the helper classes, only a newBS::thread_pool_lightclass, which is a minimal thread pool with only the 5 most basic member functions:get_thread_count()push_loop()push_task()submit()wait_for_tasks()
- A separate test program
BS_thread_pool_light_test.cpptests only the features of the lightweightBS::thread_pool_lightclass. In the spirit of minimalism, it does not generate a log file and does not do any benchmarks. - To be perfectly clear, each header file is 100% stand-alone. If you wish to use the full package, you only need
BS_thread_pool.hpp, and if you wish to use the light version, you only needBS_thread_pool_light.hpp. Only a single header file needs to be included in your project.
- This package started out as a very lightweight thread pool, but over time has expanded to include many additional features, and at the time of writing it has a total of 340 lines of code, including all the helper classes. Therefore, I have decided to bundle a light version of the thread pool in a separate and stand-alone header file,
If you use this package in published research, please cite it as follows.
Files
(60.2 kB)
| Name | Size | |
|---|---|---|
|
bshoshany/thread-pool-v3.3.0.zip
md5:de781fc0b935d9cd4983718a307ff4a6 |
60.2 kB | Download |
735
23
views
downloads
| All versions | This version | |
|---|---|---|
| Views | 735 | 159 |
| Downloads | 23 | 2 |
| Data volume | 621.5 kB | 120.4 kB |
| Unique views | 677 | 151 |
| Unique downloads | 13 | 2 |
Available in
Indexed in
Indexed in
- Publication date:
- May 3, 2021
- DOI:
-
- Related identifiers:
- Supplement to
- License (for files):
- MIT License