Documentation for c26eea874d

This commit is contained in:
realstealthninja
2025-05-19 11:38:33 +00:00
parent c7a9a42397
commit 14583a2f33
2829 changed files with 30266 additions and 21669 deletions

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.12.0"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<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" />
@@ -60,7 +60,7 @@ window.MathJax = {
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<!-- Generated by Doxygen 1.13.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "../../search/",'.html');
@@ -199,7 +199,7 @@ class queue&lt; ValueType &gt;</div><p>Definition of the queue class </p>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ValueType &gt; </div>
template&lt;class ValueType&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
@@ -210,7 +210,7 @@ template&lt;class ValueType &gt; </div>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -225,7 +225,7 @@ template&lt;class ValueType &gt; </div>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ValueType &gt; </div>
template&lt;class ValueType&gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="../../db/da9/classqueue.html">queue</a>&lt; ValueType &gt;::value_type = ValueType</td>
@@ -244,7 +244,7 @@ template&lt;class ValueType &gt; </div>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ValueType &gt; </div>
template&lt;class ValueType&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
@@ -258,7 +258,7 @@ template&lt;class ValueType &gt; </div>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -282,7 +282,7 @@ template&lt;class ValueType &gt; </div>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ValueType &gt; </div>
template&lt;class ValueType&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
@@ -296,7 +296,7 @@ template&lt;class ValueType &gt; </div>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -325,7 +325,7 @@ template&lt;class ValueType &gt; </div>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ValueType &gt; </div>
template&lt;class ValueType&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
@@ -339,7 +339,7 @@ template&lt;class ValueType &gt; </div>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -348,11 +348,12 @@ template&lt;class ValueType &gt; </div>
<p class="definition">Definition at line <a class="el" href="../../d7/ded/queue_8hpp_source.html#l00017">17</a> of file <a class="el" href="../../d7/ded/queue_8hpp_source.html">queue.hpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 17</span> {</div>
<div class="line"><span class="lineno"> 18</span> std::cout &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> std::cout &lt;&lt; <span class="charliteral">&#39;\n&#39;</span>;</div>
<div class="line"><span class="lineno"> 21</span> std::cout &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"> 18</span> <a class="code hl_class" href="../../db/da9/classqueue.html">std::cout</a> &lt;&lt; <span class="stringliteral">&quot;Front --&gt; &quot;</span>;</div>
<div class="line"><span class="lineno"> 19</span> <a class="code hl_class" href="../../db/da9/classqueue.html">display_all</a>(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_class" href="../../db/da9/classqueue.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_class" href="../../db/da9/classqueue.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="aclassqueue_html"><div class="ttname"><a href="../../db/da9/classqueue.html">queue</a></div><div class="ttdef"><b>Definition</b> <a href="../../d7/ded/queue_8hpp_source.html#l00009">queue.hpp:9</a></div></div>
</div><!-- fragment -->
</div>
</div>
@@ -362,7 +363,7 @@ template&lt;class ValueType &gt; </div>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ValueType &gt; </div>
template&lt;class ValueType&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
@@ -376,7 +377,7 @@ template&lt;class ValueType &gt; </div>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -385,14 +386,14 @@ template&lt;class ValueType &gt; </div>
<p class="definition">Definition at line <a class="el" href="../../d7/ded/queue_8hpp_source.html#l00054">54</a> of file <a class="el" href="../../d7/ded/queue_8hpp_source.html">queue.hpp</a>.</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 = std::make_shared&lt;node_type&gt;();</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"> 55</span> <span class="keyword">auto</span> <a class="code hl_class" href="../../db/da9/classqueue.html">newNode</a> = <a class="code hl_class" href="../../db/da9/classqueue.html">std::make_shared&lt;node_type&gt;</a>();</div>
<div class="line"><span class="lineno"> 56</span> <a class="code hl_class" href="../../db/da9/classqueue.html">newNode</a>-&gt;data = <a class="code hl_class" href="../../db/da9/classqueue.html">item</a>;</div>
<div class="line"><span class="lineno"> 57</span> <a class="code hl_class" href="../../db/da9/classqueue.html">newNode</a>-&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"> 59</span> <a class="code hl_variable" href="#af6780e9b43326f557da405b65f7ad094">queueFront</a> = <a class="code hl_class" href="../../db/da9/classqueue.html">newNode</a>;</div>
<div class="line"><span class="lineno"> 60</span> <a class="code hl_variable" href="#a7611df63ebefae613d311039d7305143">queueRear</a> = <a class="code hl_class" href="../../db/da9/classqueue.html">newNode</a>;</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"> 62</span> <a class="code hl_variable" href="#a7611df63ebefae613d311039d7305143">queueRear</a>-&gt;next = <a class="code hl_class" href="../../db/da9/classqueue.html">newNode</a>;</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>
@@ -407,7 +408,7 @@ template&lt;class ValueType &gt; </div>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ValueType &gt; </div>
template&lt;class ValueType&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
@@ -421,7 +422,7 @@ template&lt;class ValueType &gt; </div>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span> </td>
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -437,7 +438,7 @@ template&lt;class ValueType &gt; </div>
<p class="definition">Definition at line <a class="el" href="../../d7/ded/queue_8hpp_source.html#l00038">38</a> of file <a class="el" href="../../d7/ded/queue_8hpp_source.html">queue.hpp</a>.</p>
<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> std::invalid_argument(<span class="stringliteral">&quot;Queue is empty.&quot;</span>);</div>
<div class="line"><span class="lineno"> 40</span> <span class="keywordflow">throw</span> <a class="code hl_class" href="../../db/da9/classqueue.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><!-- fragment -->
@@ -449,7 +450,7 @@ template&lt;class ValueType &gt; </div>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ValueType &gt; </div>
template&lt;class ValueType&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
@@ -463,7 +464,7 @@ template&lt;class ValueType &gt; </div>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -489,7 +490,7 @@ template&lt;class ValueType &gt; </div>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ValueType &gt; </div>
template&lt;class ValueType&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
@@ -503,7 +504,7 @@ template&lt;class ValueType &gt; </div>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -522,7 +523,7 @@ template&lt;class ValueType &gt; </div>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ValueType &gt; </div>
template&lt;class ValueType&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
@@ -536,7 +537,7 @@ template&lt;class ValueType &gt; </div>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -546,7 +547,7 @@ template&lt;class ValueType &gt; </div>
<p class="definition">Definition at line <a class="el" href="../../d7/ded/queue_8hpp_source.html#l00029">29</a> of file <a class="el" href="../../d7/ded/queue_8hpp_source.html">queue.hpp</a>.</p>
<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"> 30</span> <span class="keywordflow">return</span> <a class="code hl_class" href="../../db/da9/classqueue.html">push_all_to_vector</a>(this-&gt;<a class="code hl_variable" href="#af6780e9b43326f557da405b65f7ad094">queueFront</a>.get(), <a class="code hl_class" href="../../db/da9/classqueue.html">this</a>-&gt;size);</div>
<div class="line"><span class="lineno"> 31</span> }</div>
</div><!-- fragment -->
</div>
@@ -558,7 +559,7 @@ template&lt;class ValueType &gt; </div>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ValueType &gt; </div>
template&lt;class ValueType&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
@@ -569,7 +570,7 @@ template&lt;class ValueType &gt; </div>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -588,7 +589,7 @@ template&lt;class ValueType &gt; </div>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ValueType &gt; </div>
template&lt;class ValueType&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
@@ -599,14 +600,13 @@ template&lt;class ValueType &gt; </div>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
<span class="mlabels"><span class="mlabel private">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><!-- fragment --><p>Pointer to the rear of the queue </p>
<p class="definition">Definition at line <a class="el" href="../../d7/ded/queue_8hpp_source.html#l00099">99</a> of file <a class="el" href="../../d7/ded/queue_8hpp_source.html">queue.hpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 100</span> {}; </div>
@@ -619,7 +619,7 @@ template&lt;class ValueType &gt; </div>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ValueType &gt; </div>
template&lt;class ValueType&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
@@ -630,7 +630,7 @@ template&lt;class ValueType &gt; </div>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -648,7 +648,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.12.0 </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>
</ul>
</div>
</body>