backup/C-Plus-Plus
1
0
Fork 0
mirror of https://github.com/TheAlgorithms/C-Plus-Plus.git synced 2026-03-22 21:01:50 +08:00
Code Issues Projects Releases Wiki Activity

Documentation for f1eddf4d65

Browse Source
This commit is contained in:
realstealthninja
2025-07-09 10:53:16 +00:00
parent e7edde96ab
commit b41207008f
2497 changed files with 31270 additions and 40283 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
db/da9/classqueue.html
View File

@@ -4,7 +4,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.13.2"/>
<meta name="generator" content="Doxygen 1.14.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>TheAlgorithms/C++: queue&lt; ValueType &gt; Class Template Reference</title>
<link rel="icon" href="../../favicon.svg" type="image/x-icon" />
@@ -19,7 +19,6 @@
<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>
@@ -60,26 +59,20 @@ window.MathJax = {
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<!-- Generated by Doxygen 1.14.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 */
$(function() { codefold.init(); });
</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 -->
@@ -94,10 +87,9 @@ $(function() {
</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 */
$(function(){initNavTree('db/da9/classqueue.html','../../','df/de3/classqueue-members'); });
</script>
<div id="container">
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
@@ -121,13 +113,6 @@ $(function(){initNavTree('db/da9/classqueue.html','../../'); initResizable(true)
</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">
@@ -136,63 +121,50 @@ $(function(){initNavTree('db/da9/classqueue.html','../../'); initResizable(true)
<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="214" height="332"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="../../d7/d31/classqueue__coll__graph.svg" width="218" height="362"><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>
<tr class="heading"><td colspan="2"><h2 id="header-pub-types" 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">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab0c58f54d07d7070c48cc2f9fd26aa90">value_type</a> = 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>
<tr class="heading"><td colspan="2"><h2 id="header-pub-methods" 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 std::cout <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">std::vector&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 std::vector <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>
<tr class="heading"><td colspan="2"><h2 id="header-pri-types" 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">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a509d8e7c43f334eb0e582690305a6519">node_type</a> = <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>
<tr class="heading"><td colspan="2"><h2 id="header-pri-methods" 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>
<tr class="heading"><td colspan="2"><h2 id="header-pri-attribs" 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">std::shared_ptr&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">std::shared_ptr&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">std::size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad30c1f3cc9c107dcc10fc06c8580354e">size</a> = 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>
<a name="details" id="details"></a><h2 id="header-details" 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>
<p class="definition">Definition at line <a class="el" href="../../d7/ded/queue_8hpp_source.html#l00009">9</a> of file <a class="el" href="../../d7/ded/queue_8hpp_source.html">queue.hpp</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
</div><a name="doc-typedef-members" id="doc-typedef-members"></a><h2 id="header-doc-typedef-members" class="groupheader">Member Typedef Documentation</h2>
<a id="a509d8e7c43f334eb0e582690305a6519" name="a509d8e7c43f334eb0e582690305a6519"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a509d8e7c43f334eb0e582690305a6519">&#9670;&#160;</a></span>node_type</h2>
@@ -237,7 +209,7 @@ template&lt;class ValueType&gt; </div>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" 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>
@@ -552,7 +524,7 @@ template&lt;class ValueType&gt; </div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a name="doc-variable-members" id="doc-variable-members"></a><h2 id="header-doc-variable-members" 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>
@@ -644,11 +616,19 @@ template&lt;class ValueType&gt; </div>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- 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.13.2 </li>
<li class="navelem"><a 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.14.0 </li>
</ul>
</div>
</body>