backup/C-Plus-Plus
1
0
Fork 0
mirror of https://github.com/TheAlgorithms/C-Plus-Plus.git synced 2026-03-21 12:23:13 +08:00
Code Issues Projects Releases Wiki Activity
Files
fe2cc4c0659ebce40c62f73c838fa866e3c55664
C-Plus-Plus/db/da9/classqueue.html
github-actions 27c0a2f2f9 Documentation for 8a368240e2
2024-08-30 17:22:07 +00:00

572 lines
35 KiB
HTML
Raw Blame History

<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Algorithms_in_C++: queue&lt; ValueType &gt; 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>
<script type="text/javascript" src="../../clipboard.js"></script>
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../cookie.js"></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/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js", "TeX/AMSmath.js", "TeX/AMSsymbols.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML/MathJax.js"></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 id="projectrow">
<td id="projectalign">
<div id="projectname">Algorithms_in_C++<span id="projectnumber">&#160;1.0.0</span>
</div>
<div id="projectbrief">Set of algorithms implemented in C++.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "../../search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(1); });
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('../../',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('db/da9/classqueue.html','../../'); initResizable(true); });
/* @license-end */
</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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-types">Private Types</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="../../df/de3/classqueue-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">queue&lt; ValueType &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="../../d7/ded/queue_8hpp_source.html">queue.hpp</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for queue&lt; ValueType &gt;:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../d7/d31/classqueue__coll__graph.svg" width="280" height="332"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<center><span class="legend">[<a target="top" href="../../graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ab0c58f54d07d7070c48cc2f9fd26aa90" id="r_ab0c58f54d07d7070c48cc2f9fd26aa90"><td class="memItemLeft" align="right" valign="top"><a id="ab0c58f54d07d7070c48cc2f9fd26aa90" name="ab0c58f54d07d7070c48cc2f9fd26aa90"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>value_type</b> = ValueType</td></tr>
<tr class="separator:ab0c58f54d07d7070c48cc2f9fd26aa90"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a353e4dd5772575905c78b0b30856e368" id="r_a353e4dd5772575905c78b0b30856e368"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a353e4dd5772575905c78b0b30856e368">display</a> () const</td></tr>
<tr class="memdesc:a353e4dd5772575905c78b0b30856e368"><td class="mdescLeft">&#160;</td><td class="mdescRight">prints the queue into the <a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> <br /></td></tr>
<tr class="separator:a353e4dd5772575905c78b0b30856e368"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a386fc1df8610948d3117b12f24655c7d" id="r_a386fc1df8610948d3117b12f24655c7d"><td class="memItemLeft" align="right" valign="top"><a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt; value_type &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a386fc1df8610948d3117b12f24655c7d">toVector</a> () const</td></tr>
<tr class="memdesc:a386fc1df8610948d3117b12f24655c7d"><td class="mdescLeft">&#160;</td><td class="mdescRight">converts the queue into the <a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a> <br /></td></tr>
<tr class="separator:a386fc1df8610948d3117b12f24655c7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4bc52ad6ed6b0cc33ad05f87f05f8bec" id="r_a4bc52ad6ed6b0cc33ad05f87f05f8bec"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4bc52ad6ed6b0cc33ad05f87f05f8bec">isEmptyQueue</a> () const</td></tr>
<tr class="memdesc:a4bc52ad6ed6b0cc33ad05f87f05f8bec"><td class="mdescLeft">&#160;</td><td class="mdescRight">checks if the queue has no elements <br /></td></tr>
<tr class="separator:a4bc52ad6ed6b0cc33ad05f87f05f8bec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada88d0c1f34946d66386b7a11bee4e4d" id="r_ada88d0c1f34946d66386b7a11bee4e4d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ada88d0c1f34946d66386b7a11bee4e4d">enQueue</a> (const value_type &amp;item)</td></tr>
<tr class="memdesc:ada88d0c1f34946d66386b7a11bee4e4d"><td class="mdescLeft">&#160;</td><td class="mdescRight">inserts a new item into the queue <br /></td></tr>
<tr class="separator:ada88d0c1f34946d66386b7a11bee4e4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a75e231798bc706b8b0773a07f78713e7" id="r_a75e231798bc706b8b0773a07f78713e7"><td class="memItemLeft" align="right" valign="top">value_type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a75e231798bc706b8b0773a07f78713e7">front</a> () const</td></tr>
<tr class="separator:a75e231798bc706b8b0773a07f78713e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af27dbb72fb63f58f817a88550d7faa85" id="r_af27dbb72fb63f58f817a88550d7faa85"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af27dbb72fb63f58f817a88550d7faa85">deQueue</a> ()</td></tr>
<tr class="memdesc:af27dbb72fb63f58f817a88550d7faa85"><td class="mdescLeft">&#160;</td><td class="mdescRight">removes the first element from the queue <br /></td></tr>
<tr class="separator:af27dbb72fb63f58f817a88550d7faa85"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6ed7f8dfefe8687841f36f2223069375" id="r_a6ed7f8dfefe8687841f36f2223069375"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6ed7f8dfefe8687841f36f2223069375">clear</a> ()</td></tr>
<tr class="memdesc:a6ed7f8dfefe8687841f36f2223069375"><td class="mdescLeft">&#160;</td><td class="mdescRight">removes all elements from the queue <br /></td></tr>
<tr class="separator:a6ed7f8dfefe8687841f36f2223069375"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-types" name="pri-types"></a>
Private Types</h2></td></tr>
<tr class="memitem:a509d8e7c43f334eb0e582690305a6519" id="r_a509d8e7c43f334eb0e582690305a6519"><td class="memItemLeft" align="right" valign="top"><a id="a509d8e7c43f334eb0e582690305a6519" name="a509d8e7c43f334eb0e582690305a6519"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>node_type</b> = <a class="el" href="../../db/d8b/struct_node.html">Node</a>&lt;ValueType&gt;</td></tr>
<tr class="separator:a509d8e7c43f334eb0e582690305a6519"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-methods" name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:ac08ebdd38cb4ad74fc0a3f51888da604" id="r_ac08ebdd38cb4ad74fc0a3f51888da604"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac08ebdd38cb4ad74fc0a3f51888da604">ensureNotEmpty</a> () const</td></tr>
<tr class="memdesc:ac08ebdd38cb4ad74fc0a3f51888da604"><td class="mdescLeft">&#160;</td><td class="mdescRight">throws an exception if queue is empty <br /></td></tr>
<tr class="separator:ac08ebdd38cb4ad74fc0a3f51888da604"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:af6780e9b43326f557da405b65f7ad094" id="r_af6780e9b43326f557da405b65f7ad094"><td class="memItemLeft" align="right" valign="top"><a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="../../db/d8b/struct_node.html">node_type</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af6780e9b43326f557da405b65f7ad094">queueFront</a></td></tr>
<tr class="separator:af6780e9b43326f557da405b65f7ad094"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7611df63ebefae613d311039d7305143" id="r_a7611df63ebefae613d311039d7305143"><td class="memItemLeft" align="right" valign="top"><a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="../../db/d8b/struct_node.html">node_type</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7611df63ebefae613d311039d7305143">queueRear</a></td></tr>
<tr class="separator:a7611df63ebefae613d311039d7305143"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad30c1f3cc9c107dcc10fc06c8580354e" id="r_ad30c1f3cc9c107dcc10fc06c8580354e"><td class="memItemLeft" align="right" valign="top"><a id="ad30c1f3cc9c107dcc10fc06c8580354e" name="ad30c1f3cc9c107dcc10fc06c8580354e"></a>
<a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>size</b> = 0</td></tr>
<tr class="separator:ad30c1f3cc9c107dcc10fc06c8580354e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;class ValueType&gt;<br />
class queue&lt; ValueType &gt;</div><p>Definition of the queue class </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a6ed7f8dfefe8687841f36f2223069375" name="a6ed7f8dfefe8687841f36f2223069375"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ed7f8dfefe8687841f36f2223069375">&#9670;&#160;</a></span>clear()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ValueType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="../../db/da9/classqueue.html">queue</a>&lt; ValueType &gt;::clear </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></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>removes all elements from the queue </p>
<div class="fragment"><div class="line"><span class="lineno"> 90</span> {</div>
<div class="line"><span class="lineno"> 91</span> <a class="code hl_variable" href="#af6780e9b43326f557da405b65f7ad094">queueFront</a> = <span class="keyword">nullptr</span>;</div>
<div class="line"><span class="lineno"> 92</span> <a class="code hl_variable" href="#a7611df63ebefae613d311039d7305143">queueRear</a> = <span class="keyword">nullptr</span>;</div>
<div class="line"><span class="lineno"> 93</span> size = 0;</div>
<div class="line"><span class="lineno"> 94</span> }</div>
<div class="ttc" id="aclassqueue_html_a7611df63ebefae613d311039d7305143"><div class="ttname"><a href="#a7611df63ebefae613d311039d7305143">queue::queueRear</a></div><div class="ttdeci">std::shared_ptr&lt; node_type &gt; queueRear</div><div class="ttdef"><b>Definition</b> queue.hpp:99</div></div>
<div class="ttc" id="aclassqueue_html_af6780e9b43326f557da405b65f7ad094"><div class="ttname"><a href="#af6780e9b43326f557da405b65f7ad094">queue::queueFront</a></div><div class="ttdeci">std::shared_ptr&lt; node_type &gt; queueFront</div><div class="ttdef"><b>Definition</b> queue.hpp:97</div></div>
</div><!-- fragment -->
</div>
</div>
<a id="af27dbb72fb63f58f817a88550d7faa85" name="af27dbb72fb63f58f817a88550d7faa85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af27dbb72fb63f58f817a88550d7faa85">&#9670;&#160;</a></span>deQueue()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ValueType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="../../db/da9/classqueue.html">queue</a>&lt; ValueType &gt;::deQueue </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></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>removes the first element from the queue </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/error/invalid_argument.html">std::invalid_argument</a></td><td>if queue is empty </td></tr>
</table>
</dd>
</dl>
<div class="fragment"><div class="line"><span class="lineno"> 81</span> {</div>
<div class="line"><span class="lineno"> 82</span> <a class="code hl_function" href="#ac08ebdd38cb4ad74fc0a3f51888da604">ensureNotEmpty</a>();</div>
<div class="line"><span class="lineno"> 83</span> <a class="code hl_variable" href="#af6780e9b43326f557da405b65f7ad094">queueFront</a> = <a class="code hl_variable" href="#af6780e9b43326f557da405b65f7ad094">queueFront</a>-&gt;next;</div>
<div class="line"><span class="lineno"> 84</span> --size;</div>
<div class="line"><span class="lineno"> 85</span> }</div>
<div class="ttc" id="aclassqueue_html_ac08ebdd38cb4ad74fc0a3f51888da604"><div class="ttname"><a href="#ac08ebdd38cb4ad74fc0a3f51888da604">queue::ensureNotEmpty</a></div><div class="ttdeci">void ensureNotEmpty() const</div><div class="ttdoc">throws an exception if queue is empty</div><div class="ttdef"><b>Definition</b> queue.hpp:38</div></div>
</div><!-- fragment --><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../db/da9/classqueue_af27dbb72fb63f58f817a88550d7faa85_cgraph.svg" width="536" height="36"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
</div>
<a id="a353e4dd5772575905c78b0b30856e368" name="a353e4dd5772575905c78b0b30856e368"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a353e4dd5772575905c78b0b30856e368">&#9670;&#160;</a></span>display()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ValueType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="../../db/da9/classqueue.html">queue</a>&lt; ValueType &gt;::display </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</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>prints the queue into the <a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> </p>
<div class="fragment"><div class="line"><span class="lineno"> 17</span> {</div>
<div class="line"><span class="lineno"> 18</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> &lt;&lt; <span class="stringliteral">&quot;Front --&gt; &quot;</span>;</div>
<div class="line"><span class="lineno"> 19</span> display_all(this-&gt;<a class="code hl_variable" href="#af6780e9b43326f557da405b65f7ad094">queueFront</a>.get());</div>
<div class="line"><span class="lineno"> 20</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> &lt;&lt; <span class="charliteral">&#39;\n&#39;</span>;</div>
<div class="line"><span class="lineno"> 21</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> &lt;&lt; <span class="stringliteral">&quot;Size of queue: &quot;</span> &lt;&lt; size &lt;&lt; <span class="charliteral">&#39;\n&#39;</span>;</div>
<div class="line"><span class="lineno"> 22</span> }</div>
<div class="ttc" id="abasic_ostream_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a></div></div>
</div><!-- fragment -->
</div>
</div>
<a id="ada88d0c1f34946d66386b7a11bee4e4d" name="ada88d0c1f34946d66386b7a11bee4e4d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ada88d0c1f34946d66386b7a11bee4e4d">&#9670;&#160;</a></span>enQueue()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ValueType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="../../db/da9/classqueue.html">queue</a>&lt; ValueType &gt;::enQueue </td>
<td>(</td>
<td class="paramtype">const value_type &amp;</td> <td class="paramname"><span class="paramname"><em>item</em></span></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>inserts a new item into the queue </p>
<div class="fragment"><div class="line"><span class="lineno"> 54</span> {</div>
<div class="line"><span class="lineno"> 55</span> <span class="keyword">auto</span> newNode = <a class="code hl_functionRef" target="_blank" href="http://en.cppreference.com/w/cpp/memory/shared_ptr/make_shared.html">std::make_shared&lt;node_type&gt;</a>();</div>
<div class="line"><span class="lineno"> 56</span> newNode-&gt;data = item;</div>
<div class="line"><span class="lineno"> 57</span> newNode-&gt;next = <span class="keyword">nullptr</span>;</div>
<div class="line"><span class="lineno"> 58</span> <span class="keywordflow">if</span> (<a class="code hl_function" href="#a4bc52ad6ed6b0cc33ad05f87f05f8bec">isEmptyQueue</a>()) {</div>
<div class="line"><span class="lineno"> 59</span> <a class="code hl_variable" href="#af6780e9b43326f557da405b65f7ad094">queueFront</a> = newNode;</div>
<div class="line"><span class="lineno"> 60</span> <a class="code hl_variable" href="#a7611df63ebefae613d311039d7305143">queueRear</a> = newNode;</div>
<div class="line"><span class="lineno"> 61</span> } <span class="keywordflow">else</span> {</div>
<div class="line"><span class="lineno"> 62</span> <a class="code hl_variable" href="#a7611df63ebefae613d311039d7305143">queueRear</a>-&gt;next = newNode;</div>
<div class="line"><span class="lineno"> 63</span> <a class="code hl_variable" href="#a7611df63ebefae613d311039d7305143">queueRear</a> = <a class="code hl_variable" href="#a7611df63ebefae613d311039d7305143">queueRear</a>-&gt;next;</div>
<div class="line"><span class="lineno"> 64</span> }</div>
<div class="line"><span class="lineno"> 65</span> ++size;</div>
<div class="line"><span class="lineno"> 66</span> }</div>
<div class="ttc" id="aclassqueue_html_a4bc52ad6ed6b0cc33ad05f87f05f8bec"><div class="ttname"><a href="#a4bc52ad6ed6b0cc33ad05f87f05f8bec">queue::isEmptyQueue</a></div><div class="ttdeci">bool isEmptyQueue() const</div><div class="ttdoc">checks if the queue has no elements</div><div class="ttdef"><b>Definition</b> queue.hpp:49</div></div>
<div class="ttc" id="amake_shared_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/memory/shared_ptr/make_shared.html">std::make_shared</a></div><div class="ttdeci">T make_shared(T... args)</div></div>
</div><!-- fragment --><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../db/da9/classqueue_ada88d0c1f34946d66386b7a11bee4e4d_cgraph.svg" width="326" height="86"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
</div>
<a id="ac08ebdd38cb4ad74fc0a3f51888da604" name="ac08ebdd38cb4ad74fc0a3f51888da604"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac08ebdd38cb4ad74fc0a3f51888da604">&#9670;&#160;</a></span>ensureNotEmpty()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ValueType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="../../db/da9/classqueue.html">queue</a>&lt; ValueType &gt;::ensureNotEmpty </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>throws an exception if queue is empty </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/error/invalid_argument.html">std::invalid_argument</a></td><td>if queue is empty </td></tr>
</table>
</dd>
</dl>
<div class="fragment"><div class="line"><span class="lineno"> 38</span> {</div>
<div class="line"><span class="lineno"> 39</span> <span class="keywordflow">if</span> (<a class="code hl_function" href="#a4bc52ad6ed6b0cc33ad05f87f05f8bec">isEmptyQueue</a>()) {</div>
<div class="line"><span class="lineno"> 40</span> <span class="keywordflow">throw</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/error/invalid_argument.html">std::invalid_argument</a>(<span class="stringliteral">&quot;Queue is empty.&quot;</span>);</div>
<div class="line"><span class="lineno"> 41</span> }</div>
<div class="line"><span class="lineno"> 42</span> }</div>
<div class="ttc" id="ainvalid_argument_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/error/invalid_argument.html">std::invalid_argument</a></div></div>
</div><!-- fragment --><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../db/da9/classqueue_ac08ebdd38cb4ad74fc0a3f51888da604_cgraph.svg" width="372" height="36"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
</div>
<a id="a75e231798bc706b8b0773a07f78713e7" name="a75e231798bc706b8b0773a07f78713e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a75e231798bc706b8b0773a07f78713e7">&#9670;&#160;</a></span>front()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ValueType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">value_type <a class="el" href="../../db/da9/classqueue.html">queue</a>&lt; ValueType &gt;::front </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the first element of the queue </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/error/invalid_argument.html">std::invalid_argument</a></td><td>if queue is empty </td></tr>
</table>
</dd>
</dl>
<div class="fragment"><div class="line"><span class="lineno"> 72</span> {</div>
<div class="line"><span class="lineno"> 73</span> <a class="code hl_function" href="#ac08ebdd38cb4ad74fc0a3f51888da604">ensureNotEmpty</a>();</div>
<div class="line"><span class="lineno"> 74</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="#af6780e9b43326f557da405b65f7ad094">queueFront</a>-&gt;data;</div>
<div class="line"><span class="lineno"> 75</span> }</div>
</div><!-- fragment --><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../db/da9/classqueue_a75e231798bc706b8b0773a07f78713e7_cgraph.svg" width="510" height="36"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
</div>
<a id="a4bc52ad6ed6b0cc33ad05f87f05f8bec" name="a4bc52ad6ed6b0cc33ad05f87f05f8bec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4bc52ad6ed6b0cc33ad05f87f05f8bec">&#9670;&#160;</a></span>isEmptyQueue()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ValueType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="../../db/da9/classqueue.html">queue</a>&lt; ValueType &gt;::isEmptyQueue </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</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>checks if the queue has no elements </p>
<dl class="section return"><dt>Returns</dt><dd>true if the queue is empty, false otherwise </dd></dl>
<div class="fragment"><div class="line"><span class="lineno"> 49</span>{ <span class="keywordflow">return</span> (<a class="code hl_variable" href="#af6780e9b43326f557da405b65f7ad094">queueFront</a> == <span class="keyword">nullptr</span>); }</div>
</div><!-- fragment -->
</div>
</div>
<a id="a386fc1df8610948d3117b12f24655c7d" name="a386fc1df8610948d3117b12f24655c7d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a386fc1df8610948d3117b12f24655c7d">&#9670;&#160;</a></span>toVector()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ValueType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt; value_type &gt; <a class="el" href="../../db/da9/classqueue.html">queue</a>&lt; ValueType &gt;::toVector </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</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>converts the queue into the <a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a> </p>
<dl class="section return"><dt>Returns</dt><dd><a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a> containning all of the elements of the queue in the same order </dd></dl>
<div class="fragment"><div class="line"><span class="lineno"> 29</span> {</div>
<div class="line"><span class="lineno"> 30</span> <span class="keywordflow">return</span> push_all_to_vector(this-&gt;<a class="code hl_variable" href="#af6780e9b43326f557da405b65f7ad094">queueFront</a>.get(), this-&gt;size);</div>
<div class="line"><span class="lineno"> 31</span> }</div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="af6780e9b43326f557da405b65f7ad094" name="af6780e9b43326f557da405b65f7ad094"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af6780e9b43326f557da405b65f7ad094">&#9670;&#160;</a></span>queueFront</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ValueType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt;<a class="el" href="../../db/d8b/struct_node.html">node_type</a>&gt; <a class="el" href="../../db/da9/classqueue.html">queue</a>&lt; ValueType &gt;::queueFront</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">=</div>
<div class="line"> {}</div>
</div><!-- fragment --><p>Pointer to the front of the queue </p>
<div class="fragment"><div class="line"><span class="lineno"> 98</span> {}; <span class="comment">/**&lt; Pointer to the front of the queue */</span></div>
</div><!-- fragment -->
</div>
</div>
<a id="a7611df63ebefae613d311039d7305143" name="a7611df63ebefae613d311039d7305143"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7611df63ebefae613d311039d7305143">&#9670;&#160;</a></span>queueRear</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ValueType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt;<a class="el" href="../../db/d8b/struct_node.html">node_type</a>&gt; <a class="el" href="../../db/da9/classqueue.html">queue</a>&lt; ValueType &gt;::queueRear</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">=</div>
<div class="line"> {}</div>
</div><!-- fragment --><p>Pointer to the rear of the queue <br />
</p>
<div class="fragment"><div class="line"><span class="lineno"> 100</span> {}; <span class="comment">/**&lt; Pointer to the rear of the queue */</span></div>
</div><!-- fragment -->
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>data_structures/<a class="el" href="../../d7/ded/queue_8hpp_source.html">queue.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"><a class="el" href="../../db/da9/classqueue.html">queue</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink