Skip to content

Commit 3a47271

Browse files
tsung-wei-huangtsung-wei-huang
committed
updated framework composition doc
1 parent 6341b5f commit 3a47271

185 files changed

Lines changed: 613 additions & 1737 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: 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.14"/>
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.14 -->
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 -->
@@ -119,7 +112,7 @@
119112
<ul>
120113
<li class="footer">Generated by
121114
<a href="http://www.doxygen.org/index.html">
122-
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
115+
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
123116
</ul>
124117
</div>
125118
</body>

‎docs/Cookbook.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ var Cookbook =
5656
[ "Visualize a Framework", "chapter7.html#C7_VisualizeAFramework", null ],
5757
[ "Lifetime of a Framework", "chapter7.html#C7_LifeTimeOfAFramework", null ],
5858
[ "Create an Application Framework", "chapter7.html#C7_CreateAppicationFramework", null ],
59-
[ "Framework Decomposition", "chapter7.html#C7_FrameworkDecomposition", null ],
59+
[ "Framework Composition", "chapter7.html#C7_FrameworkComposition", null ],
6060
[ "Caveats", "chapter7.html#C7_Caveats", null ]
6161
] ]
6262
];

‎docs/FAQ.html‎

Lines changed: 5 additions & 12 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.14"/>
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.14 -->
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 -->
@@ -125,7 +118,7 @@ <h2><a class="anchor" id="GeneralQuestion6"></a>
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><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>taskflow/threadpool/workstealing_threadpool.hpp</code> </p><hr/>
129122
<h1><a class="anchor" id="ProgrammingQuestions"></a>
130123
Programming Questions</h1>
131124
<h2><a class="anchor" id="ProgrammingQuestions1"></a>
@@ -154,7 +147,7 @@ <h2><a class="anchor" id="ProgrammingQuestions5"></a>
154147
<ul>
155148
<li class="footer">Generated by
156149
<a href="http://www.doxygen.org/index.html">
157-
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
150+
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
158151
</ul>
159152
</div>
160153
</body>

‎docs/Reference.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.14"/>
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.14 -->
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('Reference.html','');});
83-
/* @license-end */
8477
</script>
8578
<div id="doc-content">
8679
<!-- window showing the filter options -->
@@ -118,7 +111,7 @@ <h1><a class="anchor" id="RefJournal"></a>
118111
<ul>
119112
<li class="footer">Generated by
120113
<a href="http://www.doxygen.org/index.html">
121-
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
114+
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
122115
</ul>
123116
</div>
124117
</body>

‎docs/Releases.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.14"/>
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.14 -->
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 -->
@@ -114,7 +107,7 @@
114107
<ul>
115108
<li class="footer">Generated by
116109
<a href="http://www.doxygen.org/index.html">
117-
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
110+
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
118111
</ul>
119112
</div>
120113
</body>

‎docs/annotated.html‎

Lines changed: 6 additions & 18 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.14"/>
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.14 -->
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 -->
@@ -109,13 +102,8 @@
109102
<tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structtf_1_1Error.html" target="_self">Error</a></td><td class="desc">The error category of taskflow </td></tr>
110103
<tr id="row_0_2_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1FlowBuilder.html" target="_self">FlowBuilder</a></td><td class="desc">Building blocks of a task dependency graph </td></tr>
111104
<tr id="row_0_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1Framework.html" target="_self">Framework</a></td><td class="desc">A reusable task dependency graph </td></tr>
112-
<tr id="row_0_4_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1ProactiveThreadpool.html" target="_self">ProactiveThreadpool</a></td><td class="desc">Executor that implements a centralized task queue with a proactive execution strategy </td></tr>
113-
<tr id="row_0_5_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1SimpleThreadpool.html" target="_self">SimpleThreadpool</a></td><td class="desc">Executor that implements a centralized task queue with a simple execution strategy </td></tr>
114-
<tr id="row_0_6_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1SpeculativeThreadpool.html" target="_self">SpeculativeThreadpool</a></td><td class="desc">Executor that implements a centralized task queue with a speculative execution strategy </td></tr>
115-
<tr id="row_0_7_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1SubflowBuilder.html" target="_self">SubflowBuilder</a></td><td class="desc">The building blocks of dynamic tasking </td></tr>
116-
<tr id="row_0_8_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1Task.html" target="_self">Task</a></td><td class="desc">Handle to modify and access a task </td></tr>
117-
<tr id="row_0_9_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1WorkStealingQueue.html" target="_self">WorkStealingQueue</a></td><td class="desc">Lock-free unbounded single-producer multiple-consumer queue </td></tr>
118-
<tr id="row_0_10_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1WorkStealingThreadpool.html" target="_self">WorkStealingThreadpool</a></td><td class="desc">Executor that implements an efficient work stealing algorithm </td></tr>
105+
<tr id="row_0_4_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1SubflowBuilder.html" target="_self">SubflowBuilder</a></td><td class="desc">The building blocks of dynamic tasking </td></tr>
106+
<tr id="row_0_5_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1Task.html" target="_self">Task</a></td><td class="desc">Handle to modify and access a task </td></tr>
119107
</table>
120108
</div><!-- directory -->
121109
</div><!-- contents -->
@@ -125,7 +113,7 @@
125113
<ul>
126114
<li class="footer">Generated by
127115
<a href="http://www.doxygen.org/index.html">
128-
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
116+
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
129117
</ul>
130118
</div>
131119
</body>

‎docs/annotated_dup.js‎

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,7 @@ var annotated_dup =
55
[ "Error", "structtf_1_1Error.html", "structtf_1_1Error" ],
66
[ "FlowBuilder", "classtf_1_1FlowBuilder.html", "classtf_1_1FlowBuilder" ],
77
[ "Framework", "classtf_1_1Framework.html", "classtf_1_1Framework" ],
8-
[ "ProactiveThreadpool", "classtf_1_1ProactiveThreadpool.html", "classtf_1_1ProactiveThreadpool" ],
9-
[ "SimpleThreadpool", "classtf_1_1SimpleThreadpool.html", "classtf_1_1SimpleThreadpool" ],
10-
[ "SpeculativeThreadpool", "classtf_1_1SpeculativeThreadpool.html", "classtf_1_1SpeculativeThreadpool" ],
118
[ "SubflowBuilder", "classtf_1_1SubflowBuilder.html", "classtf_1_1SubflowBuilder" ],
12-
[ "Task", "classtf_1_1Task.html", "classtf_1_1Task" ],
13-
[ "WorkStealingQueue", "classtf_1_1WorkStealingQueue.html", "classtf_1_1WorkStealingQueue" ],
14-
[ "WorkStealingThreadpool", "classtf_1_1WorkStealingThreadpool.html", "classtf_1_1WorkStealingThreadpool" ]
9+
[ "Task", "classtf_1_1Task.html", "classtf_1_1Task" ]
1510
] ]
1611
];

0 commit comments

Comments
 (0)