mirror of
https://github.com/TheAlgorithms/C-Plus-Plus.git
synced 2026-11-06 07:38:47 +08:00
Documentation for 8b1eab204b
This commit is contained in:
realstealthninja
@@ -1,3 +1,4 @@
|
||||
<!-- 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>
|
||||
@@ -5,10 +6,15 @@
|
||||
<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>Algorithms_in_C++: math/modular_inverse_simple.cpp File Reference</title>
|
||||
<title>TheAlgorithms/C++: math/modular_inverse_simple.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>
|
||||
@@ -18,14 +24,24 @@
|
||||
<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 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" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML/MathJax.js"></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! -->
|
||||
@@ -33,10 +49,11 @@ MathJax.Hub.Config({
|
||||
<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">Algorithms_in_C++<span id="projectnumber"> 1.0.0</span>
|
||||
<div id="projectname">TheAlgorithms/C++<span id="projectnumber"> 1.0.0</span>
|
||||
</div>
|
||||
<div id="projectbrief">Set of algorithms implemented in C++.</div>
|
||||
<div id="projectbrief">All the algorithms implemented in C++</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@@ -120,7 +137,9 @@ Include dependency graph for modular_inverse_simple.cpp:</div>
|
||||
<div class="dyncontent">
|
||||
<div class="center"><iframe scrolling="no" frameborder="0" src="../../db/d13/modular__inverse__simple_8cpp__incl.svg" width="255" 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">
|
||||
</div>
|
||||
<p><a href="../../d6/d2d/modular__inverse__simple_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:a618b198f74a88ab0023355b3a05d9ad6" id="r_a618b198f74a88ab0023355b3a05d9ad6"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#a618b198f74a88ab0023355b3a05d9ad6">imod</a> (uint64_t x, uint64_t y)</td></tr>
|
||||
@@ -136,6 +155,8 @@ Functions</h2></td></tr>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p>Simple implementation of <a href="https://en.wikipedia.org/wiki/Modular_multiplicative_inverse" target="_blank">modular multiplicative inverse</a> </p>
|
||||
<p>this algorithm calculates the modular inverse x^{-1} \mod y iteratively </p>
|
||||
|
||||
<p class="definition">Definition in file <a class="el" href="../../d6/d2d/modular__inverse__simple_8cpp_source.html">modular_inverse_simple.cpp</a>.</p>
|
||||
</div><h2 class="groupheader">Function Documentation</h2>
|
||||
<a id="a618b198f74a88ab0023355b3a05d9ad6" name="a618b198f74a88ab0023355b3a05d9ad6"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a618b198f74a88ab0023355b3a05d9ad6">◆ </a></span>imod()</h2>
|
||||
@@ -166,6 +187,8 @@ Functions</h2></td></tr>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd>the modular inverse </dd></dl>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="../../d6/d2d/modular__inverse__simple_8cpp_source.html#l00021">21</a> of file <a class="el" href="../../d6/d2d/modular__inverse__simple_8cpp_source.html">modular_inverse_simple.cpp</a>.</p>
|
||||
<div class="fragment"><div class="line"><span class="lineno"> 21</span> {</div>
|
||||
<div class="line"><span class="lineno"> 22</span> uint64_t aux = 0; <span class="comment">// auxiliary variable</span></div>
|
||||
<div class="line"><span class="lineno"> 23</span> uint64_t itr = 0; <span class="comment">// iteration counter</span></div>
|
||||
@@ -197,16 +220,13 @@ Functions</h2></td></tr>
|
||||
|
||||
<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="../../d6/d2d/modular__inverse__simple_8cpp_source.html#l00059">59</a> of file <a class="el" href="../../d6/d2d/modular__inverse__simple_8cpp_source.html">modular_inverse_simple.cpp</a>.</p>
|
||||
<div class="fragment"><div class="line"><span class="lineno"> 59</span> {</div>
|
||||
<div class="line"><span class="lineno"> 60</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"> 61</span>};</div>
|
||||
<div class="ttc" id="amodular__inverse__simple_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> modular_inverse_simple.cpp:37</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="../../d6/d2d/modular__inverse__simple_8cpp_ae66f6b31b5ad750f1fe042a706a4e3d4_cgraph.svg" width="250" height="36"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
|
||||
</div>
|
||||
|
||||
<div class="ttc" id="amodular__inverse__simple_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="../../d6/d2d/modular__inverse__simple_8cpp_source.html#l00037">modular_inverse_simple.cpp:37</a></div></div>
|
||||
</div><!-- fragment -->
|
||||
</div>
|
||||
</div>
|
||||
<a id="aa8dca7b867074164d5f45b0f3851269d" name="aa8dca7b867074164d5f45b0f3851269d"></a>
|
||||
@@ -234,32 +254,28 @@ Here is the call graph for this function:</div>
|
||||
|
||||
<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="../../d6/d2d/modular__inverse__simple_8cpp_source.html#l00037">37</a> of file <a class="el" href="../../d6/d2d/modular__inverse__simple_8cpp_source.html">modular_inverse_simple.cpp</a>.</p>
|
||||
<div class="fragment"><div class="line"><span class="lineno"> 37</span> {</div>
|
||||
<div class="line"><span class="lineno"> 38</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> << <span class="stringliteral">"First case testing... \n"</span>;</div>
|
||||
<div class="line"><span class="lineno"> 38</span> std::cout << <span class="stringliteral">"First case testing... \n"</span>;</div>
|
||||
<div class="line"><span class="lineno"> 39</span> <span class="comment">// for a = 3 and b = 11 return 4</span></div>
|
||||
<div class="line"><span class="lineno"> 40</span> assert(<a class="code hl_function" href="#a618b198f74a88ab0023355b3a05d9ad6">imod</a>(3, 11) == 4);</div>
|
||||
<div class="line"><span class="lineno"> 41</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> << <span class="stringliteral">"\nPassed!\n"</span>;</div>
|
||||
<div class="line"><span class="lineno"> 41</span> std::cout << <span class="stringliteral">"\nPassed!\n"</span>;</div>
|
||||
<div class="line"><span class="lineno"> 42</span> </div>
|
||||
<div class="line"><span class="lineno"> 43</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> << <span class="stringliteral">"Second case testing... \n"</span>;</div>
|
||||
<div class="line"><span class="lineno"> 43</span> std::cout << <span class="stringliteral">"Second case testing... \n"</span>;</div>
|
||||
<div class="line"><span class="lineno"> 44</span> <span class="comment">// for a = 3 and b = 26 return 9</span></div>
|
||||
<div class="line"><span class="lineno"> 45</span> assert(<a class="code hl_function" href="#a618b198f74a88ab0023355b3a05d9ad6">imod</a>(3, 26) == 9);</div>
|
||||
<div class="line"><span class="lineno"> 46</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> << <span class="stringliteral">"\nPassed!\n"</span>;</div>
|
||||
<div class="line"><span class="lineno"> 46</span> std::cout << <span class="stringliteral">"\nPassed!\n"</span>;</div>
|
||||
<div class="line"><span class="lineno"> 47</span> </div>
|
||||
<div class="line"><span class="lineno"> 48</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> << <span class="stringliteral">"Third case testing... \n"</span>;</div>
|
||||
<div class="line"><span class="lineno"> 48</span> std::cout << <span class="stringliteral">"Third case testing... \n"</span>;</div>
|
||||
<div class="line"><span class="lineno"> 49</span> <span class="comment">// for a = 7 and b = 26 return 15</span></div>
|
||||
<div class="line"><span class="lineno"> 50</span> assert(<a class="code hl_function" href="#a618b198f74a88ab0023355b3a05d9ad6">imod</a>(7, 26) == 15);</div>
|
||||
<div class="line"><span class="lineno"> 51</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> << <span class="stringliteral">"\nPassed!\n"</span>;</div>
|
||||
<div class="line"><span class="lineno"> 51</span> std::cout << <span class="stringliteral">"\nPassed!\n"</span>;</div>
|
||||
<div class="line"><span class="lineno"> 52</span> </div>
|
||||
<div class="line"><span class="lineno"> 53</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> << <span class="stringliteral">"\nAll test cases have successfully passed!\n"</span>;</div>
|
||||
<div class="line"><span class="lineno"> 53</span> std::cout << <span class="stringliteral">"\nAll test cases have successfully passed!\n"</span>;</div>
|
||||
<div class="line"><span class="lineno"> 54</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="amodular__inverse__simple_8cpp_html_a618b198f74a88ab0023355b3a05d9ad6"><div class="ttname"><a href="#a618b198f74a88ab0023355b3a05d9ad6">imod</a></div><div class="ttdeci">uint64_t imod(uint64_t x, uint64_t y)</div><div class="ttdoc">for assert</div><div class="ttdef"><b>Definition</b> modular_inverse_simple.cpp:21</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="../../d6/d2d/modular__inverse__simple_8cpp_aa8dca7b867074164d5f45b0f3851269d_cgraph.svg" width="152" height="36"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
|
||||
</div>
|
||||
|
||||
<div class="ttc" id="amodular__inverse__simple_8cpp_html_a618b198f74a88ab0023355b3a05d9ad6"><div class="ttname"><a href="#a618b198f74a88ab0023355b3a05d9ad6">imod</a></div><div class="ttdeci">uint64_t imod(uint64_t x, uint64_t y)</div><div class="ttdoc">for assert</div><div class="ttdef"><b>Definition</b> <a href="../../d6/d2d/modular__inverse__simple_8cpp_source.html#l00021">modular_inverse_simple.cpp:21</a></div></div>
|
||||
</div><!-- fragment -->
|
||||
</div>
|
||||
</div>
|
||||
</div><!-- contents -->
|
||||
|
||||
Reference in New Issue
Block a user