Skip to content
Navigation Menu
{{ message }}
forked from taskflow/taskflow
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathclasstf_1_1BasicTaskflow.html
More file actions
717 lines (676 loc) · 70.4 KB
/
Copy pathclasstf_1_1BasicTaskflow.html
File metadata and controls
717 lines (676 loc) · 70.4 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
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
<!-- 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_1BasicTaskflow.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="#nested-classes">Classes</a> |
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="classtf_1_1BasicTaskflow-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">tf::BasicTaskflow< E > Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The base class to derive a taskflow class.
<a href="classtf_1_1BasicTaskflow.html#details">More...</a></p>
<p><code>#include <<a class="el" href="basic__taskflow_8hpp_source.html">basic_taskflow.hpp</a>></code></p>
<div class="dynheader">
Inheritance diagram for tf::BasicTaskflow< E >:</div>
<div class="dyncontent">
<div class="center"><img src="classtf_1_1BasicTaskflow__inherit__graph.png" border="0" usemap="#tf_1_1BasicTaskflow_3_01E_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="tf_1_1BasicTaskflow_3_01E_01_4_inherit__map" id="tf_1_1BasicTaskflow_3_01E_01_4_inherit__map">
<area shape="rect" id="node2" href="classtf_1_1FlowBuilder.html" title="Building blocks of a task dependency graph. " alt="" coords="31,5,137,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::BasicTaskflow< E >:</div>
<div class="dyncontent">
<div class="center"><img src="classtf_1_1BasicTaskflow__coll__graph.png" border="0" usemap="#tf_1_1BasicTaskflow_3_01E_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="tf_1_1BasicTaskflow_3_01E_01_4_coll__map" id="tf_1_1BasicTaskflow_3_01E_01_4_coll__map">
<area shape="rect" id="node2" href="classtf_1_1FlowBuilder.html" title="Building blocks of a task dependency graph. " alt="" coords="31,5,137,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-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:afa5ea834928f68f950f59889c626c2ff"><td class="memItemLeft" align="right" valign="top"><a id="afa5ea834928f68f950f59889c626c2ff"></a>
using </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1BasicTaskflow.html#afa5ea834928f68f950f59889c626c2ff">Executor</a> = E< Closure ></td></tr>
<tr class="memdesc:afa5ea834928f68f950f59889c626c2ff"><td class="mdescLeft"> </td><td class="mdescRight">alias of executor type <br /></td></tr>
<tr class="separator:afa5ea834928f68f950f59889c626c2ff"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:ab077a9419b9cb6cbc9f9647c621c8c71"><td class="memItemLeft" align="right" valign="top"><a id="ab077a9419b9cb6cbc9f9647c621c8c71"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1BasicTaskflow.html#ab077a9419b9cb6cbc9f9647c621c8c71">BasicTaskflow</a> ()</td></tr>
<tr class="memdesc:ab077a9419b9cb6cbc9f9647c621c8c71"><td class="mdescLeft"> </td><td class="mdescRight">constructs the taskflow with <a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/thread/thread/hardware_concurrency.html">std::thread::hardware_concurrency</a> worker threads <br /></td></tr>
<tr class="separator:ab077a9419b9cb6cbc9f9647c621c8c71"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abfad9343208ba7fa8238e544511b5e8f"><td class="memItemLeft" align="right" valign="top"><a id="abfad9343208ba7fa8238e544511b5e8f"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1BasicTaskflow.html#abfad9343208ba7fa8238e544511b5e8f">BasicTaskflow</a> (unsigned N)</td></tr>
<tr class="memdesc:abfad9343208ba7fa8238e544511b5e8f"><td class="mdescLeft"> </td><td class="mdescRight">constructs the taskflow with N worker threads <br /></td></tr>
<tr class="separator:abfad9343208ba7fa8238e544511b5e8f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aee86bd515327964e08b11ca842fe6acd"><td class="memItemLeft" align="right" valign="top"><a id="aee86bd515327964e08b11ca842fe6acd"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1BasicTaskflow.html#aee86bd515327964e08b11ca842fe6acd">BasicTaskflow</a> (<a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="classtf_1_1BasicTaskflow.html#afa5ea834928f68f950f59889c626c2ff">Executor</a> > executor)</td></tr>
<tr class="memdesc:aee86bd515327964e08b11ca842fe6acd"><td class="mdescLeft"> </td><td class="mdescRight">constructs the taskflow with a given executor <br /></td></tr>
<tr class="separator:aee86bd515327964e08b11ca842fe6acd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae820a9ab3cad471a591da4de749752ae"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1BasicTaskflow.html#ae820a9ab3cad471a591da4de749752ae">~BasicTaskflow</a> ()</td></tr>
<tr class="memdesc:ae820a9ab3cad471a591da4de749752ae"><td class="mdescLeft"> </td><td class="mdescRight">destructs the taskflow <a href="#ae820a9ab3cad471a591da4de749752ae">More...</a><br /></td></tr>
<tr class="separator:ae820a9ab3cad471a591da4de749752ae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abe76e5288016861aaf1dafc0218d3084"><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="classtf_1_1BasicTaskflow.html#afa5ea834928f68f950f59889c626c2ff">Executor</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1BasicTaskflow.html#abe76e5288016861aaf1dafc0218d3084">share_executor</a> ()</td></tr>
<tr class="memdesc:abe76e5288016861aaf1dafc0218d3084"><td class="mdescLeft"> </td><td class="mdescRight">shares ownership of the executor associated with this taskflow object <a href="#abe76e5288016861aaf1dafc0218d3084">More...</a><br /></td></tr>
<tr class="separator:abe76e5288016861aaf1dafc0218d3084"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a848e425f67b49a8a7ac21f6b791999c5"><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/thread/shared_future.html">std::shared_future</a>< void > </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1BasicTaskflow.html#a848e425f67b49a8a7ac21f6b791999c5">dispatch</a> ()</td></tr>
<tr class="memdesc:a848e425f67b49a8a7ac21f6b791999c5"><td class="mdescLeft"> </td><td class="mdescRight">dispatches the present graph to threads and returns immediately <a href="#a848e425f67b49a8a7ac21f6b791999c5">More...</a><br /></td></tr>
<tr class="separator:a848e425f67b49a8a7ac21f6b791999c5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae644520b734078d061e3ceafc7d982ad"><td class="memTemplParams" colspan="2">template<typename C > </td></tr>
<tr class="memitem:ae644520b734078d061e3ceafc7d982ad"><td class="memTemplItemLeft" align="right" valign="top"><a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/thread/shared_future.html">std::shared_future</a>< void > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classtf_1_1BasicTaskflow.html#ae644520b734078d061e3ceafc7d982ad">dispatch</a> (C &&)</td></tr>
<tr class="memdesc:ae644520b734078d061e3ceafc7d982ad"><td class="mdescLeft"> </td><td class="mdescRight">dispatches the present graph to threads and run a callback when the graph completes <a href="#ae644520b734078d061e3ceafc7d982ad">More...</a><br /></td></tr>
<tr class="separator:ae644520b734078d061e3ceafc7d982ad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a37ef86998f23ee7315be032c40fe815e"><td class="memItemLeft" align="right" valign="top"><a id="a37ef86998f23ee7315be032c40fe815e"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1BasicTaskflow.html#a37ef86998f23ee7315be032c40fe815e">wait_for_all</a> ()</td></tr>
<tr class="memdesc:a37ef86998f23ee7315be032c40fe815e"><td class="mdescLeft"> </td><td class="mdescRight">dispatches the present graph to threads and wait for all topologies to complete <br /></td></tr>
<tr class="separator:a37ef86998f23ee7315be032c40fe815e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8f0ce2026118e97b83cbd727ed0932af"><td class="memItemLeft" align="right" valign="top"><a id="a8f0ce2026118e97b83cbd727ed0932af"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1BasicTaskflow.html#a8f0ce2026118e97b83cbd727ed0932af">wait_for_topologies</a> ()</td></tr>
<tr class="memdesc:a8f0ce2026118e97b83cbd727ed0932af"><td class="mdescLeft"> </td><td class="mdescRight">blocks until all running topologies complete and then cleans up all associated storages <br /></td></tr>
<tr class="separator:a8f0ce2026118e97b83cbd727ed0932af"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adac448e1cc44307856b3116d7ed5490f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1BasicTaskflow.html#adac448e1cc44307856b3116d7ed5490f">dump</a> (<a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/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:adac448e1cc44307856b3116d7ed5490f"><td class="mdescLeft"> </td><td class="mdescRight">dumps the present task dependency graph to a <a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/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="#adac448e1cc44307856b3116d7ed5490f">More...</a><br /></td></tr>
<tr class="separator:adac448e1cc44307856b3116d7ed5490f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af17f2410531dfd08b0e55ef80a8f828d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1BasicTaskflow.html#af17f2410531dfd08b0e55ef80a8f828d">dump_topologies</a> (<a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/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:af17f2410531dfd08b0e55ef80a8f828d"><td class="mdescLeft"> </td><td class="mdescRight">dumps the present topologies to a <a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/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="#af17f2410531dfd08b0e55ef80a8f828d">More...</a><br /></td></tr>
<tr class="separator:af17f2410531dfd08b0e55ef80a8f828d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a18341302575dcb719e455d84a738273f"><td class="memItemLeft" align="right" valign="top"><a id="a18341302575dcb719e455d84a738273f"></a>
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1BasicTaskflow.html#a18341302575dcb719e455d84a738273f">num_nodes</a> () const</td></tr>
<tr class="memdesc:a18341302575dcb719e455d84a738273f"><td class="mdescLeft"> </td><td class="mdescRight">queries the number of nodes in the present task dependency graph <br /></td></tr>
<tr class="separator:a18341302575dcb719e455d84a738273f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9cef9ee3d27ffc78bfa953c8ed25b559"><td class="memItemLeft" align="right" valign="top"><a id="a9cef9ee3d27ffc78bfa953c8ed25b559"></a>
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1BasicTaskflow.html#a9cef9ee3d27ffc78bfa953c8ed25b559">num_workers</a> () const</td></tr>
<tr class="memdesc:a9cef9ee3d27ffc78bfa953c8ed25b559"><td class="mdescLeft"> </td><td class="mdescRight">queries the number of worker threads in the associated executor <br /></td></tr>
<tr class="separator:a9cef9ee3d27ffc78bfa953c8ed25b559"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7e97ed52d9d0470d2751f32748adb253"><td class="memItemLeft" align="right" valign="top"><a id="a7e97ed52d9d0470d2751f32748adb253"></a>
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1BasicTaskflow.html#a7e97ed52d9d0470d2751f32748adb253">num_topologies</a> () const</td></tr>
<tr class="memdesc:a7e97ed52d9d0470d2751f32748adb253"><td class="mdescLeft"> </td><td class="mdescRight">queries the number of existing topologies <br /></td></tr>
<tr class="separator:a7e97ed52d9d0470d2751f32748adb253"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a913a31040546bcf9d6e044580d170722"><td class="memItemLeft" align="right" valign="top"><a id="a913a31040546bcf9d6e044580d170722"></a>
<a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/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_1BasicTaskflow.html#a913a31040546bcf9d6e044580d170722">dump</a> () const</td></tr>
<tr class="memdesc:a913a31040546bcf9d6e044580d170722"><td class="mdescLeft"> </td><td class="mdescRight">dumps the present task dependency graph in DOT format to a <a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/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:a913a31040546bcf9d6e044580d170722"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae4c67b7bc87564e8b5b309837f4b6d78"><td class="memItemLeft" align="right" valign="top"><a id="ae4c67b7bc87564e8b5b309837f4b6d78"></a>
<a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/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_1BasicTaskflow.html#ae4c67b7bc87564e8b5b309837f4b6d78">dump_topologies</a> () const</td></tr>
<tr class="memdesc:ae4c67b7bc87564e8b5b309837f4b6d78"><td class="mdescLeft"> </td><td class="mdescRight">dumps the existing topologies in DOT format to a <a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/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:ae4c67b7bc87564e8b5b309837f4b6d78"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afc7f9ac974ee803b2d3b5577a6c8a2bc"><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/thread/shared_future.html">std::shared_future</a>< void > </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1BasicTaskflow.html#afc7f9ac974ee803b2d3b5577a6c8a2bc">run</a> (<a class="el" href="classtf_1_1Framework.html">Framework</a> &framework)</td></tr>
<tr class="memdesc:afc7f9ac974ee803b2d3b5577a6c8a2bc"><td class="mdescLeft"> </td><td class="mdescRight">runs the framework once <a href="#afc7f9ac974ee803b2d3b5577a6c8a2bc">More...</a><br /></td></tr>
<tr class="separator:afc7f9ac974ee803b2d3b5577a6c8a2bc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a876ef3bbdbae7333bd2c3bf0f36a865c"><td class="memTemplParams" colspan="2">template<typename C > </td></tr>
<tr class="memitem:a876ef3bbdbae7333bd2c3bf0f36a865c"><td class="memTemplItemLeft" align="right" valign="top"><a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/thread/shared_future.html">std::shared_future</a>< void > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classtf_1_1BasicTaskflow.html#a876ef3bbdbae7333bd2c3bf0f36a865c">run</a> (<a class="el" href="classtf_1_1Framework.html">Framework</a> &framework, C &&callable)</td></tr>
<tr class="memdesc:a876ef3bbdbae7333bd2c3bf0f36a865c"><td class="mdescLeft"> </td><td class="mdescRight">runs the framework once and invoke a callback upon completion <a href="#a876ef3bbdbae7333bd2c3bf0f36a865c">More...</a><br /></td></tr>
<tr class="separator:a876ef3bbdbae7333bd2c3bf0f36a865c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abe9f7964777c2d65052b2dda7307efb6"><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/thread/shared_future.html">std::shared_future</a>< void > </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1BasicTaskflow.html#abe9f7964777c2d65052b2dda7307efb6">run_n</a> (<a class="el" href="classtf_1_1Framework.html">Framework</a> &framework, size_t N)</td></tr>
<tr class="memdesc:abe9f7964777c2d65052b2dda7307efb6"><td class="mdescLeft"> </td><td class="mdescRight">runs the framework for N times <a href="#abe9f7964777c2d65052b2dda7307efb6">More...</a><br /></td></tr>
<tr class="separator:abe9f7964777c2d65052b2dda7307efb6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a006f2d8acf994a9c6e721b1bcc007b17"><td class="memTemplParams" colspan="2">template<typename C > </td></tr>
<tr class="memitem:a006f2d8acf994a9c6e721b1bcc007b17"><td class="memTemplItemLeft" align="right" valign="top"><a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/thread/shared_future.html">std::shared_future</a>< void > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classtf_1_1BasicTaskflow.html#a006f2d8acf994a9c6e721b1bcc007b17">run_n</a> (<a class="el" href="classtf_1_1Framework.html">Framework</a> &framework, size_t N, C &&callable)</td></tr>
<tr class="memdesc:a006f2d8acf994a9c6e721b1bcc007b17"><td class="mdescLeft"> </td><td class="mdescRight">runs the framework for N times and invokes a callback upon completion <a href="#a006f2d8acf994a9c6e721b1bcc007b17">More...</a><br /></td></tr>
<tr class="separator:a006f2d8acf994a9c6e721b1bcc007b17"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3a24f26ead77969d133d72372df456e0"><td class="memTemplParams" colspan="2">template<typename P > </td></tr>
<tr class="memitem:a3a24f26ead77969d133d72372df456e0"><td class="memTemplItemLeft" align="right" valign="top"><a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/thread/shared_future.html">std::shared_future</a>< void > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classtf_1_1BasicTaskflow.html#a3a24f26ead77969d133d72372df456e0">run_until</a> (<a class="el" href="classtf_1_1Framework.html">Framework</a> &framework, P &&predicate)</td></tr>
<tr class="memdesc:a3a24f26ead77969d133d72372df456e0"><td class="mdescLeft"> </td><td class="mdescRight">runs the framework multiple times until the predicate becomes true and invoke a callback <a href="#a3a24f26ead77969d133d72372df456e0">More...</a><br /></td></tr>
<tr class="separator:a3a24f26ead77969d133d72372df456e0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaa4618b734a976a39ca1cc47a8e44c4e"><td class="memTemplParams" colspan="2">template<typename P , typename C > </td></tr>
<tr class="memitem:aaa4618b734a976a39ca1cc47a8e44c4e"><td class="memTemplItemLeft" align="right" valign="top"><a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/thread/shared_future.html">std::shared_future</a>< void > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classtf_1_1BasicTaskflow.html#aaa4618b734a976a39ca1cc47a8e44c4e">run_until</a> (<a class="el" href="classtf_1_1Framework.html">Framework</a> &framework, P &&predicate, C &&callable)</td></tr>
<tr class="memdesc:aaa4618b734a976a39ca1cc47a8e44c4e"><td class="mdescLeft"> </td><td class="mdescRight">runs the framework multiple times until the predicate becomes true and invoke a callback <a href="#aaa4618b734a976a39ca1cc47a8e44c4e">More...</a><br /></td></tr>
<tr class="separator:aaa4618b734a976a39ca1cc47a8e44c4e"><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/docs/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/docs/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/docs/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/docs/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/docs/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/docs/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/docs/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/docs/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/docs/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/docs/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/docs/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/docs/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/docs/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>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template<template< typename... > typename E><br />
class tf::BasicTaskflow< E ></h3>
<p>The base class to derive a taskflow class. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">E</td><td>executor type to use in this taskflow</td></tr>
</table>
</dd>
</dl>
<p>This class is the base class to derive a taskflow class. It inherits all public methods to create tasks from <a class="el" href="classtf_1_1FlowBuilder.html" title="Building blocks of a task dependency graph. ">tf::FlowBuilder</a> and defines means to execute task dependency graphs. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="ae820a9ab3cad471a591da4de749752ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae820a9ab3cad471a591da4de749752ae">◆ </a></span>~BasicTaskflow()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<template< typename... > typename E> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classtf_1_1BasicTaskflow.html">tf::BasicTaskflow</a>< E >::~<a class="el" href="classtf_1_1BasicTaskflow.html">BasicTaskflow</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>destructs the taskflow </p>
<p>Destructing a taskflow object will first wait for all running topologies to finish and then clean up all associated data storages. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a848e425f67b49a8a7ac21f6b791999c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a848e425f67b49a8a7ac21f6b791999c5">◆ </a></span>dispatch() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<template< typename... > typename E> </div>
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/thread/shared_future.html">std::shared_future</a>< void > <a class="el" href="classtf_1_1BasicTaskflow.html">tf::BasicTaskflow</a>< E >::dispatch </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>dispatches the present graph to threads and returns immediately </p>
<dl class="section return"><dt>Returns</dt><dd>a <a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/thread/shared_future.html">std::shared_future</a> to access the execution status of the dispatched graph </dd></dl>
</div>
</div>
<a id="ae644520b734078d061e3ceafc7d982ad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae644520b734078d061e3ceafc7d982ad">◆ </a></span>dispatch() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<template< typename... > typename E> </div>
<div class="memtemplate">
template<typename C > </div>
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/thread/shared_future.html">std::shared_future</a>< void > <a class="el" href="classtf_1_1BasicTaskflow.html">tf::BasicTaskflow</a>< E >::dispatch </td>
<td>(</td>
<td class="paramtype">C && </td>
<td class="paramname"><em>c</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>dispatches the present graph to threads and run a callback when the graph completes </p>
<dl class="section return"><dt>Returns</dt><dd>a <a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/thread/shared_future.html">std::shared_future</a> to access the execution status of the dispatched graph </dd></dl>
</div>
</div>
<a id="adac448e1cc44307856b3116d7ed5490f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adac448e1cc44307856b3116d7ed5490f">◆ </a></span>dump()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<template< typename... > typename E> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classtf_1_1BasicTaskflow.html">tf::BasicTaskflow</a>< E >::dump </td>
<td>(</td>
<td class="paramtype"><a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/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>
</div><div class="memdoc">
<p>dumps the present task dependency graph to a <a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/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/docs/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>
<a id="af17f2410531dfd08b0e55ef80a8f828d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af17f2410531dfd08b0e55ef80a8f828d">◆ </a></span>dump_topologies()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<template< typename... > typename E> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classtf_1_1BasicTaskflow.html">tf::BasicTaskflow</a>< E >::dump_topologies </td>
<td>(</td>
<td class="paramtype"><a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/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>
</div><div class="memdoc">
<p>dumps the present topologies to a <a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/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/docs/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>
<a id="afc7f9ac974ee803b2d3b5577a6c8a2bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc7f9ac974ee803b2d3b5577a6c8a2bc">◆ </a></span>run() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<template< typename... > typename E> </div>
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/thread/shared_future.html">std::shared_future</a>< void > <a class="el" href="classtf_1_1BasicTaskflow.html">tf::BasicTaskflow</a>< E >::run </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classtf_1_1Framework.html">Framework</a> & </td>
<td class="paramname"><em>framework</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>runs the framework once </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">framework</td><td>a <a class="el" href="classtf_1_1Framework.html" title="A reusable task dependency graph. ">tf::Framework</a> object</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a <a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/thread/shared_future.html">std::shared_future</a> to access the execution status of the framework </dd></dl>
</div>
</div>
<a id="a876ef3bbdbae7333bd2c3bf0f36a865c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a876ef3bbdbae7333bd2c3bf0f36a865c">◆ </a></span>run() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<template< typename... > typename E> </div>
<div class="memtemplate">
template<typename C > </div>
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/thread/shared_future.html">std::shared_future</a>< void > <a class="el" href="classtf_1_1BasicTaskflow.html">tf::BasicTaskflow</a>< E >::run </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classtf_1_1Framework.html">Framework</a> & </td>
<td class="paramname"><em>framework</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">C && </td>
<td class="paramname"><em>callable</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>runs the framework once and invoke a callback upon completion </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">framework</td><td>a <a class="el" href="classtf_1_1Framework.html" title="A reusable task dependency graph. ">tf::Framework</a> object </td></tr>
<tr><td class="paramname">callable</td><td>a callable object to be invoked after this run</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a <a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/thread/shared_future.html">std::shared_future</a> to access the execution status of the framework </dd></dl>
</div>
</div>
<a id="abe9f7964777c2d65052b2dda7307efb6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe9f7964777c2d65052b2dda7307efb6">◆ </a></span>run_n() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<template< typename... > typename E> </div>
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/thread/shared_future.html">std::shared_future</a>< void > <a class="el" href="classtf_1_1BasicTaskflow.html">tf::BasicTaskflow</a>< E >::run_n </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classtf_1_1Framework.html">Framework</a> & </td>
<td class="paramname"><em>framework</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>N</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>runs the framework for N times </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">framework</td><td>a <a class="el" href="classtf_1_1Framework.html" title="A reusable task dependency graph. ">tf::Framework</a> object </td></tr>
<tr><td class="paramname">N</td><td>number of runs</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a <a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/thread/shared_future.html">std::shared_future</a> to access the execution status of the framework </dd></dl>
</div>
</div>
<a id="a006f2d8acf994a9c6e721b1bcc007b17"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a006f2d8acf994a9c6e721b1bcc007b17">◆ </a></span>run_n() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<template< typename... > typename E> </div>
<div class="memtemplate">
template<typename C > </div>
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/thread/shared_future.html">std::shared_future</a>< void > <a class="el" href="classtf_1_1BasicTaskflow.html">tf::BasicTaskflow</a>< E >::run_n </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classtf_1_1Framework.html">Framework</a> & </td>
<td class="paramname"><em>framework</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>N</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">C && </td>
<td class="paramname"><em>callable</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>runs the framework for N times and invokes a callback upon completion </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">framework</td><td>a <a class="el" href="classtf_1_1Framework.html" title="A reusable task dependency graph. ">tf::Framework</a> </td></tr>
<tr><td class="paramname">N</td><td>number of runs </td></tr>
<tr><td class="paramname">callable</td><td>a callable object to be invoked after this run</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a <a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/thread/shared_future.html">std::shared_future</a> to access the execution status of the framework </dd></dl>
</div>
</div>
<a id="a3a24f26ead77969d133d72372df456e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a24f26ead77969d133d72372df456e0">◆ </a></span>run_until() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<template< typename... > typename E> </div>
<div class="memtemplate">
template<typename P > </div>
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/thread/shared_future.html">std::shared_future</a>< void > <a class="el" href="classtf_1_1BasicTaskflow.html">tf::BasicTaskflow</a>< E >::run_until </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classtf_1_1Framework.html">Framework</a> & </td>
<td class="paramname"><em>framework</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">P && </td>
<td class="paramname"><em>predicate</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>runs the framework multiple times until the predicate becomes true and invoke a callback </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">framework</td><td>a <a class="el" href="classtf_1_1Framework.html" title="A reusable task dependency graph. ">tf::Framework</a> </td></tr>
<tr><td class="paramname">predicate</td><td>a boolean predicate to return true for stop</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a <a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/thread/shared_future.html">std::shared_future</a> to access the execution status of the framework </dd></dl>
</div>
</div>
<a id="aaa4618b734a976a39ca1cc47a8e44c4e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa4618b734a976a39ca1cc47a8e44c4e">◆ </a></span>run_until() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<template< typename... > typename E> </div>
<div class="memtemplate">
template<typename P , typename C > </div>
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/thread/shared_future.html">std::shared_future</a>< void > <a class="el" href="classtf_1_1BasicTaskflow.html">tf::BasicTaskflow</a>< E >::run_until </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classtf_1_1Framework.html">Framework</a> & </td>
<td class="paramname"><em>framework</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">P && </td>
<td class="paramname"><em>predicate</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">C && </td>
<td class="paramname"><em>callable</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>runs the framework multiple times until the predicate becomes true and invoke a callback </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">framework</td><td>a <a class="el" href="classtf_1_1Framework.html" title="A reusable task dependency graph. ">tf::Framework</a> </td></tr>
<tr><td class="paramname">predicate</td><td>a boolean predicate to return true for stop </td></tr>
<tr><td class="paramname">callable</td><td>a callable object to be invoked after this run</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a <a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/thread/shared_future.html">std::shared_future</a> to access the execution status of the framework </dd></dl>
</div>
</div>
<a id="abe76e5288016861aaf1dafc0218d3084"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe76e5288016861aaf1dafc0218d3084">◆ </a></span>share_executor()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<template< typename... > typename E> </div>
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< typename <a class="el" href="classtf_1_1BasicTaskflow.html">BasicTaskflow</a>< E >::<a class="el" href="classtf_1_1BasicTaskflow.html#afa5ea834928f68f950f59889c626c2ff">Executor</a> > <a class="el" href="classtf_1_1BasicTaskflow.html">tf::BasicTaskflow</a>< E >::share_executor </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>shares ownership of the executor associated with this taskflow object </p>
<dl class="section return"><dt>Returns</dt><dd>a <a class="elRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/docs/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a> of the executor </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="basic__taskflow_8hpp_source.html">basic_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_1BasicTaskflow.html">BasicTaskflow</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>
You can’t perform that action at this time.