backup/C-Plus-Plus
1
0
Fork 0
mirror of https://github.com/TheAlgorithms/C-Plus-Plus.git synced 2026-03-21 04:18:34 +08:00
Code Issues Projects Releases Wiki Activity
Files
c7a9a423978c7b19fa9d19302d875bb995b81038
C-Plus-Plus/de/dcd/kadanes3_8cpp.html
realstealthninja a7bccf7d01 Documentation for 8b1eab204b
2024-11-04 12:43:05 +00:00

314 lines
19 KiB
HTML
Raw Blame History

<!-- 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>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>TheAlgorithms/C++: others/kadanes3.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>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../cookie.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/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" 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! -->
<div id="titlearea">
<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">TheAlgorithms/C++<span id="projectnumber">&#160;1.0.0</span>
</div>
<div id="projectbrief">All the algorithms implemented in C++</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "../../search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(1); });
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('../../',true,false,'search.php','Search',true);
$(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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('de/dcd/kadanes3_8cpp.html','../../'); initResizable(true); });
/* @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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">kadanes3.cpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Efficient implementation for maximum contiguous subarray sum by <a href="https://www.geeksforgeeks.org/largest-sum-contiguous-subarray/" target="_blank">Kadane's algorithm</a>.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;array&gt;</code><br />
<code>#include &lt;cassert&gt;</code><br />
<code>#include &lt;climits&gt;</code><br />
<code>#include &lt;cstdint&gt;</code><br />
<code>#include &lt;iostream&gt;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for kadanes3.cpp:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../d3/dbb/kadanes3_8cpp__incl.svg" width="412" height="111"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
<p><a href="../../de/dcd/kadanes3_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="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a338439a04148ae89f695595acfa5c147" id="r_a338439a04148ae89f695595acfa5c147"><td class="memTemplParams" colspan="2">template&lt;std::size_t SIZE&gt; </td></tr>
<tr class="memitem:a338439a04148ae89f695595acfa5c147"><td class="memTemplItemLeft" align="right" valign="top">int&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a338439a04148ae89f695595acfa5c147">max_subarray_sum</a> (std::array&lt; int64_t, SIZE &gt; arr, uint64_t length)</td></tr>
<tr class="memdesc:a338439a04148ae89f695595acfa5c147"><td class="mdescLeft">&#160;</td><td class="mdescRight">for IO operations <br /></td></tr>
<tr class="separator:a338439a04148ae89f695595acfa5c147"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8dca7b867074164d5f45b0f3851269d" id="r_aa8dca7b867074164d5f45b0f3851269d"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa8dca7b867074164d5f45b0f3851269d">test</a> ()</td></tr>
<tr class="memdesc:aa8dca7b867074164d5f45b0f3851269d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Self-test implementations. <br /></td></tr>
<tr class="separator:aa8dca7b867074164d5f45b0f3851269d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae66f6b31b5ad750f1fe042a706a4e3d4" id="r_ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a> ()</td></tr>
<tr class="memdesc:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main function. <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"><p>Efficient implementation for maximum contiguous subarray sum by <a href="https://www.geeksforgeeks.org/largest-sum-contiguous-subarray/" target="_blank">Kadane's algorithm</a>. </p>
<p>Our task is to take length of array and then the whole array as input from the user and then calculate the maximum contiguos subarray sum for the input array, using the kadane's algorithm.</p>
<p>There can be a case that all the elements in the input array are negative. In that case, the least value among all elements is the maximum sum with subarray length = 1. </p><dl class="section author"><dt>Author</dt><dd><a href="https://github.com/thisabhijeet" target="_blank">Abhijeet Tiwari</a> </dd></dl>
<p class="definition">Definition in file <a class="el" href="../../de/dcd/kadanes3_8cpp_source.html">kadanes3.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>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int main </td>
<td>(</td>
<td class="paramtype">void</td> <td class="paramname"><span class="paramname"><em></em></span></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>
<p class="definition">Definition at line <a class="el" href="../../de/dcd/kadanes3_8cpp_source.html#l00060">60</a> of file <a class="el" href="../../de/dcd/kadanes3_8cpp_source.html">kadanes3.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 60</span> {</div>
<div class="line"><span class="lineno"> 61</span> <span class="comment">// Below is the code for accepting array from the user and then</span></div>
<div class="line"><span class="lineno"> 62</span> <span class="comment">// calling the function for the required output.</span></div>
<div class="line"><span class="lineno"> 63</span> <span class="comment">// It has been commented for now so that the test() function can run</span></div>
<div class="line"><span class="lineno"> 64</span> <span class="comment">// and the test cases can be verified.</span></div>
<div class="line"><span class="lineno"> 65</span> <span class="comment">// code for accepting array from user starts</span></div>
<div class="line"><span class="lineno"> 66</span> </div>
<div class="line"><span class="lineno"> 67</span> <span class="comment">// std::size_t n; // variable for length of input array</span></div>
<div class="line"><span class="lineno"> 68</span> <span class="comment">// std::cout &lt;&lt; &quot;Enter length of the array: &quot;;</span></div>
<div class="line"><span class="lineno"> 69</span> <span class="comment">// std::cin &gt;&gt; n;</span></div>
<div class="line"><span class="lineno"> 70</span> <span class="comment">// std::array&lt;int64_t, 100&gt; arr = {0};</span></div>
<div class="line"><span class="lineno"> 71</span> <span class="comment">// // we need to give a constant in size. Hence we have allocated 100</span></div>
<div class="line"><span class="lineno"> 72</span> <span class="comment">// for now.</span></div>
<div class="line"><span class="lineno"> 73</span> <span class="comment">// for (int i = 0; i &lt; n; i++)</span></div>
<div class="line"><span class="lineno"> 74</span> <span class="comment">// taking input of each element of the array</span></div>
<div class="line"><span class="lineno"> 75</span> <span class="comment">// {</span></div>
<div class="line"><span class="lineno"> 76</span> <span class="comment">// std::cin &gt;&gt; arr[i];</span></div>
<div class="line"><span class="lineno"> 77</span> <span class="comment">// }</span></div>
<div class="line"><span class="lineno"> 78</span> <span class="comment">// code for accepting array from user ends</span></div>
<div class="line"><span class="lineno"> 79</span> </div>
<div class="line"><span class="lineno"> 80</span> <span class="comment">// int max_sum = max_subarray_sum(arr, n);</span></div>
<div class="line"><span class="lineno"> 81</span> <span class="comment">// std::cout &lt;&lt; &quot;Maximum contiguous sum for this array is : &quot; &lt;&lt; max_sum</span></div>
<div class="line"><span class="lineno"> 82</span> <span class="comment">// &lt;&lt; std::endl;</span></div>
<div class="line"><span class="lineno"> 83</span> </div>
<div class="line"><span class="lineno"> 84</span> <a class="code hl_function" href="#aa8dca7b867074164d5f45b0f3851269d">test</a>(); <span class="comment">// run self-test implementations</span></div>
<div class="line"><span class="lineno"> 85</span> <span class="keywordflow">return</span> 0;</div>
<div class="line"><span class="lineno"> 86</span>}</div>
<div class="ttc" id="akadanes3_8cpp_html_aa8dca7b867074164d5f45b0f3851269d"><div class="ttname"><a href="#aa8dca7b867074164d5f45b0f3851269d">test</a></div><div class="ttdeci">static void test()</div><div class="ttdoc">Self-test implementations.</div><div class="ttdef"><b>Definition</b> <a href="../../de/dcd/kadanes3_8cpp_source.html#l00048">kadanes3.cpp:48</a></div></div>
</div><!-- fragment -->
</div>
</div>
<a id="a338439a04148ae89f695595acfa5c147" name="a338439a04148ae89f695595acfa5c147"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a338439a04148ae89f695595acfa5c147">&#9670;&#160;</a></span>max_subarray_sum()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;std::size_t SIZE&gt; </div>
<table class="memname">
<tr>
<td class="memname">int max_subarray_sum </td>
<td>(</td>
<td class="paramtype">std::array&lt; int64_t, SIZE &gt;</td> <td class="paramname"><span class="paramname"><em>arr</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint64_t</td> <td class="paramname"><span class="paramname"><em>length</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>for IO operations </p>
<p>for std::array for assert for INT_MIN value</p>
<p>Utility function to check the current maximum number </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">arr</td><td>input array </td></tr>
<tr><td class="paramname">length</td><td>length of the input array </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>maximum contiguous subarray sum </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../de/dcd/kadanes3_8cpp_source.html#l00029">29</a> of file <a class="el" href="../../de/dcd/kadanes3_8cpp_source.html">kadanes3.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 29</span> {</div>
<div class="line"><span class="lineno"> 30</span> int64_t current_max = INT_MIN, current_sum = 0;</div>
<div class="line"><span class="lineno"> 31</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; length; i++) {</div>
<div class="line"><span class="lineno"> 32</span> current_sum = current_sum + arr[i];</div>
<div class="line"><span class="lineno"> 33</span> <span class="keywordflow">if</span> (current_max &lt; current_sum) {</div>
<div class="line"><span class="lineno"> 34</span> current_max = current_sum;</div>
<div class="line"><span class="lineno"> 35</span> }</div>
<div class="line"><span class="lineno"> 36</span> </div>
<div class="line"><span class="lineno"> 37</span> <span class="keywordflow">if</span> (current_sum &lt; 0) {</div>
<div class="line"><span class="lineno"> 38</span> current_sum = 0;</div>
<div class="line"><span class="lineno"> 39</span> }</div>
<div class="line"><span class="lineno"> 40</span> }</div>
<div class="line"><span class="lineno"> 41</span> <span class="keywordflow">return</span> current_max;</div>
<div class="line"><span class="lineno"> 42</span>}</div>
</div><!-- fragment -->
</div>
</div>
<a id="aa8dca7b867074164d5f45b0f3851269d" name="aa8dca7b867074164d5f45b0f3851269d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8dca7b867074164d5f45b0f3851269d">&#9670;&#160;</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"><span class="paramname"><em></em></span></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>Self-test implementations. </p>
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../de/dcd/kadanes3_8cpp_source.html#l00048">48</a> of file <a class="el" href="../../de/dcd/kadanes3_8cpp_source.html">kadanes3.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 48</span> {</div>
<div class="line"><span class="lineno"> 49</span> std::array&lt;int64_t, 4&gt; arr = {1, 2, 3, 4};</div>
<div class="line"><span class="lineno"> 50</span> std::array&lt;int64_t, 5&gt; arr1 = {-1, -2, -4, -6, 7};</div>
<div class="line"><span class="lineno"> 51</span> assert(<a class="code hl_function" href="#a338439a04148ae89f695595acfa5c147">max_subarray_sum</a>(arr, 4) == 10);</div>
<div class="line"><span class="lineno"> 52</span> assert(<a class="code hl_function" href="#a338439a04148ae89f695595acfa5c147">max_subarray_sum</a>(arr1, 5) == 7);</div>
<div class="line"><span class="lineno"> 53</span> std::cout &lt;&lt; <span class="stringliteral">&quot;All test cases have passed!\n&quot;</span>;</div>
<div class="line"><span class="lineno"> 54</span>}</div>
<div class="ttc" id="akadanes3_8cpp_html_a338439a04148ae89f695595acfa5c147"><div class="ttname"><a href="#a338439a04148ae89f695595acfa5c147">max_subarray_sum</a></div><div class="ttdeci">int max_subarray_sum(std::array&lt; int64_t, SIZE &gt; arr, uint64_t length)</div><div class="ttdoc">for IO operations</div><div class="ttdef"><b>Definition</b> <a href="../../de/dcd/kadanes3_8cpp_source.html#l00029">kadanes3.cpp:29</a></div></div>
</div><!-- fragment -->
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="../../dir_9510827d0b234b3cc54b29892f217477.html">others</a></li><li class="navelem"><a class="el" href="../../de/dcd/kadanes3_8cpp.html">kadanes3.cpp</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink