OpenSoure_Repos/TheAlgorithms-C
1
0
Fork 0
mirror of https://github.moeyy.xyz/https://github.com/TheAlgorithms/C.git synced 2023-10-11 15:56:24 +08:00
Code Issues Packages Projects Releases Wiki Activity
2c389ac4fe
TheAlgorithms-C/d5/df9/euclidean__algorithm__extended_8c.html
github-actions 478bb303a5 Documentation for 2b885108b8
2023-04-27 19:43:13 +00:00

535 lines
34 KiB
HTML
Raw Blame History

<!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.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Algorithms_in_C: math/euclidean_algorithm_extended.c 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>
<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 id="projectrow">
<td id="projectalign">
<div id="projectname">Algorithms_in_C<span id="projectnumber">&#160;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.9.6 -->
<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" 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');
$(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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('d5/df9/euclidean__algorithm__extended_8c.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">
<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="#nested-classes">Data Structures</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">euclidean_algorithm_extended.c File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Program to perform the <a href="https://en.wikipedia.org/wiki/Extended_Euclidean_algorithm" target="_blank">extended Euclidean algorithm</a>
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;assert.h&gt;</code><br />
<code>#include &lt;stdio.h&gt;</code><br />
<code>#include &lt;stdlib.h&gt;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for euclidean_algorithm_extended.c:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../da/d3c/euclidean__algorithm__extended_8c__incl.svg" width="250" 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">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</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/d1e/structeuclidean__result.html">euclidean_result</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">for tests <a href="../../d8/d1e/structeuclidean__result.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 id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aaa5f87fdd4cc35a6c77e255416de66ba"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/df9/euclidean__algorithm__extended_8c.html#aaa5f87fdd4cc35a6c77e255416de66ba">single_test</a> (int a, int b, int gcd, int x, int y)</td></tr>
<tr class="memdesc:aaa5f87fdd4cc35a6c77e255416de66ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">perform one single check on the result of the algorithm with provided parameters and expected output <br /></td></tr>
<tr class="separator:aaa5f87fdd4cc35a6c77e255416de66ba"><td class="memSeparator" colspan="2">&#160;</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="../../d5/df9/euclidean__algorithm__extended_8c.html#aa8dca7b867074164d5f45b0f3851269d">test</a> ()</td></tr>
<tr class="memdesc:aa8dca7b867074164d5f45b0f3851269d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Perform tests on known results. <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="../../d5/df9/euclidean__algorithm__extended_8c.html#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>
<tr class="memitem:a55267ed2a397f82118bb1140fa5336c0"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="../../d8/d1e/structeuclidean__result.html">euclidean_result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/df9/euclidean__algorithm__extended_8c.html#a55267ed2a397f82118bb1140fa5336c0">euclidean_result_t</a></td></tr>
<tr class="memdesc:a55267ed2a397f82118bb1140fa5336c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">for tests <br /></td></tr>
<tr class="separator:a55267ed2a397f82118bb1140fa5336c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a14f0d2347018c28ef17be3185b373d8f"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/df9/euclidean__algorithm__extended_8c.html#a14f0d2347018c28ef17be3185b373d8f">xy_push</a> (int arr[2], int newval)</td></tr>
<tr class="memdesc:a14f0d2347018c28ef17be3185b373d8f"><td class="mdescLeft">&#160;</td><td class="mdescRight">gives queue-like behavior to an array of two ints, pushing an element onto the end and pushing one off the front <br /></td></tr>
<tr class="separator:a14f0d2347018c28ef17be3185b373d8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2692f7190cf9d281ae23df491902d1c8"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/df9/euclidean__algorithm__extended_8c.html#a2692f7190cf9d281ae23df491902d1c8">calculate_next_xy</a> (int quotient, int prev[2])</td></tr>
<tr class="memdesc:a2692f7190cf9d281ae23df491902d1c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">calculates the value of x or y and push those into the small 'queues' <br /></td></tr>
<tr class="separator:a2692f7190cf9d281ae23df491902d1c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e7f9cce2f756c6a016ae7e2592f9c5d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d5/df9/euclidean__algorithm__extended_8c.html#a55267ed2a397f82118bb1140fa5336c0">euclidean_result_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/df9/euclidean__algorithm__extended_8c.html#a2e7f9cce2f756c6a016ae7e2592f9c5d">extended_euclidean_algorithm</a> (int a, int b)</td></tr>
<tr class="memdesc:a2e7f9cce2f756c6a016ae7e2592f9c5d"><td class="mdescLeft">&#160;</td><td class="mdescRight">performs the extended Euclidean algorithm on integer inputs a and b <br /></td></tr>
<tr class="separator:a2e7f9cce2f756c6a016ae7e2592f9c5d"><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>Program to perform the <a href="https://en.wikipedia.org/wiki/Extended_Euclidean_algorithm" target="_blank">extended Euclidean algorithm</a> </p>
<p>The extended Euclidean algorithm, on top of finding the GCD (greatest common divisor) of two integers a and b, also finds the values x and y such that ax+by = gcd(a, b) </p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a id="a55267ed2a397f82118bb1140fa5336c0" name="a55267ed2a397f82118bb1140fa5336c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a55267ed2a397f82118bb1140fa5336c0">&#9670;&#160;</a></span>euclidean_result_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="../../d8/d1e/structeuclidean__result.html">euclidean_result</a> <a class="el" href="../../d5/df9/euclidean__algorithm__extended_8c.html#a55267ed2a397f82118bb1140fa5336c0">euclidean_result_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>for tests </p>
<p>for IO for div function and corresponding div_t struct</p>
<p>a structure holding the values resulting from the extended Euclidean algorithm </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a2692f7190cf9d281ae23df491902d1c8" name="a2692f7190cf9d281ae23df491902d1c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2692f7190cf9d281ae23df491902d1c8">&#9670;&#160;</a></span>calculate_next_xy()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void calculate_next_xy </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>quotient</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>prev</em>[2]&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>calculates the value of x or y and push those into the small 'queues' </p>
<p>Both x and y are found by taking their value from 2 iterations ago minus the product of their value from 1 iteration ago and the most recent quotient.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">quotient</td><td>the quotient from the latest iteration of the Euclidean algorithm </td></tr>
<tr><td class="paramname">prev</td><td>the 'queue' holding the values of the two previous iterations</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
<div class="fragment"><div class="line"><span class="lineno"> 55</span>{</div>
<div class="line"><span class="lineno"> 56</span> <span class="keywordtype">int</span> <a class="code hl_function" href="../../df/dfa/vector_8c.html#af2f92e8cc55e764980bc0573ab5cd06f">next</a> = prev[1] - (prev[0] * quotient);</div>
<div class="line"><span class="lineno"> 57</span> <a class="code hl_function" href="../../d5/df9/euclidean__algorithm__extended_8c.html#a14f0d2347018c28ef17be3185b373d8f">xy_push</a>(prev, <a class="code hl_function" href="../../df/dfa/vector_8c.html#af2f92e8cc55e764980bc0573ab5cd06f">next</a>);</div>
<div class="line"><span class="lineno"> 58</span>}</div>
<div class="ttc" id="aeuclidean__algorithm__extended_8c_html_a14f0d2347018c28ef17be3185b373d8f"><div class="ttname"><a href="../../d5/df9/euclidean__algorithm__extended_8c.html#a14f0d2347018c28ef17be3185b373d8f">xy_push</a></div><div class="ttdeci">static void xy_push(int arr[2], int newval)</div><div class="ttdoc">gives queue-like behavior to an array of two ints, pushing an element onto the end and pushing one of...</div><div class="ttdef"><b>Definition:</b> euclidean_algorithm_extended.c:36</div></div>
<div class="ttc" id="avector_8c_html_af2f92e8cc55e764980bc0573ab5cd06f"><div class="ttname"><a href="../../df/dfa/vector_8c.html#af2f92e8cc55e764980bc0573ab5cd06f">next</a></div><div class="ttdeci">int next(Vector *vec)</div><div class="ttdoc">This function gets the next item from the Vector each time it's called.</div><div class="ttdef"><b>Definition:</b> vector.c:102</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="../../d5/df9/euclidean__algorithm__extended_8c_a2692f7190cf9d281ae23df491902d1c8_cgraph.svg" width="256" height="86"><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="a2e7f9cce2f756c6a016ae7e2592f9c5d" name="a2e7f9cce2f756c6a016ae7e2592f9c5d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2e7f9cce2f756c6a016ae7e2592f9c5d">&#9670;&#160;</a></span>extended_euclidean_algorithm()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../d5/df9/euclidean__algorithm__extended_8c.html#a55267ed2a397f82118bb1140fa5336c0">euclidean_result_t</a> extended_euclidean_algorithm </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>b</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>performs the extended Euclidean algorithm on integer inputs a and b </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td>first integer input </td></tr>
<tr><td class="paramname">b</td><td>second integer input</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>euclidean_result_t containing the gcd, and values x and y such that ax + by = gcd </dd></dl>
<div class="fragment"><div class="line"><span class="lineno"> 70</span>{</div>
<div class="line"><span class="lineno"> 71</span> <span class="keywordtype">int</span> previous_remainder = 1;</div>
<div class="line"><span class="lineno"> 72</span> <span class="keywordtype">int</span> previous_x_values[2] = {0, 1};</div>
<div class="line"><span class="lineno"> 73</span> <span class="keywordtype">int</span> previous_y_values[2] = {1, 0};</div>
<div class="line"><span class="lineno"> 74</span> div_t div_result;</div>
<div class="line"><span class="lineno"> 75</span> <a class="code hl_struct" href="../../d8/d1e/structeuclidean__result.html">euclidean_result_t</a> result;</div>
<div class="line"><span class="lineno"> 76</span> </div>
<div class="line"><span class="lineno"> 77</span> <span class="comment">/* swap values of a and b */</span></div>
<div class="line"><span class="lineno"> 78</span> <span class="keywordflow">if</span> (abs(a) &lt; abs(b))</div>
<div class="line"><span class="lineno"> 79</span> {</div>
<div class="line"><span class="lineno"> 80</span> a ^= b;</div>
<div class="line"><span class="lineno"> 81</span> b ^= a;</div>
<div class="line"><span class="lineno"> 82</span> a ^= b;</div>
<div class="line"><span class="lineno"> 83</span> }</div>
<div class="line"><span class="lineno"> 84</span> </div>
<div class="line"><span class="lineno"> 85</span> div_result.rem = b;</div>
<div class="line"><span class="lineno"> 86</span> </div>
<div class="line"><span class="lineno"> 87</span> <span class="keywordflow">while</span> (div_result.rem &gt; 0)</div>
<div class="line"><span class="lineno"> 88</span> {</div>
<div class="line"><span class="lineno"> 89</span> div_result = div(a, b);</div>
<div class="line"><span class="lineno"> 90</span> </div>
<div class="line"><span class="lineno"> 91</span> previous_remainder = b;</div>
<div class="line"><span class="lineno"> 92</span> </div>
<div class="line"><span class="lineno"> 93</span> a = b;</div>
<div class="line"><span class="lineno"> 94</span> b = div_result.rem;</div>
<div class="line"><span class="lineno"> 95</span> </div>
<div class="line"><span class="lineno"> 96</span> <a class="code hl_function" href="../../d5/df9/euclidean__algorithm__extended_8c.html#a2692f7190cf9d281ae23df491902d1c8">calculate_next_xy</a>(div_result.quot, previous_x_values);</div>
<div class="line"><span class="lineno"> 97</span> <a class="code hl_function" href="../../d5/df9/euclidean__algorithm__extended_8c.html#a2692f7190cf9d281ae23df491902d1c8">calculate_next_xy</a>(div_result.quot, previous_y_values);</div>
<div class="line"><span class="lineno"> 98</span> }</div>
<div class="line"><span class="lineno"> 99</span> </div>
<div class="line"><span class="lineno"> 100</span> result.<a class="code hl_variable" href="../../d8/d1e/structeuclidean__result.html#af112efeacb49a666b59047336c968607">gcd</a> = previous_remainder;</div>
<div class="line"><span class="lineno"> 101</span> result.x = previous_x_values[1];</div>
<div class="line"><span class="lineno"> 102</span> result.<a class="code hl_variable" href="../../d8/d1e/structeuclidean__result.html#ac6a0162c4014f399f847c83d312217a3">y</a> = previous_y_values[1];</div>
<div class="line"><span class="lineno"> 103</span> </div>
<div class="line"><span class="lineno"> 104</span> <span class="keywordflow">return</span> result;</div>
<div class="line"><span class="lineno"> 105</span>}</div>
<div class="ttc" id="aeuclidean__algorithm__extended_8c_html_a2692f7190cf9d281ae23df491902d1c8"><div class="ttname"><a href="../../d5/df9/euclidean__algorithm__extended_8c.html#a2692f7190cf9d281ae23df491902d1c8">calculate_next_xy</a></div><div class="ttdeci">static void calculate_next_xy(int quotient, int prev[2])</div><div class="ttdoc">calculates the value of x or y and push those into the small 'queues'</div><div class="ttdef"><b>Definition:</b> euclidean_algorithm_extended.c:54</div></div>
<div class="ttc" id="astructeuclidean__result_html"><div class="ttname"><a href="../../d8/d1e/structeuclidean__result.html">euclidean_result</a></div><div class="ttdoc">for tests</div><div class="ttdef"><b>Definition:</b> euclidean_algorithm_extended.c:21</div></div>
<div class="ttc" id="astructeuclidean__result_html_ac6a0162c4014f399f847c83d312217a3"><div class="ttname"><a href="../../d8/d1e/structeuclidean__result.html#ac6a0162c4014f399f847c83d312217a3">euclidean_result::y</a></div><div class="ttdeci">int y</div><div class="ttdoc">the values x and y such that ax + by = gcd(a, b)</div><div class="ttdef"><b>Definition:</b> euclidean_algorithm_extended.c:24</div></div>
<div class="ttc" id="astructeuclidean__result_html_af112efeacb49a666b59047336c968607"><div class="ttname"><a href="../../d8/d1e/structeuclidean__result.html#af112efeacb49a666b59047336c968607">euclidean_result::gcd</a></div><div class="ttdeci">int gcd</div><div class="ttdoc">the greatest common divisor calculated with the Euclidean algorithm</div><div class="ttdef"><b>Definition:</b> euclidean_algorithm_extended.c:22</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="../../d5/df9/euclidean__algorithm__extended_8c_a2e7f9cce2f756c6a016ae7e2592f9c5d_cgraph.svg" width="440" height="86"><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="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&#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 upon successful program exit </dd></dl>
<div class="fragment"><div class="line"><span class="lineno"> 151</span>{</div>
<div class="line"><span class="lineno"> 152</span> <a class="code hl_function" href="../../d5/df9/euclidean__algorithm__extended_8c.html#aa8dca7b867074164d5f45b0f3851269d">test</a>(); <span class="comment">// run self-test implementations</span></div>
<div class="line"><span class="lineno"> 153</span> <span class="keywordflow">return</span> 0;</div>
<div class="line"><span class="lineno"> 154</span>}</div>
<div class="ttc" id="aeuclidean__algorithm__extended_8c_html_aa8dca7b867074164d5f45b0f3851269d"><div class="ttname"><a href="../../d5/df9/euclidean__algorithm__extended_8c.html#aa8dca7b867074164d5f45b0f3851269d">test</a></div><div class="ttdeci">static void test()</div><div class="ttdoc">Perform tests on known results.</div><div class="ttdef"><b>Definition:</b> euclidean_algorithm_extended.c:135</div></div>
</div><!-- fragment --><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="../../d5/df9/euclidean__algorithm__extended_8c_ae66f6b31b5ad750f1fe042a706a4e3d4_cgraph.svg" width="100%" height="364"><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>
<a id="aaa5f87fdd4cc35a6c77e255416de66ba" name="aaa5f87fdd4cc35a6c77e255416de66ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa5f87fdd4cc35a6c77e255416de66ba">&#9670;&#160;</a></span>single_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 single_test </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>b</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>gcd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>perform one single check on the result of the algorithm with provided parameters and expected output </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td>first paramater for Euclidean algorithm </td></tr>
<tr><td class="paramname">b</td><td>second parameter for Euclidean algorithm </td></tr>
<tr><td class="paramname">gcd</td><td>expected value of result.gcd </td></tr>
<tr><td class="paramname">x</td><td>expected value of result.x </td></tr>
<tr><td class="paramname">y</td><td>expected value of result.y</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
<div class="fragment"><div class="line"><span class="lineno"> 122</span>{</div>
<div class="line"><span class="lineno"> 123</span> <a class="code hl_struct" href="../../d8/d1e/structeuclidean__result.html">euclidean_result_t</a> result;</div>
<div class="line"><span class="lineno"> 124</span> </div>
<div class="line"><span class="lineno"> 125</span> result = <a class="code hl_function" href="../../d5/df9/euclidean__algorithm__extended_8c.html#a2e7f9cce2f756c6a016ae7e2592f9c5d">extended_euclidean_algorithm</a>(a, b);</div>
<div class="line"><span class="lineno"> 126</span> assert(result.<a class="code hl_variable" href="../../d8/d1e/structeuclidean__result.html#af112efeacb49a666b59047336c968607">gcd</a> == gcd);</div>
<div class="line"><span class="lineno"> 127</span> assert(result.x == x);</div>
<div class="line"><span class="lineno"> 128</span> assert(result.<a class="code hl_variable" href="../../d8/d1e/structeuclidean__result.html#ac6a0162c4014f399f847c83d312217a3">y</a> == y);</div>
<div class="line"><span class="lineno"> 129</span>}</div>
<div class="ttc" id="aeuclidean__algorithm__extended_8c_html_a2e7f9cce2f756c6a016ae7e2592f9c5d"><div class="ttname"><a href="../../d5/df9/euclidean__algorithm__extended_8c.html#a2e7f9cce2f756c6a016ae7e2592f9c5d">extended_euclidean_algorithm</a></div><div class="ttdeci">euclidean_result_t extended_euclidean_algorithm(int a, int b)</div><div class="ttdoc">performs the extended Euclidean algorithm on integer inputs a and b</div><div class="ttdef"><b>Definition:</b> euclidean_algorithm_extended.c:69</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="../../d5/df9/euclidean__algorithm__extended_8c_aaa5f87fdd4cc35a6c77e255416de66ba_cgraph.svg" width="572" height="86"><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" 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="paramtype">void&#160;</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>Perform tests on known results. </p>
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
<div class="fragment"><div class="line"><span class="lineno"> 136</span>{</div>
<div class="line"><span class="lineno"> 137</span> <a class="code hl_function" href="../../d5/df9/euclidean__algorithm__extended_8c.html#aaa5f87fdd4cc35a6c77e255416de66ba">single_test</a>(40, 27, 1, -2, 3);</div>
<div class="line"><span class="lineno"> 138</span> <a class="code hl_function" href="../../d5/df9/euclidean__algorithm__extended_8c.html#aaa5f87fdd4cc35a6c77e255416de66ba">single_test</a>(71, 41, 1, -15, 26);</div>
<div class="line"><span class="lineno"> 139</span> <a class="code hl_function" href="../../d5/df9/euclidean__algorithm__extended_8c.html#aaa5f87fdd4cc35a6c77e255416de66ba">single_test</a>(48, 18, 6, -1, 3);</div>
<div class="line"><span class="lineno"> 140</span> <a class="code hl_function" href="../../d5/df9/euclidean__algorithm__extended_8c.html#aaa5f87fdd4cc35a6c77e255416de66ba">single_test</a>(99, 303, 3, -16, 49);</div>
<div class="line"><span class="lineno"> 141</span> <a class="code hl_function" href="../../d5/df9/euclidean__algorithm__extended_8c.html#aaa5f87fdd4cc35a6c77e255416de66ba">single_test</a>(14005, 3507, 1, -305, 1218);</div>
<div class="line"><span class="lineno"> 142</span> </div>
<div class="line"><span class="lineno"> 143</span> printf(<span class="stringliteral">&quot;All tests have successfully passed!\n&quot;</span>);</div>
<div class="line"><span class="lineno"> 144</span>}</div>
<div class="ttc" id="aeuclidean__algorithm__extended_8c_html_aaa5f87fdd4cc35a6c77e255416de66ba"><div class="ttname"><a href="../../d5/df9/euclidean__algorithm__extended_8c.html#aaa5f87fdd4cc35a6c77e255416de66ba">single_test</a></div><div class="ttdeci">static void single_test(int a, int b, int gcd, int x, int y)</div><div class="ttdoc">perform one single check on the result of the algorithm with provided parameters and expected output</div><div class="ttdef"><b>Definition:</b> euclidean_algorithm_extended.c:121</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="../../d5/df9/euclidean__algorithm__extended_8c_aa8dca7b867074164d5f45b0f3851269d_cgraph.svg" width="664" height="86"><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="a14f0d2347018c28ef17be3185b373d8f" name="a14f0d2347018c28ef17be3185b373d8f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a14f0d2347018c28ef17be3185b373d8f">&#9670;&#160;</a></span>xy_push()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void xy_push </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>arr</em>[2], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>newval</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>gives queue-like behavior to an array of two ints, pushing an element onto the end and pushing one off the front </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">arr</td><td>an array of ints acting as a queue </td></tr>
<tr><td class="paramname">newval</td><td>the value being pushed into arr</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
<div class="fragment"><div class="line"><span class="lineno"> 37</span>{</div>
<div class="line"><span class="lineno"> 38</span> arr[1] = arr[0];</div>
<div class="line"><span class="lineno"> 39</span> arr[0] = newval;</div>
<div class="line"><span class="lineno"> 40</span>}</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_296d53ceaeaa7e099814a6def439fe8a.html">math</a></li><li class="navelem"><a class="el" href="../../d5/df9/euclidean__algorithm__extended_8c.html">euclidean_algorithm_extended.c</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.6 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink