Skip to content

Commit 76bae51

Browse files
committed
updated docs
1 parent 65f31e2 commit 76bae51

28 files changed

Lines changed: 558 additions & 300 deletions

docs/GPUTaskingcudaFlow.html

Lines changed: 9 additions & 10 deletions
Large diffs are not rendered by default.

docs/GPUTaskingcudaFlowCapturer.html

Lines changed: 18 additions & 18 deletions
Large diffs are not rendered by default.

docs/LimitTheMaximumConcurrency.html

Lines changed: 68 additions & 21 deletions
Large diffs are not rendered by default.

docs/classtf_1_1CriticalSection.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,8 @@ <h2><a href="#base-classes">Base classes</a></h2>
8989
<section id="typeless-methods">
9090
<h2><a href="#typeless-methods">Constructors, destructors, conversion operators</a></h2>
9191
<dl class="m-doc">
92-
<dt id="a64e16d9410b9a31e1f0e2c8bd562480f">
93-
<span class="m-doc-wrap-bumper"><a href="#a64e16d9410b9a31e1f0e2c8bd562480f" class="m-doc-self">CriticalSection</a>(</span><span class="m-doc-wrap">int max_workers = 1) <span class="m-label m-flat m-info">explicit</span> </span>
92+
<dt id="af690812215dfed0327cff39c77fc6545">
93+
<span class="m-doc-wrap-bumper"><a href="#af690812215dfed0327cff39c77fc6545" class="m-doc-self">CriticalSection</a>(</span><span class="m-doc-wrap">size_t max_workers = 1) <span class="m-label m-flat m-info">explicit</span> </span>
9494
</dt>
9595
<dd>constructs a critical region of a limited number of workers</dd>
9696
</dl>

docs/classtf_1_1FlowBuilder.html

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,10 @@ <h2><a href="#pub-methods">Public functions</a></h2>
108108
<span class="m-doc-wrap-bumper">auto <a href="#a1f6118326ad434f6c839007a1a79fe1b" class="m-doc">emplace</a>(</span><span class="m-doc-wrap">C &amp;&amp; ... callables) -&gt; auto</span>
109109
</dt>
110110
<dd>creates multiple tasks from a list of callable objects</dd>
111+
<dt>
112+
<span class="m-doc-wrap-bumper">void <a href="#a5627f7962099ac7c4986993cffa7b909" class="m-doc">erase</a>(</span><span class="m-doc-wrap"><a href="classtf_1_1Task.html" class="m-doc">Task</a> task)</span>
113+
</dt>
114+
<dd>removes a task from a taskflow</dd>
111115
<dt>
112116
<span class="m-doc-wrap-bumper">auto <a href="#a0a01192f4f92c15380a4f259e2fec2d9" class="m-doc">composed_of</a>(</span><span class="m-doc-wrap"><a href="classtf_1_1Taskflow.html" class="m-doc">Taskflow</a>&amp; taskflow) -&gt; <a href="classtf_1_1Task.html" class="m-doc">Task</a></span>
113117
</dt>
@@ -370,6 +374,24 @@ <h3>
370374
<span class="p">[]</span> <span class="p">()</span> <span class="p">{</span> <span class="n">std</span><span class="o">::</span><span class="n">cout</span> <span class="o">&lt;&lt;</span> <span class="s">&quot;C&quot;</span><span class="p">;</span> <span class="p">},</span>
371375
<span class="p">[]</span> <span class="p">()</span> <span class="p">{</span> <span class="n">std</span><span class="o">::</span><span class="n">cout</span> <span class="o">&lt;&lt;</span> <span class="s">&quot;D&quot;</span><span class="p">;</span> <span class="p">}</span>
372376
<span class="p">);</span></pre>
377+
</div></section>
378+
<section class="m-doc-details" id="a5627f7962099ac7c4986993cffa7b909"><div>
379+
<h3>
380+
<span class="m-doc-wrap-bumper">void tf::<wbr />FlowBuilder::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a5627f7962099ac7c4986993cffa7b909" class="m-doc-self">erase</a>(</span><span class="m-doc-wrap"><a href="classtf_1_1Task.html" class="m-doc">Task</a> task)</span></span>
381+
</h3>
382+
<p>removes a task from a taskflow</p>
383+
<table class="m-table m-fullwidth m-flat">
384+
<thead>
385+
<tr><th colspan="2">Parameters</th></tr>
386+
</thead>
387+
<tbody>
388+
<tr>
389+
<td style="width: 1%">task</td>
390+
<td>task to remove</td>
391+
</tr>
392+
</tbody>
393+
</table>
394+
<p>Removes a task and its input and output dependencies from this graph. If the task does not belong to this graph, nothing will happen.</p>
373395
</div></section>
374396
<section class="m-doc-details" id="a0a01192f4f92c15380a4f259e2fec2d9"><div>
375397
<h3>

