Skip to content

Commit 8f9b1a7

Browse files
tsung-wei-huangtsung-wei-huang
committed
updated docs
1 parent c3e889f commit 8f9b1a7

229 files changed

Lines changed: 1057 additions & 2155 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: 6 additions & 14 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.16"/>
7+
<meta name="generator" content="Doxygen 1.8.13"/>
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,16 +16,13 @@
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 */
2019
$(document).ready(initResizable);
21-
/* @license-end */</script>
20+
</script>
2221
<link href="search/search.css" rel="stylesheet" type="text/css"/>
2322
<script type="text/javascript" src="search/searchdata.js"></script>
2423
<script type="text/javascript" src="search/search.js"></script>
2524
<script type="text/javascript">
26-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2725
$(document).ready(function() { init_search(); });
28-
/* @license-end */
2926
</script>
3027
<link href="doxygen.css" rel="stylesheet" type="text/css" />
3128
</head>
@@ -60,11 +57,9 @@
6057
</table>
6158
</div>
6259
<!-- end header part -->
63-
<!-- Generated by Doxygen 1.8.16 -->
60+
<!-- Generated by Doxygen 1.8.13 -->
6461
<script type="text/javascript">
65-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
6662
var searchBox = new SearchBox("searchBox", "search",false,'Search');
67-
/* @license-end */
6863
</script>
6964
</div><!-- top -->
7065
<div id="side-nav" class="ui-resizable side-nav-resizable">
@@ -78,9 +73,7 @@
7873
</div>
7974
</div>
8075
<script type="text/javascript">
81-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
8276
$(document).ready(function(){initNavTree('Cookbook.html','');});
83-
/* @license-end */
8477
</script>
8578
<div id="doc-content">
8679
<!-- window showing the filter options -->
@@ -97,7 +90,7 @@
9790
</iframe>
9891
</div>
9992

100-
<div class="PageDoc"><div class="header">
93+
<div class="header">
10194
<div class="headertitle">
10295
<div class="title">Cookbook </div> </div>
10396
</div><!--header-->
@@ -112,15 +105,14 @@
112105
<a class="el" href="chapter6.html">C6: Manage Threads and Executor</a> <br />
113106
<a class="el" href="chapter7.html">C7: Framework (Experimental)</a> <br />
114107
</p>
115-
</div></div><!-- PageDoc -->
116-
</div><!-- contents -->
108+
</div></div><!-- contents -->
117109
</div><!-- doc-content -->
118110
<!-- start footer part -->
119111
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
120112
<ul>
121113
<li class="footer">Generated by
122114
<a href="http://www.doxygen.org/index.html">
123-
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.16 </li>
115+
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
124116
</ul>
125117
</div>
126118
</body>

‎docs/FAQ.html‎

Lines changed: 10 additions & 19 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.16"/>
7+
<meta name="generator" content="Doxygen 1.8.13"/>
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,16 +16,13 @@
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 */
2019
$(document).ready(initResizable);
21-
/* @license-end */</script>
20+
</script>
2221
<link href="search/search.css" rel="stylesheet" type="text/css"/>
2322
<script type="text/javascript" src="search/searchdata.js"></script>
2423
<script type="text/javascript" src="search/search.js"></script>
2524
<script type="text/javascript">
26-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2725
$(document).ready(function() { init_search(); });
28-
/* @license-end */
2926
</script>
3027
<link href="doxygen.css" rel="stylesheet" type="text/css" />
3128
</head>
@@ -60,11 +57,9 @@
6057
</table>
6158
</div>
6259
<!-- end header part -->
63-
<!-- Generated by Doxygen 1.8.16 -->
60+
<!-- Generated by Doxygen 1.8.13 -->
6461
<script type="text/javascript">
65-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
6662
var searchBox = new SearchBox("searchBox", "search",false,'Search');
67-
/* @license-end */
6863
</script>
6964
</div><!-- top -->
7065
<div id="side-nav" class="ui-resizable side-nav-resizable">
@@ -78,9 +73,7 @@
7873
</div>
7974
</div>
8075
<script type="text/javascript">
81-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
8276
$(document).ready(function(){initNavTree('FAQ.html','');});
83-
/* @license-end */
8477
</script>
8578
<div id="doc-content">
8679
<!-- window showing the filter options -->
@@ -97,7 +90,7 @@
9790
</iframe>
9891
</div>
9992

100-
<div class="PageDoc"><div class="header">
93+
<div class="header">
10194
<div class="headertitle">
10295
<div class="title">Frequently Asked Questions </div> </div>
10396
</div><!--header-->
@@ -119,14 +112,13 @@ <h2><a class="anchor" id="GeneralQuestion4"></a>
119112
<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>
120113
<h2><a class="anchor" id="GeneralQuestion5"></a>
121114
Q5: What is the weird hex value, like 0x7fc39d402ab0, in the dumped graph?</h2>
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>
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>
123116
<h2><a class="anchor" id="GeneralQuestion6"></a>
124117
Q6: Does Cpp-Taskflow have backward compatibility with C++03/11/14?</h2>
125118
<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>
126119
<h2><a class="anchor" id="GeneralQuestion7"></a>
127120
Q7: How does Cpp-Taskflow schedule tasks?</h2>
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><a class="el" href="workstealing__threadpool_8hpp_source.html">taskflow/threadpool/workstealing_threadpool.hpp</a></code> </p>
129-
<hr/>
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><a class="el" href="workstealing__threadpool_8hpp_source.html">taskflow/threadpool/workstealing_threadpool.hpp</a></code> </p><hr/>
130122
<h1><a class="anchor" id="ProgrammingQuestions"></a>
131123
Programming Questions</h1>
132124
<h2><a class="anchor" id="ProgrammingQuestions1"></a>
@@ -141,22 +133,21 @@ <h2><a class="anchor" id="ProgrammingQuestions3"></a>
141133
<p>No, the taskflow object is not thread-safe. You can't create tasks from multiple threads at the same time.</p>
142134
<h2><a class="anchor" id="ProgrammingQuestions4"></a>
143135
Q4: My program hangs and never returns after dispatching a taskflow graph. What's wrong?</h2>
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>
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>
145137
<h2><a class="anchor" id="ProgrammingQuestions5"></a>
146138
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>
147139
<div class="image">
148-
<img src="dynamic_graph.png" alt="" width="60%"/>
140+
<img src="dynamic_graph.png" alt="dynamic_graph.png" width="60%"/>
149141
</div>
150142
<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>
151-
</div></div><!-- PageDoc -->
152-
</div><!-- contents -->
143+
</div></div><!-- contents -->
153144
</div><!-- doc-content -->
154145
<!-- start footer part -->
155146
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
156147
<ul>
157148
<li class="footer">Generated by
158149
<a href="http://www.doxygen.org/index.html">
159-
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.16 </li>
150+
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
160151
</ul>
161152
</div>
162153
</body>

