deploy: 1c112c2

classdispenso_1_1_thread_pool.html

@@ -145,7 +145,7 @@
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <div class="textblock"><p>The basic executor for dispenso. It provides typical thread pool functionality, plus allows work stealing by related types (e.g. <a class="el" href="classdispenso_1_1_task_set.html">TaskSet</a>, <a class="el" href="classdispenso_1_1_future.html">Future</a>, etc...), which prevents deadlock when waiting for pool-recursive tasks. </p>
 
-<p class="definition">Definition at line <a class="el" href="thread__pool_8h_source.html#l00070">70</a> of file <a class="el" href="thread__pool_8h_source.html">thread_pool.h</a>.</p>
+<p class="definition">Definition at line <a class="el" href="thread__pool_8h_source.html#l00073">73</a> of file <a class="el" href="thread__pool_8h_source.html">thread_pool.h</a>.</p>
 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 <a id="a2442016e8a4924ca665d3993c1879b4d" name="a2442016e8a4924ca665d3993c1879b4d"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a2442016e8a4924ca665d3993c1879b4d">&#9670;&#160;</a></span>ThreadPool()</h2>
@@ -231,7 +231,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a790fecdf2ce448db2f02af91
 <p>Get the number of threads backing the pool. If called concurrently to <code>resize</code>, the number returned may be stale.</p>
 <dl class="section return"><dt>Returns</dt><dd>The current number of threads backing the pool. </dd></dl>
 
-<p class="definition">Definition at line <a class="el" href="thread__pool_8h_source.html#l00127">127</a> of file <a class="el" href="thread__pool_8h_source.html">thread_pool.h</a>.</p>
+<p class="definition">Definition at line <a class="el" href="thread__pool_8h_source.html#l00130">130</a> of file <a class="el" href="thread__pool_8h_source.html">thread_pool.h</a>.</p>
 
 </div>
 </div>
@@ -259,7 +259,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a33493dd6c5ef378a74a82380
 </table>
 </div><div class="memdoc">
 
-<p class="definition">Definition at line <a class="el" href="thread__pool_8h_source.html#l00220">220</a> of file <a class="el" href="thread__pool_8h_source.html">thread_pool.h</a>.</p>
+<p class="definition">Definition at line <a class="el" href="thread__pool_8h_source.html#l00223">223</a> of file <a class="el" href="thread__pool_8h_source.html">thread_pool.h</a>.</p>
 
 </div>
 </div>
@@ -287,7 +287,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a267594d95ec2a23b9e5cbd36
 </table>
 </div><div class="memdoc">
 
-<p class="definition">Definition at line <a class="el" href="thread__pool_8h_source.html#l00217">217</a> of file <a class="el" href="thread__pool_8h_source.html">thread_pool.h</a>.</p>
+<p class="definition">Definition at line <a class="el" href="thread__pool_8h_source.html#l00220">220</a> of file <a class="el" href="thread__pool_8h_source.html">thread_pool.h</a>.</p>
 
 </div>
 </div>
@@ -322,7 +322,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a6b6d82ff0d0a23686cee515b
  </dd>
 </dl>
 
-<p class="definition">Definition at line <a class="el" href="thread__pool_8h_source.html#l00116">116</a> of file <a class="el" href="thread__pool_8h_source.html">thread_pool.h</a>.</p>
+<p class="definition">Definition at line <a class="el" href="thread__pool_8h_source.html#l00119">119</a> of file <a class="el" href="thread__pool_8h_source.html">thread_pool.h</a>.</p>
 
 </div>
 </div>
@@ -359,7 +359,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a656639db1edaa1293a7dfec9
  </dd>
 </dl>
 
-<p class="definition">Definition at line <a class="el" href="thread__pool_8h_source.html#l00268">268</a> of file <a class="el" href="thread__pool_8h_source.html">thread_pool.h</a>.</p>
+<p class="definition">Definition at line <a class="el" href="thread__pool_8h_source.html#l00271">271</a> of file <a class="el" href="thread__pool_8h_source.html">thread_pool.h</a>.</p>
 
 </div>
 </div>
