Skip to content

Commit e8bfdd0

Browse files
clin99clin99
committed
Fix error in cookbook
1 parent 90828db commit e8bfdd0

259 files changed

Lines changed: 2460 additions & 1199 deletions

File tree

Some content is hidden

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

‎docs/Cookbook.html‎

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<head>
55
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
66
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
7-
<meta name="generator" content="Doxygen 1.8.13"/>
7+
<meta name="generator" content="Doxygen 1.8.16"/>
88
<meta name="viewport" content="width=device-width, initial-scale=1"/>
99
<title>Cpp-Taskflow</title>
1010
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -16,13 +16,16 @@
1616
<script type="text/javascript" src="navtreedata.js"></script>
1717
<script type="text/javascript" src="navtree.js"></script>
1818
<script type="text/javascript">
19+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
1920
$(document).ready(initResizable);
20-
</script>
21+
/* @license-end */</script>
2122
<link href="search/search.css" rel="stylesheet" type="text/css"/>
2223
<script type="text/javascript" src="search/searchdata.js"></script>
2324
<script type="text/javascript" src="search/search.js"></script>
2425
<script type="text/javascript">
26+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2527
$(document).ready(function() { init_search(); });
28+
/* @license-end */
2629
</script>
2730
<link href="doxygen.css" rel="stylesheet" type="text/css" />
2831
</head>
@@ -57,9 +60,11 @@
5760
</table>
5861
</div>
5962
<!-- end header part -->
60-
<!-- Generated by Doxygen 1.8.13 -->
63+
<!-- Generated by Doxygen 1.8.16 -->
6164
<script type="text/javascript">
65+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
6266
var searchBox = new SearchBox("searchBox", "search",false,'Search');
67+
/* @license-end */
6368
</script>
6469
</div><!-- top -->
6570
<div id="side-nav" class="ui-resizable side-nav-resizable">
@@ -73,7 +78,9 @@
7378
</div>
7479
</div>
7580
<script type="text/javascript">
81+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
7682
$(document).ready(function(){initNavTree('Cookbook.html','');});
83+
/* @license-end */
7784
</script>
7885
<div id="doc-content">
7986
<!-- window showing the filter options -->
@@ -90,7 +97,7 @@
9097
</iframe>
9198
</div>
9299

93-
<div class="header">
100+
<div class="PageDoc"><div class="header">
94101
<div class="headertitle">
95102
<div class="title">Cookbook </div> </div>
96103
</div><!--header-->
@@ -105,14 +112,15 @@
105112
<a class="el" href="chapter6.html">C6: Manage Threads and Executor</a> <br />
106113
<a class="el" href="chapter7.html">C7: Framework (Experimental)</a> <br />
107114
</p>
108-
</div></div><!-- contents -->
115+
</div></div><!-- PageDoc -->
116+
</div><!-- contents -->
109117
</div><!-- doc-content -->
110118
<!-- start footer part -->
111119
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
112120
<ul>
113121
<li class="footer">Generated by
114122
<a href="http://www.doxygen.org/index.html">
115-
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
123+
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.16 </li>
116124
</ul>
117125
</div>
118126
</body>

‎docs/Cookbook.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ var Cookbook =
33
[ "C0: Project Motivation", "chapter0.html", [
44
[ "The Era of Multicore", "chapter0.html#TheEraOfMulticore", null ],
55
[ "Loop-level Parallelism", "chapter0.html#LoopLevelParallelism", null ],
6-
[ "TaskBasedParallelism Task-based Parallelism", "chapter0.html#html", null ],
6+
[ "Task-based Parallelism", "chapter0.html#TaskBasedParallelism", null ],
77
[ "Challenges of Task-based Parallel Programming", "chapter0.html#ChallengesOfTaskBasedParallelProgramming", null ],
88
[ "The Project Mantra", "chapter0.html#TheProjectMantra", null ]
99
] ],

