Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit bd54308

Browse files
twhuang-utahtwhuang-utah
committed
updated docs
1 parent a7ffe9a commit bd54308

File tree

60 files changed

+3299
-397
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+3299
-397
lines changed

‎docs/Algorithms.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848
<h1>
4949
Taskflow Algorithms
5050
</h1>
51-
<p>Taskflow defines a collection of algorithm functions especially designed to be used on ranges of elements.</p><ul><li><a href="ParallelIterations.html" class="m-doc">Parallel Iterations</a></li><li><a href="ParallelTransforms.html" class="m-doc">Parallel Transforms</a></li><li><a href="ParallelReduction.html" class="m-doc">Parallel Reduction</a></li><li><a href="ParallelSort.html" class="m-doc">Parallel Sort</a></li><li><a href="ParallelPipeline.html" class="m-doc">Parallel Pipeline</a></li></ul>
51+
<p>Taskflow defines a collection of algorithm functions especially designed to be used on ranges of elements.</p><ul><li><a href="ParallelIterations.html" class="m-doc">Parallel Iterations</a></li><li><a href="ParallelTransforms.html" class="m-doc">Parallel Transforms</a></li><li><a href="ParallelReduction.html" class="m-doc">Parallel Reduction</a></li><li><a href="ParallelSort.html" class="m-doc">Parallel Sort</a></li><li><a href="ParallelPipeline.html" class="m-doc">Parallel Pipeline</a></li><li><a href="ParallelScalablePipeline.html" class="m-doc">Parallel Scalable Pipeline</a></li></ul>
5252
</div>
5353
</div>
5454
</div>

‎docs/ParallelPipeline.html‎

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

‎docs/ParallelScalablePipeline.html‎

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

‎docs/annotated.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ <h1>Classes</h1>
7272
<li>class <a href="classtf_1_1Pipeflow.html" class="m-doc">Pipeflow</a> <span class="m-doc">class to create a pipeflow object used by the pipe callable</span></li>
7373
<li>class <a href="classtf_1_1Pipeline.html" class="m-doc">Pipeline</a> <span class="m-doc">class to create a pipeline scheduling framework</span></li>
7474
<li>class <a href="classtf_1_1Runtime.html" class="m-doc">Runtime</a> <span class="m-doc">class to create a runtime object used by a runtime task</span></li>
75+
<li>class <a href="classtf_1_1ScalablePipeline.html" class="m-doc">ScalablePipeline</a> <span class="m-doc">class to create a scalable pipeline object</span></li>
7576
<li>class <a href="classtf_1_1Semaphore.html" class="m-doc">Semaphore</a> <span class="m-doc">class to create a semophore object for building a concurrency constraint</span></li>
7677
<li>class <a href="classtf_1_1SmallVector.html" class="m-doc">SmallVector</a> <span class="m-doc">class to define a vector optimized for small array</span></li>
7778
<li>class <a href="classtf_1_1Subflow.html" class="m-doc">Subflow</a> <span class="m-doc">class to construct a subflow graph from the execution of a dynamic task</span></li>

‎docs/classtf_1_1Pipe.html‎

