blob: fc7713c6716ae0961afd106d1168f91564e935d7 [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/num-bigint-0.2.6/src/monty.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>monty.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../num_bigint/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../num_bigint/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
</pre><pre class="rust"><code><span class="kw">use </span>integer::Integer;
<span class="kw">use </span>traits::Zero;
<span class="kw">use </span>biguint::BigUint;
<span class="kw">struct </span>MontyReducer&lt;<span class="lifetime">&#39;a</span>&gt; {
n: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>BigUint,
n0inv: u32,
}
<span class="comment">// Calculate the modular inverse of `num`, using Extended GCD.
//
// Reference:
// Brent &amp; Zimmermann, Modern Computer Arithmetic, v0.5.9, Algorithm 1.20
</span><span class="kw">fn </span>inv_mod_u32(num: u32) -&gt; u32 {
<span class="comment">// num needs to be relatively prime to 2**32 -- i.e. it must be odd.
</span><span class="macro">assert!</span>(num % <span class="number">2 </span>!= <span class="number">0</span>);
<span class="kw">let </span><span class="kw-2">mut </span>a: i64 = i64::from(num);
<span class="kw">let </span><span class="kw-2">mut </span>b: i64 = i64::from(u32::max_value()) + <span class="number">1</span>;
<span class="comment">// ExtendedGcd
// Input: positive integers a and b
// Output: integers (g, u, v) such that g = gcd(a, b) = ua + vb
// As we don&#39;t need v for modular inverse, we don&#39;t calculate it.
// 1: (u, w) &lt;- (1, 0)
</span><span class="kw">let </span><span class="kw-2">mut </span>u = <span class="number">1</span>;
<span class="kw">let </span><span class="kw-2">mut </span>w = <span class="number">0</span>;
<span class="comment">// 3: while b != 0
</span><span class="kw">while </span>b != <span class="number">0 </span>{
<span class="comment">// 4: (q, r) &lt;- DivRem(a, b)
</span><span class="kw">let </span>q = a / b;
<span class="kw">let </span>r = a % b;
<span class="comment">// 5: (a, b) &lt;- (b, r)
</span>a = b;
b = r;
<span class="comment">// 6: (u, w) &lt;- (w, u - qw)
</span><span class="kw">let </span>m = u - w * q;
u = w;
w = m;
}
<span class="macro">assert!</span>(a == <span class="number">1</span>);
<span class="comment">// Downcasting acts like a mod 2^32 too.
</span>u <span class="kw">as </span>u32
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; MontyReducer&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="kw">fn </span>new(n: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>BigUint) -&gt; <span class="self">Self </span>{
<span class="kw">let </span>n0inv = inv_mod_u32(n.data[<span class="number">0</span>]);
MontyReducer { n: n, n0inv: n0inv }
}
}
<span class="comment">// Montgomery Reduction
//
// Reference:
// Brent &amp; Zimmermann, Modern Computer Arithmetic, v0.5.9, Algorithm 2.6
</span><span class="kw">fn </span>monty_redc(a: BigUint, mr: <span class="kw-2">&amp;</span>MontyReducer) -&gt; BigUint {
<span class="kw">let </span><span class="kw-2">mut </span>c = a.data;
<span class="kw">let </span>n = <span class="kw-2">&amp;</span>mr.n.data;
<span class="kw">let </span>n_size = n.len();
<span class="comment">// Allocate sufficient work space
</span>c.resize(<span class="number">2 </span>* n_size + <span class="number">2</span>, <span class="number">0</span>);
<span class="comment">// β is the size of a word, in this case 32 bits. So &quot;a mod β&quot; is
// equivalent to masking a to 32 bits.
// mu &lt;- -N^(-1) mod β
</span><span class="kw">let </span>mu = <span class="number">0u32</span>.wrapping_sub(mr.n0inv);
<span class="comment">// 1: for i = 0 to (n-1)
</span><span class="kw">for </span>i <span class="kw">in </span><span class="number">0</span>..n_size {
<span class="comment">// 2: q_i &lt;- mu*c_i mod β
</span><span class="kw">let </span>q_i = c[i].wrapping_mul(mu);
<span class="comment">// 3: C &lt;- C + q_i * N * β^i
</span><span class="kw">super</span>::algorithms::mac_digit(<span class="kw-2">&amp;mut </span>c[i..], n, q_i);
}
<span class="comment">// 4: R &lt;- C * β^(-n)
// This is an n-word bitshift, equivalent to skipping n words.
</span><span class="kw">let </span>ret = BigUint::new(c[n_size..].to_vec());
<span class="comment">// 5: if R &gt;= β^n then return R-N else return R.
</span><span class="kw">if </span>ret &lt; <span class="kw-2">*</span>mr.n {
ret
} <span class="kw">else </span>{
ret - mr.n
}
}
<span class="comment">// Montgomery Multiplication
</span><span class="kw">fn </span>monty_mult(a: BigUint, b: <span class="kw-2">&amp;</span>BigUint, mr: <span class="kw-2">&amp;</span>MontyReducer) -&gt; BigUint {
monty_redc(a * b, mr)
}
<span class="comment">// Montgomery Squaring
</span><span class="kw">fn </span>monty_sqr(a: BigUint, mr: <span class="kw-2">&amp;</span>MontyReducer) -&gt; BigUint {
<span class="comment">// TODO: Replace with an optimised squaring function
</span>monty_redc(<span class="kw-2">&amp;</span>a * <span class="kw-2">&amp;</span>a, mr)
}
<span class="kw">pub fn </span>monty_modpow(a: <span class="kw-2">&amp;</span>BigUint, exp: <span class="kw-2">&amp;</span>BigUint, modulus: <span class="kw-2">&amp;</span>BigUint) -&gt; BigUint {
<span class="kw">let </span>mr = MontyReducer::new(modulus);
<span class="comment">// Calculate the Montgomery parameter
</span><span class="kw">let </span><span class="kw-2">mut </span>v = <span class="macro">vec!</span>[<span class="number">0</span>; modulus.data.len()];
v.push(<span class="number">1</span>);
<span class="kw">let </span>r = BigUint::new(v);
<span class="comment">// Map the base to the Montgomery domain
</span><span class="kw">let </span><span class="kw-2">mut </span>apri = a * <span class="kw-2">&amp;</span>r % modulus;
<span class="comment">// Binary exponentiation
</span><span class="kw">let </span><span class="kw-2">mut </span>ans = <span class="kw-2">&amp;</span>r % modulus;
<span class="kw">let </span><span class="kw-2">mut </span>e = exp.clone();
<span class="kw">while </span>!e.is_zero() {
<span class="kw">if </span>e.is_odd() {
ans = monty_mult(ans, <span class="kw-2">&amp;</span>apri, <span class="kw-2">&amp;</span>mr);
}
apri = monty_sqr(apri, <span class="kw-2">&amp;</span>mr);
e &gt;&gt;= <span class="number">1</span>;
}
<span class="comment">// Map the result back to the residues domain
</span>monty_redc(ans, <span class="kw-2">&amp;</span>mr)
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="num_bigint" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>