‎docs/FAQ.html‎

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<head>
55
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
66
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
7-
<meta name="generator" content="Doxygen 1.8.13"/>
7+
<meta name="generator" content="Doxygen 1.8.16"/>
88
<meta name="viewport" content="width=device-width, initial-scale=1"/>
99
<title>Cpp-Taskflow</title>
1010
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -16,13 +16,16 @@
1616
<script type="text/javascript" src="navtreedata.js"></script>
1717
<script type="text/javascript" src="navtree.js"></script>
1818
<script type="text/javascript">
19+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
1920
$(document).ready(initResizable);
20-
</script>
21+
/* @license-end */</script>
2122
<link href="search/search.css" rel="stylesheet" type="text/css"/>
2223
<script type="text/javascript" src="search/searchdata.js"></script>
2324
<script type="text/javascript" src="search/search.js"></script>
2425
<script type="text/javascript">
26+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2527
$(document).ready(function() { init_search(); });
28+
/* @license-end */
2629
</script>
2730
<link href="doxygen.css" rel="stylesheet" type="text/css" />
2831
</head>
@@ -57,9 +60,11 @@
5760
</table>
5861
</div>
5962
<!-- end header part -->
60-
<!-- Generated by Doxygen 1.8.13 -->
63+
<!-- Generated by Doxygen 1.8.16 -->
6164
<script type="text/javascript">
65+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
6266
var searchBox = new SearchBox("searchBox", "search",false,'Search');
67+
/* @license-end */
6368
</script>
6469
</div><!-- top -->
6570
<div id="side-nav" class="ui-resizable side-nav-resizable">
@@ -73,7 +78,9 @@
7378
</div>
7479
</div>
7580
<script type="text/javascript">
81+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
7682
$(document).ready(function(){initNavTree('FAQ.html','');});
83+
/* @license-end */
7784
</script>
7885
<div id="doc-content">
7986
<!-- window showing the filter options -->
@@ -90,7 +97,7 @@
9097
</iframe>
9198
</div>
9299

