May 3, 2021 Software Open Access

Shoshany, Barak

MARC21 XML Export

<?xml version='1.0' encoding='UTF-8'?>
<record xmlns="http://www.loc.gov/MARC21/slim">
  <leader>00000nmm##2200000uu#4500</leader>
  <controlfield tag="005">20220804014920.0</controlfield>
  <datafield tag="500" ind1=" " ind2=" ">
    <subfield code="a">If you use this package in published research, please cite it as follows.</subfield>
  </datafield>
  <controlfield tag="001">6959270</controlfield>
  <datafield tag="856" ind1="4" ind2=" ">
    <subfield code="s">60179</subfield>
    <subfield code="z">md5:de781fc0b935d9cd4983718a307ff4a6</subfield>
    <subfield code="u">https://zenodo.org/record/6959270/files/bshoshany/thread-pool-v3.3.0.zip</subfield>
  </datafield>
  <datafield tag="542" ind1=" " ind2=" ">
    <subfield code="l">open</subfield>
  </datafield>
  <datafield tag="260" ind1=" " ind2=" ">
    <subfield code="c">2021-05-03</subfield>
  </datafield>
  <datafield tag="909" ind1="C" ind2="O">
    <subfield code="p">software</subfield>
    <subfield code="o">oai:zenodo.org:6959270</subfield>
  </datafield>
  <datafield tag="100" ind1=" " ind2=" ">
    <subfield code="0">(orcid)0000-0003-2222-127X</subfield>
    <subfield code="a">Shoshany, Barak</subfield>
  </datafield>
  <datafield tag="245" ind1=" " ind2=" ">
    <subfield code="a">A C++17 Thread Pool for High-Performance Scientific Computing</subfield>
  </datafield>
  <datafield tag="540" ind1=" " ind2=" ">
    <subfield code="u">https://opensource.org/licenses/MIT</subfield>
    <subfield code="a">MIT License</subfield>
  </datafield>
  <datafield tag="650" ind1="1" ind2="7">
    <subfield code="a">cc-by</subfield>
    <subfield code="2">opendefinition.org</subfield>
  </datafield>
  <datafield tag="520" ind1=" " ind2=" ">
    <subfield code="a">v3.3.0 (2022-08-03)
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;BS_thread_pool.hpp&lt;/code&gt;:&lt;ul&gt;
&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;/ul&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;README.md&lt;/code&gt;. See &lt;a href="https://github.com/bshoshany/thread-pool/issues/64"&gt;#64&lt;/a&gt;.&lt;/li&gt;
&lt;/ul&gt;
&lt;/li&gt;
&lt;li&gt;&lt;code&gt;BS_thread_pool_light.hpp&lt;/code&gt;:&lt;ul&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;&lt;code&gt;get_thread_count()&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;push_loop()&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;push_task()&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;submit()&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;wait_for_tasks()&lt;/code&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;/li&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;
&lt;/ul&gt;
&lt;/li&gt;
&lt;/ul&gt;</subfield>
  </datafield>
  <datafield tag="773" ind1=" " ind2=" ">
    <subfield code="n">url</subfield>
    <subfield code="i">isSupplementTo</subfield>
    <subfield code="a">https://github.com/bshoshany/thread-pool/tree/v3.3.0</subfield>
  </datafield>
  <datafield tag="773" ind1=" " ind2=" ">
    <subfield code="n">doi</subfield>
    <subfield code="i">isVersionOf</subfield>
    <subfield code="a">10.5281/zenodo.4742687</subfield>
  </datafield>
  <datafield tag="024" ind1=" " ind2=" ">
    <subfield code="a">10.5281/zenodo.6959270</subfield>
    <subfield code="2">doi</subfield>
  </datafield>
  <datafield tag="980" ind1=" " ind2=" ">
    <subfield code="a">software</subfield>
  </datafield>
</record>