@@ -406,7 +406,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a56a9388c1cfc7903b612b57c
  </dd>
 </dl>
 
-<p class="definition">Definition at line <a class="el" href="thread__pool_8h_source.html#l00281">281</a> of file <a class="el" href="thread__pool_8h_source.html">thread_pool.h</a>.</p>
+<p class="definition">Definition at line <a class="el" href="thread__pool_8h_source.html#l00284">284</a> of file <a class="el" href="thread__pool_8h_source.html">thread_pool.h</a>.</p>
 
 </div>
 </div>
@@ -455,7 +455,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a1496e66b4081c1f35ab2ff70
 </dl>
 <dl class="section note"><dt>Note</dt><dd>It is highly recommended to leave signaling wake enabled on Windows platforms, as sleeping/polling tends to perform poorly for intermittent workloads. For Mac/Linux platforms, it is okay to enable signaling wake, particularly if you wish to set a longer expected duration between work. If signaling wake is disabled, ensure sleepDuration is small (e.g. 200us) for best performance. Most users will not need to call this function, as defaults are reasonable. </dd></dl>
 
-<p class="definition">Definition at line <a class="el" href="thread__pool_8h_source.html#l00100">100</a> of file <a class="el" href="thread__pool_8h_source.html">thread_pool.h</a>.</p>
+<p class="definition">Definition at line <a class="el" href="thread__pool_8h_source.html#l00103">103</a> of file <a class="el" href="thread__pool_8h_source.html">thread_pool.h</a>.</p>
 
 </div>
 </div>
@@ -480,7 +480,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ae12e56c1c8c5a87ab7e47c98
 </table>
 </div><div class="memdoc">
 
-<p class="definition">Definition at line <a class="el" href="thread__pool_8h_source.html#l00247">247</a> of file <a class="el" href="thread__pool_8h_source.html">thread_pool.h</a>.</p>
+<p class="definition">Definition at line <a class="el" href="thread__pool_8h_source.html#l00250">250</a> of file <a class="el" href="thread__pool_8h_source.html">thread_pool.h</a>.</p>
 
 </div>
 </div>
@@ -504,7 +504,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a92fc40642e875f71f86ca4fc
 </table>
 </div><div class="memdoc">
 
-<p class="definition">Definition at line <a class="el" href="thread__pool_8h_source.html#l00248">248</a> of file <a class="el" href="thread__pool_8h_source.html">thread_pool.h</a>.</p>
+<p class="definition">Definition at line <a class="el" href="thread__pool_8h_source.html#l00251">251</a> of file <a class="el" href="thread__pool_8h_source.html">thread_pool.h</a>.</p>
 
 </div>
 </div>

future_8h_source.html

@@ -541,7 +541,7 @@
 <div class="ttc" id="aclassdispenso_1_1_future_html_aefc734821391a9975fd07f4ee80c8ec1"><div class="ttname"><a href="classdispenso_1_1_future.html#aefc734821391a9975fd07f4ee80c8ec1">dispenso::Future::Future</a></div><div class="ttdeci">Future(F &amp;&amp;f, Schedulable &amp;schedulable, std::launch asyncPolicy=kNotAsync, std::launch deferredPolicy=std::launch::deferred)</div><div class="ttdef"><b>Definition</b> <a href="future_8h_source.html#l00110">future.h:110</a></div></div>
 <div class="ttc" id="aclassdispenso_1_1_new_thread_invoker_html"><div class="ttname"><a href="classdispenso_1_1_new_thread_invoker.html">dispenso::NewThreadInvoker</a></div><div class="ttdef"><b>Definition</b> <a href="schedulable_8h_source.html#l00059">schedulable.h:59</a></div></div>
 <div class="ttc" id="aclassdispenso_1_1_task_set_html"><div class="ttname"><a href="classdispenso_1_1_task_set.html">dispenso::TaskSet</a></div><div class="ttdef"><b>Definition</b> <a href="task__set_8h_source.html#l00037">task_set.h:37</a></div></div>
