Software Open Access

A C++17 Thread Pool for High-Performance Scientific Computing

Shoshany, Barak

DataCite XML Export

<?xml version='1.0' encoding='utf-8'?>
<resource xmlns:xsi="" xmlns="" xsi:schemaLocation="">
  <identifier identifierType="DOI">10.5281/zenodo.6959270</identifier>
      <creatorName>Shoshany, Barak</creatorName>
      <nameIdentifier nameIdentifierScheme="ORCID" schemeURI="">0000-0003-2222-127X</nameIdentifier>
    <title>A C++17 Thread Pool for High-Performance Scientific Computing</title>
    <date dateType="Issued">2021-05-03</date>
  <resourceType resourceTypeGeneral="Software"/>
    <alternateIdentifier alternateIdentifierType="url"></alternateIdentifier>
    <relatedIdentifier relatedIdentifierType="URL" relationType="IsSupplementTo"></relatedIdentifier>
    <relatedIdentifier relatedIdentifierType="DOI" relationType="IsVersionOf">10.5281/zenodo.4742687</relatedIdentifier>
    <rights rightsURI="">MIT License</rights>
    <rights rightsURI="info:eu-repo/semantics/openAccess">Open Access</rights>
    <description descriptionType="Abstract">v3.3.0 (2022-08-03)
&lt;li&gt;The public member variable &lt;code&gt;paused&lt;/code&gt; of &lt;code&gt;BS::thread_pool&lt;/code&gt; has 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 the &lt;code&gt;pause()&lt;/code&gt;, &lt;code&gt;unpause()&lt;/code&gt;, and &lt;code&gt;is_paused()&lt;/code&gt; member functions. In other words:&lt;ul&gt;
&lt;li&gt;Replace &lt;code&gt;pool.paused = true&lt;/code&gt; with &lt;code&gt;pool.pause()&lt;/code&gt;.&lt;/li&gt;
&lt;li&gt;Replace &lt;code&gt;pool.paused = false&lt;/code&gt; with &lt;code&gt;pool.unpause()&lt;/code&gt;.&lt;/li&gt;
&lt;li&gt;Replace &lt;code&gt;if (pool.paused)&lt;/code&gt; (or similar) with &lt;code&gt;if (pool.is_paused())&lt;/code&gt;.&lt;/li&gt;
&lt;li&gt;The public member variable &lt;code&gt;f&lt;/code&gt; of &lt;code&gt;BS::multi_future&lt;/code&gt; has been renamed to &lt;code&gt;futures&lt;/code&gt; for clarity, and has been made private for encapsulation and simplification purposes. Instead of operating on the vector &lt;code&gt;futures&lt;/code&gt; itself, you can now use the &lt;code&gt;[]&lt;/code&gt; operator of the &lt;code&gt;BS::multi_future&lt;/code&gt; to access the future at a specific index directly, or the &lt;code&gt;push_back()&lt;/code&gt; member function to append a new future to the list. The &lt;code&gt;size()&lt;/code&gt; member function tells you how many futures are currently stored in the object.&lt;/li&gt;
&lt;li&gt;The explicit casts of &lt;code&gt;std::endl&lt;/code&gt; and &lt;code&gt;std::flush&lt;/code&gt;, added in v3.2.0 to enable flushing a &lt;code&gt;BS::synced_stream&lt;/code&gt;, caused ODR (One Definition Rule) violations if &lt;code&gt;BS_thread_pool.hpp&lt;/code&gt; was included in two different translation units, since they were mistakenly not defined as &lt;code&gt;inline&lt;/code&gt;. To fix this, I decided to make them static members of &lt;code&gt;BS::synced_stream&lt;/code&gt; instead of global variables, which also makes the code better organized in my opinion. These objects can now be accessed as &lt;code&gt;BS::synced_stream::endl&lt;/code&gt; and &lt;code&gt;BS::synced_stream::flush&lt;/code&gt;. I also added an example for how to use them in &lt;code&gt;;/code&gt;. See &lt;a href=""&gt;#64&lt;/a&gt;.&lt;/li&gt;
&lt;li&gt;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, &lt;code&gt;BS_thread_pool_light.hpp&lt;/code&gt;, 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 new &lt;code&gt;BS::thread_pool_light&lt;/code&gt; class, which is a minimal thread pool with only the 5 most basic member functions:&lt;ul&gt;
&lt;li&gt;A separate test program &lt;code&gt;BS_thread_pool_light_test.cpp&lt;/code&gt; tests only the features of the lightweight &lt;code&gt;BS::thread_pool_light&lt;/code&gt; class. In the spirit of minimalism, it does not generate a log file and does not do any benchmarks.&lt;/li&gt;
&lt;li&gt;To be perfectly clear, each header file is 100% stand-alone. If you wish to use the full package, you only need &lt;code&gt;BS_thread_pool.hpp&lt;/code&gt;, and if you wish to use the light version, you only need &lt;code&gt;BS_thread_pool_light.hpp&lt;/code&gt;. Only a single header file needs to be included in your project.&lt;/li&gt;
    <description descriptionType="Other">If you use this package in published research, please cite it as follows.</description>
All versions This version
Views 737161
Downloads 232
Data volume 621.5 kB120.4 kB
Unique views 679153
Unique downloads 132


Cite as