cpp-taskflow/docs/classtf_1_1WorkStealingQueue.html at dev · cppwanderboy/cpp-taskflow · GitHub

History

287 lines (270 loc) · 15.3 KB

Raw

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

285

286

287

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>Cpp-Taskflow</title>

$(document).ready(initResizable);

</script>

$(document).ready(function() { init_search(); });

</script>

</head>

<body>

<tbody>

<div id="projectname"><a href="https://github.com/cpp-taskflow/cpp-taskflow">Cpp-Taskflow</a>

</div>

</td>

<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">

</span>

</div>

</td>

</tr>

</tbody>

</table>

</div>

var searchBox = new SearchBox("searchBox", "search",false,'Search');

</script>

</div>

</div>

<div id="splitbar" style="-moz-user-select:none;"

class="ui-resizable-handle">

</div>

$(document).ready(function(){initNavTree('classtf_1_1WorkStealingQueue.html','');});

</script>

<div id="MSearchSelectWindow"

onmouseover="return searchBox.OnSearchSelectShow()"

onmouseout="return searchBox.OnSearchSelectHide()"

onkeydown="return searchBox.OnSearchSelectKey(event)">

</div>

name="MSearchResults" id="MSearchResults">

</iframe>

</div>

<a href="#nested-classes">Classes</a> |

<a href="#pub-methods">Public Member Functions</a> |

<a href="classtf_1_1WorkStealingQueue-members.html">List of all members</a> </div>

<div class="title">tf::WorkStealingQueue< T > Class Template Reference</div> </div>

</div>

<p>Lock-free unbounded single-producer multiple-consumer queue.

<p><code>#include <<a class="el" href="spmc__queue_8hpp_source.html">spmc_queue.hpp</a>></code></p>

Public Member Functions</h2></td></tr>

<tr class="memitem:a0c790ba6a203092fa8f15297dcb5b1d6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1WorkStealingQueue.html#a0c790ba6a203092fa8f15297dcb5b1d6">WorkStealingQueue</a> (int64_t <a class="el" href="classtf_1_1WorkStealingQueue.html#aa24605d46953ae1d27dd35451c72c9b3">capacity</a>=1024)</td></tr>

<tr class="memdesc:a0c790ba6a203092fa8f15297dcb5b1d6"><td class="mdescLeft"> </td><td class="mdescRight">constructs the queue with a given capacity <a href="#a0c790ba6a203092fa8f15297dcb5b1d6">More...</a><br /></td></tr>

 </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1WorkStealingQueue.html#acb22a49430fd235aa2ae4770d1cd662b">~WorkStealingQueue</a> ()</td></tr>

<tr class="memdesc:acb22a49430fd235aa2ae4770d1cd662b"><td class="mdescLeft"> </td><td class="mdescRight">destructs the queue <br /></td></tr>

bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1WorkStealingQueue.html#adc85682657a3cd6c0fe87a71d350036c">empty</a> () const noexcept</td></tr>

<tr class="memdesc:adc85682657a3cd6c0fe87a71d350036c"><td class="mdescLeft"> </td><td class="mdescRight">queries if the queue is empty at the time of this call <br /></td></tr>

size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1WorkStealingQueue.html#ab5fe261361a29226f52e6a5eb6351d38">size</a> () const noexcept</td></tr>

<tr class="memdesc:ab5fe261361a29226f52e6a5eb6351d38"><td class="mdescLeft"> </td><td class="mdescRight">queries the number of items at the time of this call <br /></td></tr>

int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1WorkStealingQueue.html#aa24605d46953ae1d27dd35451c72c9b3">capacity</a> () const noexcept</td></tr>

<tr class="memdesc:aa24605d46953ae1d27dd35451c72c9b3"><td class="mdescLeft"> </td><td class="mdescRight">queries the capacity of the queue <br /></td></tr>

<tr class="memitem:aa54d323bb06b310e133820b60b3379fb"><td class="memTemplParams" colspan="2">template<typename O > </td></tr>

<tr class="memdesc:aa54d323bb06b310e133820b60b3379fb"><td class="mdescLeft"> </td><td class="mdescRight">inserts an item to the queue <a href="#aa54d323bb06b310e133820b60b3379fb">More...</a><br /></td></tr>

<tr class="memitem:a1ba75ce446b149de97e62310851a243d"><td class="memItemLeft" align="right" valign="top">std::optional< T > </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1WorkStealingQueue.html#a1ba75ce446b149de97e62310851a243d">pop</a> ()</td></tr>

