<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.15"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>libstdc++: __gnu_parallel::_RestrictedBoundedConcurrentQueue< _Tp > Class Template Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <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"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(document).ready(initResizable); /* @license-end */</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">libstdc++ </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.15 --> </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"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(document).ready(function(){initNavTree('a09600.html','');}); /* @license-end */ </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="a09597.html">List of all members</a> </div> <div class="headertitle"> <div class="title">__gnu_parallel::_RestrictedBoundedConcurrentQueue< _Tp > Class Template Reference</div> </div> </div><!--header--> <div class="contents"> <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:a7070da9f66983a3fa24ae4dc92614c0c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a09600.html#a7070da9f66983a3fa24ae4dc92614c0c">_RestrictedBoundedConcurrentQueue</a> (<a class="el" href="a01572.html#a1cbb61a4863a306daa23823d89f9bef1">_SequenceIndex</a> __max_size)</td></tr> <tr class="separator:a7070da9f66983a3fa24ae4dc92614c0c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0e201d45c998cc913577af578f0b9a16"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a09600.html#a0e201d45c998cc913577af578f0b9a16">~_RestrictedBoundedConcurrentQueue</a> ()</td></tr> <tr class="separator:a0e201d45c998cc913577af578f0b9a16"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aff5854a49d63fcd08aae08eb282361e7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a09600.html#aff5854a49d63fcd08aae08eb282361e7">pop_back</a> (_Tp &__t)</td></tr> <tr class="separator:aff5854a49d63fcd08aae08eb282361e7"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a4b760899cefaccb86586c447b12c4cc3"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a09600.html#a4b760899cefaccb86586c447b12c4cc3">pop_front</a> (_Tp &__t)</td></tr> <tr class="separator:a4b760899cefaccb86586c447b12c4cc3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2ac4fcc26b5a8e8d3db9993ca3b6f777"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a09600.html#a2ac4fcc26b5a8e8d3db9993ca3b6f777">push_front</a> (const _Tp &__t)</td></tr> <tr class="separator:a2ac4fcc26b5a8e8d3db9993ca3b6f777"><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 _Tp><br /> class __gnu_parallel::_RestrictedBoundedConcurrentQueue< _Tp ></h3> <p>Double-ended queue of bounded size, allowing lock-free atomic access. push_front() and pop_front() must not be called concurrently to each other, while pop_back() can be called concurrently at all times. <code>empty()</code>, <code>size()</code>, and <code>top()</code> are intentionally not provided. Calling them would not make sense in a concurrent setting. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">_Tp</td><td>Contained element type. </td></tr> </table> </dd> </dl> <p class="definition">Definition at line <a class="el" href="a00941_source.html#l00052">52</a> of file <a class="el" href="a00941_source.html">queue.h</a>.</p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a id="a7070da9f66983a3fa24ae4dc92614c0c"></a> <h2 class="memtitle"><span class="permalink"><a href="#a7070da9f66983a3fa24ae4dc92614c0c">◆ </a></span>_RestrictedBoundedConcurrentQueue()</h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _Tp> </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a09600.html">__gnu_parallel::_RestrictedBoundedConcurrentQueue</a>< _Tp >::<a class="el" href="a09600.html">_RestrictedBoundedConcurrentQueue</a> </td> <td>(</td> <td class="paramtype"><a class="el" href="a01572.html#a1cbb61a4863a306daa23823d89f9bef1">_SequenceIndex</a> </td> <td class="paramname"><em>__max_size</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Constructor. Not to be called concurrent, of course. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">__max_size</td><td>Maximal number of elements to be contained. </td></tr> </table> </dd> </dl> <p class="definition">Definition at line <a class="el" href="a00941_source.html#l00068">68</a> of file <a class="el" href="a00941_source.html">queue.h</a>.</p> </div> </div> <a id="a0e201d45c998cc913577af578f0b9a16"></a> <h2 class="memtitle"><span class="permalink"><a href="#a0e201d45c998cc913577af578f0b9a16">◆ </a></span>~_RestrictedBoundedConcurrentQueue()</h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _Tp> </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a09600.html">__gnu_parallel::_RestrictedBoundedConcurrentQueue</a>< _Tp >::~<a class="el" href="a09600.html">_RestrictedBoundedConcurrentQueue</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Destructor. Not to be called concurrent, of course. </p> <p class="definition">Definition at line <a class="el" href="a00941_source.html#l00077">77</a> of file <a class="el" href="a00941_source.html">queue.h</a>.</p> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a id="aff5854a49d63fcd08aae08eb282361e7"></a> <h2 class="memtitle"><span class="permalink"><a href="#aff5854a49d63fcd08aae08eb282361e7">◆ </a></span>pop_back()</h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _Tp> </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">bool <a class="el" href="a09600.html">__gnu_parallel::_RestrictedBoundedConcurrentQueue</a>< _Tp >::pop_back </td> <td>(</td> <td class="paramtype">_Tp & </td> <td class="paramname"><em>__t</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Pops one element from the queue at the front end. Must not be called concurrently with pop_front(). </p> <p class="definition">Definition at line <a class="el" href="a00941_source.html#l00127">127</a> of file <a class="el" href="a00941_source.html">queue.h</a>.</p> </div> </div> <a id="a4b760899cefaccb86586c447b12c4cc3"></a> <h2 class="memtitle"><span class="permalink"><a href="#a4b760899cefaccb86586c447b12c4cc3">◆ </a></span>pop_front()</h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _Tp> </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">bool <a class="el" href="a09600.html">__gnu_parallel::_RestrictedBoundedConcurrentQueue</a>< _Tp >::pop_front </td> <td>(</td> <td class="paramtype">_Tp & </td> <td class="paramname"><em>__t</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Pops one element from the queue at the front end. Must not be called concurrently with pop_front(). </p> <p class="definition">Definition at line <a class="el" href="a00941_source.html#l00100">100</a> of file <a class="el" href="a00941_source.html">queue.h</a>.</p> </div> </div> <a id="a2ac4fcc26b5a8e8d3db9993ca3b6f777"></a> <h2 class="memtitle"><span class="permalink"><a href="#a2ac4fcc26b5a8e8d3db9993ca3b6f777">◆ </a></span>push_front()</h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _Tp> </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void <a class="el" href="a09600.html">__gnu_parallel::_RestrictedBoundedConcurrentQueue</a>< _Tp >::push_front </td> <td>(</td> <td class="paramtype">const _Tp & </td> <td class="paramname"><em>__t</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Pushes one element into the queue at the front end. Must not be called concurrently with pop_front(). </p> <p class="definition">Definition at line <a class="el" href="a00941_source.html#l00083">83</a> of file <a class="el" href="a00941_source.html">queue.h</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="a00941_source.html">queue.h</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"><a class="el" href="a01572.html">__gnu_parallel</a></li><li class="navelem"><a class="el" href="a09600.html">_RestrictedBoundedConcurrentQueue</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.15 </li> </ul> </div> </body> </html>