Documentation for 6376bf46af

This commit is contained in:
github-actions
2023-09-27 18:42:32 +00:00
parent d28eba1fef
commit b5b4d78981
5708 changed files with 52275 additions and 51112 deletions

View File

@@ -3,7 +3,7 @@
<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.9.7"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<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"/>
@@ -41,7 +41,7 @@ MathJax.Hub.Config({
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.7 -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "../../search/",'.html');
@@ -117,52 +117,52 @@ Collaboration diagram for queue&lt; ValueType &gt;:</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"><td class="memItemLeft" align="right" valign="top"><a id="ab0c58f54d07d7070c48cc2f9fd26aa90" name="ab0c58f54d07d7070c48cc2f9fd26aa90"></a>
<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"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/da9/classqueue.html#a353e4dd5772575905c78b0b30856e368">display</a> () const</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="../../db/da9/classqueue.html#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"><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="../../db/da9/classqueue.html#a386fc1df8610948d3117b12f24655c7d">toVector</a> () const</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="../../db/da9/classqueue.html#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"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/da9/classqueue.html#a4bc52ad6ed6b0cc33ad05f87f05f8bec">isEmptyQueue</a> () const</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="../../db/da9/classqueue.html#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"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/da9/classqueue.html#ada88d0c1f34946d66386b7a11bee4e4d">enQueue</a> (const value_type &amp;item)</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="../../db/da9/classqueue.html#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"><td class="memItemLeft" align="right" valign="top">value_type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/da9/classqueue.html#a75e231798bc706b8b0773a07f78713e7">front</a> () const</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="../../db/da9/classqueue.html#a75e231798bc706b8b0773a07f78713e7">front</a> () const</td></tr>
<tr class="separator:a75e231798bc706b8b0773a07f78713e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af27dbb72fb63f58f817a88550d7faa85"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/da9/classqueue.html#af27dbb72fb63f58f817a88550d7faa85">deQueue</a> ()</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="../../db/da9/classqueue.html#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"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/da9/classqueue.html#a6ed7f8dfefe8687841f36f2223069375">clear</a> ()</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="../../db/da9/classqueue.html#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"><td class="memItemLeft" align="right" valign="top"><a id="a509d8e7c43f334eb0e582690305a6519" name="a509d8e7c43f334eb0e582690305a6519"></a>
<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"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/da9/classqueue.html#ac08ebdd38cb4ad74fc0a3f51888da604">ensureNotEmpty</a> () const</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="../../db/da9/classqueue.html#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"><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="../../db/da9/classqueue.html#af6780e9b43326f557da405b65f7ad094">queueFront</a></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="../../db/da9/classqueue.html#af6780e9b43326f557da405b65f7ad094">queueFront</a></td></tr>
<tr class="separator:af6780e9b43326f557da405b65f7ad094"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem: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="../../db/da9/classqueue.html#a7611df63ebefae613d311039d7305143">queueRear</a></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="../../db/da9/classqueue.html#a7611df63ebefae613d311039d7305143">queueRear</a></td></tr>
<tr class="separator:a7611df63ebefae613d311039d7305143"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad30c1f3cc9c107dcc10fc06c8580354e"><td class="memItemLeft" align="right" valign="top"><a id="ad30c1f3cc9c107dcc10fc06c8580354e" name="ad30c1f3cc9c107dcc10fc06c8580354e"></a>
<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>
@@ -515,7 +515,8 @@ template&lt;class ValueType &gt; </div>
<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>
@@ -543,7 +544,8 @@ template&lt;class ValueType &gt; </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>
@@ -555,7 +557,7 @@ template&lt;class ValueType &gt; </div>
<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.9.7 </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.9.8 </li>
</ul>
</div>
</body>