Lines changed: 86 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -69,12 +69,12 @@ <h3>Contents</h3>
6969
<ul>
7070
<li><a href="#pub-types">Public types</a></li>
7171
<li><a href="#typeless-methods">Constructors, destructors, conversion operators</a></li>
72+
<li><a href="#pub-methods">Public functions</a></li>
7273
</ul>
7374
</li>
7475
</ul>
7576
</div>
76-
<p>A pipe represents a stage of a pipeline. A pipe can be either <em>parallel</em> direction or <em>serial</em> direction (specified by <a href="namespacetf.html#abb7a11e41fd457f69e7ff45d4c769564" class="m-doc">tf::<wbr />PipeType</a>) and is coupled with a callable to invoke by the pipeline scheduler. The callable is one of the following possible forms:</p><pre class="m-code"><span class="n">Pipe</span><span class="p">{</span><span class="n">PipeType</span><span class="o">::</span><span class="n">SERIAL</span><span class="p">,</span> <span class="p">[](</span><span class="n">tf</span><span class="o">::</span><span class="n">Pipeflow</span><span class="o">&amp;</span><span class="p">){}}</span>
77-
<span class="n">Pipe</span><span class="p">{</span><span class="n">PipeType</span><span class="o">::</span><span class="n">SERIAL</span><span class="p">,</span> <span class="p">[](</span><span class="n">tf</span><span class="o">::</span><span class="n">Pipeflow</span><span class="o">&amp;</span><span class="p">,</span> <span class="n">tf</span><span class="o">::</span><span class="n">Runtime</span><span class="o">&amp;</span><span class="p">){}}</span></pre><p>The first version takes a pipeflow object for user to to query the present statistics of a pipeline scheduling token. The second version takes an additional runtime object for users to interact with the taskflow scheduler, such as scheduling a task and spawning a subflow.</p>
77+
<p>A pipe represents a stage of a pipeline. A pipe can be either <em>parallel</em> direction or <em>serial</em> direction (specified by <a href="namespacetf.html#abb7a11e41fd457f69e7ff45d4c769564" class="m-doc">tf::<wbr />PipeType</a>) and is coupled with a callable to invoke by the pipeline scheduler. The callable must take a <a href="classtf_1_1Pipeflow.html" class="m-doc">tf::<wbr />Pipeflow</a> object in reference:</p><pre class="m-code"><span class="n">Pipe</span><span class="p">{</span><span class="n">PipeType</span><span class="o">::</span><span class="n">SERIAL</span><span class="p">,</span> <span class="p">[](</span><span class="n">tf</span><span class="o">::</span><span class="n">Pipeflow</span><span class="o">&amp;</span><span class="p">){}}</span></pre><p>The pipeflow object is used to query the statistics of a scheduling token in the pipeline, such as pipe, line, and token numbers.</p>
7878
<section id="pub-types">
7979
<h2><a href="#pub-types">Public types</a></h2>
8080
<dl class="m-doc">
@@ -87,13 +87,35 @@ <h2><a href="#pub-types">Public types</a></h2>
8787
<section id="typeless-methods">
8888
<h2><a href="#typeless-methods">Constructors, destructors, conversion operators</a></h2>
8989
<dl class="m-doc">
90+
<dt id="ad2c372074ba5daacb54811cb48141570">
91+
<span class="m-doc-wrap-bumper"><a href="#ad2c372074ba5daacb54811cb48141570" class="m-doc-self">Pipe</a>(</span><span class="m-doc-wrap">) <span class="m-label m-flat m-info">defaulted</span></span>
92+
</dt>
93+
<dd>default constructor</dd>
9094
<dt>
9195
<span class="m-doc-wrap-bumper"><a href="#aebe1462048fa147ad8328fb13577cdf2" class="m-doc">Pipe</a>(</span><span class="m-doc-wrap"><a href="namespacetf.html#abb7a11e41fd457f69e7ff45d4c769564" class="m-doc">PipeType</a> d,
9296
C&amp;&amp; callable)</span>
9397
</dt>
9498
<dd>constructs the pipe object</dd>
9599
</dl>
96100
</section>
101+
<section id="pub-methods">
102+
<h2><a href="#pub-methods">Public functions</a></h2>
103+
<dl class="m-doc">
104+
<dt>
105+
<span class="m-doc-wrap-bumper">auto <a href="#a0a8ad99dbb66ad0bca766da47ef11b21" class="m-doc">type</a>(</span><span class="m-doc-wrap">) const -&gt; <a href="namespacetf.html#abb7a11e41fd457f69e7ff45d4c769564" class="m-doc">PipeType</a></span>
106+
</dt>
107+
<dd>queries the type of the pipe</dd>
108+
<dt>
109+
<span class="m-doc-wrap-bumper">void <a href="#ad939617c84a9e97ef1dd56ad56b84e33" class="m-doc">type</a>(</span><span class="m-doc-wrap"><a href="namespacetf.html#abb7a11e41fd457f69e7ff45d4c769564" class="m-doc">PipeType</a> type)</span>
110+
</dt>
111+
<dd>assigns a new type to the pipe</dd>
112+
<dt>
113+
<div class="m-doc-template">template&lt;typename U&gt;</div>
114+
<span class="m-doc-wrap-bumper">void <a href="#a43da5ae4ba56e35e4d0a705f7fa25686" class="m-doc">callable</a>(</span><span class="m-doc-wrap">U&amp;&amp; callable)</span>
115+
</dt>
116+
<dd>assigns a new callable to the pipe</dd>
117+
</dl>
118+
</section>
97119
<section>
98120
<h2>Function documentation</h2>
99121
<section class="m-doc-details" id="aebe1462048fa147ad8328fb13577cdf2"><div>
@@ -120,8 +142,68 @@ <h3>
120142
</tr>
121143
</tbody>
122144
</table>
123-
<p>The constructor constructs a pipe with the given direction (either <a href="namespacetf.html#abb7a11e41fd457f69e7ff45d4c769564a7b804a28d6154ab8007287532037f1d0" class="m-doc">tf::<wbr />PipeType::<wbr />SERIAL</a> or <a href="namespacetf.html#abb7a11e41fd457f69e7ff45d4c769564adf13a99b035d6f0bce4f44ab18eec8eb" class="m-doc">tf::<wbr />PipeType::<wbr />PARALLEL</a>) and the given callable. The callable is one of the following possible forms:</p><pre class="m-code"><span class="n">Pipe</span><span class="p">{</span><span class="n">PipeType</span><span class="o">::</span><span class="n">SERIAL</span><span class="p">,</span> <span class="p">[](</span><span class="n">tf</span><span class="o">::</span><span class="n">Pipeflow</span><span class="o">&amp;</span><span class="p">){}}</span>
124-
<span class="n">Pipe</span><span class="p">{</span><span class="n">PipeType</span><span class="o">::</span><span class="n">SERIAL</span><span class="p">,</span> <span class="p">[](</span><span class="n">tf</span><span class="o">::</span><span class="n">Pipeflow</span><span class="o">&amp;</span><span class="p">,</span> <span class="n">tf</span><span class="o">::</span><span class="n">Runtime</span><span class="o">&amp;</span><span class="p">){}}</span></pre><p>When creating a pipeline, the direction of the first pipe must be serial (<a href="namespacetf.html#abb7a11e41fd457f69e7ff45d4c769564a7b804a28d6154ab8007287532037f1d0" class="m-doc">tf::<wbr />PipeType::<wbr />SERIAL</a>).</p>
145+
<p>The constructor constructs a pipe with the given direction (either <a href="namespacetf.html#abb7a11e41fd457f69e7ff45d4c769564a7b804a28d6154ab8007287532037f1d0" class="m-doc">tf::<wbr />PipeType::<wbr />SERIAL</a> or <a href="namespacetf.html#abb7a11e41fd457f69e7ff45d4c769564adf13a99b035d6f0bce4f44ab18eec8eb" class="m-doc">tf::<wbr />PipeType::<wbr />PARALLEL</a>) and the given callable. The callable must take a <a href="classtf_1_1Pipeflow.html" class="m-doc">tf::<wbr />Pipeflow</a> object in reference:</p><pre class="m-code"><span class="n">Pipe</span><span class="p">{</span><span class="n">PipeType</span><span class="o">::</span><span class="n">SERIAL</span><span class="p">,</span> <span class="p">[](</span><span class="n">tf</span><span class="o">::</span><span class="n">Pipeflow</span><span class="o">&amp;</span><span class="p">){}}</span></pre><p>When creating a pipeline, the direction of the first pipe must be serial (<a href="namespacetf.html#abb7a11e41fd457f69e7ff45d4c769564a7b804a28d6154ab8007287532037f1d0" class="m-doc">tf::<wbr />PipeType::<wbr />SERIAL</a>).</p>
146+
</div></section>
147+
<section class="m-doc-details" id="a0a8ad99dbb66ad0bca766da47ef11b21"><div>
148+
<h3>
149+
<div class="m-doc-template">
150+
template&lt;typename C&gt;
151+
</div>
152+
<span class="m-doc-wrap-bumper"><a href="namespacetf.html#abb7a11e41fd457f69e7ff45d4c769564" class="m-doc">PipeType</a> tf::<wbr />Pipe&lt;C&gt;::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a0a8ad99dbb66ad0bca766da47ef11b21" class="m-doc-self">type</a>(</span><span class="m-doc-wrap">) const</span></span>
153+
</h3>
154+
<p>queries the type of the pipe</p>
155+
<p>Returns the type of the callable.</p>
156+
</div></section>
157+
<section class="m-doc-details" id="ad939617c84a9e97ef1dd56ad56b84e33"><div>
158+
<h3>
159+
<div class="m-doc-template">
160+
template&lt;typename C&gt;
161+
</div>
162+
<span class="m-doc-wrap-bumper">void tf::<wbr />Pipe&lt;C&gt;::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ad939617c84a9e97ef1dd56ad56b84e33" class="m-doc-self">type</a>(</span><span class="m-doc-wrap"><a href="namespacetf.html#abb7a11e41fd457f69e7ff45d4c769564" class="m-doc">PipeType</a> type)</span></span>
163+
</h3>
164+
<p>assigns a new type to the pipe</p>
165+
<table class="m-table m-fullwidth m-flat">
166+
<thead>
167+
<tr><th colspan="2">Parameters</th></tr>
168+
</thead>
169+
<tbody>
170+
<tr>
171+
<td style="width: 1%">type</td>
172+
<td>a <a href="namespacetf.html#abb7a11e41fd457f69e7ff45d4c769564" class="m-doc">tf::<wbr />PipeType</a> variable</td>
173+
</tr>
174+
</tbody>
175+
</table>
176+
</div></section>
177+
<section class="m-doc-details" id="a43da5ae4ba56e35e4d0a705f7fa25686"><div>
178+
<h3>
179+
<div class="m-doc-template">
180+
template&lt;typename C&gt;
181+
template&lt;typename U&gt;
182+
</div>
183+
<span class="m-doc-wrap-bumper">void tf::<wbr />Pipe&lt;C&gt;::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a43da5ae4ba56e35e4d0a705f7fa25686" class="m-doc-self">callable</a>(</span><span class="m-doc-wrap">U&amp;&amp; callable)</span></span>
184+
</h3>
185+
<p>assigns a new callable to the pipe</p>
186+
<table class="m-table m-fullwidth m-flat">
187+
<thead>
188+
<tr><th colspan="2">Template parameters</th></tr>
189+
</thead>
190+
<tbody>
191+
<tr>
192+
<td style="width: 1%">U</td>
193+
<td>callable type</td>
194+
</tr>
195+
</tbody>
196+
<thead>
197+
<tr><th colspan="2">Parameters</th></tr>
198+
</thead>
199+
<tbody>
200+
<tr>
201+
<td>callable</td>
202+
<td>a callable object constructible from std::function&lt;void(tf::Pipeflow&amp;)&gt;</td>
203+
</tr>
204+
</tbody>
205+
</table>
206+
<p>Assigns a new callable to the pipe with universal forwarding.</p>
125207
</div></section>
126208
</section>
127209
</div>

0 commit comments

Comments
 (0)