-<div class="ttc" id="aclassdispenso_1_1_thread_pool_html"><div class="ttname"><a href="classdispenso_1_1_thread_pool.html">dispenso::ThreadPool</a></div><div class="ttdef"><b>Definition</b> <a href="thread__pool_8h_source.html#l00070">thread_pool.h:70</a></div></div>
+<div class="ttc" id="aclassdispenso_1_1_thread_pool_html"><div class="ttname"><a href="classdispenso_1_1_thread_pool.html">dispenso::ThreadPool</a></div><div class="ttdef"><b>Definition</b> <a href="thread__pool_8h_source.html#l00073">thread_pool.h:73</a></div></div>
 <div class="ttc" id="afuture_8h_html_a1e26a81b8ac83022faf9be5fa9116944"><div class="ttname"><a href="future_8h.html#a1e26a81b8ac83022faf9be5fa9116944">dispenso::async</a></div><div class="ttdeci">Future&lt; detail::ResultOf&lt; F, Args... &gt; &gt; async(std::launch policy, F &amp;&amp;f, Args &amp;&amp;... args)</div><div class="ttdef"><b>Definition</b> <a href="future_8h_source.html#l00429">future.h:429</a></div></div>
 <div class="ttc" id="afuture_8h_html_a76b9f7ac83b05ef4121ea164c3b8127c"><div class="ttname"><a href="future_8h.html#a76b9f7ac83b05ef4121ea164c3b8127c">dispenso::make_ready_future</a></div><div class="ttdeci">Future&lt; std::decay_t&lt; T &gt; &gt; make_ready_future(T &amp;&amp;t)</div><div class="ttdef"><b>Definition</b> <a href="future_8h_source.html#l00576">future.h:576</a></div></div>
 <div class="ttc" id="afuture_8h_html_a7910e3bd46b9cf1c12fe246ef65053f1"><div class="ttname"><a href="future_8h.html#a7910e3bd46b9cf1c12fe246ef65053f1">dispenso::when_all</a></div><div class="ttdeci">Future&lt; std::vector&lt; typename std::iterator_traits&lt; InputIt &gt;::value_type &gt; &gt; when_all(InputIt first, InputIt last)</div></div>

pipeline_8h_source.html

@@ -145,7 +145,7 @@
 <div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> </div>
 <div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span>} <span class="comment">// namespace dispenso</span></div>
 <div class="ttc" id="aclassdispenso_1_1_concurrent_task_set_html"><div class="ttname"><a href="classdispenso_1_1_concurrent_task_set.html">dispenso::ConcurrentTaskSet</a></div><div class="ttdef"><b>Definition</b> <a href="task__set_8h_source.html#l00173">task_set.h:173</a></div></div>
-<div class="ttc" id="aclassdispenso_1_1_thread_pool_html"><div class="ttname"><a href="classdispenso_1_1_thread_pool.html">dispenso::ThreadPool</a></div><div class="ttdef"><b>Definition</b> <a href="thread__pool_8h_source.html#l00070">thread_pool.h:70</a></div></div>
+<div class="ttc" id="aclassdispenso_1_1_thread_pool_html"><div class="ttname"><a href="classdispenso_1_1_thread_pool.html">dispenso::ThreadPool</a></div><div class="ttdef"><b>Definition</b> <a href="thread__pool_8h_source.html#l00073">thread_pool.h:73</a></div></div>
 <div class="ttc" id="apipeline_8h_html_a360af299cbfaa8e0069ec014f87d1ddb"><div class="ttname"><a href="pipeline_8h.html#a360af299cbfaa8e0069ec014f87d1ddb">dispenso::stage</a></div><div class="ttdeci">auto stage(F &amp;&amp;f, ssize_t limit)</div><div class="ttdef"><b>Definition</b> <a href="pipeline_8h_source.html#l00048">pipeline.h:48</a></div></div>
 <div class="ttc" id="apipeline_8h_html_a5438114dce2544c8cdab8100309478ab"><div class="ttname"><a href="pipeline_8h.html#a5438114dce2544c8cdab8100309478ab">dispenso::pipeline</a></div><div class="ttdeci">void pipeline(ThreadPool &amp;pool, Stages &amp;&amp;... sIn)</div><div class="ttdef"><b>Definition</b> <a href="pipeline_8h_source.html#l00077">pipeline.h:77</a></div></div>
 <div class="ttc" id="apipeline_8h_html_aa1d380eb639cdbd92330b96253a68e4a"><div class="ttname"><a href="pipeline_8h.html#aa1d380eb639cdbd92330b96253a68e4a">dispenso::kStageNoLimit</a></div><div class="ttdeci">constexpr ssize_t kStageNoLimit</div><div class="ttdef"><b>Definition</b> <a href="pipeline_8h_source.html#l00035">pipeline.h:35</a></div></div>