93-
<div class="header">
100+
<div class="PageDoc"><div class="header">
94101
<div class="headertitle">
95102
<div class="title">Frequently Asked Questions </div> </div>
96103
</div><!--header-->
@@ -112,13 +119,14 @@ <h2><a class="anchor" id="GeneralQuestion4"></a>
112119
<p>Benchmarks showed Cpp-Taskflow can efficiently handle millions or billions of tasks (both large and small tasks) on a machine with up to 64 CPUs.</p>
113120
<h2><a class="anchor" id="GeneralQuestion5"></a>
114121
Q5: What is the weird hex value, like 0x7fc39d402ab0, in the dumped graph?</h2>
115-
<p>The hex value represents the memory address of the task. Each task has a method <a class="el" href="classtf_1_1Task.html#a9057ecd0f3833b717480e914f8568f02" title="assigns a name to the task ">tf::Task::name(const std::string&amp;)</a> for user to assign a human readable string to ease the debugging process. If a task is not assigned a name or is an internal node, its address value in the memory is used instead.</p>
122+
<p>The hex value represents the memory address of the task. Each task has a method <a class="el" href="classtf_1_1Task.html#a9057ecd0f3833b717480e914f8568f02" title="assigns a name to the task">tf::Task::name(const std::string&amp;)</a> for user to assign a human readable string to ease the debugging process. If a task is not assigned a name or is an internal node, its address value in the memory is used instead.</p>
116123
<h2><a class="anchor" id="GeneralQuestion6"></a>
117124
Q6: Does Cpp-Taskflow have backward compatibility with C++03/11/14?</h2>
118125
<p>Unfortunately, Cpp-Taskflow is heavily relying on modern C++17's features/idoms/STL and it is very difficult to provide a version that compiles under older C++ versions.</p>
119126
<h2><a class="anchor" id="GeneralQuestion7"></a>
120127
Q7: How does Cpp-Taskflow schedule tasks?</h2>
121-
<p>Cpp-Taskflow has implemented different scheduler modules (centralized queue, proactive shceduler, speculative strategy, and work stealing). The default scheduler implements the famous <a href="https://en.wikipedia.org/wiki/Work_stealing">work stealing algorithm</a> that has shown to behave efficiently in most multicore architectures. You can find the source code at <code>taskflow/threadpool/workstealing_threadpool.hpp</code> </p><hr/>
128+
<p>Cpp-Taskflow has implemented different scheduler modules (centralized queue, proactive shceduler, speculative strategy, and work stealing). The default scheduler implements the famous <a href="https://en.wikipedia.org/wiki/Work_stealing">work stealing algorithm</a> that has shown to behave efficiently in most multicore architectures. You can find the source code at <code>taskflow/threadpool/workstealing_threadpool.hpp</code> </p>
129+
<hr/>
122130
<h1><a class="anchor" id="ProgrammingQuestions"></a>
123131
Programming Questions</h1>
124132
<h2><a class="anchor" id="ProgrammingQuestions1"></a>
@@ -133,21 +141,22 @@ <h2><a class="anchor" id="ProgrammingQuestions3"></a>
133141
<p>No, the taskflow object is not thread-safe. You can't create tasks from multiple threads at the same time.</p>
134142
<h2><a class="anchor" id="ProgrammingQuestions4"></a>
135143
Q4: My program hangs and never returns after dispatching a taskflow graph. What's wrong?</h2>
136-
<p>When the program hangs forever it is very likely your taskflow graph has a cycle. Try the <a class="el" href="classtf_1_1BasicTaskflow.html#adac448e1cc44307856b3116d7ed5490f" title="dumps the present task dependency graph to a std::ostream in DOT format ">tf::Taskflow::dump</a> method to debug the graph before dispatching your taskflow graph.</p>
144+
<p>When the program hangs forever it is very likely your taskflow graph has a cycle. Try the <a class="el" href="classtf_1_1BasicTaskflow.html#adac448e1cc44307856b3116d7ed5490f" title="dumps the present task dependency graph to a std::ostream in DOT format">tf::Taskflow::dump</a> method to debug the graph before dispatching your taskflow graph.</p>
137145
<h2><a class="anchor" id="ProgrammingQuestions5"></a>
138146
Q5: In the following example where B spawns a joined subflow of two tasks B1 and B2, do they run concurrently with task A?</h2>
139147
<div class="image">
140-
<img src="dynamic_graph.png" alt="dynamic_graph.png" width="60%"/>
148+
<img src="dynamic_graph.png" alt="" width="60%"/>
141149
</div>
142150
<p>No. The subflow is spawned during the execution of B, and at this point A must finish because A precedes B. This gives rise to the fact B1 and B2 must run after A. This graph may looks strange because B seems to run twice! However, Cpp-Taskflow will schedule B only once to create its subflow. Whether this subflow joins or detaches from B only affects the future object returned from B. </p>
143-
</div></div><!-- contents -->
151+
</div></div><!-- PageDoc -->
152+
</div><!-- contents -->
144153
</div><!-- doc-content -->
145154
<!-- start footer part -->
146155
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
147156
<ul>
148157
<li class="footer">Generated by
149158
<a href="http://www.doxygen.org/index.html">
150-
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
159+
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.16 </li>
151160
</ul>
152161
</div>
153162
</body>

‎docs/Reference.html‎

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<head>
55
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
66
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
7-
<meta name="generator" content="Doxygen 1.8.13"/>
7+
<meta name="generator" content="Doxygen 1.8.16"/>
88
<meta name="viewport" content="width=device-width, initial-scale=1"/>
99
<title>Cpp-Taskflow</title>
1010
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -16,13 +16,16 @@
1616
<script type="text/javascript" src="navtreedata.js"></script>
1717
<script type="text/javascript" src="navtree.js"></script>
1818
<script type="text/javascript">
19+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
1920
$(document).ready(initResizable);
20-
</script>
21+
/* @license-end */</script>
2122
<link href="search/search.css" rel="stylesheet" type="text/css"/>
2223
<script type="text/javascript" src="search/searchdata.js"></script>
2324
<script type="text/javascript" src="search/search.js"></script>
2425
<script type="text/javascript">
26+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2527
$(document).ready(function() { init_search(); });
28+
/* @license-end */
2629
</script>
2730
<link href="doxygen.css" rel="stylesheet" type="text/css" />
2831
</head>
@@ -57,9 +60,11 @@
5760
</table>
5861
</div>
5962
<!-- end header part -->
60-
<!-- Generated by Doxygen 1.8.13 -->
63+
<!-- Generated by Doxygen 1.8.16 -->
6164
<script type="text/javascript">
65+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
6266
var searchBox = new SearchBox("searchBox", "search",false,'Search');
67+
/* @license-end */
6368
</script>
6469
</div><!-- top -->
6570
<div id="side-nav" class="ui-resizable side-nav-resizable">
@@ -73,7 +78,9 @@
7378
</div>
7479
</div>
7580
<script type="text/javascript">
81+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
7682
$(document).ready(function(){initNavTree('Reference.html','');});
83+
/* @license-end */
7784
</script>
7885
<div id="doc-content">
7986
<!-- window showing the filter options -->
@@ -90,7 +97,7 @@
9097
</iframe>
9198
</div>
9299