docs/classtf_1_1Semaphore.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -93,17 +93,17 @@ <h2><a href="#derived-classes">Derived classes</a></h2>
9393
<section id="typeless-methods">
9494
<h2><a href="#typeless-methods">Constructors, destructors, conversion operators</a></h2>
9595
<dl class="m-doc">
96-
<dt id="a383f31970a822941988f1641da914302">
97-
<span class="m-doc-wrap-bumper"><a href="#a383f31970a822941988f1641da914302" class="m-doc-self">Semaphore</a>(</span><span class="m-doc-wrap">int max_workers) <span class="m-label m-flat m-info">explicit</span> </span>
96+
<dt id="a70ffe5c1611dba350d105b70377f8cd2">
97+
<span class="m-doc-wrap-bumper"><a href="#a70ffe5c1611dba350d105b70377f8cd2" class="m-doc-self">Semaphore</a>(</span><span class="m-doc-wrap">size_t max_workers) <span class="m-label m-flat m-info">explicit</span> </span>
9898
</dt>
9999
<dd>constructs a semaphore with the given counter</dd>
100100
</dl>
101101
</section>
102102
<section id="pub-methods">
103103
<h2><a href="#pub-methods">Public functions</a></h2>
104104
<dl class="m-doc">
105-
<dt id="ad6cad6f9cb643348adf27fc491c918ef">
106-
<span class="m-doc-wrap-bumper">auto <a href="#ad6cad6f9cb643348adf27fc491c918ef" class="m-doc-self">count</a>(</span><span class="m-doc-wrap">) const -&gt; int</span>
105+
<dt id="a8e4236750edd903ec0492231076ba2ba">
106+
<span class="m-doc-wrap-bumper">auto <a href="#a8e4236750edd903ec0492231076ba2ba" class="m-doc-self">count</a>(</span><span class="m-doc-wrap">) const -&gt; size_t</span>
107107
</dt>
108108
<dd>queries the counter value (not thread-safe during the run)</dd>
109109
</dl>

