Documentation for e44943aadb

This commit is contained in:
github-actions
2020-10-28 17:27:18 +00:00
parent da35a543e7
commit d31d6ec33e
218 changed files with 5568 additions and 4450 deletions

View File

@@ -0,0 +1,257 @@
<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Algorithms_in_C++: /Users/runner/work/C-Plus-Plus/C-Plus-Plus/sorting/wiggle_sort.cpp</title>
<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>
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<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>
<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>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Algorithms_in_C++
&#160;<span id="projectnumber">1.0.0</span>
</div>
<div id="projectbrief">Set of algorithms implemented in C++.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
/* @license-end */
</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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('dd/db0/_2_users_2runner_2work_2_c-_plus-_plus_2_c-_plus-_plus_2sorting_2wiggle_sort_8cpp-example.html','../../'); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">/Users/runner/work/C-Plus-Plus/C-Plus-Plus/sorting/wiggle_sort.cpp</div> </div>
</div><!--header-->
<div class="contents">
<p>arr = [1,1,5,6,1,4], after wiggle sort arr will become equal to [1,1,6,1,5,4] arr = [2,8,9,1,7], after wiggle sort arr will become equal to [8,2,9,1,7]</p>
<div class="fragment"><div class="line"><span class="comment">/**</span></div>
<div class="line"><span class="comment"> * \addtogroup sorting Sorting Algorithms</span></div>
<div class="line"><span class="comment"> * @{</span></div>
<div class="line"><span class="comment"> * \file</span></div>
<div class="line"><span class="comment"> * \brief [Wiggle Sort Algorithm]</span></div>
<div class="line"><span class="comment"> * (https://leetcode.com/problems/wiggle-sort-ii/) Implementation</span></div>
<div class="line"><span class="comment"> *</span></div>
<div class="line"><span class="comment"> * \author [Roshan Kanwar](http://github.com/roshan0708)</span></div>
<div class="line"><span class="comment"> *</span></div>
<div class="line"><span class="comment"> * \details</span></div>
<div class="line"><span class="comment"> * Wiggle Sort sorts the array into a wave like array.</span></div>
<div class="line"><span class="comment"> * An array arr[0..n-1] is sorted in wave form,</span></div>
<div class="line"><span class="comment"> * if arr[0] &gt;= arr[1] &lt;= arr[2] &gt;= arr[3] &lt;= arr[4] &gt;= …..</span></div>
<div class="line"><span class="comment"> *</span></div>
<div class="line"><span class="comment"> * \example</span></div>
<div class="line"><span class="comment"> * arr = [1,1,5,6,1,4], after wiggle sort arr will become equal to [1,1,6,1,5,4]</span></div>
<div class="line"><span class="comment"> * arr = [2,8,9,1,7], after wiggle sort arr will become equal to [8,2,9,1,7]</span></div>
<div class="line"><span class="comment"> */</span></div>
<div class="line"> </div>
<div class="line"><span class="preprocessor">#include &lt;iostream&gt;</span> <span class="comment">/// for io operations</span></div>
<div class="line"><span class="comment"></span><span class="preprocessor">#include &lt;algorithm&gt;</span></div>
<div class="line"><span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><span class="preprocessor">#include &lt;cassert&gt;</span></div>
<div class="line"><span class="preprocessor">#include &lt;ctime&gt;</span></div>
<div class="line"><span class="comment"></span> </div>
<div class="line"><span class="comment">/**</span></div>
<div class="line"><span class="comment"> * @namespace sorting</span></div>
<div class="line"><span class="comment"> * @brief Sorting algorithms</span></div>
<div class="line"><span class="comment"> */</span></div>
<div class="line"><span class="keyword">namespace </span><a class="code" href="../../d5/d91/namespacesorting.html">sorting</a> {<span class="comment"></span></div>
<div class="line"><span class="comment"> /**</span></div>
<div class="line"><span class="comment"> * @namespace wiggle_sort</span></div>
<div class="line"><span class="comment"> * @brief Functions for [Wiggle Sort](https://leetcode.com/problems/wiggle-sort-ii/) algorithm</span></div>
<div class="line"><span class="comment"> */</span></div>
<div class="line"> <span class="keyword">namespace </span><a class="code" href="../../d0/d52/namespacewiggle__sort.html">wiggle_sort</a> {</div>
<div class="line"><span class="comment"></span> </div>
<div class="line"><span class="comment"> /**</span></div>
<div class="line"><span class="comment"> *</span></div>
<div class="line"><span class="comment"> * @brief Function used for sorting the elements in wave form.</span></div>
<div class="line"><span class="comment"> * @details</span></div>
<div class="line"><span class="comment"> * Checking whether the even indexed elements are greater than</span></div>
<div class="line"><span class="comment"> * their adjacent odd elements.</span></div>
<div class="line"><span class="comment"> * Traversing all even indexed elements of the input arr.</span></div>
<div class="line"><span class="comment"> * If current element is smaller than the previous odd element, swap them.</span></div>
<div class="line"><span class="comment"> * If current element is smaller than the next odd element, swap them.</span></div>
<div class="line"><span class="comment"> *</span></div>
<div class="line"><span class="comment"> * @param arr input array (unsorted elements)</span></div>
<div class="line"><span class="comment"> *</span></div>
<div class="line"><span class="comment"> */</span></div>
<div class="line"> <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt; <span class="comment">// this allows to have vectors of ints, double, float, etc</span></div>
<div class="line"> <a name="_a0"></a><a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector&lt;T&gt;</a> <a name="a1"></a><a class="code" href="../../d1/dcc/wiggle__sort_8cpp.html#a52955ecf8669ff6c5b9b1e66bd7db41d">wiggleSort</a>(<span class="keyword">const</span> <a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector&lt;T&gt;</a>&amp; arr) {</div>
<div class="line"> </div>
<div class="line"> uint32_t size = arr.<a name="a2"></a><a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector/size.html">size</a>();</div>
<div class="line"> </div>
<div class="line"> <a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector&lt;T&gt;</a> out(arr); <span class="comment">// create a copy of input vector. this way, the original input vector does not get modified. a sorted array is is returned.</span></div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">for</span>(<span class="keywordtype">int</span> i = 0; i &lt; size ; i +=2) {</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span>(i &gt; 0 &amp;&amp; out[i-1] &gt; out[i]) {</div>
<div class="line"> <a name="a3"></a><a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/algorithm/swap.html">std::swap</a>(out[i],out[i-1]); <span class="comment">//swapping the two values</span></div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span>(i &lt; size - 1 &amp;&amp; out[i] &lt; out[i+1]) {</div>
<div class="line"> <a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/algorithm/swap.html">std::swap</a>(out[i],out[i+1]); <span class="comment">//swapping the two values</span></div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">return</span> out; <span class="comment">//returns the sorted vector</span></div>
<div class="line"> </div>
<div class="line"> }</div>
<div class="line"> } <span class="comment">// namespace wiggle_sort</span></div>
<div class="line">} <span class="comment">// namespace sorting</span></div>
<div class="line"><span class="comment"></span> </div>
<div class="line"><span class="comment">/**</span></div>
<div class="line"><span class="comment"> *</span></div>
<div class="line"><span class="comment"> * @brief Utility function used for printing the elements.</span></div>
<div class="line"><span class="comment"> * Prints elements of the array after they&#39;re sorted using wiggle sort algorithm.</span></div>
<div class="line"><span class="comment"> *</span></div>
<div class="line"><span class="comment"> * @param arr array containing the sorted elements</span></div>
<div class="line"><span class="comment"> *</span></div>
<div class="line"><span class="comment"> */</span></div>
<div class="line"><span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><span class="keyword">static</span> <span class="keywordtype">void</span> <a name="a4"></a><a class="code" href="../../d5/d4c/group__sorting.html#ga135e4c638e3bcf548bd122b5f49a3e72">displayElements</a>(<span class="keyword">const</span> <a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector&lt;T&gt;</a> &amp;arr) {</div>
<div class="line"> </div>
<div class="line"> uint32_t size = arr.<a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector/size.html">size</a>();</div>
<div class="line"> </div>
<div class="line"> <a name="_a5"></a><a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> &lt;&lt; <span class="stringliteral">&quot;Sorted elements are as follows: &quot;</span>;</div>
<div class="line"> </div>
<div class="line"> <a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> &lt;&lt; <span class="stringliteral">&quot;[&quot;</span>;</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">for</span>(<span class="keywordtype">int</span> i = 0 ; i &lt; size ; i++ ) {</div>
<div class="line"> </div>
<div class="line"> <a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> &lt;&lt; arr[i] ;</div>
<div class="line"> <span class="keywordflow">if</span>(i != size - 1) {</div>
<div class="line"> <a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> &lt;&lt; <span class="stringliteral">&quot;, &quot;</span> ;</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> &lt;&lt; <span class="stringliteral">&quot;]&quot;</span>&lt;&lt;<a name="a6"></a><a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/manip/endl.html">std::endl</a>;</div>
<div class="line"> </div>
<div class="line">}</div>
<div class="line"><span class="comment"></span> </div>
<div class="line"><span class="comment">/**</span></div>
<div class="line"><span class="comment"> * Test function</span></div>
<div class="line"><span class="comment"> * @returns void</span></div>
<div class="line"><span class="comment"> */</span></div>
<div class="line"><span class="keyword">static</span> <span class="keywordtype">void</span> <a name="a7"></a><a class="code" href="../../dc/d5a/rat__maze_8cpp.html#aa8dca7b867074164d5f45b0f3851269d">test</a>() {</div>
<div class="line"> </div>
<div class="line"> <a name="a8"></a><a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/numeric/random/srand.html">std::srand</a>(<a name="a9"></a><a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/chrono/c/time.html">std::time</a>(<span class="keyword">nullptr</span>)); <span class="comment">// initialize random number generator</span></div>
<div class="line"> </div>
<div class="line"> <a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector&lt;float&gt;</a> data1(100);</div>
<div class="line"> <span class="keywordflow">for</span> (<span class="keyword">auto</span> &amp;d: data1) { <span class="comment">// generate random numbers between -5.0 and 4.99</span></div>
<div class="line"> d = float(<a name="a10"></a><a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/numeric/random/rand.html">std::rand</a>() % 1000 - 500) / 100.f;</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector&lt;float&gt;</a> sorted = sorting::wiggle_sort::wiggleSort&lt;float&gt;(data1);</div>
<div class="line"> </div>
<div class="line"> <a class="code" href="../../d5/d4c/group__sorting.html#ga135e4c638e3bcf548bd122b5f49a3e72">displayElements</a>(sorted);</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">for</span>(uint32_t j = 0; j &lt; data1.size(); j+=2) {</div>
<div class="line"> assert(data1[j] &lt;= data1[j+1] &amp;&amp; data1[j+1] &gt;= data1[j+2]); <span class="comment">// check the validation condition</span></div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> &lt;&lt; <span class="stringliteral">&quot;Test 1 passed\n&quot;</span>;</div>
<div class="line"> </div>
<div class="line">}</div>
<div class="line"><span class="comment"></span> </div>
<div class="line"><span class="comment">/** Driver Code */</span></div>
<div class="line"><span class="keywordtype">int</span> <a name="a11"></a><a class="code" href="../../d3/d40/graph__coloring_8cpp.html#gae66f6b31b5ad750f1fe042a706a4e3d4">main</a>() {</div>
<div class="line"> <a class="code" href="../../dc/d5a/rat__maze_8cpp.html#aa8dca7b867074164d5f45b0f3851269d">test</a>();</div>
<div class="line"> <span class="keywordflow">return</span> 0;</div>
<div class="line">}</div>
<div class="line"><span class="comment"></span> </div>
<div class="line"><span class="comment">/** @} */</span></div>
</div><!-- fragment --> </div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="asrand_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/numeric/random/srand.html">std::srand</a></div><div class="ttdeci">T srand(T... args)</div></div>
<div class="ttc" id="arat__maze_8cpp_html_aa8dca7b867074164d5f45b0f3851269d"><div class="ttname"><a href="../../dc/d5a/rat__maze_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> rat_maze.cpp:84</div></div>
<div class="ttc" id="avector_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a></div><div class="ttdoc">STL class.</div></div>
<div class="ttc" id="asize_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/container/vector/size.html">std::vector::size</a></div><div class="ttdeci">T size(T... args)</div></div>
<div class="ttc" id="anamespacesorting_html"><div class="ttname"><a href="../../d5/d91/namespacesorting.html">sorting</a></div><div class="ttdoc">Sorting algorithms.</div></div>
<div class="ttc" id="agraph__coloring_8cpp_html_gae66f6b31b5ad750f1fe042a706a4e3d4"><div class="ttname"><a href="../../d3/d40/graph__coloring_8cpp.html#gae66f6b31b5ad750f1fe042a706a4e3d4">main</a></div><div class="ttdeci">int main()</div><div class="ttdef"><b>Definition:</b> graph_coloring.cpp:96</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="agroup__sorting_html_ga135e4c638e3bcf548bd122b5f49a3e72"><div class="ttname"><a href="../../d5/d4c/group__sorting.html#ga135e4c638e3bcf548bd122b5f49a3e72">displayElements</a></div><div class="ttdeci">static void displayElements(const std::vector&lt; T &gt; &amp;arr)</div><div class="ttdoc">Utility function used for printing the elements. Prints elements of the array after they're sorted us...</div><div class="ttdef"><b>Definition:</b> wiggle_sort.cpp:84</div></div>
<div class="ttc" id="awiggle__sort_8cpp_html_a52955ecf8669ff6c5b9b1e66bd7db41d"><div class="ttname"><a href="../../d1/dcc/wiggle__sort_8cpp.html#a52955ecf8669ff6c5b9b1e66bd7db41d">sorting::wiggle_sort::wiggleSort</a></div><div class="ttdeci">std::vector&lt; T &gt; wiggleSort(const std::vector&lt; T &gt; &amp;arr)</div><div class="ttdoc">Function used for sorting the elements in wave form.</div><div class="ttdef"><b>Definition:</b> wiggle_sort.cpp:51</div></div>
<div class="ttc" id="arand_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/numeric/random/rand.html">std::rand</a></div><div class="ttdeci">T rand(T... args)</div></div>
<div class="ttc" id="aswap_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/algorithm/swap.html">std::swap</a></div><div class="ttdeci">T swap(T... args)</div></div>
<div class="ttc" id="aendl_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/io/manip/endl.html">std::endl</a></div><div class="ttdeci">T endl(T... args)</div></div>
<div class="ttc" id="anamespacewiggle__sort_html"><div class="ttname"><a href="../../d0/d52/namespacewiggle__sort.html">wiggle_sort</a></div><div class="ttdoc">Functions for Wiggle Sort algorithm.</div></div>
<div class="ttc" id="atime_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/chrono/c/time.html">std::time</a></div><div class="ttdeci">T time(T... args)</div></div>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li>
</ul>
</div>
</body>
</html>