schedulable_8h_source.html

@@ -165,7 +165,7 @@
 <div class="ttc" id="aclassdispenso_1_1_new_thread_invoker_html_a3f688605cef1aa19b219fd4e502f4231"><div class="ttname"><a href="classdispenso_1_1_new_thread_invoker.html#a3f688605cef1aa19b219fd4e502f4231">dispenso::NewThreadInvoker::schedule</a></div><div class="ttdeci">void schedule(F &amp;&amp;f, ForceQueuingTag) const</div><div class="ttdef"><b>Definition</b> <a href="schedulable_8h_source.html#l00080">schedulable.h:80</a></div></div>
 <div class="ttc" id="aclassdispenso_1_1_new_thread_invoker_html_a460beb76088b55f1f463f601e2f45e23"><div class="ttname"><a href="classdispenso_1_1_new_thread_invoker.html#a460beb76088b55f1f463f601e2f45e23">dispenso::NewThreadInvoker::schedule</a></div><div class="ttdeci">void schedule(F &amp;&amp;f) const</div><div class="ttdef"><b>Definition</b> <a href="schedulable_8h_source.html#l00069">schedulable.h:69</a></div></div>
 <div class="ttc" id="apipeline_8h_html_ac10c8908b42e2d7fc3761b483a350967"><div class="ttname"><a href="pipeline_8h.html#ac10c8908b42e2d7fc3761b483a350967">dispenso::OpResult</a></div><div class="ttdeci">detail::OpResult&lt; T &gt; OpResult</div><div class="ttdef"><b>Definition</b> <a href="pipeline_8h_source.html#l00029">pipeline.h:29</a></div></div>
-<div class="ttc" id="astructdispenso_1_1_force_queuing_tag_html"><div class="ttname"><a href="structdispenso_1_1_force_queuing_tag.html">dispenso::ForceQueuingTag</a></div><div class="ttdef"><b>Definition</b> <a href="thread__pool_8h_source.html#l00063">thread_pool.h:63</a></div></div>
+<div class="ttc" id="astructdispenso_1_1_force_queuing_tag_html"><div class="ttname"><a href="structdispenso_1_1_force_queuing_tag.html">dispenso::ForceQueuingTag</a></div><div class="ttdef"><b>Definition</b> <a href="thread__pool_8h_source.html#l00066">thread_pool.h:66</a></div></div>
 <div class="ttc" id="atask__set_8h_html"><div class="ttname"><a href="task__set_8h.html">task_set.h</a></div></div>
 </div><!-- fragment --></div><!-- contents -->
 </div><!-- doc-content -->

structdispenso_1_1_force_queuing_tag.html

@@ -104,7 +104,7 @@
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <div class="textblock"><p>A simple tag specifier that can be fed to TaskSets and ThreadPools to denote that the current thread should never immediately execute a functor, but rather, the functor should always be placed in the <a class="el" href="classdispenso_1_1_thread_pool.html">ThreadPool</a>'s queue. </p>
 