docs/release-3-3-0.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ <h3>Contents</h3>
7373
<li><a href="#release-3-3-0_miscellaneous_items">Miscellaneous Items</a></li>
7474
</ul>
7575
</div>
76-
<p>Taskflow 3.3.0 is the newest developing line to new features and improvements we continue to support. It is also where this documentation is generated. Many things are considered <em>experimental</em> and may change or break from time to time. While it may be difficult to be keep all things consistent when introducing new features, we continue to try our best to ensure backward compatibility.</p><section id="release-3-3-0_download"><h2><a href="#release-3-3-0_download">Download</a></h2><p>To download the newest version of Taskflow, please clone from <a href="https://github.com/taskflow/taskflow">Taskflow&#x27;s GitHub</a>.</p></section><section id="release-3-3-0_system_requirements"><h2><a href="#release-3-3-0_system_requirements">System Requirements</a></h2><p>To use Taskflow v3.3.0, you need a compiler that supports C++17:</p><ul><li>GNU C++ Compiler at least v8.4 with -std=c++17</li><li>Clang C++ Compiler at least v6.0 with -std=c++17</li><li>Microsoft Visual Studio at least v19.27 with /std:c++17</li><li>AppleClang Xode Version at least v12.0 with -std=c++17</li><li>Nvidia CUDA Toolkit and Compiler (nvcc) at least v11.1 with -std=c++17</li><li>Intel C++ Compiler at least v19.0.1 with -std=c++17</li><li>Intel DPC++ Clang Compiler at least v13.0.0 with -std=c++17 and SYCL20</li></ul><p>Taskflow works on Linux, Windows, and Mac OS X.</p></section><section id="release-3-3-0_summary"><h2><a href="#release-3-3-0_summary">Release Summary</a></h2><p>This release has resolved data race issues and incorporated essential sanitizers into the <a href="https://github.com/taskflow/taskflow/actions">continuous integration workflows</a> to detect data race, illegal memory access, and memory leak of the Taskflow codebase.</p></section><section id="release-3-3-0_new_features"><h2><a href="#release-3-3-0_new_features">New Features</a></h2><section id="release-3-3-0_taskflow_core"><h3><a href="#release-3-3-0_taskflow_core">Taskflow Core</a></h3><ul><li>Changed all lambda operators in parallel algorithms to copy by default</li><li>Cleaned up data race errors in <a href="https://github.com/google/sanitizers">tsan</a> caused by incorrect memory order</li><li>Added <a href="classtf_1_1Task.html#afd82ab6d6518d1142a72c4d2c97ff114" class="m-doc">tf::<wbr />Task::<wbr />data</a> to allow associating a task with user-level data</li></ul></section><section id="release-3-3-0_cudaflow"><h3><a href="#release-3-3-0_cudaflow">cudaFlow</a></h3></section><section id="release-3-3-0_syclflow"><h3><a href="#release-3-3-0_syclflow">syclFlow</a></h3></section><section id="release-3-3-0_cuda_std_algorithms"><h3><a href="#release-3-3-0_cuda_std_algorithms">CUDA Standard Parallel Algorithms</a></h3></section><section id="release-3-3-0_utilities"><h3><a href="#release-3-3-0_utilities">Utilities</a></h3></section><section id="release-3-3-0_profiler"><h3><a href="#release-3-3-0_profiler">Taskflow Profiler (TFProf)</a></h3></section></section><section id="release-3-3-0_bug_fixes"><h2><a href="#release-3-3-0_bug_fixes">Bug Fixes</a></h2><ul><li>Fixed memory leak in updating <a href="classtf_1_1cudaFlowCapturer.html" class="m-doc">tf::<wbr />cudaFlowCapturer</a> of undestroyed graph</li><li>Fixed invalid lambda capture by reference in <a href="classtf_1_1FlowBuilder.html#a7ef36ae799b89a5a37a2c5b09b12349c" class="m-doc">tf::<wbr />Taskflow::<wbr />sort</a></li></ul></section><section id="release-3-3-0_breaking_changes"><h2><a href="#release-3-3-0_breaking_changes">Breaking Changes</a></h2></section><section id="release-3-3-0_deprecated_items"><h2><a href="#release-3-3-0_deprecated_items">Deprecated and Removed Items</a></h2></section><section id="release-3-3-0_documentation"><h2><a href="#release-3-3-0_documentation">Documentation</a></h2><ul><li>Revised <a href="install.html" class="m-doc">Building and Installing</a><ul><li><a href="install.html#BAIBuildSanitizers" class="m-doc">Build Sanitizers</a></li></ul></li><li>Revised <a href="StaticTasking.html" class="m-doc">Static Tasking</a><ul><li><a href="StaticTasking.html#AttachUserDataToATask" class="m-doc">Attach User Data to a Task</a></li></ul></li></ul></section><section id="release-3-3-0_miscellaneous_items"><h2><a href="#release-3-3-0_miscellaneous_items">Miscellaneous Items</a></h2><p>We have published Taskflow in the following journal:</p><ul><li>Tsung-Wei Huang, Dian-Lun Lin, Chun-Xun Lin, and Yibo Lin, &quot;<a href="https://tsung-wei-huang.github.io/papers/tpds21-taskflow.pdf">Taskflow: A Lightweight Parallel and Heterogeneous Task Graph Computing System</a>,&quot; <em>IEEE Transactions on Parallel and Distributed Systems (TPDS)</em>, 2021</li></ul></section>
76+
<p>Taskflow 3.3.0 is the newest developing line to new features and improvements we continue to support. It is also where this documentation is generated. Many things are considered <em>experimental</em> and may change or break from time to time. While it may be difficult to be keep all things consistent when introducing new features, we continue to try our best to ensure backward compatibility.</p><section id="release-3-3-0_download"><h2><a href="#release-3-3-0_download">Download</a></h2><p>To download the newest version of Taskflow, please clone from <a href="https://github.com/taskflow/taskflow">Taskflow&#x27;s GitHub</a>.</p></section><section id="release-3-3-0_system_requirements"><h2><a href="#release-3-3-0_system_requirements">System Requirements</a></h2><p>To use Taskflow v3.3.0, you need a compiler that supports C++17:</p><ul><li>GNU C++ Compiler at least v8.4 with -std=c++17</li><li>Clang C++ Compiler at least v6.0 with -std=c++17</li><li>Microsoft Visual Studio at least v19.27 with /std:c++17</li><li>AppleClang Xode Version at least v12.0 with -std=c++17</li><li>Nvidia CUDA Toolkit and Compiler (nvcc) at least v11.1 with -std=c++17</li><li>Intel C++ Compiler at least v19.0.1 with -std=c++17</li><li>Intel DPC++ Clang Compiler at least v13.0.0 with -std=c++17 and SYCL20</li></ul><p>Taskflow works on Linux, Windows, and Mac OS X.</p></section><section id="release-3-3-0_summary"><h2><a href="#release-3-3-0_summary">Release Summary</a></h2><p>This release has resolved data race issues reported by <a href="https://github.com/google/sanitizers">tsan</a> and has incorporated essential sanitizers into the <a href="https://github.com/taskflow/taskflow/actions">continuous integration workflows</a> for detecting data race, illegal memory access, and memory leak of the Taskflow codebase.</p></section><section id="release-3-3-0_new_features"><h2><a href="#release-3-3-0_new_features">New Features</a></h2><section id="release-3-3-0_taskflow_core"><h3><a href="#release-3-3-0_taskflow_core">Taskflow Core</a></h3><ul><li>Changed all lambda operators in parallel algorithms to copy by default</li><li>Cleaned up data race errors in <a href="https://github.com/google/sanitizers">tsan</a> caused by incorrect memory order</li><li>Added <a href="classtf_1_1Task.html#afd82ab6d6518d1142a72c4d2c97ff114" class="m-doc">tf::<wbr />Task::<wbr />data</a> to allow associating a task with user-level data</li></ul></section><section id="release-3-3-0_cudaflow"><h3><a href="#release-3-3-0_cudaflow">cudaFlow</a></h3></section><section id="release-3-3-0_syclflow"><h3><a href="#release-3-3-0_syclflow">syclFlow</a></h3></section><section id="release-3-3-0_cuda_std_algorithms"><h3><a href="#release-3-3-0_cuda_std_algorithms">CUDA Standard Parallel Algorithms</a></h3></section><section id="release-3-3-0_utilities"><h3><a href="#release-3-3-0_utilities">Utilities</a></h3></section><section id="release-3-3-0_profiler"><h3><a href="#release-3-3-0_profiler">Taskflow Profiler (TFProf)</a></h3></section></section><section id="release-3-3-0_bug_fixes"><h2><a href="#release-3-3-0_bug_fixes">Bug Fixes</a></h2><ul><li>Fixed memory leak in updating <a href="classtf_1_1cudaFlowCapturer.html" class="m-doc">tf::<wbr />cudaFlowCapturer</a> of undestroyed graph</li><li>Fixed invalid lambda capture by reference in <a href="classtf_1_1FlowBuilder.html#a7ef36ae799b89a5a37a2c5b09b12349c" class="m-doc">tf::<wbr />Taskflow::<wbr />sort</a></li></ul></section><section id="release-3-3-0_breaking_changes"><h2><a href="#release-3-3-0_breaking_changes">Breaking Changes</a></h2></section><section id="release-3-3-0_deprecated_items"><h2><a href="#release-3-3-0_deprecated_items">Deprecated and Removed Items</a></h2></section><section id="release-3-3-0_documentation"><h2><a href="#release-3-3-0_documentation">Documentation</a></h2><ul><li>Revised <a href="install.html" class="m-doc">Building and Installing</a><ul><li><a href="install.html#BAIBuildSanitizers" class="m-doc">Build Sanitizers</a></li></ul></li><li>Revised <a href="StaticTasking.html" class="m-doc">Static Tasking</a><ul><li><a href="StaticTasking.html#AttachUserDataToATask" class="m-doc">Attach User Data to a Task</a></li></ul></li><li>Revised <a href="GPUTaskingcudaFlow.html" class="m-doc">GPU Tasking (cudaFlow)</a></li><li>Revised <a href="GPUTaskingcudaFlowCapturer.html" class="m-doc">GPU Tasking (cudaFlowCapturer)</a></li><li>Revised <a href="LimitTheMaximumConcurrency.html" class="m-doc">Limit the Maximum Concurrency</a><ul><li><a href="LimitTheMaximumConcurrency.html#DefineAConflictGraph" class="m-doc">Define a Conflict Graph</a></li></ul></li></ul></section><section id="release-3-3-0_miscellaneous_items"><h2><a href="#release-3-3-0_miscellaneous_items">Miscellaneous Items</a></h2><p>We have published Taskflow in the following journal:</p><ul><li>Tsung-Wei Huang, Dian-Lun Lin, Chun-Xun Lin, and Yibo Lin, &quot;<a href="https://tsung-wei-huang.github.io/papers/tpds21-taskflow.pdf">Taskflow: A Lightweight Parallel and Heterogeneous Task Graph Computing System</a>,&quot; <em>IEEE Transactions on Parallel and Distributed Systems (TPDS)</em>, 2021</li></ul></section>
7777
</div>
7878
</div>
7979
</div>

docs/searchdata-v1.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)