93-
<div class="header">
100+
<div class="PageDoc"><div class="header">
94101
<div class="headertitle">
95102
<div class="title">Reference </div> </div>
96103
</div><!--header-->
@@ -104,14 +111,15 @@ <h1><a class="anchor" id="RefConference"></a>
104111
</ol>
105112
<h1><a class="anchor" id="RefJournal"></a>
106113
Journal</h1>
107-
</div></div><!-- contents -->
114+
</div></div><!-- PageDoc -->
115+
</div><!-- contents -->
108116
</div><!-- doc-content -->
109117
<!-- start footer part -->
110118
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
111119
<ul>
112120
<li class="footer">Generated by
113121
<a href="http://www.doxygen.org/index.html">
114-
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
122+
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.16 </li>
115123
</ul>
116124
</div>
117125
</body>

‎docs/Releases.html‎

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<head>
55
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
66
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
7-
<meta name="generator" content="Doxygen 1.8.13"/>
7+
<meta name="generator" content="Doxygen 1.8.16"/>
88
<meta name="viewport" content="width=device-width, initial-scale=1"/>
99
<title>Cpp-Taskflow</title>
1010
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -16,13 +16,16 @@
1616
<script type="text/javascript" src="navtreedata.js"></script>
1717
<script type="text/javascript" src="navtree.js"></script>
1818
<script type="text/javascript">
19+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
1920
$(document).ready(initResizable);
20-
</script>
21+
/* @license-end */</script>
2122
<link href="search/search.css" rel="stylesheet" type="text/css"/>
2223
<script type="text/javascript" src="search/searchdata.js"></script>
2324
<script type="text/javascript" src="search/search.js"></script>
2425
<script type="text/javascript">
26+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2527
$(document).ready(function() { init_search(); });
28+
/* @license-end */
2629
</script>
2730
<link href="doxygen.css" rel="stylesheet" type="text/css" />
2831
</head>
@@ -57,9 +60,11 @@
5760
</table>
5861
</div>
5962
<!-- end header part -->
60-
<!-- Generated by Doxygen 1.8.13 -->
63+
<!-- Generated by Doxygen 1.8.16 -->
6164
<script type="text/javascript">
65+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
6266
var searchBox = new SearchBox("searchBox", "search",false,'Search');
67+
/* @license-end */
6368
</script>
6469
</div><!-- top -->
6570
<div id="side-nav" class="ui-resizable side-nav-resizable">
@@ -73,7 +78,9 @@
7378
</div>
7479
</div>
7580
<script type="text/javascript">
81+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
7682
$(document).ready(function(){initNavTree('Releases.html','');});
83+
/* @license-end */
7784
</script>
7885
<div id="doc-content">
7986
<!-- window showing the filter options -->
@@ -90,7 +97,7 @@
9097
</iframe>
9198
</div>
9299

93-
<div class="header">
100+
<div class="PageDoc"><div class="header">
94101
<div class="headertitle">
95102
<div class="title">Releases </div> </div>
96103
</div><!--header-->
@@ -100,14 +107,15 @@
100107
<a class="el" href="release-2-1-0.html">Release 2.1.0 (2019/02/15)</a> <br />
101108
<a class="el" href="release-2-0-0.html">Release 2.0.0 (2018/08/28)</a> <br />
102109
</p>
103-
</div></div><!-- contents -->
110+
</div></div><!-- PageDoc -->
111+
</div><!-- contents -->
104112
</div><!-- doc-content -->
105113
<!-- start footer part -->
106114
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
107115
<ul>
108116
<li class="footer">Generated by
109117
<a href="http://www.doxygen.org/index.html">
110-
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
118+
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.16 </li>
111119
</ul>
112120
</div>
113121
</body>

0 commit comments

Comments
 (0)