-<p class="definition">Definition at line <a class="el" href="thread__pool_8h_source.html#l00063">63</a> of file <a class="el" href="thread__pool_8h_source.html">thread_pool.h</a>.</p>
+<p class="definition">Definition at line <a class="el" href="thread__pool_8h_source.html#l00066">66</a> of file <a class="el" href="thread__pool_8h_source.html">thread_pool.h</a>.</p>
 </div><hr/>The documentation for this struct was generated from the following file:<ul>
 <li>/github/workspace/dispenso/<a class="el" href="thread__pool_8h_source.html">thread_pool.h</a></li>
 </ul>

task__set_8h_source.html

@@ -286,9 +286,9 @@
 <div class="ttc" id="aclassdispenso_1_1_task_set_html_acf2fa200d57c597d9df06f95825d0f08"><div class="ttname"><a href="classdispenso_1_1_task_set.html#acf2fa200d57c597d9df06f95825d0f08">dispenso::TaskSet::TaskSet</a></div><div class="ttdeci">TaskSet(ThreadPool &amp;p, ParentCascadeCancel registerForParentCancel, ssize_t stealingLoadMultiplier=kDefaultStealingMultiplier)</div><div class="ttdef"><b>Definition</b> <a href="task__set_8h_source.html#l00046">task_set.h:46</a></div></div>
 <div class="ttc" id="aclassdispenso_1_1_task_set_html_adaf78b774cf53f55332f6708f988fc02"><div class="ttname"><a href="classdispenso_1_1_task_set.html#adaf78b774cf53f55332f6708f988fc02">dispenso::TaskSet::cancel</a></div><div class="ttdeci">void cancel()</div><div class="ttdef"><b>Definition</b> <a href="task__set_8h_source.html#l00130">task_set.h:130</a></div></div>
 <div class="ttc" id="aclassdispenso_1_1_task_set_html_aeb89ca02444f82497b0ed81543ab4d4b"><div class="ttname"><a href="classdispenso_1_1_task_set.html#aeb89ca02444f82497b0ed81543ab4d4b">dispenso::TaskSet::wait</a></div><div class="ttdeci">DISPENSO_DLL_ACCESS bool wait()</div><div class="ttdef"><b>Definition</b> <a href="task__set_8cpp_source.html#l00114">task_set.cpp:114</a></div></div>
-<div class="ttc" id="aclassdispenso_1_1_thread_pool_html"><div class="ttname"><a href="classdispenso_1_1_thread_pool.html">dispenso::ThreadPool</a></div><div class="ttdef"><b>Definition</b> <a href="thread__pool_8h_source.html#l00070">thread_pool.h:70</a></div></div>
+<div class="ttc" id="aclassdispenso_1_1_thread_pool_html"><div class="ttname"><a href="classdispenso_1_1_thread_pool.html">dispenso::ThreadPool</a></div><div class="ttdef"><b>Definition</b> <a href="thread__pool_8h_source.html#l00073">thread_pool.h:73</a></div></div>
 <div class="ttc" id="apipeline_8h_html_ac10c8908b42e2d7fc3761b483a350967"><div class="ttname"><a href="pipeline_8h.html#ac10c8908b42e2d7fc3761b483a350967">dispenso::OpResult</a></div><div class="ttdeci">detail::OpResult&lt; T &gt; OpResult</div><div class="ttdef"><b>Definition</b> <a href="pipeline_8h_source.html#l00029">pipeline.h:29</a></div></div>
-<div class="ttc" id="astructdispenso_1_1_force_queuing_tag_html"><div class="ttname"><a href="structdispenso_1_1_force_queuing_tag.html">dispenso::ForceQueuingTag</a></div><div class="ttdef"><b>Definition</b> <a href="thread__pool_8h_source.html#l00063">thread_pool.h:63</a></div></div>
+<div class="ttc" id="astructdispenso_1_1_force_queuing_tag_html"><div class="ttname"><a href="structdispenso_1_1_force_queuing_tag.html">dispenso::ForceQueuingTag</a></div><div class="ttdef"><b>Definition</b> <a href="thread__pool_8h_source.html#l00066">thread_pool.h:66</a></div></div>
 </div><!-- fragment --></div><!-- contents -->
 </div><!-- doc-content -->
 <!-- start footer part -->