<tr class="memdesc:a1ba75ce446b149de97e62310851a243d"><td class="mdescLeft"> </td><td class="mdescRight">pops out an item from the queue <a href="#a1ba75ce446b149de97e62310851a243d">More...</a><br /></td></tr>

<tr class="memitem:a6b63dca550a2f576b92f05bdc2e03a74"><td class="memItemLeft" align="right" valign="top">std::optional< T > </td><td class="memItemRight" valign="bottom"><a class="el" href="classtf_1_1WorkStealingQueue.html#a6b63dca550a2f576b92f05bdc2e03a74">steal</a> ()</td></tr>

<tr class="memdesc:a6b63dca550a2f576b92f05bdc2e03a74"><td class="mdescLeft"> </td><td class="mdescRight">steals an item from the queue <a href="#a6b63dca550a2f576b92f05bdc2e03a74">More...</a><br /></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::WorkStealingQueue< T ></h3>

<p>Lock-free unbounded single-producer multiple-consumer queue. </p>

<dl class="tparams"><dt>Template Parameters</dt><dd>

</table>

</dd>

</dl>

<p>This class implements the work stealing queue described in the paper, "Dynamic Circular Work-stealing Deque," SPAA, 2015. Only the queue owner can perform pop and push operations, while others can steal data from the queue.</p>

<p>PPoPP implementation paper "Correct and Efficient Work-Stealing for Weak Memory Models" <a href="https://www.di.ens.fr/~zappa/readings/ppopp13.pdf">https://www.di.ens.fr/~zappa/readings/ppopp13.pdf</a> </p>

</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>

<h2 class="memtitle"><span class="permalink"><a href="#a0c790ba6a203092fa8f15297dcb5b1d6">◆ </a></span>WorkStealingQueue()</h2>

template<typename T > </div>

<tr>

<tr>

<td class="memname"><a class="el" href="classtf_1_1WorkStealingQueue.html">tf::WorkStealingQueue</a>< T >::<a class="el" href="classtf_1_1WorkStealingQueue.html">WorkStealingQueue</a> </td>

<td class="paramname"><em>capacity</em> = <code>1024</code></td><td>)</td>

</tr>

</table>

</td>

<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>

<tr><td class="paramname">capacity</td><td>the capacity of the queue (must be power of 2) </td></tr>

</table>

</dd>

</dl>

</div>

<h2 class="groupheader">Member Function Documentation</h2>

template<typename T > </div>

<tr>

<td class="memname">std::optional< T > <a class="el" href="classtf_1_1WorkStealingQueue.html">tf::WorkStealingQueue</a>< T >::pop </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 <a href="https://en.cppreference.com/w/cpp/utility/optional/nullopt">std::nullopt</a> if this operation failed (empty queue). </p>

</div>

template<typename T > </div>

template<typename O > </div>

<tr>

<td class="memname">void <a class="el" href="classtf_1_1WorkStealingQueue.html">tf::WorkStealingQueue</a>< T >::push </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>

</dd>

</dl>

<dl class="params"><dt>Parameters</dt><dd>

<tr><td class="paramname">item</td><td>the item to perfect-forward to the queue </td></tr>

</table>

</dd>

</dl>

</div>

<h2 class="memtitle"><span class="permalink"><a href="#a6b63dca550a2f576b92f05bdc2e03a74">◆ </a></span>steal()</h2>

template<typename T > </div>

<tr>

<td class="memname">std::optional< T > <a class="el" href="classtf_1_1WorkStealingQueue.html">tf::WorkStealingQueue</a>< T >::steal </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 <a href="https://en.cppreference.com/w/cpp/utility/optional/nullopt">std::nullopt</a> if this operation failed (not necessary empty). </p>

</div>

<hr/>The documentation for this class was generated from the following file:<ul>

<li><a class="el" href="spmc__queue_8hpp_source.html">spmc_queue.hpp</a></li>

</ul>

</div>

</div>

<ul>

<li class="navelem"><b>tf</b></li><li class="navelem"><a class="el" href="classtf_1_1WorkStealingQueue.html">WorkStealingQueue</a></li>

<li class="footer">Generated by

</ul>

</div>

</body>

</html>

cpp-taskflow/docs/classtf_1_1WorkStealingQueue.html at dev · cppwanderboy/cpp-taskflow · GitHub

Expand file tree

Breadcrumbs

classtf_1_1WorkStealingQueue.html

Latest commit

History

Breadcrumbs

classtf_1_1WorkStealingQueue.html

File metadata and controls