Documentation for e813f9b2a6

This commit is contained in:
github-actions
2021-02-05 10:11:27 +00:00
parent e044750129
commit 3d06b0aa77
406 changed files with 7862 additions and 6611 deletions

View File

@@ -92,35 +92,165 @@ $(document).ready(function(){initNavTree('d7/d00/list__array_8cpp.html','../../'
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">list_array.cpp File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;array&gt;</code><br />
<code>#include &lt;iostream&gt;</code><br />
<p><a href="https://en.wikipedia.org/wiki/Dynamic_array">Dynamic Array</a>
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;iostream&gt;</code><br />
<code>#include &lt;array&gt;</code><br />
<code>#include &lt;cassert&gt;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for list_array.cpp:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../dd/d4d/list__array_8cpp__incl.svg" width="158" height="127"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
<div class="center"><iframe scrolling="no" frameborder="0" src="../../dd/d4d/list__array_8cpp__incl.svg" width="248" height="127"><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">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d10/structlist.html">list</a></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/dab/structdata__structures_1_1list__array_1_1list.html">data_structures::list_array::list</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Structure of List with supporting methods. <a href="../../d5/dab/structdata__structures_1_1list__array_1_1list.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:d5/d3c/namespacedata__structures"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d3c/namespacedata__structures.html">data_structures</a></td></tr>
<tr class="memdesc:d5/d3c/namespacedata__structures"><td class="mdescLeft">&#160;</td><td class="mdescRight">Data Structures algorithms. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:d9/d27/namespacelist__array"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/d27/namespacelist__array.html">list_array</a></td></tr>
<tr class="memdesc:d9/d27/namespacelist__array"><td class="mdescLeft">&#160;</td><td class="mdescRight">Functions for <a href="https://en.wikipedia.org/wiki/Dynamic_array">Dynamic Array</a> algorithm. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="memItemLeft" align="right" valign="top"><a id="ae66f6b31b5ad750f1fe042a706a4e3d4"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>main</b> ()</td></tr>
<tr class="memitem:aa8dca7b867074164d5f45b0f3851269d"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d00/list__array_8cpp.html#aa8dca7b867074164d5f45b0f3851269d">test</a> ()</td></tr>
<tr class="memdesc:aa8dca7b867074164d5f45b0f3851269d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test implementations. <a href="../../d7/d00/list__array_8cpp.html#aa8dca7b867074164d5f45b0f3851269d">More...</a><br /></td></tr>
<tr class="separator:aa8dca7b867074164d5f45b0f3851269d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d00/list__array_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a> ()</td></tr>
<tr class="memdesc:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main function. <a href="../../d7/d00/list__array_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">More...</a><br /></td></tr>
<tr class="separator:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><dl class="todo"><dt><b><a class="el" href="../../dd/da0/todo.html#_todo000004">Todo:</a></b></dt><dd>Add documentation </dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>The sorting algorithm is erroneous </dd></dl>
</div></div><!-- contents -->
<div class="textblock"><p><a href="https://en.wikipedia.org/wiki/Dynamic_array">Dynamic Array</a> </p>
<p>The <a class="el" href="../../d9/d27/namespacelist__array.html" title="Functions for Dynamic Array algorithm.">list_array</a> is the implementation of list represented using array. We can perform basic CRUD operations as well as other operations like sorting etc.</p>
<h3><a class="anchor" id="autotoc_md28"></a>
Algorithm</h3>
<p>It implements various method like insert, sort, search etc. efficiently. You can select the operation and methods will do the rest work for you. You can insert element, sort them in order, search efficiently, delete values and print the list. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="ae66f6b31b5ad750f1fe042a706a4e3d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae66f6b31b5ad750f1fe042a706a4e3d4">&#9670;&nbsp;</a></span>main()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int main </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Main function. </p>
<dl class="section return"><dt>Returns</dt><dd>0 on exit </dd></dl>
<div class="fragment"><div class="line"><a name="l00247"></a><span class="lineno"> 247</span>&#160; {</div>
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span>&#160; <a class="code" href="../../d7/d00/list__array_8cpp.html#aa8dca7b867074164d5f45b0f3851269d">test</a>(); <span class="comment">// Execute the tests</span></div>
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span>&#160; <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l00250"></a><span class="lineno"> 250</span>&#160;}</div>
<div class="ttc" id="alist__array_8cpp_html_aa8dca7b867074164d5f45b0f3851269d"><div class="ttname"><a href="../../d7/d00/list__array_8cpp.html#aa8dca7b867074164d5f45b0f3851269d">test</a></div><div class="ttdeci">static void test()</div><div class="ttdoc">Test implementations.</div><div class="ttdef"><b>Definition:</b> list_array.cpp:205</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="../../d7/d00/list__array_8cpp_ae66f6b31b5ad750f1fe042a706a4e3d4_cgraph.svg" width="466" height="248"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</div>
</div>
<a id="aa8dca7b867074164d5f45b0f3851269d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8dca7b867074164d5f45b0f3851269d">&#9670;&nbsp;</a></span>test()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void test </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Test implementations. </p>
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
<div class="fragment"><div class="line"><a name="l00205"></a><span class="lineno"> 205</span>&#160; {</div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span>&#160; <a class="code" href="../../d5/dab/structdata__structures_1_1list__array_1_1list.html">data_structures::list_array::list</a> L;</div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>&#160; </div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span>&#160; <span class="comment">// Insert testing</span></div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>&#160; L.<a class="code" href="../../d5/dab/structdata__structures_1_1list__array_1_1list.html#a0f44d5e3a52d35f8ff23ace9569c6305">insert</a>(11);</div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span>&#160; L.<a class="code" href="../../d5/dab/structdata__structures_1_1list__array_1_1list.html#a0f44d5e3a52d35f8ff23ace9569c6305">insert</a>(12);</div>
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span>&#160; assert(L.top == 2);</div>
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span>&#160; L.<a class="code" href="../../d5/dab/structdata__structures_1_1list__array_1_1list.html#a0f44d5e3a52d35f8ff23ace9569c6305">insert</a>(15);</div>
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span>&#160; L.<a class="code" href="../../d5/dab/structdata__structures_1_1list__array_1_1list.html#a0f44d5e3a52d35f8ff23ace9569c6305">insert</a>(10);</div>
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span>&#160; L.<a class="code" href="../../d5/dab/structdata__structures_1_1list__array_1_1list.html#a0f44d5e3a52d35f8ff23ace9569c6305">insert</a>(12);</div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span>&#160; L.<a class="code" href="../../d5/dab/structdata__structures_1_1list__array_1_1list.html#a0f44d5e3a52d35f8ff23ace9569c6305">insert</a>(20);</div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span>&#160; L.<a class="code" href="../../d5/dab/structdata__structures_1_1list__array_1_1list.html#a0f44d5e3a52d35f8ff23ace9569c6305">insert</a>(18);</div>
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span>&#160; assert(L.top == 7);</div>
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span>&#160; L.<a class="code" href="../../d5/dab/structdata__structures_1_1list__array_1_1list.html#ae5c15d93819c4e437ebb7a1b41f2d594">show</a>(); <span class="comment">// To print the array</span></div>
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span>&#160; </div>
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span>&#160; <span class="comment">// Remove testing</span></div>
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span>&#160; L.<a class="code" href="../../d5/dab/structdata__structures_1_1list__array_1_1list.html#a0499455a80156134cc79c98eabb376d9">remove</a>(12); <span class="comment">// Remove Duplicate value in the list</span></div>
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span>&#160; L.<a class="code" href="../../d5/dab/structdata__structures_1_1list__array_1_1list.html#a0499455a80156134cc79c98eabb376d9">remove</a>(15); <span class="comment">// Remove the existing value in the list</span></div>
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span>&#160; assert(L.top == 5);</div>
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span>&#160; L.<a class="code" href="../../d5/dab/structdata__structures_1_1list__array_1_1list.html#a0499455a80156134cc79c98eabb376d9">remove</a>(50); <span class="comment">// Try to remove the non-existing value in the list</span></div>
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span>&#160; assert(L.top == 5);</div>
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span>&#160; </div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span>&#160; <span class="comment">// LinearSearch testing</span></div>
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span>&#160; assert(L.search(11) == 0); <span class="comment">// search for the existing element</span></div>
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span>&#160; assert(L.search(12) == 2);</div>
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span>&#160; assert(L.search(50) == -1); <span class="comment">// search for the non-existing element</span></div>
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span>&#160; </div>
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span>&#160; <span class="comment">// Sort testing</span></div>
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span>&#160; L.<a class="code" href="../../d5/dab/structdata__structures_1_1list__array_1_1list.html#a39a712c8413b0d7861695ec019474469">sort</a>();</div>
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span>&#160; assert(L.isSorted == <span class="keyword">true</span>);</div>
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span>&#160; L.<a class="code" href="../../d5/dab/structdata__structures_1_1list__array_1_1list.html#ae5c15d93819c4e437ebb7a1b41f2d594">show</a>();</div>
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span>&#160; </div>
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span>&#160; <span class="comment">// BinarySearch testing</span></div>
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span>&#160; assert(L.search(11) == 1); <span class="comment">// search for the existing element</span></div>
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span>&#160; assert(L.search(12) == 2);</div>
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span>&#160; assert(L.search(50) == -1); <span class="comment">// search for the non-existing element</span></div>
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span>&#160;}</div>
<div class="ttc" id="astructdata__structures_1_1list__array_1_1list_html"><div class="ttname"><a href="../../d5/dab/structdata__structures_1_1list__array_1_1list.html">data_structures::list_array::list</a></div><div class="ttdoc">Structure of List with supporting methods.</div><div class="ttdef"><b>Definition:</b> list_array.cpp:32</div></div>
<div class="ttc" id="astructdata__structures_1_1list__array_1_1list_html_a0499455a80156134cc79c98eabb376d9"><div class="ttname"><a href="../../d5/dab/structdata__structures_1_1list__array_1_1list.html#a0499455a80156134cc79c98eabb376d9">data_structures::list_array::list::remove</a></div><div class="ttdeci">void remove(const uint64_t &amp;val)</div><div class="ttdoc">To remove the element from the list.</div><div class="ttdef"><b>Definition:</b> list_array.cpp:171</div></div>
<div class="ttc" id="astructdata__structures_1_1list__array_1_1list_html_a0f44d5e3a52d35f8ff23ace9569c6305"><div class="ttname"><a href="../../d5/dab/structdata__structures_1_1list__array_1_1list.html#a0f44d5e3a52d35f8ff23ace9569c6305">data_structures::list_array::list::insert</a></div><div class="ttdeci">void insert(const uint64_t &amp;val)</div><div class="ttdoc">Insert the new element in the list.</div><div class="ttdef"><b>Definition:</b> list_array.cpp:132</div></div>
<div class="ttc" id="astructdata__structures_1_1list__array_1_1list_html_a39a712c8413b0d7861695ec019474469"><div class="ttname"><a href="../../d5/dab/structdata__structures_1_1list__array_1_1list.html#a39a712c8413b0d7861695ec019474469">data_structures::list_array::list::sort</a></div><div class="ttdeci">void sort()</div><div class="ttdoc">Sort the list.</div><div class="ttdef"><b>Definition:</b> list_array.cpp:110</div></div>
<div class="ttc" id="astructdata__structures_1_1list__array_1_1list_html_ae5c15d93819c4e437ebb7a1b41f2d594"><div class="ttname"><a href="../../d5/dab/structdata__structures_1_1list__array_1_1list.html#ae5c15d93819c4e437ebb7a1b41f2d594">data_structures::list_array::list::show</a></div><div class="ttdeci">void show()</div><div class="ttdoc">Utility function to print array.</div><div class="ttdef"><b>Definition:</b> list_array.cpp:190</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="../../d7/d00/list__array_8cpp_aa8dca7b867074164d5f45b0f3851269d_cgraph.svg" width="367" height="248"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->