mirror of
https://github.com/TheAlgorithms/C-Plus-Plus.git
synced 2026-03-25 06:12:11 +08:00
Documentation for 8b1eab204b
This commit is contained in:
@@ -1,3 +1,4 @@
|
||||
<!-- HTML header for doxygen 1.12.0-->
|
||||
<!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>
|
||||
@@ -5,10 +6,15 @@
|
||||
<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< ValueType > Class Template Reference</title>
|
||||
<title>TheAlgorithms/C++: queue< ValueType > Class Template Reference</title>
|
||||
<link rel="icon" href="../../favicon.svg" type="image/x-icon" />
|
||||
<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="https://cdn.jsdelivr.net/npm/@xpack-3rd-party/doxygen-awesome-css@2.2.0-1/doxygen-awesome-darkmode-toggle.js"></script>
|
||||
<script type="text/javascript">
|
||||
DoxygenAwesomeDarkModeToggle.init()
|
||||
</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>
|
||||
@@ -18,14 +24,24 @@
|
||||
<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 type="text/javascript">
|
||||
window.MathJax = {
|
||||
options: {
|
||||
ignoreHtmlClass: 'tex2jax_ignore',
|
||||
processHtmlClass: 'tex2jax_process'
|
||||
},
|
||||
loader: {
|
||||
load: ['[tex]/ams']
|
||||
},
|
||||
tex: {
|
||||
macros: {},
|
||||
packages: ['base','configmacros','ams']
|
||||
}
|
||||
};
|
||||
</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>
|
||||
<script type="text/javascript" id="MathJax-script" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-chtml.js"></script>
|
||||
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
|
||||
<link href="../../doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
@@ -33,10 +49,11 @@ MathJax.Hub.Config({
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr id="projectrow">
|
||||
<td id="projectlogo"><img alt="Logo" src="../../project_logo.png"/></td>
|
||||
<td id="projectalign">
|
||||
<div id="projectname">Algorithms_in_C++<span id="projectnumber"> 1.0.0</span>
|
||||
<div id="projectname">TheAlgorithms/C++<span id="projectnumber"> 1.0.0</span>
|
||||
</div>
|
||||
<div id="projectbrief">Set of algorithms implemented in C++.</div>
|
||||
<div id="projectbrief">All the algorithms implemented in C++</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@@ -119,22 +136,21 @@ $(function(){initNavTree('db/da9/classqueue.html','../../'); initResizable(true)
|
||||
<div class="dynheader">
|
||||
Collaboration diagram for queue< ValueType >:</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>
|
||||
<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>
|
||||
<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 </td><td class="memItemRight" valign="bottom"><b>value_type</b> = ValueType</td></tr>
|
||||
<tr class="memitem:ab0c58f54d07d7070c48cc2f9fd26aa90" id="r_ab0c58f54d07d7070c48cc2f9fd26aa90"><td class="memItemLeft" align="right" valign="top">using </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"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="#a353e4dd5772575905c78b0b30856e368">display</a> () const</td></tr>
|
||||
<tr class="memdesc:a353e4dd5772575905c78b0b30856e368"><td class="mdescLeft"> </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="memdesc:a353e4dd5772575905c78b0b30856e368"><td class="mdescLeft"> </td><td class="mdescRight">prints the queue into the std::cout <br /></td></tr>
|
||||
<tr class="separator:a353e4dd5772575905c78b0b30856e368"><td class="memSeparator" colspan="2"> </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>< value_type > </td><td class="memItemRight" valign="bottom"><a class="el" href="#a386fc1df8610948d3117b12f24655c7d">toVector</a> () const</td></tr>
|
||||
<tr class="memdesc:a386fc1df8610948d3117b12f24655c7d"><td class="mdescLeft"> </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="memitem:a386fc1df8610948d3117b12f24655c7d" id="r_a386fc1df8610948d3117b12f24655c7d"><td class="memItemLeft" align="right" valign="top">std::vector< value_type > </td><td class="memItemRight" valign="bottom"><a class="el" href="#a386fc1df8610948d3117b12f24655c7d">toVector</a> () const</td></tr>
|
||||
<tr class="memdesc:a386fc1df8610948d3117b12f24655c7d"><td class="mdescLeft"> </td><td class="mdescRight">converts the queue into the std::vector <br /></td></tr>
|
||||
<tr class="separator:a386fc1df8610948d3117b12f24655c7d"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a4bc52ad6ed6b0cc33ad05f87f05f8bec" id="r_a4bc52ad6ed6b0cc33ad05f87f05f8bec"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4bc52ad6ed6b0cc33ad05f87f05f8bec">isEmptyQueue</a> () const</td></tr>
|
||||
<tr class="memdesc:a4bc52ad6ed6b0cc33ad05f87f05f8bec"><td class="mdescLeft"> </td><td class="mdescRight">checks if the queue has no elements <br /></td></tr>
|
||||
@@ -153,8 +169,7 @@ Public Member Functions</h2></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 </td><td class="memItemRight" valign="bottom"><b>node_type</b> = <a class="el" href="../../db/d8b/struct_node.html">Node</a><ValueType></td></tr>
|
||||
<tr class="memitem:a509d8e7c43f334eb0e582690305a6519" id="r_a509d8e7c43f334eb0e582690305a6519"><td class="memItemLeft" align="right" valign="top">using </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><ValueType></td></tr>
|
||||
<tr class="separator:a509d8e7c43f334eb0e582690305a6519"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table><table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-methods" name="pri-methods"></a>
|
||||
@@ -165,18 +180,64 @@ Private Member Functions</h2></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>< <a class="el" href="../../db/d8b/struct_node.html">node_type</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="#af6780e9b43326f557da405b65f7ad094">queueFront</a></td></tr>
|
||||
<tr class="memitem:af6780e9b43326f557da405b65f7ad094" id="r_af6780e9b43326f557da405b65f7ad094"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="../../db/d8b/struct_node.html">node_type</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="#af6780e9b43326f557da405b65f7ad094">queueFront</a></td></tr>
|
||||
<tr class="separator:af6780e9b43326f557da405b65f7ad094"><td class="memSeparator" colspan="2"> </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>< <a class="el" href="../../db/d8b/struct_node.html">node_type</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7611df63ebefae613d311039d7305143">queueRear</a></td></tr>
|
||||
<tr class="memitem:a7611df63ebefae613d311039d7305143" id="r_a7611df63ebefae613d311039d7305143"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="../../db/d8b/struct_node.html">node_type</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7611df63ebefae613d311039d7305143">queueRear</a></td></tr>
|
||||
<tr class="separator:a7611df63ebefae613d311039d7305143"><td class="memSeparator" colspan="2"> </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> </td><td class="memItemRight" valign="bottom"><b>size</b> = 0</td></tr>
|
||||
<tr class="memitem:ad30c1f3cc9c107dcc10fc06c8580354e" id="r_ad30c1f3cc9c107dcc10fc06c8580354e"><td class="memItemLeft" align="right" valign="top">std::size_t </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"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><div class="compoundTemplParams">template<class ValueType><br />
|
||||
class queue< ValueType ></div><p>Definition of the queue class </p>
|
||||
</div><h2 class="groupheader">Member Function Documentation</h2>
|
||||
|
||||
<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>
|
||||
<a id="a509d8e7c43f334eb0e582690305a6519" name="a509d8e7c43f334eb0e582690305a6519"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a509d8e7c43f334eb0e582690305a6519">◆ </a></span>node_type</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<div class="memtemplate">
|
||||
template<class ValueType > </div>
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">using <a class="el" href="../../db/da9/classqueue.html">queue</a>< ValueType >::node_type = <a class="el" href="../../db/d8b/struct_node.html">Node</a><ValueType></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="../../d7/ded/queue_8hpp_source.html#l00010">10</a> of file <a class="el" href="../../d7/ded/queue_8hpp_source.html">queue.hpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="ab0c58f54d07d7070c48cc2f9fd26aa90" name="ab0c58f54d07d7070c48cc2f9fd26aa90"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ab0c58f54d07d7070c48cc2f9fd26aa90">◆ </a></span>value_type</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<div class="memtemplate">
|
||||
template<class ValueType > </div>
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">using <a class="el" href="../../db/da9/classqueue.html">queue</a>< ValueType >::value_type = ValueType</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="../../d7/ded/queue_8hpp_source.html#l00013">13</a> of file <a class="el" href="../../d7/ded/queue_8hpp_source.html">queue.hpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2 class="groupheader">Member Function Documentation</h2>
|
||||
<a id="a6ed7f8dfefe8687841f36f2223069375" name="a6ed7f8dfefe8687841f36f2223069375"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a6ed7f8dfefe8687841f36f2223069375">◆ </a></span>clear()</h2>
|
||||
|
||||
@@ -203,13 +264,15 @@ template<class ValueType > </div>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>removes all elements from the queue </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="../../d7/ded/queue_8hpp_source.html#l00090">90</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"> 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< node_type > 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< node_type > queueFront</div><div class="ttdef"><b>Definition</b> queue.hpp:97</div></div>
|
||||
<div class="ttc" id="aclassqueue_html_a7611df63ebefae613d311039d7305143"><div class="ttname"><a href="#a7611df63ebefae613d311039d7305143">queue::queueRear</a></div><div class="ttdeci">std::shared_ptr< node_type > queueRear</div><div class="ttdef"><b>Definition</b> <a href="../../d7/ded/queue_8hpp_source.html#l00099">queue.hpp:99</a></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< node_type > queueFront</div><div class="ttdef"><b>Definition</b> <a href="../../d7/ded/queue_8hpp_source.html#l00097">queue.hpp:97</a></div></div>
|
||||
</div><!-- fragment -->
|
||||
</div>
|
||||
</div>
|
||||
@@ -241,22 +304,19 @@ template<class ValueType > </div>
|
||||
<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>
|
||||
<tr><td class="paramname">std::invalid_argument</td><td>if queue is empty </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="../../d7/ded/queue_8hpp_source.html#l00081">81</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"> 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>->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 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> <a href="../../d7/ded/queue_8hpp_source.html#l00038">queue.hpp:38</a></div></div>
|
||||
</div><!-- fragment -->
|
||||
</div>
|
||||
</div>
|
||||
<a id="a353e4dd5772575905c78b0b30856e368" name="a353e4dd5772575905c78b0b30856e368"></a>
|
||||
@@ -284,14 +344,15 @@ template<class ValueType > </div>
|
||||
</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>
|
||||
<p>prints the queue into the std::cout </p>
|
||||
|
||||
<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> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> << <span class="stringliteral">"Front --> "</span>;</div>
|
||||
<div class="line"><span class="lineno"> 18</span> std::cout << <span class="stringliteral">"Front --> "</span>;</div>
|
||||
<div class="line"><span class="lineno"> 19</span> display_all(this-><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> << <span class="charliteral">'\n'</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> << <span class="stringliteral">"Size of queue: "</span> << size << <span class="charliteral">'\n'</span>;</div>
|
||||
<div class="line"><span class="lineno"> 20</span> std::cout << <span class="charliteral">'\n'</span>;</div>
|
||||
<div class="line"><span class="lineno"> 21</span> std::cout << <span class="stringliteral">"Size of queue: "</span> << size << <span class="charliteral">'\n'</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>
|
||||
@@ -321,8 +382,10 @@ template<class ValueType > </div>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>inserts a new item into the queue </p>
|
||||
|
||||
<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 = <a class="code hl_functionRef" target="_blank" href="http://en.cppreference.com/w/cpp/memory/shared_ptr/make_shared.html">std::make_shared<node_type></a>();</div>
|
||||
<div class="line"><span class="lineno"> 55</span> <span class="keyword">auto</span> newNode = std::make_shared<node_type>();</div>
|
||||
<div class="line"><span class="lineno"> 56</span> newNode->data = item;</div>
|
||||
<div class="line"><span class="lineno"> 57</span> newNode->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>
|
||||
@@ -334,14 +397,8 @@ template<class ValueType > </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 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> <a href="../../d7/ded/queue_8hpp_source.html#l00049">queue.hpp:49</a></div></div>
|
||||
</div><!-- fragment -->
|
||||
</div>
|
||||
</div>
|
||||
<a id="ac08ebdd38cb4ad74fc0a3f51888da604" name="ac08ebdd38cb4ad74fc0a3f51888da604"></a>
|
||||
@@ -372,22 +429,18 @@ template<class ValueType > </div>
|
||||
<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>
|
||||
<tr><td class="paramname">std::invalid_argument</td><td>if queue is empty </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<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> <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">"Queue is empty."</span>);</div>
|
||||
<div class="line"><span class="lineno"> 40</span> <span class="keywordflow">throw</span> std::invalid_argument(<span class="stringliteral">"Queue is empty."</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><!-- fragment -->
|
||||
</div>
|
||||
</div>
|
||||
<a id="a75e231798bc706b8b0773a07f78713e7" name="a75e231798bc706b8b0773a07f78713e7"></a>
|
||||
@@ -417,20 +470,17 @@ template<class ValueType > </div>
|
||||
<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>
|
||||
<tr><td class="paramname">std::invalid_argument</td><td>if queue is empty </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="../../d7/ded/queue_8hpp_source.html#l00072">72</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"> 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>->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><!-- fragment -->
|
||||
</div>
|
||||
</div>
|
||||
<a id="a4bc52ad6ed6b0cc33ad05f87f05f8bec" name="a4bc52ad6ed6b0cc33ad05f87f05f8bec"></a>
|
||||
@@ -460,6 +510,8 @@ template<class ValueType > </div>
|
||||
|
||||
<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>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="../../d7/ded/queue_8hpp_source.html#l00049">49</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"> 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>
|
||||
@@ -476,7 +528,7 @@ template<class ValueType > </div>
|
||||
<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>< value_type > <a class="el" href="../../db/da9/classqueue.html">queue</a>< ValueType >::toVector </td>
|
||||
<td class="memname">std::vector< value_type > <a class="el" href="../../db/da9/classqueue.html">queue</a>< ValueType >::toVector </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||||
<td> const</td>
|
||||
@@ -489,8 +541,10 @@ template<class ValueType > </div>
|
||||
</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>
|
||||
<p>converts the queue into the std::vector </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>std::vector containning all of the elements of the queue in the same order </dd></dl>
|
||||
|
||||
<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-><a class="code hl_variable" href="#af6780e9b43326f557da405b65f7ad094">queueFront</a>.get(), this->size);</div>
|
||||
<div class="line"><span class="lineno"> 31</span> }</div>
|
||||
@@ -510,7 +564,7 @@ template<class ValueType > </div>
|
||||
<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><<a class="el" href="../../db/d8b/struct_node.html">node_type</a>> <a class="el" href="../../db/da9/classqueue.html">queue</a>< ValueType >::queueFront</td>
|
||||
<td class="memname">std::shared_ptr<<a class="el" href="../../db/d8b/struct_node.html">node_type</a>> <a class="el" href="../../db/da9/classqueue.html">queue</a>< ValueType >::queueFront</td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
@@ -522,7 +576,9 @@ template<class ValueType > </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">/**< Pointer to the front of the queue */</span></div>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="../../d7/ded/queue_8hpp_source.html#l00097">97</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"> 98</span> {}; </div>
|
||||
</div><!-- fragment -->
|
||||
</div>
|
||||
</div>
|
||||
@@ -538,7 +594,7 @@ template<class ValueType > </div>
|
||||
<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><<a class="el" href="../../db/d8b/struct_node.html">node_type</a>> <a class="el" href="../../db/da9/classqueue.html">queue</a>< ValueType >::queueRear</td>
|
||||
<td class="memname">std::shared_ptr<<a class="el" href="../../db/d8b/struct_node.html">node_type</a>> <a class="el" href="../../db/da9/classqueue.html">queue</a>< ValueType >::queueRear</td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
@@ -551,8 +607,36 @@ template<class ValueType > </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">/**< Pointer to the rear of the queue */</span></div>
|
||||
|
||||
<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>
|
||||
</div><!-- fragment -->
|
||||
</div>
|
||||
</div>
|
||||
<a id="ad30c1f3cc9c107dcc10fc06c8580354e" name="ad30c1f3cc9c107dcc10fc06c8580354e"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ad30c1f3cc9c107dcc10fc06c8580354e">◆ </a></span>size</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<div class="memtemplate">
|
||||
template<class ValueType > </div>
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">std::size_t <a class="el" href="../../db/da9/classqueue.html">queue</a>< ValueType >::size = 0</td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="../../d7/ded/queue_8hpp_source.html#l00101">101</a> of file <a class="el" href="../../d7/ded/queue_8hpp_source.html">queue.hpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<hr/>The documentation for this class was generated from the following file:<ul>
|
||||
|
||||
Reference in New Issue
Block a user