Documentation for 2dadbf73f4

This commit is contained in:
github-actions
2024-02-12 20:07:08 +00:00
parent b5b4d78981
commit a1eb9bd385
1261 changed files with 30404 additions and 29974 deletions

View File

@@ -3,16 +3,18 @@
<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.9.8"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Algorithms_in_C++: math/least_common_multiple.cpp File Reference</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>
<script type="text/javascript" src="../../clipboard.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>
<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>
@@ -41,7 +43,7 @@ MathJax.Hub.Config({
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "../../search/",'.html');
@@ -53,7 +55,7 @@ var searchBox = new SearchBox("searchBox", "../../search/",'.html');
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
$(function() { init_search(); });
});
/* @license-end */
</script>
@@ -71,7 +73,7 @@ $(function() {
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('d4/d21/least__common__multiple_8cpp.html','../../'); initResizable(); });
$(function(){initNavTree('d4/d21/least__common__multiple_8cpp.html','../../'); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
@@ -112,13 +114,13 @@ Include dependency graph for least_common_multiple.cpp:</div>
</div><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:a8ba1fc66e4134ab25b2602b323150563" id="r_a8ba1fc66e4134ab25b2602b323150563"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d21/least__common__multiple_8cpp.html#a8ba1fc66e4134ab25b2602b323150563">gcd</a> (unsigned int x, unsigned int y)</td></tr>
<tr class="memitem:a8ba1fc66e4134ab25b2602b323150563" id="r_a8ba1fc66e4134ab25b2602b323150563"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8ba1fc66e4134ab25b2602b323150563">gcd</a> (unsigned int x, unsigned int y)</td></tr>
<tr class="separator:a8ba1fc66e4134ab25b2602b323150563"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8d0e241db517813725e721a152e3a25" id="r_aa8d0e241db517813725e721a152e3a25"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d21/least__common__multiple_8cpp.html#aa8d0e241db517813725e721a152e3a25">lcm</a> (unsigned int x, unsigned int y)</td></tr>
<tr class="memitem:aa8d0e241db517813725e721a152e3a25" id="r_aa8d0e241db517813725e721a152e3a25"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa8d0e241db517813725e721a152e3a25">lcm</a> (unsigned int x, unsigned int y)</td></tr>
<tr class="separator:aa8d0e241db517813725e721a152e3a25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a88ec9ad42717780d6caaff9d3d6977f9" id="r_a88ec9ad42717780d6caaff9d3d6977f9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d21/least__common__multiple_8cpp.html#a88ec9ad42717780d6caaff9d3d6977f9">tests</a> ()</td></tr>
<tr class="memitem:a88ec9ad42717780d6caaff9d3d6977f9" id="r_a88ec9ad42717780d6caaff9d3d6977f9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a88ec9ad42717780d6caaff9d3d6977f9">tests</a> ()</td></tr>
<tr class="separator:a88ec9ad42717780d6caaff9d3d6977f9"><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="../../d4/d21/least__common__multiple_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a> ()</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="separator:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
@@ -134,19 +136,12 @@ Functions</h2></td></tr>
<tr>
<td class="memname">unsigned int gcd </td>
<td>(</td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>x</em>, </td>
<td class="paramtype">unsigned int</td> <td class="paramname"><span class="paramname"><em>x</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
<td class="paramtype">unsigned int</td> <td class="paramname"><span class="paramname"><em>y</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
@@ -165,14 +160,14 @@ Functions</h2></td></tr>
<div class="line"><span class="lineno"> 27</span> <span class="comment">// The following is valid because we have checked whether y == 0</span></div>
<div class="line"><span class="lineno"> 28</span> </div>
<div class="line"><span class="lineno"> 29</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> temp = x / y;</div>
<div class="line"><span class="lineno"> 30</span> <span class="keywordflow">return</span> <a class="code hl_function" href="../../d4/d21/least__common__multiple_8cpp.html#a8ba1fc66e4134ab25b2602b323150563">gcd</a>(y, x - temp * y);</div>
<div class="line"><span class="lineno"> 30</span> <span class="keywordflow">return</span> <a class="code hl_function" href="#a8ba1fc66e4134ab25b2602b323150563">gcd</a>(y, x - temp * y);</div>
<div class="line"><span class="lineno"> 31</span> }</div>
<div class="line"><span class="lineno"> 32</span> <span class="comment">// Again the following is valid because we have checked whether x == 0</span></div>
<div class="line"><span class="lineno"> 33</span> </div>
<div class="line"><span class="lineno"> 34</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> temp = y / x;</div>
<div class="line"><span class="lineno"> 35</span> <span class="keywordflow">return</span> <a class="code hl_function" href="../../d4/d21/least__common__multiple_8cpp.html#a8ba1fc66e4134ab25b2602b323150563">gcd</a>(x, y - temp * x);</div>
<div class="line"><span class="lineno"> 35</span> <span class="keywordflow">return</span> <a class="code hl_function" href="#a8ba1fc66e4134ab25b2602b323150563">gcd</a>(x, y - temp * x);</div>
<div class="line"><span class="lineno"> 36</span>}</div>
<div class="ttc" id="aleast__common__multiple_8cpp_html_a8ba1fc66e4134ab25b2602b323150563"><div class="ttname"><a href="../../d4/d21/least__common__multiple_8cpp.html#a8ba1fc66e4134ab25b2602b323150563">gcd</a></div><div class="ttdeci">unsigned int gcd(unsigned int x, unsigned int y)</div><div class="ttdef"><b>Definition</b> least_common_multiple.cpp:16</div></div>
<div class="ttc" id="aleast__common__multiple_8cpp_html_a8ba1fc66e4134ab25b2602b323150563"><div class="ttname"><a href="#a8ba1fc66e4134ab25b2602b323150563">gcd</a></div><div class="ttdeci">unsigned int gcd(unsigned int x, unsigned int y)</div><div class="ttdef"><b>Definition</b> least_common_multiple.cpp:16</div></div>
</div><!-- fragment --><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
@@ -190,25 +185,18 @@ Here is the call graph for this function:</div>
<tr>
<td class="memname">unsigned int lcm </td>
<td>(</td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>x</em>, </td>
<td class="paramtype">unsigned int</td> <td class="paramname"><span class="paramname"><em>x</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
<td class="paramtype">unsigned int</td> <td class="paramname"><span class="paramname"><em>y</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Function for finding the least common multiple of two numbers. @params integer x and y whose lcm we want to find. </p><dl class="section return"><dt>Returns</dt><dd>lcm of x and y using the relation x * y = gcd(x, y) * lcm(x, y) </dd></dl>
<div class="fragment"><div class="line"><span class="lineno"> 43</span> {</div>
<div class="line"><span class="lineno"> 44</span> <span class="keywordflow">return</span> x / <a class="code hl_function" href="../../d4/d21/least__common__multiple_8cpp.html#a8ba1fc66e4134ab25b2602b323150563">gcd</a>(x, y) * y;</div>
<div class="line"><span class="lineno"> 44</span> <span class="keywordflow">return</span> x / <a class="code hl_function" href="#a8ba1fc66e4134ab25b2602b323150563">gcd</a>(x, y) * y;</div>
<div class="line"><span class="lineno"> 45</span>}</div>
</div><!-- fragment --><div class="dynheader">
Here is the call graph for this function:</div>
@@ -227,18 +215,17 @@ Here is the call graph for this function:</div>
<tr>
<td class="memname">int main </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td class="paramtype">void</td> <td class="paramname"><span class="paramname"></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Main function </p>
<div class="fragment"><div class="line"><span class="lineno"> 78</span> {</div>
<div class="line"><span class="lineno"> 79</span> <a class="code hl_function" href="../../d4/d21/least__common__multiple_8cpp.html#a88ec9ad42717780d6caaff9d3d6977f9">tests</a>();</div>
<div class="line"><span class="lineno"> 79</span> <a class="code hl_function" href="#a88ec9ad42717780d6caaff9d3d6977f9">tests</a>();</div>
<div class="line"><span class="lineno"> 80</span> <span class="keywordflow">return</span> 0;</div>
<div class="line"><span class="lineno"> 81</span>}</div>
<div class="ttc" id="aleast__common__multiple_8cpp_html_a88ec9ad42717780d6caaff9d3d6977f9"><div class="ttname"><a href="../../d4/d21/least__common__multiple_8cpp.html#a88ec9ad42717780d6caaff9d3d6977f9">tests</a></div><div class="ttdeci">void tests()</div><div class="ttdef"><b>Definition</b> least_common_multiple.cpp:50</div></div>
<div class="ttc" id="aleast__common__multiple_8cpp_html_a88ec9ad42717780d6caaff9d3d6977f9"><div class="ttname"><a href="#a88ec9ad42717780d6caaff9d3d6977f9">tests</a></div><div class="ttdeci">void tests()</div><div class="ttdef"><b>Definition</b> least_common_multiple.cpp:50</div></div>
</div><!-- fragment --><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
@@ -256,39 +243,39 @@ Here is the call graph for this function:</div>
<tr>
<td class="memname">void tests </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Function for testing the <a class="el" href="../../d4/d21/least__common__multiple_8cpp.html#aa8d0e241db517813725e721a152e3a25">lcm()</a> functions with some assert statements. </p>
<p>Function for testing the <a class="el" href="#aa8d0e241db517813725e721a152e3a25">lcm()</a> functions with some assert statements. </p>
<div class="fragment"><div class="line"><span class="lineno"> 50</span> {</div>
<div class="line"><span class="lineno"> 51</span> <span class="comment">// First test on lcm(5,10) == 10</span></div>
<div class="line"><span class="lineno"> 52</span> assert(((<span class="keywordtype">void</span>)<span class="stringliteral">&quot;LCM of 5 and 10 is 10 but lcm function gives a different &quot;</span></div>
<div class="line"><span class="lineno"> 53</span> <span class="stringliteral">&quot;result.\n&quot;</span>,</div>
<div class="line"><span class="lineno"> 54</span> <a class="code hl_function" href="../../d4/d21/least__common__multiple_8cpp.html#aa8d0e241db517813725e721a152e3a25">lcm</a>(5, 10) == 10));</div>
<div class="line"><span class="lineno"> 55</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;First assertion passes: LCM of 5 and 10 is &quot;</span> &lt;&lt; <a class="code hl_function" href="../../d4/d21/least__common__multiple_8cpp.html#aa8d0e241db517813725e721a152e3a25">lcm</a>(5, 10)</div>
<div class="line"><span class="lineno"> 54</span> <a class="code hl_function" href="#aa8d0e241db517813725e721a152e3a25">lcm</a>(5, 10) == 10));</div>
<div class="line"><span class="lineno"> 55</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;First assertion passes: LCM of 5 and 10 is &quot;</span> &lt;&lt; <a class="code hl_function" href="#aa8d0e241db517813725e721a152e3a25">lcm</a>(5, 10)</div>
<div class="line"><span class="lineno"> 56</span> &lt;&lt; <a class="code hl_functionRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/manip/endl.html">std::endl</a>;</div>
<div class="line"><span class="lineno"> 57</span> </div>
<div class="line"><span class="lineno"> 58</span> <span class="comment">// Second test on lcm(2,3) == 6 as 2 and 3 are coprime (prime in fact)</span></div>
<div class="line"><span class="lineno"> 59</span> assert(((<span class="keywordtype">void</span>)<span class="stringliteral">&quot;LCM of 2 and 3 is 6 but lcm function gives a different &quot;</span></div>
<div class="line"><span class="lineno"> 60</span> <span class="stringliteral">&quot;result.\n&quot;</span>,</div>
<div class="line"><span class="lineno"> 61</span> <a class="code hl_function" href="../../d4/d21/least__common__multiple_8cpp.html#aa8d0e241db517813725e721a152e3a25">lcm</a>(2, 3) == 6));</div>
<div class="line"><span class="lineno"> 62</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;Second assertion passes: LCM of 2 and 3 is &quot;</span> &lt;&lt; <a class="code hl_function" href="../../d4/d21/least__common__multiple_8cpp.html#aa8d0e241db517813725e721a152e3a25">lcm</a>(2, 3)</div>
<div class="line"><span class="lineno"> 61</span> <a class="code hl_function" href="#aa8d0e241db517813725e721a152e3a25">lcm</a>(2, 3) == 6));</div>
<div class="line"><span class="lineno"> 62</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;Second assertion passes: LCM of 2 and 3 is &quot;</span> &lt;&lt; <a class="code hl_function" href="#aa8d0e241db517813725e721a152e3a25">lcm</a>(2, 3)</div>
<div class="line"><span class="lineno"> 63</span> &lt;&lt; <a class="code hl_functionRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/manip/endl.html">std::endl</a>;</div>
<div class="line"><span class="lineno"> 64</span> </div>
<div class="line"><span class="lineno"> 65</span> <span class="comment">// Testing an integer overflow.</span></div>
<div class="line"><span class="lineno"> 66</span> <span class="comment">// The algorithm should work as long as the result fits into integer.</span></div>
<div class="line"><span class="lineno"> 67</span> assert(((<span class="keywordtype">void</span>)<span class="stringliteral">&quot;LCM of 987654321 and 987654321 is 987654321 but lcm function&quot;</span></div>
<div class="line"><span class="lineno"> 68</span> <span class="stringliteral">&quot; gives a different result.\n&quot;</span>,</div>
<div class="line"><span class="lineno"> 69</span> <a class="code hl_function" href="../../d4/d21/least__common__multiple_8cpp.html#aa8d0e241db517813725e721a152e3a25">lcm</a>(987654321, 987654321) == 987654321));</div>
<div class="line"><span class="lineno"> 69</span> <a class="code hl_function" href="#aa8d0e241db517813725e721a152e3a25">lcm</a>(987654321, 987654321) == 987654321));</div>
<div class="line"><span class="lineno"> 70</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;Third assertion passes: LCM of 987654321 and 987654321 is &quot;</span></div>
<div class="line"><span class="lineno"> 71</span> &lt;&lt; <a class="code hl_function" href="../../d4/d21/least__common__multiple_8cpp.html#aa8d0e241db517813725e721a152e3a25">lcm</a>(987654321, 987654321)</div>
<div class="line"><span class="lineno"> 71</span> &lt;&lt; <a class="code hl_function" href="#aa8d0e241db517813725e721a152e3a25">lcm</a>(987654321, 987654321)</div>
<div class="line"><span class="lineno"> 72</span> &lt;&lt; <a class="code hl_functionRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/manip/endl.html">std::endl</a>;</div>
<div class="line"><span class="lineno"> 73</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 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="aleast__common__multiple_8cpp_html_aa8d0e241db517813725e721a152e3a25"><div class="ttname"><a href="../../d4/d21/least__common__multiple_8cpp.html#aa8d0e241db517813725e721a152e3a25">lcm</a></div><div class="ttdeci">unsigned int lcm(unsigned int x, unsigned int y)</div><div class="ttdef"><b>Definition</b> least_common_multiple.cpp:43</div></div>
<div class="ttc" id="aleast__common__multiple_8cpp_html_aa8d0e241db517813725e721a152e3a25"><div class="ttname"><a href="#aa8d0e241db517813725e721a152e3a25">lcm</a></div><div class="ttdeci">unsigned int lcm(unsigned int x, unsigned int y)</div><div class="ttdef"><b>Definition</b> least_common_multiple.cpp:43</div></div>
</div><!-- fragment --><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
@@ -303,7 +290,7 @@ Here is the call graph for this function:</div>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="../../dir_296d53ceaeaa7e099814a6def439fe8a.html">math</a></li><li class="navelem"><a class="el" href="../../d4/d21/least__common__multiple_8cpp.html">least_common_multiple.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.9.8 </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.10.0 </li>
</ul>
</div>
</body>