forked from taskflow/taskflow
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathclasstf_1_1TaskQueue.html
More file actions
284 lines (267 loc) · 14.5 KB
/
classtf_1_1TaskQueue.html
File metadata and controls
284 lines (267 loc) · 14.5 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
<!-- 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.3.1</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_1TaskQueue.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-methods">Public Member Functions</a> |
<a href="classtf_1_1TaskQueue-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">tf::TaskQueue< T > Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Lock-free unbounded single-producer multiple-consumer queue.
<a href="classtf_1_1TaskQueue.html#details">More...</a></p>
<p><code>#include <<a class="el" href="tsq_8hpp_source.html">tsq.hpp</a>></code></p>
<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:aa8a6ebf97af5a701c6f1ef9def9541e2"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1TaskQueue.html#aa8a6ebf97af5a701c6f1ef9def9541e2">TaskQueue</a> (int64_t <a class="el" href="classtf_1_1TaskQueue.html#a38570912add100d4db04428c9ac234ea">capacity</a>=1024)</td></tr>
<tr class="memdesc:aa8a6ebf97af5a701c6f1ef9def9541e2"><td class="mdescLeft"> </td><td class="mdescRight">constructs the queue with a given capacity <a href="#aa8a6ebf97af5a701c6f1ef9def9541e2">More...</a><br /></td></tr>
<tr class="separator:aa8a6ebf97af5a701c6f1ef9def9541e2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6b1b54083f0e4e62c888b155690f1062"><td class="memItemLeft" align="right" valign="top"><a id="a6b1b54083f0e4e62c888b155690f1062"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1TaskQueue.html#a6b1b54083f0e4e62c888b155690f1062">~TaskQueue</a> ()</td></tr>
<tr class="memdesc:a6b1b54083f0e4e62c888b155690f1062"><td class="mdescLeft"> </td><td class="mdescRight">destructs the queue <br /></td></tr>
<tr class="separator:a6b1b54083f0e4e62c888b155690f1062"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aae8fbace765cc27b104eba6c8e1fa09e"><td class="memItemLeft" align="right" valign="top"><a id="aae8fbace765cc27b104eba6c8e1fa09e"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1TaskQueue.html#aae8fbace765cc27b104eba6c8e1fa09e">empty</a> () const noexcept</td></tr>
<tr class="memdesc:aae8fbace765cc27b104eba6c8e1fa09e"><td class="mdescLeft"> </td><td class="mdescRight">queries if the queue is empty at the time of this call <br /></td></tr>
<tr class="separator:aae8fbace765cc27b104eba6c8e1fa09e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa5cbc35f3df79a4f14985bb8790c6d94"><td class="memItemLeft" align="right" valign="top"><a id="aa5cbc35f3df79a4f14985bb8790c6d94"></a>
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1TaskQueue.html#aa5cbc35f3df79a4f14985bb8790c6d94">size</a> () const noexcept</td></tr>
<tr class="memdesc:aa5cbc35f3df79a4f14985bb8790c6d94"><td class="mdescLeft"> </td><td class="mdescRight">queries the number of items at the time of this call <br /></td></tr>
<tr class="separator:aa5cbc35f3df79a4f14985bb8790c6d94"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a38570912add100d4db04428c9ac234ea"><td class="memItemLeft" align="right" valign="top"><a id="a38570912add100d4db04428c9ac234ea"></a>
int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1TaskQueue.html#a38570912add100d4db04428c9ac234ea">capacity</a> () const noexcept</td></tr>
<tr class="memdesc:a38570912add100d4db04428c9ac234ea"><td class="mdescLeft"> </td><td class="mdescRight">queries the capacity of the queue <br /></td></tr>
<tr class="separator:a38570912add100d4db04428c9ac234ea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1c4398713ae2ce1817978c7a7395dd8a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1TaskQueue.html#a1c4398713ae2ce1817978c7a7395dd8a">push</a> (T item)</td></tr>
<tr class="memdesc:a1c4398713ae2ce1817978c7a7395dd8a"><td class="mdescLeft"> </td><td class="mdescRight">inserts an item to the queue <a href="#a1c4398713ae2ce1817978c7a7395dd8a">More...</a><br /></td></tr>
<tr class="separator:a1c4398713ae2ce1817978c7a7395dd8a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a71ed7cd132bb4d948adfe06dc49b32d3"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1TaskQueue.html#a71ed7cd132bb4d948adfe06dc49b32d3">pop</a> ()</td></tr>
<tr class="memdesc:a71ed7cd132bb4d948adfe06dc49b32d3"><td class="mdescLeft"> </td><td class="mdescRight">pops out an item from the queue <a href="#a71ed7cd132bb4d948adfe06dc49b32d3">More...</a><br /></td></tr>
<tr class="separator:a71ed7cd132bb4d948adfe06dc49b32d3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:accf64f0fbab5014a928d16eb3774d0d3"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1TaskQueue.html#accf64f0fbab5014a928d16eb3774d0d3">steal</a> ()</td></tr>
<tr class="memdesc:accf64f0fbab5014a928d16eb3774d0d3"><td class="mdescLeft"> </td><td class="mdescRight">steals an item from the queue <a href="#accf64f0fbab5014a928d16eb3774d0d3">More...</a><br /></td></tr>
<tr class="separator:accf64f0fbab5014a928d16eb3774d0d3"><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<typename T><br />
class tf::TaskQueue< T ></h3>
<p>Lock-free unbounded single-producer multiple-consumer queue. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>data type (must be a pointer)</td></tr>
</table>
</dd>
</dl>
<p>This class implements the work stealing queue described in the paper, "Correct and Efficient Work-Stealing for Weak Memory Models," available at <a href="https://www.di.ens.fr/~zappa/readings/ppopp13.pdf">https://www.di.ens.fr/~zappa/readings/ppopp13.pdf</a>.</p>
<p>Only the queue owner can perform pop and push operations, while others can steal data from the queue. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="aa8a6ebf97af5a701c6f1ef9def9541e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8a6ebf97af5a701c6f1ef9def9541e2">◆ </a></span>TaskQueue()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classtf_1_1TaskQueue.html">tf::TaskQueue</a>< T >::<a class="el" href="classtf_1_1TaskQueue.html">TaskQueue</a> </td>
<td>(</td>
<td class="paramtype">int64_t </td>
<td class="paramname"><em>capacity</em> = <code>1024</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>constructs the queue with a given capacity </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">capacity</td><td>the capacity of the queue (must be power of 2) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a71ed7cd132bb4d948adfe06dc49b32d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a71ed7cd132bb4d948adfe06dc49b32d3">◆ </a></span>pop()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname">T <a class="el" href="classtf_1_1TaskQueue.html">tf::TaskQueue</a>< T >::pop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>pops out an item from the queue </p>
<p>Only the owner thread can pop out an item from the queue. The return can be a nullptr if this operation failed (empty queue). </p>
</div>
</div>
<a id="a1c4398713ae2ce1817978c7a7395dd8a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c4398713ae2ce1817978c7a7395dd8a">◆ </a></span>push()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classtf_1_1TaskQueue.html">tf::TaskQueue</a>< T >::push </td>
<td>(</td>
<td class="paramtype">T </td>
<td class="paramname"><em>item</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>inserts an item to the queue </p>
<p>Only the owner thread can insert an item to the queue. The operation can trigger the queue to resize its capacity if more space is required.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">O</td><td>data type</td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">item</td><td>the item to perfect-forward to the queue </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="accf64f0fbab5014a928d16eb3774d0d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#accf64f0fbab5014a928d16eb3774d0d3">◆ </a></span>steal()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname">T <a class="el" href="classtf_1_1TaskQueue.html">tf::TaskQueue</a>< T >::steal </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>steals an item from the queue </p>
<p>Any threads can try to steal an item from the queue. The return can be a nullptr if this operation failed (not necessary empty). </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="tsq_8hpp_source.html">tsq.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_1TaskQueue.html">TaskQueue</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>