‎docs/Releases.html‎

Lines changed: 6 additions & 14 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.16"/>
7+
<meta name="generator" content="Doxygen 1.8.13"/>
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,16 +16,13 @@
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 */
2019
$(document).ready(initResizable);
21-
/* @license-end */</script>
20+
</script>
2221
<link href="search/search.css" rel="stylesheet" type="text/css"/>
2322
<script type="text/javascript" src="search/searchdata.js"></script>
2423
<script type="text/javascript" src="search/search.js"></script>
2524
<script type="text/javascript">
26-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2725
$(document).ready(function() { init_search(); });
28-
/* @license-end */
2926
</script>
3027
<link href="doxygen.css" rel="stylesheet" type="text/css" />
3128
</head>
@@ -60,11 +57,9 @@
6057
</table>
6158
</div>
6259
<!-- end header part -->
63-
<!-- Generated by Doxygen 1.8.16 -->
60+
<!-- Generated by Doxygen 1.8.13 -->
6461
<script type="text/javascript">
65-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
6662
var searchBox = new SearchBox("searchBox", "search",false,'Search');
67-
/* @license-end */
6863
</script>
6964
</div><!-- top -->
7065
<div id="side-nav" class="ui-resizable side-nav-resizable">
@@ -78,9 +73,7 @@
7873
</div>
7974
</div>
8075
<script type="text/javascript">
81-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
8276
$(document).ready(function(){initNavTree('Releases.html','');});
83-
/* @license-end */
8477
</script>
8578
<div id="doc-content">
8679
<!-- window showing the filter options -->
@@ -97,7 +90,7 @@
9790
</iframe>
9891
</div>
9992

100-
<div class="PageDoc"><div class="header">
93+
<div class="header">
10194
<div class="headertitle">
10295
<div class="title">Releases </div> </div>
10396
</div><!--header-->
@@ -107,15 +100,14 @@
107100
<a class="el" href="release-2-1-0.html">Release 2.1.0 (2019/02/15)</a> <br />
108101
<a class="el" href="release-2-0-0.html">Release 2.0.0 (2018/08/28)</a> <br />
109102
</p>
110-
</div></div><!-- PageDoc -->
111-
</div><!-- contents -->
103+
</div></div><!-- contents -->
112104
</div><!-- doc-content -->
113105
<!-- start footer part -->
114106
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
115107
<ul>
116108
<li class="footer">Generated by
117109
<a href="http://www.doxygen.org/index.html">
118-
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.16 </li>
110+
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
119111
</ul>
120112
</div>
121113
</body>

‎docs/annotated.html‎

Lines changed: 4 additions & 11 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.16"/>
7+
<meta name="generator" content="Doxygen 1.8.13"/>
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,16 +16,13 @@
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 */
2019
$(document).ready(initResizable);
21-
/* @license-end */</script>
20+
</script>
2221
<link href="search/search.css" rel="stylesheet" type="text/css"/>
2322
<script type="text/javascript" src="search/searchdata.js"></script>
2423
<script type="text/javascript" src="search/search.js"></script>
2524
<script type="text/javascript">
26-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2725
$(document).ready(function() { init_search(); });
28-
/* @license-end */
2926
</script>
3027
<link href="doxygen.css" rel="stylesheet" type="text/css" />
3128
</head>
@@ -60,11 +57,9 @@
6057
</table>
6158
</div>
6259
<!-- end header part -->
63-
<!-- Generated by Doxygen 1.8.16 -->
60+
<!-- Generated by Doxygen 1.8.13 -->
6461
<script type="text/javascript">
65-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
6662
var searchBox = new SearchBox("searchBox", "search",false,'Search');
67-
/* @license-end */
6863
</script>
6964
</div><!-- top -->
7065
<div id="side-nav" class="ui-resizable side-nav-resizable">
@@ -78,9 +73,7 @@
7873
</div>
7974
</div>
8075
<script type="text/javascript">
81-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
8276
$(document).ready(function(){initNavTree('annotated.html','');});
83-
/* @license-end */
8477
</script>
8578
<div id="doc-content">
8679
<!-- window showing the filter options -->
@@ -125,7 +118,7 @@
125118
<ul>
126119
<li class="footer">Generated by
127120
<a href="http://www.doxygen.org/index.html">
128-
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.16 </li>
121+
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
129122
</ul>
130123
</div>
131124
</body>

‎docs/basic__taskflow_8hpp_source.html‎

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

0 commit comments

Comments
 (0)