blob: fc4a644027e7952eae13e6420bb73b0a32f5726f [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/ring-0.16.20/src/ec/suite_b/ops/elem.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>elem.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="../../../../../ring/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="../../../../../ring/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>
</pre><pre class="rust"><code><span class="comment">// Copyright 2017 Brian Smith.
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHORS DISCLAIM ALL WARRANTIES
// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
// SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
// OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
// CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
</span><span class="kw">use crate</span>::{
arithmetic::montgomery::{Encoding, ProductEncoding},
limb::{Limb, LIMB_BITS},
};
<span class="kw">use </span>core::marker::PhantomData;
<span class="doccomment">/// Elements of ℤ/mℤ for some modulus *m*. Elements are always fully reduced
/// with respect to *m*; i.e. the 0 &lt;= x &lt; m for every value x.
</span><span class="attribute">#[derive(Clone, Copy)]
</span><span class="kw">pub struct </span>Elem&lt;M, E: Encoding&gt; {
<span class="comment">// XXX: pub
</span><span class="kw">pub </span>limbs: [Limb; MAX_LIMBS],
<span class="doccomment">/// The modulus *m* for the ring ℤ/mℤ for which this element is a value.
</span><span class="kw">pub </span>m: PhantomData&lt;M&gt;,
<span class="doccomment">/// The number of Montgomery factors that need to be canceled out from
/// `value` to get the actual value.
</span><span class="kw">pub </span>encoding: PhantomData&lt;E&gt;,
}
<span class="kw">impl</span>&lt;M, E: Encoding&gt; Elem&lt;M, E&gt; {
<span class="comment">// There&#39;s no need to convert `value` to the Montgomery domain since
// 0 * R**2 (mod m) == 0, so neither the modulus nor the encoding are needed
// as inputs for constructing a zero-valued element.
</span><span class="kw">pub fn </span>zero() -&gt; <span class="self">Self </span>{
<span class="self">Self </span>{
limbs: [<span class="number">0</span>; MAX_LIMBS],
m: PhantomData,
encoding: PhantomData,
}
}
}
<span class="attribute">#[inline]
</span><span class="kw">pub fn </span>mul_mont&lt;M, EA: Encoding, EB: Encoding&gt;(
f: <span class="kw">unsafe extern </span><span class="string">&quot;C&quot; </span><span class="kw">fn</span>(r: <span class="kw-2">*mut </span>Limb, a: <span class="kw-2">*const </span>Limb, b: <span class="kw-2">*const </span>Limb),
a: <span class="kw-2">&amp;</span>Elem&lt;M, EA&gt;,
b: <span class="kw-2">&amp;</span>Elem&lt;M, EB&gt;,
) -&gt; Elem&lt;M, &lt;(EA, EB) <span class="kw">as </span>ProductEncoding&gt;::Output&gt;
<span class="kw">where
</span>(EA, EB): ProductEncoding,
{
binary_op(f, a, b)
}
<span class="comment">// let r = f(a, b); return r;
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>binary_op&lt;M, EA: Encoding, EB: Encoding, ER: Encoding&gt;(
f: <span class="kw">unsafe extern </span><span class="string">&quot;C&quot; </span><span class="kw">fn</span>(r: <span class="kw-2">*mut </span>Limb, a: <span class="kw-2">*const </span>Limb, b: <span class="kw-2">*const </span>Limb),
a: <span class="kw-2">&amp;</span>Elem&lt;M, EA&gt;,
b: <span class="kw-2">&amp;</span>Elem&lt;M, EB&gt;,
) -&gt; Elem&lt;M, ER&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>r = Elem {
limbs: [<span class="number">0</span>; MAX_LIMBS],
m: PhantomData,
encoding: PhantomData,
};
<span class="kw">unsafe </span>{ f(r.limbs.as_mut_ptr(), a.limbs.as_ptr(), b.limbs.as_ptr()) }
r
}
<span class="comment">// a := f(a, b);
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>binary_op_assign&lt;M, EA: Encoding, EB: Encoding&gt;(
f: <span class="kw">unsafe extern </span><span class="string">&quot;C&quot; </span><span class="kw">fn</span>(r: <span class="kw-2">*mut </span>Limb, a: <span class="kw-2">*const </span>Limb, b: <span class="kw-2">*const </span>Limb),
a: <span class="kw-2">&amp;mut </span>Elem&lt;M, EA&gt;,
b: <span class="kw-2">&amp;</span>Elem&lt;M, EB&gt;,
) {
<span class="kw">unsafe </span>{ f(a.limbs.as_mut_ptr(), a.limbs.as_ptr(), b.limbs.as_ptr()) }
}
<span class="comment">// let r = f(a); return r;
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>unary_op&lt;M, E: Encoding&gt;(
f: <span class="kw">unsafe extern </span><span class="string">&quot;C&quot; </span><span class="kw">fn</span>(r: <span class="kw-2">*mut </span>Limb, a: <span class="kw-2">*const </span>Limb),
a: <span class="kw-2">&amp;</span>Elem&lt;M, E&gt;,
) -&gt; Elem&lt;M, E&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>r = Elem {
limbs: [<span class="number">0</span>; MAX_LIMBS],
m: PhantomData,
encoding: PhantomData,
};
<span class="kw">unsafe </span>{ f(r.limbs.as_mut_ptr(), a.limbs.as_ptr()) }
r
}
<span class="comment">// a := f(a);
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>unary_op_assign&lt;M, E: Encoding&gt;(
f: <span class="kw">unsafe extern </span><span class="string">&quot;C&quot; </span><span class="kw">fn</span>(r: <span class="kw-2">*mut </span>Limb, a: <span class="kw-2">*const </span>Limb),
a: <span class="kw-2">&amp;mut </span>Elem&lt;M, E&gt;,
) {
<span class="kw">unsafe </span>{ f(a.limbs.as_mut_ptr(), a.limbs.as_ptr()) }
}
<span class="comment">// a := f(a, a);
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>unary_op_from_binary_op_assign&lt;M, E: Encoding&gt;(
f: <span class="kw">unsafe extern </span><span class="string">&quot;C&quot; </span><span class="kw">fn</span>(r: <span class="kw-2">*mut </span>Limb, a: <span class="kw-2">*const </span>Limb, b: <span class="kw-2">*const </span>Limb),
a: <span class="kw-2">&amp;mut </span>Elem&lt;M, E&gt;,
) {
<span class="kw">unsafe </span>{ f(a.limbs.as_mut_ptr(), a.limbs.as_ptr(), a.limbs.as_ptr()) }
}
<span class="kw">pub const </span>MAX_LIMBS: usize = (<span class="number">384 </span>+ (LIMB_BITS - <span class="number">1</span>)) / LIMB_BITS;
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../../" data-current-crate="ring" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>