Skip to content

Commit 86f287a

Browse files
twhuang-utahtwhuang-utah
committed
updated README/docs
1 parent b8c0dc0 commit 86f287a

189 files changed

Lines changed: 539 additions & 1429 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.

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -818,7 +818,6 @@ thousands of task nodes and links, there are a few amateur pitfalls and mistakes
818818
+ Having a cycle in a graph may result in running forever
819819
+ Destructing a taskflow while it is running in one execution results in undefined behavior
820820
+ Trying to modify a running task can result in undefined behavior
821-
+ Touching a taskflow or an executor from multiple threads is not safe
822821

823822
Cpp-Taskflow is known to work on Linux distributions, MAC OSX, and Microsoft Visual Studio.
824823
Please [let me know][email me] if you found any issues in a particular platform.
@@ -921,6 +920,7 @@ Cpp-Taskflow is being actively developed and contributed by the following people
921920
- [mrogez-yseop](https://github.com/mrogez-yseop) helped fix the missing comma in outputting the execution timeline JSON from the observer and the composition of an empty taskflow.
922921
- [Sztergbaum Roman](https://github.com/Milerius) replaced the error-prone global setting in cmake with project-specific targets
923922
- [mrogez-yseop](https://github.com/mrogez-yseop) fixed the bug of empty taskflow to block the executor
923+
- [Robin Christ](https://github.com/robinchrist) identified things to fix in the outdated documentation and readme.
924924

925925
Meanwhile, we appreciate the support from many organizations for our development on Cpp-Taskflow.
926926
Please [let me know][email me] if I forgot someone!

‎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 -->
@@ -117,7 +110,7 @@
117110
<ul>
118111
<li class="footer">Generated by
119112
<a href="http://www.doxygen.org/index.html">
120-
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
113+
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
121114
</ul>
122115
</div>
123116
</body>

‎docs/FAQ.html‎

Lines changed: 6 additions & 13 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 -->
@@ -110,7 +103,7 @@ <h2><a class="anchor" id="GeneralQuestion1"></a>
110103
<p>Cpp-Taskflow aims to help C++ developers quickly implement efficient parallel decomposition strategies using task-based approaches.</p>
111104
<h2><a class="anchor" id="GeneralQuestion2"></a>
112105
Q2: How do I use Cpp-Taskflow in my projects?</h2>
113-
<p>Cpp-Taskflow is a header-only library with zero dependencies. The only thing you need is a <a href="https://en.wikipedia.org/wiki/C%2B%2B17">C++17</a> compiler. To use Cpp-Taskflow, simply drop the folder <code>taskflow/</code> to your project and include taskflow.hpp.</p>
106+
<p>Cpp-Taskflow is a header-only library with zero dependencies. The only thing you need is a C++17 compiler. To use Cpp-Taskflow, simply drop the folder <code>taskflow/</code> to your project and include taskflow.hpp.</p>
114107
<h2><a class="anchor" id="GeneralQuestion3"></a>
115108
Q3: What is the difference between static tasking and dynamic tasking?</h2>
116109
<p>Static tasking refers to those tasks created before execution, while dynamic tasking refers to those tasks created during the execution of static tasks or dynamic tasks (nested). Dynamic tasks created by the same task node are grouped together to a subflow.</p>
@@ -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="executor_8hpp_source.html">taskflow/core/executor.hpp</a></code> </p><hr/>
121+
<p>Cpp-Taskflow implemented a very efficient <a href="https://en.wikipedia.org/wiki/Work_stealing">work-stealing scheduler</a> to execute task dependency graphs. You can find the source code at <code><a class="el" href="executor_8hpp_source.html">taskflow/core/executor.hpp</a></code> </p><hr/>
129122
<h1><a class="anchor" id="ProgrammingQuestions"></a>
130123
Programming Questions</h1>
131124
<h2><a class="anchor" id="ProgrammingQuestions1"></a>
@@ -157,7 +150,7 @@ <h2><a class="anchor" id="ProgrammingQuestions6"></a>
157150
<ul>
158151
<li class="footer">Generated by
159152
<a href="http://www.doxygen.org/index.html">
160-
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
153+
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
161154
</ul>
162155
</div>
163156
</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 -->
@@ -115,7 +108,7 @@
115108
<ul>
116109
<li class="footer">Generated by
117110
<a href="http://www.doxygen.org/index.html">
118-
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
111+
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
119112
</ul>
120113
</div>
121114
</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.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 -->
@@ -124,7 +117,7 @@
124117
<ul>
125118
<li class="footer">Generated by
126119
<a href="http://www.doxygen.org/index.html">
127-
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
120+
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
128121
</ul>
129122
</div>
130123
</body>

‎docs/chapter0.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('chapter0.html','');});
83-
/* @license-end */
8477
</script>
8578
<div id="doc-content">
8679
<!-- window showing the filter options -->
@@ -143,7 +136,7 @@ <h1><a class="anchor" id="TheProjectMantra"></a>
143136
<ul>
144137
<li class="footer">Generated by
145138
<a href="http://www.doxygen.org/index.html">
146-
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
139+
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
147140
</ul>
148141
</div>
149142
</body>

0 commit comments

Comments
 (0)