thread__pool_8cpp_source.html

@@ -337,9 +337,9 @@
 <div class="line"><a id="l00232" name="l00232"></a><span class="lineno"> 232</span>}</div>
 <div class="line"><a id="l00233" name="l00233"></a><span class="lineno"> 233</span> </div>
 <div class="line"><a id="l00234" name="l00234"></a><span class="lineno"> 234</span>} <span class="comment">// namespace dispenso</span></div>
-<div class="ttc" id="aclassdispenso_1_1_thread_pool_html"><div class="ttname"><a href="classdispenso_1_1_thread_pool.html">dispenso::ThreadPool</a></div><div class="ttdef"><b>Definition</b> <a href="thread__pool_8h_source.html#l00070">thread_pool.h:70</a></div></div>
+<div class="ttc" id="aclassdispenso_1_1_thread_pool_html"><div class="ttname"><a href="classdispenso_1_1_thread_pool.html">dispenso::ThreadPool</a></div><div class="ttdef"><b>Definition</b> <a href="thread__pool_8h_source.html#l00073">thread_pool.h:73</a></div></div>
 <div class="ttc" id="aclassdispenso_1_1_thread_pool_html_a2442016e8a4924ca665d3993c1879b4d"><div class="ttname"><a href="classdispenso_1_1_thread_pool.html#a2442016e8a4924ca665d3993c1879b4d">dispenso::ThreadPool::ThreadPool</a></div><div class="ttdeci">DISPENSO_DLL_ACCESS ThreadPool(size_t n, size_t poolLoadMultiplier=32)</div><div class="ttdef"><b>Definition</b> <a href="thread__pool_8cpp_source.html#l00069">thread_pool.cpp:69</a></div></div>
-<div class="ttc" id="aclassdispenso_1_1_thread_pool_html_a6b6d82ff0d0a23686cee515b3c2a22dc"><div class="ttname"><a href="classdispenso_1_1_thread_pool.html#a6b6d82ff0d0a23686cee515b3c2a22dc">dispenso::ThreadPool::resize</a></div><div class="ttdeci">DISPENSO_DLL_ACCESS void resize(ssize_t n)</div><div class="ttdef"><b>Definition</b> <a href="thread__pool_8h_source.html#l00116">thread_pool.h:116</a></div></div>
+<div class="ttc" id="aclassdispenso_1_1_thread_pool_html_a6b6d82ff0d0a23686cee515b3c2a22dc"><div class="ttname"><a href="classdispenso_1_1_thread_pool.html#a6b6d82ff0d0a23686cee515b3c2a22dc">dispenso::ThreadPool::resize</a></div><div class="ttdeci">DISPENSO_DLL_ACCESS void resize(ssize_t n)</div><div class="ttdef"><b>Definition</b> <a href="thread__pool_8h_source.html#l00119">thread_pool.h:119</a></div></div>
 <div class="ttc" id="aclassdispenso_1_1_thread_pool_html_acd886dd712424330935b64959e8188af"><div class="ttname"><a href="classdispenso_1_1_thread_pool.html#acd886dd712424330935b64959e8188af">dispenso::ThreadPool::~ThreadPool</a></div><div class="ttdeci">DISPENSO_DLL_ACCESS ~ThreadPool()</div><div class="ttdef"><b>Definition</b> <a href="thread__pool_8cpp_source.html#l00196">thread_pool.cpp:196</a></div></div>
 <div class="ttc" id="apipeline_8h_html_ac10c8908b42e2d7fc3761b483a350967"><div class="ttname"><a href="pipeline_8h.html#ac10c8908b42e2d7fc3761b483a350967">dispenso::OpResult</a></div><div class="ttdeci">detail::OpResult&lt; T &gt; OpResult</div><div class="ttdef"><b>Definition</b> <a href="pipeline_8h_source.html#l00029">pipeline.h:29</a></div></div>
 <div class="ttc" id="athread__pool_8h_html"><div class="ttname"><a href="thread__pool_8h.html">thread_pool.h</a></div></div>