Documentation for 8b1eab204b

This commit is contained in:
realstealthninja
2024-11-04 12:43:05 +00:00
parent 4fb6e622e9
commit a7bccf7d01
6732 changed files with 153919 additions and 365711 deletions

View File

@@ -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++: data_structures/queue_using_array.cpp File Reference</title>
<title>TheAlgorithms/C++: data_structures/queue_using_array.cpp File 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">&#160;1.0.0</span>
<div id="projectname">TheAlgorithms/C++<span id="projectnumber">&#160;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>
@@ -123,7 +140,9 @@ Include dependency graph for queue_using_array.cpp:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../d1/d6d/queue__using__array_8cpp__incl.svg" width="242" height="126"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div><table class="memberdecls">
</div>
<p><a href="../../d8/df0/queue__using__array_8cpp_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/d04/classdata__structures_1_1queue__using__array_1_1_queue___array.html">data_structures::queue_using_array::Queue_Array</a></td></tr>
@@ -148,7 +167,7 @@ Functions</h2></td></tr>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a2d49e79bd164c298912db252970520d8" id="r_a2d49e79bd164c298912db252970520d8"><td class="memItemLeft" align="right" valign="top">constexpr uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2d49e79bd164c298912db252970520d8">max_size</a> {10}</td></tr>
<tr class="memdesc:a2d49e79bd164c298912db252970520d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">for <a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/array.html">std::array</a> <br /></td></tr>
<tr class="memdesc:a2d49e79bd164c298912db252970520d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">for std::array <br /></td></tr>
<tr class="separator:a2d49e79bd164c298912db252970520d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
@@ -161,6 +180,8 @@ Algorithm</h3>
<dl class="section author"><dt>Author</dt><dd><a href="https://github.com/pooja-git11" target="_blank">Pooja</a> </dd>
<dd>
<a href="https://github.com/farbodahm" target="_blank">Farbod Ahmadian</a> </dd></dl>
<p class="definition">Definition in file <a class="el" href="../../d8/df0/queue__using__array_8cpp_source.html">queue_using_array.cpp</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="ae66f6b31b5ad750f1fe042a706a4e3d4" name="ae66f6b31b5ad750f1fe042a706a4e3d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae66f6b31b5ad750f1fe042a706a4e3d4">&#9670;&#160;</a></span>main()</h2>
@@ -179,49 +200,43 @@ Algorithm</h3>
<p>Main function. </p>
<p>Allows the user to add and delete values from the queue. Also allows user to display values in the queue. </p><dl class="section return"><dt>Returns</dt><dd>0 on exit </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d8/df0/queue__using__array_8cpp_source.html#l00112">112</a> of file <a class="el" href="../../d8/df0/queue__using__array_8cpp_source.html">queue_using_array.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 112</span> {</div>
<div class="line"><span class="lineno"> 113</span> <span class="keywordtype">int</span> op{0}, <a class="code hl_variable" href="../../d1/df3/hash__search_8cpp.html#a6e1a77282bc65ad359d753d25df23243">data</a>{0};</div>
<div class="line"><span class="lineno"> 114</span> <a class="code hl_class" href="../../d6/d04/classdata__structures_1_1queue__using__array_1_1_queue___array.html">data_structures::queue_using_array::Queue_Array</a> ob;</div>
<div class="line"><span class="lineno"> 115</span> </div>
<div class="line"><span class="lineno"> 116</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;\n1. enqueue(Insertion) &quot;</span>;</div>
<div class="line"><span class="lineno"> 117</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;\n2. dequeue(Deletion)&quot;</span>;</div>
<div class="line"><span class="lineno"> 118</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;\n3. Display&quot;</span>;</div>
<div class="line"><span class="lineno"> 119</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;\n4. Exit&quot;</span>;</div>
<div class="line"><span class="lineno"> 116</span> std::cout &lt;&lt; <span class="stringliteral">&quot;\n1. enqueue(Insertion) &quot;</span>;</div>
<div class="line"><span class="lineno"> 117</span> std::cout &lt;&lt; <span class="stringliteral">&quot;\n2. dequeue(Deletion)&quot;</span>;</div>
<div class="line"><span class="lineno"> 118</span> std::cout &lt;&lt; <span class="stringliteral">&quot;\n3. Display&quot;</span>;</div>
<div class="line"><span class="lineno"> 119</span> std::cout &lt;&lt; <span class="stringliteral">&quot;\n4. Exit&quot;</span>;</div>
<div class="line"><span class="lineno"> 120</span> <span class="keywordflow">while</span> (<span class="keyword">true</span>) {</div>
<div class="line"><span class="lineno"> 121</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;\nEnter your choice &quot;</span>;</div>
<div class="line"><span class="lineno"> 122</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_istream.html">std::cin</a> &gt;&gt; op;</div>
<div class="line"><span class="lineno"> 121</span> std::cout &lt;&lt; <span class="stringliteral">&quot;\nEnter your choice &quot;</span>;</div>
<div class="line"><span class="lineno"> 122</span> std::cin &gt;&gt; op;</div>
<div class="line"><span class="lineno"> 123</span> <span class="keywordflow">if</span> (op == 1) {</div>
<div class="line"><span class="lineno"> 124</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;Enter data &quot;</span>;</div>
<div class="line"><span class="lineno"> 125</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_istream.html">std::cin</a> &gt;&gt; <a class="code hl_variable" href="../../d1/df3/hash__search_8cpp.html#a6e1a77282bc65ad359d753d25df23243">data</a>;</div>
<div class="line"><span class="lineno"> 124</span> std::cout &lt;&lt; <span class="stringliteral">&quot;Enter data &quot;</span>;</div>
<div class="line"><span class="lineno"> 125</span> std::cin &gt;&gt; <a class="code hl_variable" href="../../d1/df3/hash__search_8cpp.html#a6e1a77282bc65ad359d753d25df23243">data</a>;</div>
<div class="line"><span class="lineno"> 126</span> ob.<a class="code hl_function" href="../../d6/d04/classdata__structures_1_1queue__using__array_1_1_queue___array.html#a4dc64488c36f84d927365fa8d1933663">enqueue</a>(<a class="code hl_variable" href="../../d1/df3/hash__search_8cpp.html#a6e1a77282bc65ad359d753d25df23243">data</a>);</div>
<div class="line"><span class="lineno"> 127</span> } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (op == 2) {</div>
<div class="line"><span class="lineno"> 128</span> <a class="code hl_variable" href="../../d1/df3/hash__search_8cpp.html#a6e1a77282bc65ad359d753d25df23243">data</a> = ob.<a class="code hl_function" href="../../d6/d04/classdata__structures_1_1queue__using__array_1_1_queue___array.html#a2aaf88c9954ef3ab686f8e4bfbd87622">dequeue</a>();</div>
<div class="line"><span class="lineno"> 129</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;\ndequeue element is:\t&quot;</span> &lt;&lt; <a class="code hl_variable" href="../../d1/df3/hash__search_8cpp.html#a6e1a77282bc65ad359d753d25df23243">data</a>;</div>
<div class="line"><span class="lineno"> 129</span> std::cout &lt;&lt; <span class="stringliteral">&quot;\ndequeue element is:\t&quot;</span> &lt;&lt; <a class="code hl_variable" href="../../d1/df3/hash__search_8cpp.html#a6e1a77282bc65ad359d753d25df23243">data</a>;</div>
<div class="line"><span class="lineno"> 130</span> } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (op == 3) {</div>
<div class="line"><span class="lineno"> 131</span> ob.<a class="code hl_function" href="../../d6/d04/classdata__structures_1_1queue__using__array_1_1_queue___array.html#a688b7ea064739ea9fa66bf64bf4ae631">display</a>();</div>
<div class="line"><span class="lineno"> 132</span> } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (op == 4) {</div>
<div class="line"><span class="lineno"> 133</span> <a class="code hl_functionRef" target="_blank" href="http://en.cppreference.com/w/cpp/utility/program/exit.html">exit</a>(0);</div>
<div class="line"><span class="lineno"> 133</span> exit(0);</div>
<div class="line"><span class="lineno"> 134</span> } <span class="keywordflow">else</span> {</div>
<div class="line"><span class="lineno"> 135</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;\nWrong choice &quot;</span>;</div>
<div class="line"><span class="lineno"> 135</span> std::cout &lt;&lt; <span class="stringliteral">&quot;\nWrong choice &quot;</span>;</div>
<div class="line"><span class="lineno"> 136</span> }</div>
<div class="line"><span class="lineno"> 137</span> }</div>
<div class="line"><span class="lineno"> 138</span> </div>
<div class="line"><span class="lineno"> 139</span> <span class="keywordflow">return</span> 0;</div>
<div class="line"><span class="lineno"> 140</span>}</div>
<div class="ttc" id="abasic_istream_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/io/basic_istream.html">std::cin</a></div></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 class="ttc" id="aclassdata__structures_1_1queue__using__array_1_1_queue___array_html"><div class="ttname"><a href="../../d6/d04/classdata__structures_1_1queue__using__array_1_1_queue___array.html">data_structures::queue_using_array::Queue_Array</a></div><div class="ttdoc">Queue_Array class containing the main data and also index of head and tail of the array.</div><div class="ttdef"><b>Definition</b> queue_using_array.cpp:44</div></div>
<div class="ttc" id="aclassdata__structures_1_1queue__using__array_1_1_queue___array_html_a2aaf88c9954ef3ab686f8e4bfbd87622"><div class="ttname"><a href="../../d6/d04/classdata__structures_1_1queue__using__array_1_1_queue___array.html#a2aaf88c9954ef3ab686f8e4bfbd87622">data_structures::queue_using_array::Queue_Array::dequeue</a></div><div class="ttdeci">int dequeue()</div><div class="ttdoc">Delete element from back of the queue.</div><div class="ttdef"><b>Definition</b> queue_using_array.cpp:76</div></div>
<div class="ttc" id="aclassdata__structures_1_1queue__using__array_1_1_queue___array_html_a4dc64488c36f84d927365fa8d1933663"><div class="ttname"><a href="../../d6/d04/classdata__structures_1_1queue__using__array_1_1_queue___array.html#a4dc64488c36f84d927365fa8d1933663">data_structures::queue_using_array::Queue_Array::enqueue</a></div><div class="ttdeci">void enqueue(const int16_t &amp;)</div><div class="ttdoc">Add element to the first of the queue.</div><div class="ttdef"><b>Definition</b> queue_using_array.cpp:59</div></div>
<div class="ttc" id="aclassdata__structures_1_1queue__using__array_1_1_queue___array_html_a688b7ea064739ea9fa66bf64bf4ae631"><div class="ttname"><a href="../../d6/d04/classdata__structures_1_1queue__using__array_1_1_queue___array.html#a688b7ea064739ea9fa66bf64bf4ae631">data_structures::queue_using_array::Queue_Array::display</a></div><div class="ttdeci">void display() const</div><div class="ttdoc">Show all saved data.</div><div class="ttdef"><b>Definition</b> queue_using_array.cpp:94</div></div>
<div class="ttc" id="aexit_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/program/exit.html">std::exit</a></div><div class="ttdeci">T exit(T... args)</div></div>
<div class="ttc" id="ahash__search_8cpp_html_a6e1a77282bc65ad359d753d25df23243"><div class="ttname"><a href="../../d1/df3/hash__search_8cpp.html#a6e1a77282bc65ad359d753d25df23243">data</a></div><div class="ttdeci">int data[MAX]</div><div class="ttdoc">test data</div><div class="ttdef"><b>Definition</b> hash_search.cpp:24</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="../../d8/df0/queue__using__array_8cpp_ae66f6b31b5ad750f1fe042a706a4e3d4_cgraph.svg" width="444" height="227"><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="aclassdata__structures_1_1queue__using__array_1_1_queue___array_html"><div class="ttname"><a href="../../d6/d04/classdata__structures_1_1queue__using__array_1_1_queue___array.html">data_structures::queue_using_array::Queue_Array</a></div><div class="ttdoc">Queue_Array class containing the main data and also index of head and tail of the array.</div><div class="ttdef"><b>Definition</b> <a href="../../d8/df0/queue__using__array_8cpp_source.html#l00044">queue_using_array.cpp:44</a></div></div>
<div class="ttc" id="aclassdata__structures_1_1queue__using__array_1_1_queue___array_html_a2aaf88c9954ef3ab686f8e4bfbd87622"><div class="ttname"><a href="../../d6/d04/classdata__structures_1_1queue__using__array_1_1_queue___array.html#a2aaf88c9954ef3ab686f8e4bfbd87622">data_structures::queue_using_array::Queue_Array::dequeue</a></div><div class="ttdeci">int dequeue()</div><div class="ttdoc">Delete element from back of the queue.</div><div class="ttdef"><b>Definition</b> <a href="../../d8/df0/queue__using__array_8cpp_source.html#l00076">queue_using_array.cpp:76</a></div></div>
<div class="ttc" id="aclassdata__structures_1_1queue__using__array_1_1_queue___array_html_a4dc64488c36f84d927365fa8d1933663"><div class="ttname"><a href="../../d6/d04/classdata__structures_1_1queue__using__array_1_1_queue___array.html#a4dc64488c36f84d927365fa8d1933663">data_structures::queue_using_array::Queue_Array::enqueue</a></div><div class="ttdeci">void enqueue(const int16_t &amp;)</div><div class="ttdoc">Add element to the first of the queue.</div><div class="ttdef"><b>Definition</b> <a href="../../d8/df0/queue__using__array_8cpp_source.html#l00059">queue_using_array.cpp:59</a></div></div>
<div class="ttc" id="aclassdata__structures_1_1queue__using__array_1_1_queue___array_html_a688b7ea064739ea9fa66bf64bf4ae631"><div class="ttname"><a href="../../d6/d04/classdata__structures_1_1queue__using__array_1_1_queue___array.html#a688b7ea064739ea9fa66bf64bf4ae631">data_structures::queue_using_array::Queue_Array::display</a></div><div class="ttdeci">void display() const</div><div class="ttdoc">Show all saved data.</div><div class="ttdef"><b>Definition</b> <a href="../../d8/df0/queue__using__array_8cpp_source.html#l00094">queue_using_array.cpp:94</a></div></div>
<div class="ttc" id="ahash__search_8cpp_html_a6e1a77282bc65ad359d753d25df23243"><div class="ttname"><a href="../../d1/df3/hash__search_8cpp.html#a6e1a77282bc65ad359d753d25df23243">data</a></div><div class="ttdeci">int data[MAX]</div><div class="ttdoc">test data</div><div class="ttdef"><b>Definition</b> <a href="../../d1/df3/hash__search_8cpp_source.html#l00024">hash_search.cpp:24</a></div></div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
@@ -245,9 +260,11 @@ Here is the call graph for this function:</div>
</table>
</div><div class="memdoc">
<p>for <a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/array.html">std::array</a> </p>
<p>for std::array </p>
<p>for io operations Maximum size of the queue </p>
<div class="fragment"><div class="line"><span class="lineno"> 24</span>{10}; <span class="comment">///&lt; Maximum size of the queue</span></div>
<p class="definition">Definition at line <a class="el" href="../../d8/df0/queue__using__array_8cpp_source.html#l00024">24</a> of file <a class="el" href="../../d8/df0/queue__using__array_8cpp_source.html">queue_using_array.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 24</span>{10}; </div>
</div><!-- fragment -->
</div>
</div>