forked from taskflow/taskflow
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathclasstf_1_1Taskflow.html
More file actions
330 lines (320 loc) · 39.2 KB
/
classtf_1_1Taskflow.html
File metadata and controls
330 lines (320 loc) · 39.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Cpp-Taskflow</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link rel="icon" type="image/x-icon" href="favicon.ico" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname"><a href="https://github.com/cpp-taskflow/cpp-taskflow">Cpp-Taskflow</a>
 <span id="projectnumber">2.2.0</span>
</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classtf_1_1Taskflow.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#friends">Friends</a> |
<a href="classtf_1_1Taskflow-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">tf::Taskflow Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>the class to create a task dependency graph
<a href="classtf_1_1Taskflow.html#details">More...</a></p>
<p><code>#include <<a class="el" href="core_2taskflow_8hpp_source.html">taskflow.hpp</a>></code></p>
<div class="dynheader">
Inheritance diagram for tf::Taskflow:</div>
<div class="dyncontent">
<div class="center"><img src="classtf_1_1Taskflow__inherit__graph.png" border="0" usemap="#tf_1_1Taskflow_inherit__map" alt="Inheritance graph"/></div>
<map name="tf_1_1Taskflow_inherit__map" id="tf_1_1Taskflow_inherit__map">
<area shape="rect" id="node2" href="classtf_1_1FlowBuilder.html" title="Building blocks of a task dependency graph. " alt="" coords="5,5,112,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for tf::Taskflow:</div>
<div class="dyncontent">
<div class="center"><img src="classtf_1_1Taskflow__coll__graph.png" border="0" usemap="#tf_1_1Taskflow_coll__map" alt="Collaboration graph"/></div>
<map name="tf_1_1Taskflow_coll__map" id="tf_1_1Taskflow_coll__map">
<area shape="rect" id="node2" href="classtf_1_1FlowBuilder.html" title="Building blocks of a task dependency graph. " alt="" coords="5,5,112,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ade7fc641d136a3f8c96682c08040626a"><td class="memItemLeft" align="right" valign="top"><a id="ade7fc641d136a3f8c96682c08040626a"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1Taskflow.html#ade7fc641d136a3f8c96682c08040626a">Taskflow</a> ()</td></tr>
<tr class="memdesc:ade7fc641d136a3f8c96682c08040626a"><td class="mdescLeft"> </td><td class="mdescRight">constructs the taskflow with an empty task dependency graph <br /></td></tr>
<tr class="separator:ade7fc641d136a3f8c96682c08040626a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a00325e9799c833b75455ba1407b2695c"><td class="memItemLeft" align="right" valign="top"><a id="a00325e9799c833b75455ba1407b2695c"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1Taskflow.html#a00325e9799c833b75455ba1407b2695c">~Taskflow</a> ()</td></tr>
<tr class="memdesc:a00325e9799c833b75455ba1407b2695c"><td class="mdescLeft"> </td><td class="mdescRight">destroy the taskflow (virtual call) <br /></td></tr>
<tr class="separator:a00325e9799c833b75455ba1407b2695c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac433018262e44b12c4cc9f0c4748d758"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1Taskflow.html#ac433018262e44b12c4cc9f0c4748d758">dump</a> (<a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::ostream</a> &ostream) const</td></tr>
<tr class="memdesc:ac433018262e44b12c4cc9f0c4748d758"><td class="mdescLeft"> </td><td class="mdescRight">dumps the taskflow to a <a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::ostream</a> in DOT format <a href="#ac433018262e44b12c4cc9f0c4748d758">More...</a><br /></td></tr>
<tr class="separator:ac433018262e44b12c4cc9f0c4748d758"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9c4900da1831dce708664a06b3e3a3fb"><td class="memItemLeft" align="right" valign="top"><a id="a9c4900da1831dce708664a06b3e3a3fb"></a>
<a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1Taskflow.html#a9c4900da1831dce708664a06b3e3a3fb">dump</a> () const</td></tr>
<tr class="memdesc:a9c4900da1831dce708664a06b3e3a3fb"><td class="mdescLeft"> </td><td class="mdescRight">dumps the taskflow in DOT format to a <a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <br /></td></tr>
<tr class="separator:a9c4900da1831dce708664a06b3e3a3fb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a66ada311b948a920d2c26255ef731e6d"><td class="memItemLeft" align="right" valign="top"><a id="a66ada311b948a920d2c26255ef731e6d"></a>
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1Taskflow.html#a66ada311b948a920d2c26255ef731e6d">num_nodes</a> () const</td></tr>
<tr class="memdesc:a66ada311b948a920d2c26255ef731e6d"><td class="mdescLeft"> </td><td class="mdescRight">queries the number of nodes in the taskflow <br /></td></tr>
<tr class="separator:a66ada311b948a920d2c26255ef731e6d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a21b96ca779cc68d1117fdf1b053d11ee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classtf_1_1Task.html">tf::Task</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1Taskflow.html#a21b96ca779cc68d1117fdf1b053d11ee">composed_of</a> (<a class="el" href="classtf_1_1Taskflow.html">Taskflow</a> &taskflow)</td></tr>
<tr class="memdesc:a21b96ca779cc68d1117fdf1b053d11ee"><td class="mdescLeft"> </td><td class="mdescRight">creates a module task from a taskflow <a href="#a21b96ca779cc68d1117fdf1b053d11ee">More...</a><br /></td></tr>
<tr class="separator:a21b96ca779cc68d1117fdf1b053d11ee"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad1d1c025231e606adab089b1c73ac535"><td class="memItemLeft" align="right" valign="top"><a id="ad1d1c025231e606adab089b1c73ac535"></a>
auto & </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1Taskflow.html#ad1d1c025231e606adab089b1c73ac535">name</a> (const <a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> &)</td></tr>
<tr class="memdesc:ad1d1c025231e606adab089b1c73ac535"><td class="mdescLeft"> </td><td class="mdescRight">sets the name of the taskflow <br /></td></tr>
<tr class="separator:ad1d1c025231e606adab089b1c73ac535"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a911edd95acc1322433bddfcfeaf2ccb0"><td class="memItemLeft" align="right" valign="top"><a id="a911edd95acc1322433bddfcfeaf2ccb0"></a>
const <a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1Taskflow.html#a911edd95acc1322433bddfcfeaf2ccb0">name</a> () const</td></tr>
<tr class="memdesc:a911edd95acc1322433bddfcfeaf2ccb0"><td class="mdescLeft"> </td><td class="mdescRight">queries the name of the taskflow <br /></td></tr>
<tr class="separator:a911edd95acc1322433bddfcfeaf2ccb0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1f00bbe72a1553c9656ecae4d98bb9af"><td class="memItemLeft" align="right" valign="top"><a id="a1f00bbe72a1553c9656ecae4d98bb9af"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1Taskflow.html#a1f00bbe72a1553c9656ecae4d98bb9af">clear</a> ()</td></tr>
<tr class="memdesc:a1f00bbe72a1553c9656ecae4d98bb9af"><td class="mdescLeft"> </td><td class="mdescRight">clears the associated task dependency graph <br /></td></tr>
<tr class="separator:a1f00bbe72a1553c9656ecae4d98bb9af"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classtf_1_1FlowBuilder"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classtf_1_1FlowBuilder')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classtf_1_1FlowBuilder.html">tf::FlowBuilder</a></td></tr>
<tr class="memitem:a67d023d5493da1594a1d2eaea89da179 inherit pub_methods_classtf_1_1FlowBuilder"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1FlowBuilder.html#a67d023d5493da1594a1d2eaea89da179">FlowBuilder</a> (Graph &graph)</td></tr>
<tr class="memdesc:a67d023d5493da1594a1d2eaea89da179 inherit pub_methods_classtf_1_1FlowBuilder"><td class="mdescLeft"> </td><td class="mdescRight">construct a flow builder object <a href="classtf_1_1FlowBuilder.html#a67d023d5493da1594a1d2eaea89da179">More...</a><br /></td></tr>
<tr class="separator:a67d023d5493da1594a1d2eaea89da179 inherit pub_methods_classtf_1_1FlowBuilder"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4d52a7fe2814b264846a2085e931652c inherit pub_methods_classtf_1_1FlowBuilder"><td class="memTemplParams" colspan="2">template<typename C > </td></tr>
<tr class="memitem:a4d52a7fe2814b264846a2085e931652c inherit pub_methods_classtf_1_1FlowBuilder"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classtf_1_1Task.html">Task</a> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classtf_1_1FlowBuilder.html#a4d52a7fe2814b264846a2085e931652c">emplace</a> (C &&callable)</td></tr>
<tr class="memdesc:a4d52a7fe2814b264846a2085e931652c inherit pub_methods_classtf_1_1FlowBuilder"><td class="mdescLeft"> </td><td class="mdescRight">creates a task from a given callable object <a href="classtf_1_1FlowBuilder.html#a4d52a7fe2814b264846a2085e931652c">More...</a><br /></td></tr>
<tr class="separator:a4d52a7fe2814b264846a2085e931652c inherit pub_methods_classtf_1_1FlowBuilder"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1f6118326ad434f6c839007a1a79fe1b inherit pub_methods_classtf_1_1FlowBuilder"><td class="memTemplParams" colspan="2">template<typename... C, std::enable_if_t<(sizeof...(C)> 1> </td></tr>
<tr class="memitem:a1f6118326ad434f6c839007a1a79fe1b inherit pub_methods_classtf_1_1FlowBuilder"><td class="memTemplItemLeft" align="right" valign="top">auto </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classtf_1_1FlowBuilder.html#a1f6118326ad434f6c839007a1a79fe1b">emplace</a> (C &&... callables)</td></tr>
<tr class="memdesc:a1f6118326ad434f6c839007a1a79fe1b inherit pub_methods_classtf_1_1FlowBuilder"><td class="mdescLeft"> </td><td class="mdescRight">creates multiple tasks from a list of callable objects at one time <a href="classtf_1_1FlowBuilder.html#a1f6118326ad434f6c839007a1a79fe1b">More...</a><br /></td></tr>
<tr class="separator:a1f6118326ad434f6c839007a1a79fe1b inherit pub_methods_classtf_1_1FlowBuilder"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abf3da84e99b67248d6d8fdba48267caf inherit pub_methods_classtf_1_1FlowBuilder"><td class="memTemplParams" colspan="2"><a id="abf3da84e99b67248d6d8fdba48267caf"></a>
template<typename C > </td></tr>
<tr class="memitem:abf3da84e99b67248d6d8fdba48267caf inherit pub_methods_classtf_1_1FlowBuilder"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classtf_1_1Task.html">Task</a> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classtf_1_1FlowBuilder.html#abf3da84e99b67248d6d8fdba48267caf">silent_emplace</a> (C &&callable)</td></tr>
<tr class="memdesc:abf3da84e99b67248d6d8fdba48267caf inherit pub_methods_classtf_1_1FlowBuilder"><td class="mdescLeft"> </td><td class="mdescRight">the same as <a class="el" href="classtf_1_1FlowBuilder.html#a4d52a7fe2814b264846a2085e931652c" title="creates a task from a given callable object ">tf::FlowBuilder::emplace</a> (starting at 2.1.0) <br /></td></tr>
<tr class="separator:abf3da84e99b67248d6d8fdba48267caf inherit pub_methods_classtf_1_1FlowBuilder"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acf423e2775a25c2b8be4dce7dae8880a inherit pub_methods_classtf_1_1FlowBuilder"><td class="memTemplParams" colspan="2"><a id="acf423e2775a25c2b8be4dce7dae8880a"></a>
template<typename... C, std::enable_if_t<(sizeof...(C)> 1> </td></tr>
<tr class="memitem:acf423e2775a25c2b8be4dce7dae8880a inherit pub_methods_classtf_1_1FlowBuilder"><td class="memTemplItemLeft" align="right" valign="top">auto </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classtf_1_1FlowBuilder.html#acf423e2775a25c2b8be4dce7dae8880a">silent_emplace</a> (C &&... callables)</td></tr>
<tr class="memdesc:acf423e2775a25c2b8be4dce7dae8880a inherit pub_methods_classtf_1_1FlowBuilder"><td class="mdescLeft"> </td><td class="mdescRight">the same as <a class="el" href="classtf_1_1FlowBuilder.html#a4d52a7fe2814b264846a2085e931652c" title="creates a task from a given callable object ">tf::FlowBuilder::emplace</a> (starting at 2.1.0) <br /></td></tr>
<tr class="separator:acf423e2775a25c2b8be4dce7dae8880a inherit pub_methods_classtf_1_1FlowBuilder"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a84d411f16939bc158c5a90256e5d210e inherit pub_methods_classtf_1_1FlowBuilder"><td class="memTemplParams" colspan="2">template<typename I , typename C > </td></tr>
<tr class="memitem:a84d411f16939bc158c5a90256e5d210e inherit pub_methods_classtf_1_1FlowBuilder"><td class="memTemplItemLeft" align="right" valign="top"><a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="el" href="classtf_1_1Task.html">Task</a>, <a class="el" href="classtf_1_1Task.html">Task</a> > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classtf_1_1FlowBuilder.html#a84d411f16939bc158c5a90256e5d210e">parallel_for</a> (I beg, I end, C &&callable, size_t chunk=0)</td></tr>
<tr class="memdesc:a84d411f16939bc158c5a90256e5d210e inherit pub_methods_classtf_1_1FlowBuilder"><td class="mdescLeft"> </td><td class="mdescRight">constructs a task dependency graph of range-based parallel_for <a href="classtf_1_1FlowBuilder.html#a84d411f16939bc158c5a90256e5d210e">More...</a><br /></td></tr>
<tr class="separator:a84d411f16939bc158c5a90256e5d210e inherit pub_methods_classtf_1_1FlowBuilder"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abe18f8824cba16cde03e0dea8fae14ac inherit pub_methods_classtf_1_1FlowBuilder"><td class="memTemplParams" colspan="2">template<typename I , typename C , std::enable_if_t< std::is_arithmetic_v< I >, void > * = nullptr> </td></tr>
<tr class="memitem:abe18f8824cba16cde03e0dea8fae14ac inherit pub_methods_classtf_1_1FlowBuilder"><td class="memTemplItemLeft" align="right" valign="top"><a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="el" href="classtf_1_1Task.html">Task</a>, <a class="el" href="classtf_1_1Task.html">Task</a> > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classtf_1_1FlowBuilder.html#abe18f8824cba16cde03e0dea8fae14ac">parallel_for</a> (I beg, I end, I step, C &&callable, size_t chunk=0)</td></tr>
<tr class="memdesc:abe18f8824cba16cde03e0dea8fae14ac inherit pub_methods_classtf_1_1FlowBuilder"><td class="mdescLeft"> </td><td class="mdescRight">constructs a task dependency graph of index-based parallel_for <a href="classtf_1_1FlowBuilder.html#abe18f8824cba16cde03e0dea8fae14ac">More...</a><br /></td></tr>
<tr class="separator:abe18f8824cba16cde03e0dea8fae14ac inherit pub_methods_classtf_1_1FlowBuilder"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a06b06b57f8ec8bb060951fc71dd375fb inherit pub_methods_classtf_1_1FlowBuilder"><td class="memTemplParams" colspan="2">template<typename I , typename T , typename B > </td></tr>
<tr class="memitem:a06b06b57f8ec8bb060951fc71dd375fb inherit pub_methods_classtf_1_1FlowBuilder"><td class="memTemplItemLeft" align="right" valign="top"><a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="el" href="classtf_1_1Task.html">Task</a>, <a class="el" href="classtf_1_1Task.html">Task</a> > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classtf_1_1FlowBuilder.html#a06b06b57f8ec8bb060951fc71dd375fb">reduce</a> (I beg, I end, T &result, B &&bop)</td></tr>
<tr class="memdesc:a06b06b57f8ec8bb060951fc71dd375fb inherit pub_methods_classtf_1_1FlowBuilder"><td class="mdescLeft"> </td><td class="mdescRight">construct a task dependency graph of parallel reduction <a href="classtf_1_1FlowBuilder.html#a06b06b57f8ec8bb060951fc71dd375fb">More...</a><br /></td></tr>
<tr class="separator:a06b06b57f8ec8bb060951fc71dd375fb inherit pub_methods_classtf_1_1FlowBuilder"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae10e34cf00f7128d23e24c524c18d970 inherit pub_methods_classtf_1_1FlowBuilder"><td class="memTemplParams" colspan="2">template<typename I , typename T > </td></tr>
<tr class="memitem:ae10e34cf00f7128d23e24c524c18d970 inherit pub_methods_classtf_1_1FlowBuilder"><td class="memTemplItemLeft" align="right" valign="top"><a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="el" href="classtf_1_1Task.html">Task</a>, <a class="el" href="classtf_1_1Task.html">Task</a> > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classtf_1_1FlowBuilder.html#ae10e34cf00f7128d23e24c524c18d970">reduce_min</a> (I beg, I end, T &result)</td></tr>
<tr class="memdesc:ae10e34cf00f7128d23e24c524c18d970 inherit pub_methods_classtf_1_1FlowBuilder"><td class="mdescLeft"> </td><td class="mdescRight">constructs a task dependency graph of parallel reduction through <a href="https://en.cppreference.com/w/cpp/algorithm/min">std::min</a> <a href="classtf_1_1FlowBuilder.html#ae10e34cf00f7128d23e24c524c18d970">More...</a><br /></td></tr>
<tr class="separator:ae10e34cf00f7128d23e24c524c18d970 inherit pub_methods_classtf_1_1FlowBuilder"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a076fa5b55e0ef6eba3c962e85727f218 inherit pub_methods_classtf_1_1FlowBuilder"><td class="memTemplParams" colspan="2">template<typename I , typename T > </td></tr>
<tr class="memitem:a076fa5b55e0ef6eba3c962e85727f218 inherit pub_methods_classtf_1_1FlowBuilder"><td class="memTemplItemLeft" align="right" valign="top"><a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="el" href="classtf_1_1Task.html">Task</a>, <a class="el" href="classtf_1_1Task.html">Task</a> > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classtf_1_1FlowBuilder.html#a076fa5b55e0ef6eba3c962e85727f218">reduce_max</a> (I beg, I end, T &result)</td></tr>
<tr class="memdesc:a076fa5b55e0ef6eba3c962e85727f218 inherit pub_methods_classtf_1_1FlowBuilder"><td class="mdescLeft"> </td><td class="mdescRight">constructs a task dependency graph of parallel reduction through <a href="https://en.cppreference.com/w/cpp/algorithm/max">std::max</a> <a href="classtf_1_1FlowBuilder.html#a076fa5b55e0ef6eba3c962e85727f218">More...</a><br /></td></tr>
<tr class="separator:a076fa5b55e0ef6eba3c962e85727f218 inherit pub_methods_classtf_1_1FlowBuilder"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a08d669f2286cb90fd5ba7dade1e93fef inherit pub_methods_classtf_1_1FlowBuilder"><td class="memTemplParams" colspan="2">template<typename I , typename T , typename B , typename U > </td></tr>
<tr class="memitem:a08d669f2286cb90fd5ba7dade1e93fef inherit pub_methods_classtf_1_1FlowBuilder"><td class="memTemplItemLeft" align="right" valign="top"><a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="el" href="classtf_1_1Task.html">Task</a>, <a class="el" href="classtf_1_1Task.html">Task</a> > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classtf_1_1FlowBuilder.html#a08d669f2286cb90fd5ba7dade1e93fef">transform_reduce</a> (I beg, I end, T &result, B &&bop, U &&uop)</td></tr>
<tr class="memdesc:a08d669f2286cb90fd5ba7dade1e93fef inherit pub_methods_classtf_1_1FlowBuilder"><td class="mdescLeft"> </td><td class="mdescRight">constructs a task dependency graph of parallel transformation and reduction <a href="classtf_1_1FlowBuilder.html#a08d669f2286cb90fd5ba7dade1e93fef">More...</a><br /></td></tr>
<tr class="separator:a08d669f2286cb90fd5ba7dade1e93fef inherit pub_methods_classtf_1_1FlowBuilder"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9b81ad3b206a63adff8b8bc423f8c425 inherit pub_methods_classtf_1_1FlowBuilder"><td class="memTemplParams" colspan="2">template<typename I , typename T , typename B , typename P , typename U > </td></tr>
<tr class="memitem:a9b81ad3b206a63adff8b8bc423f8c425 inherit pub_methods_classtf_1_1FlowBuilder"><td class="memTemplItemLeft" align="right" valign="top"><a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="el" href="classtf_1_1Task.html">Task</a>, <a class="el" href="classtf_1_1Task.html">Task</a> > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classtf_1_1FlowBuilder.html#a9b81ad3b206a63adff8b8bc423f8c425">transform_reduce</a> (I beg, I end, T &result, B &&bop1, P &&bop2, U &&uop)</td></tr>
<tr class="memdesc:a9b81ad3b206a63adff8b8bc423f8c425 inherit pub_methods_classtf_1_1FlowBuilder"><td class="mdescLeft"> </td><td class="mdescRight">constructs a task dependency graph of parallel transformation and reduction <a href="classtf_1_1FlowBuilder.html#a9b81ad3b206a63adff8b8bc423f8c425">More...</a><br /></td></tr>
<tr class="separator:a9b81ad3b206a63adff8b8bc423f8c425 inherit pub_methods_classtf_1_1FlowBuilder"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acab0b4ac82260f47fdb36a3244ee3aaf inherit pub_methods_classtf_1_1FlowBuilder"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classtf_1_1Task.html">Task</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1FlowBuilder.html#acab0b4ac82260f47fdb36a3244ee3aaf">placeholder</a> ()</td></tr>
<tr class="memdesc:acab0b4ac82260f47fdb36a3244ee3aaf inherit pub_methods_classtf_1_1FlowBuilder"><td class="mdescLeft"> </td><td class="mdescRight">creates an empty task <a href="classtf_1_1FlowBuilder.html#acab0b4ac82260f47fdb36a3244ee3aaf">More...</a><br /></td></tr>
<tr class="separator:acab0b4ac82260f47fdb36a3244ee3aaf inherit pub_methods_classtf_1_1FlowBuilder"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af7c4a5d732d49bd63d554a92cd240f3f inherit pub_methods_classtf_1_1FlowBuilder"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1FlowBuilder.html#af7c4a5d732d49bd63d554a92cd240f3f">precede</a> (<a class="el" href="classtf_1_1Task.html">Task</a> A, <a class="el" href="classtf_1_1Task.html">Task</a> B)</td></tr>
<tr class="memdesc:af7c4a5d732d49bd63d554a92cd240f3f inherit pub_methods_classtf_1_1FlowBuilder"><td class="mdescLeft"> </td><td class="mdescRight">adds a dependency link from task A to task B <a href="classtf_1_1FlowBuilder.html#af7c4a5d732d49bd63d554a92cd240f3f">More...</a><br /></td></tr>
<tr class="separator:af7c4a5d732d49bd63d554a92cd240f3f inherit pub_methods_classtf_1_1FlowBuilder"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a90f3d9b9d6fcf4df8e7d7878dfdd130d inherit pub_methods_classtf_1_1FlowBuilder"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1FlowBuilder.html#a90f3d9b9d6fcf4df8e7d7878dfdd130d">linearize</a> (<a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>< <a class="el" href="classtf_1_1Task.html">Task</a> > &tasks)</td></tr>
<tr class="memdesc:a90f3d9b9d6fcf4df8e7d7878dfdd130d inherit pub_methods_classtf_1_1FlowBuilder"><td class="mdescLeft"> </td><td class="mdescRight">adds adjacent dependency links to a linear list of tasks <a href="classtf_1_1FlowBuilder.html#a90f3d9b9d6fcf4df8e7d7878dfdd130d">More...</a><br /></td></tr>
<tr class="separator:a90f3d9b9d6fcf4df8e7d7878dfdd130d inherit pub_methods_classtf_1_1FlowBuilder"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4ec89b554d15ad5fb96f4fdb10dbbb16 inherit pub_methods_classtf_1_1FlowBuilder"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1FlowBuilder.html#a4ec89b554d15ad5fb96f4fdb10dbbb16">linearize</a> (<a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/utility/initializer_list.html">std::initializer_list</a>< <a class="el" href="classtf_1_1Task.html">Task</a> > tasks)</td></tr>
<tr class="memdesc:a4ec89b554d15ad5fb96f4fdb10dbbb16 inherit pub_methods_classtf_1_1FlowBuilder"><td class="mdescLeft"> </td><td class="mdescRight">adds adjacent dependency links to a linear list of tasks <a href="classtf_1_1FlowBuilder.html#a4ec89b554d15ad5fb96f4fdb10dbbb16">More...</a><br /></td></tr>
<tr class="separator:a4ec89b554d15ad5fb96f4fdb10dbbb16 inherit pub_methods_classtf_1_1FlowBuilder"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3be7d982efad780eb6adbd1cf11a3d97 inherit pub_methods_classtf_1_1FlowBuilder"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1FlowBuilder.html#a3be7d982efad780eb6adbd1cf11a3d97">broadcast</a> (<a class="el" href="classtf_1_1Task.html">Task</a> A, <a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>< <a class="el" href="classtf_1_1Task.html">Task</a> > &others)</td></tr>
<tr class="memdesc:a3be7d982efad780eb6adbd1cf11a3d97 inherit pub_methods_classtf_1_1FlowBuilder"><td class="mdescLeft"> </td><td class="mdescRight">adds dependency links from one task A to many tasks <a href="classtf_1_1FlowBuilder.html#a3be7d982efad780eb6adbd1cf11a3d97">More...</a><br /></td></tr>
<tr class="separator:a3be7d982efad780eb6adbd1cf11a3d97 inherit pub_methods_classtf_1_1FlowBuilder"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:add973c333ea0d51dcefd5ebaef71cff8 inherit pub_methods_classtf_1_1FlowBuilder"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1FlowBuilder.html#add973c333ea0d51dcefd5ebaef71cff8">broadcast</a> (<a class="el" href="classtf_1_1Task.html">Task</a> A, <a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/utility/initializer_list.html">std::initializer_list</a>< <a class="el" href="classtf_1_1Task.html">Task</a> > others)</td></tr>
<tr class="memdesc:add973c333ea0d51dcefd5ebaef71cff8 inherit pub_methods_classtf_1_1FlowBuilder"><td class="mdescLeft"> </td><td class="mdescRight">adds dependency links from one task A to many tasks <a href="classtf_1_1FlowBuilder.html#add973c333ea0d51dcefd5ebaef71cff8">More...</a><br /></td></tr>
<tr class="separator:add973c333ea0d51dcefd5ebaef71cff8 inherit pub_methods_classtf_1_1FlowBuilder"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8871a9277dad477a69fb3a323d9c7bdb inherit pub_methods_classtf_1_1FlowBuilder"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1FlowBuilder.html#a8871a9277dad477a69fb3a323d9c7bdb">gather</a> (<a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>< <a class="el" href="classtf_1_1Task.html">Task</a> > &others, <a class="el" href="classtf_1_1Task.html">Task</a> A)</td></tr>
<tr class="memdesc:a8871a9277dad477a69fb3a323d9c7bdb inherit pub_methods_classtf_1_1FlowBuilder"><td class="mdescLeft"> </td><td class="mdescRight">adds dependency links from many tasks to one task A <a href="classtf_1_1FlowBuilder.html#a8871a9277dad477a69fb3a323d9c7bdb">More...</a><br /></td></tr>
<tr class="separator:a8871a9277dad477a69fb3a323d9c7bdb inherit pub_methods_classtf_1_1FlowBuilder"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae62feb52131f930695357dca68ea2acb inherit pub_methods_classtf_1_1FlowBuilder"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1FlowBuilder.html#ae62feb52131f930695357dca68ea2acb">gather</a> (<a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/utility/initializer_list.html">std::initializer_list</a>< <a class="el" href="classtf_1_1Task.html">Task</a> > others, <a class="el" href="classtf_1_1Task.html">Task</a> A)</td></tr>
<tr class="memdesc:ae62feb52131f930695357dca68ea2acb inherit pub_methods_classtf_1_1FlowBuilder"><td class="mdescLeft"> </td><td class="mdescRight">adds dependency links from many tasks to one task A <a href="classtf_1_1FlowBuilder.html#ae62feb52131f930695357dca68ea2acb">More...</a><br /></td></tr>
<tr class="separator:ae62feb52131f930695357dca68ea2acb inherit pub_methods_classtf_1_1FlowBuilder"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:acd2b8699ab7559c0da687cd775e2c778"><td class="memItemLeft" align="right" valign="top"><a id="acd2b8699ab7559c0da687cd775e2c778"></a>
class </td><td class="memItemRight" valign="bottom"><b>Topology</b></td></tr>
<tr class="separator:acd2b8699ab7559c0da687cd775e2c778"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a763b2f90bc53f92d680a635fe28e858e"><td class="memItemLeft" align="right" valign="top"><a id="a763b2f90bc53f92d680a635fe28e858e"></a>
class </td><td class="memItemRight" valign="bottom"><b>Executor</b></td></tr>
<tr class="separator:a763b2f90bc53f92d680a635fe28e858e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>the class to create a task dependency graph </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a21b96ca779cc68d1117fdf1b053d11ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21b96ca779cc68d1117fdf1b053d11ee">◆ </a></span>composed_of()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classtf_1_1Task.html">tf::Task</a> tf::Taskflow::composed_of </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classtf_1_1Taskflow.html">Taskflow</a> & </td>
<td class="paramname"><em>taskflow</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>creates a module task from a taskflow </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">taskflow</td><td>a taskflow object to create the module </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac433018262e44b12c4cc9f0c4748d758"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac433018262e44b12c4cc9f0c4748d758">◆ </a></span>dump()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void tf::Taskflow::dump </td>
<td>(</td>
<td class="paramtype"><a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::ostream</a> & </td>
<td class="paramname"><em>ostream</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>dumps the taskflow to a <a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::ostream</a> in DOT format </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ostream</td><td>a <a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::ostream</a> target </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="core_2taskflow_8hpp_source.html">core/taskflow.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>tf</b></li><li class="navelem"><a class="el" href="classtf_1_1Taskflow.html">Taskflow</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
</html>