| <!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/git/checkouts/incubator-teaclave-crates-c8106113f74feefc/ede1f68/rand/src/distributions/float.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>float.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="icon" href="https://www.rust-lang.org/favicon.ico"></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="../../../rand/index.html"><div class="logo-container"> |
| <img src="https://www.rust-lang.org/logos/rust-logo-128x128-blk.png" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../rand/index.html"> |
| <img src="https://www.rust-lang.org/logos/rust-logo-128x128-blk.png" 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> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| <span id="182">182</span> |
| <span id="183">183</span> |
| <span id="184">184</span> |
| <span id="185">185</span> |
| <span id="186">186</span> |
| <span id="187">187</span> |
| <span id="188">188</span> |
| <span id="189">189</span> |
| <span id="190">190</span> |
| <span id="191">191</span> |
| <span id="192">192</span> |
| <span id="193">193</span> |
| <span id="194">194</span> |
| <span id="195">195</span> |
| <span id="196">196</span> |
| <span id="197">197</span> |
| <span id="198">198</span> |
| <span id="199">199</span> |
| <span id="200">200</span> |
| <span id="201">201</span> |
| <span id="202">202</span> |
| <span id="203">203</span> |
| <span id="204">204</span> |
| <span id="205">205</span> |
| <span id="206">206</span> |
| <span id="207">207</span> |
| <span id="208">208</span> |
| <span id="209">209</span> |
| <span id="210">210</span> |
| <span id="211">211</span> |
| <span id="212">212</span> |
| <span id="213">213</span> |
| <span id="214">214</span> |
| <span id="215">215</span> |
| <span id="216">216</span> |
| <span id="217">217</span> |
| <span id="218">218</span> |
| <span id="219">219</span> |
| <span id="220">220</span> |
| <span id="221">221</span> |
| <span id="222">222</span> |
| <span id="223">223</span> |
| <span id="224">224</span> |
| <span id="225">225</span> |
| <span id="226">226</span> |
| <span id="227">227</span> |
| <span id="228">228</span> |
| <span id="229">229</span> |
| <span id="230">230</span> |
| <span id="231">231</span> |
| <span id="232">232</span> |
| <span id="233">233</span> |
| <span id="234">234</span> |
| <span id="235">235</span> |
| <span id="236">236</span> |
| <span id="237">237</span> |
| <span id="238">238</span> |
| <span id="239">239</span> |
| <span id="240">240</span> |
| <span id="241">241</span> |
| <span id="242">242</span> |
| <span id="243">243</span> |
| <span id="244">244</span> |
| <span id="245">245</span> |
| <span id="246">246</span> |
| <span id="247">247</span> |
| <span id="248">248</span> |
| <span id="249">249</span> |
| <span id="250">250</span> |
| <span id="251">251</span> |
| <span id="252">252</span> |
| <span id="253">253</span> |
| <span id="254">254</span> |
| <span id="255">255</span> |
| <span id="256">256</span> |
| <span id="257">257</span> |
| <span id="258">258</span> |
| <span id="259">259</span> |
| <span id="260">260</span> |
| <span id="261">261</span> |
| <span id="262">262</span> |
| <span id="263">263</span> |
| <span id="264">264</span> |
| <span id="265">265</span> |
| <span id="266">266</span> |
| <span id="267">267</span> |
| <span id="268">268</span> |
| <span id="269">269</span> |
| <span id="270">270</span> |
| <span id="271">271</span> |
| <span id="272">272</span> |
| <span id="273">273</span> |
| <span id="274">274</span> |
| <span id="275">275</span> |
| <span id="276">276</span> |
| <span id="277">277</span> |
| <span id="278">278</span> |
| <span id="279">279</span> |
| <span id="280">280</span> |
| <span id="281">281</span> |
| <span id="282">282</span> |
| <span id="283">283</span> |
| <span id="284">284</span> |
| <span id="285">285</span> |
| <span id="286">286</span> |
| <span id="287">287</span> |
| <span id="288">288</span> |
| <span id="289">289</span> |
| <span id="290">290</span> |
| <span id="291">291</span> |
| <span id="292">292</span> |
| <span id="293">293</span> |
| <span id="294">294</span> |
| <span id="295">295</span> |
| <span id="296">296</span> |
| <span id="297">297</span> |
| <span id="298">298</span> |
| <span id="299">299</span> |
| <span id="300">300</span> |
| <span id="301">301</span> |
| <span id="302">302</span> |
| <span id="303">303</span> |
| <span id="304">304</span> |
| <span id="305">305</span> |
| <span id="306">306</span> |
| <span id="307">307</span> |
| <span id="308">308</span> |
| <span id="309">309</span> |
| <span id="310">310</span> |
| <span id="311">311</span> |
| <span id="312">312</span> |
| </pre><pre class="rust"><code><span class="comment">// Copyright 2018 Developers of the Rand project. |
| // |
| // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or |
| // https://www.apache.org/licenses/LICENSE-2.0> or the MIT license |
| // <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your |
| // option. This file may not be copied, modified, or distributed |
| // except according to those terms. |
| |
| </span><span class="doccomment">//! Basic floating-point number distributions |
| |
| </span><span class="kw">use </span><span class="kw">crate</span>::distributions::utils::FloatSIMDUtils; |
| <span class="kw">use </span><span class="kw">crate</span>::distributions::{Distribution, Standard}; |
| <span class="kw">use </span><span class="kw">crate</span>::Rng; |
| <span class="kw">use </span>core::mem; |
| <span class="attribute">#[cfg(feature = <span class="string">"simd_support"</span>)] </span><span class="kw">use </span>packed_simd::<span class="kw-2">*</span>; |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"serde1"</span>)] |
| </span><span class="kw">use </span>serde::{Serialize, Deserialize}; |
| |
| <span class="doccomment">/// A distribution to sample floating point numbers uniformly in the half-open |
| /// interval `(0, 1]`, i.e. including 1 but not 0. |
| /// |
| /// All values that can be generated are of the form `n * ε/2`. For `f32` |
| /// the 24 most significant random bits of a `u32` are used and for `f64` the |
| /// 53 most significant bits of a `u64` are used. The conversion uses the |
| /// multiplicative method. |
| /// |
| /// See also: [`Standard`] which samples from `[0, 1)`, [`Open01`] |
| /// which samples from `(0, 1)` and [`Uniform`] which samples from arbitrary |
| /// ranges. |
| /// |
| /// # Example |
| /// ``` |
| /// use rand::{thread_rng, Rng}; |
| /// use rand::distributions::OpenClosed01; |
| /// |
| /// let val: f32 = thread_rng().sample(OpenClosed01); |
| /// println!("f32 from (0, 1): {}", val); |
| /// ``` |
| /// |
| /// [`Standard`]: crate::distributions::Standard |
| /// [`Open01`]: crate::distributions::Open01 |
| /// [`Uniform`]: crate::distributions::uniform::Uniform |
| </span><span class="attribute">#[derive(Clone, Copy, Debug)] |
| #[cfg_attr(feature = <span class="string">"serde1"</span>, derive(Serialize, Deserialize))] |
| </span><span class="kw">pub struct </span>OpenClosed01; |
| |
| <span class="doccomment">/// A distribution to sample floating point numbers uniformly in the open |
| /// interval `(0, 1)`, i.e. not including either endpoint. |
| /// |
| /// All values that can be generated are of the form `n * ε + ε/2`. For `f32` |
| /// the 23 most significant random bits of an `u32` are used, for `f64` 52 from |
| /// an `u64`. The conversion uses a transmute-based method. |
| /// |
| /// See also: [`Standard`] which samples from `[0, 1)`, [`OpenClosed01`] |
| /// which samples from `(0, 1]` and [`Uniform`] which samples from arbitrary |
| /// ranges. |
| /// |
| /// # Example |
| /// ``` |
| /// use rand::{thread_rng, Rng}; |
| /// use rand::distributions::Open01; |
| /// |
| /// let val: f32 = thread_rng().sample(Open01); |
| /// println!("f32 from (0, 1): {}", val); |
| /// ``` |
| /// |
| /// [`Standard`]: crate::distributions::Standard |
| /// [`OpenClosed01`]: crate::distributions::OpenClosed01 |
| /// [`Uniform`]: crate::distributions::uniform::Uniform |
| </span><span class="attribute">#[derive(Clone, Copy, Debug)] |
| #[cfg_attr(feature = <span class="string">"serde1"</span>, derive(Serialize, Deserialize))] |
| </span><span class="kw">pub struct </span>Open01; |
| |
| |
| <span class="comment">// This trait is needed by both this lib and rand_distr hence is a hidden export |
| </span><span class="attribute">#[doc(hidden)] |
| </span><span class="kw">pub trait </span>IntoFloat { |
| <span class="kw">type </span>F; |
| |
| <span class="doccomment">/// Helper method to combine the fraction and a constant exponent into a |
| /// float. |
| /// |
| /// Only the least significant bits of `self` may be set, 23 for `f32` and |
| /// 52 for `f64`. |
| /// The resulting value will fall in a range that depends on the exponent. |
| /// As an example the range with exponent 0 will be |
| /// [2<sup>0</sup>..2<sup>1</sup>), which is [1..2). |
| </span><span class="kw">fn </span>into_float_with_exponent(<span class="self">self</span>, exponent: i32) -> <span class="self">Self</span>::F; |
| } |
| |
| <span class="macro">macro_rules! </span>float_impls { |
| (<span class="macro-nonterminal">$ty</span>:ident, <span class="macro-nonterminal">$uty</span>:ident, <span class="macro-nonterminal">$f_scalar</span>:ident, <span class="macro-nonterminal">$u_scalar</span>:ty, |
| <span class="macro-nonterminal">$fraction_bits</span>:expr, <span class="macro-nonterminal">$exponent_bias</span>:expr) => { |
| <span class="kw">impl </span>IntoFloat <span class="kw">for </span><span class="macro-nonterminal">$uty </span>{ |
| <span class="kw">type </span>F = <span class="macro-nonterminal">$ty</span>; |
| <span class="attribute">#[inline(always)] |
| </span><span class="kw">fn </span>into_float_with_exponent(<span class="self">self</span>, exponent: i32) -> <span class="macro-nonterminal">$ty </span>{ |
| <span class="comment">// The exponent is encoded using an offset-binary representation |
| </span><span class="kw">let </span>exponent_bits: <span class="macro-nonterminal">$u_scalar </span>= |
| ((<span class="macro-nonterminal">$exponent_bias </span>+ exponent) <span class="kw">as </span><span class="macro-nonterminal">$u_scalar</span>) << <span class="macro-nonterminal">$fraction_bits</span>; |
| <span class="macro-nonterminal">$ty::from_bits</span>(<span class="self">self </span>| exponent_bits) |
| } |
| } |
| |
| <span class="kw">impl </span>Distribution<<span class="macro-nonterminal">$ty</span>> <span class="kw">for </span>Standard { |
| <span class="kw">fn </span>sample<R: Rng + <span class="question-mark">?</span>Sized>(<span class="kw-2">&</span><span class="self">self</span>, rng: <span class="kw-2">&mut </span>R) -> <span class="macro-nonterminal">$ty </span>{ |
| <span class="comment">// Multiply-based method; 24/53 random bits; [0, 1) interval. |
| // We use the most significant bits because for simple RNGs |
| // those are usually more random. |
| </span><span class="kw">let </span>float_size = mem::size_of::<<span class="macro-nonterminal">$f_scalar</span>>() <span class="kw">as </span>u32 * <span class="number">8</span>; |
| <span class="kw">let </span>precision = <span class="macro-nonterminal">$fraction_bits </span>+ <span class="number">1</span>; |
| <span class="kw">let </span>scale = <span class="number">1.0 </span>/ ((<span class="number">1 </span><span class="kw">as </span><span class="macro-nonterminal">$u_scalar </span><< precision) <span class="kw">as </span><span class="macro-nonterminal">$f_scalar</span>); |
| |
| <span class="kw">let </span>value: <span class="macro-nonterminal">$uty </span>= rng.gen(); |
| <span class="kw">let </span>value = value >> (float_size - precision); |
| scale * <span class="macro-nonterminal">$ty::cast_from_int</span>(value) |
| } |
| } |
| |
| <span class="kw">impl </span>Distribution<<span class="macro-nonterminal">$ty</span>> <span class="kw">for </span>OpenClosed01 { |
| <span class="kw">fn </span>sample<R: Rng + <span class="question-mark">?</span>Sized>(<span class="kw-2">&</span><span class="self">self</span>, rng: <span class="kw-2">&mut </span>R) -> <span class="macro-nonterminal">$ty </span>{ |
| <span class="comment">// Multiply-based method; 24/53 random bits; (0, 1] interval. |
| // We use the most significant bits because for simple RNGs |
| // those are usually more random. |
| </span><span class="kw">let </span>float_size = mem::size_of::<<span class="macro-nonterminal">$f_scalar</span>>() <span class="kw">as </span>u32 * <span class="number">8</span>; |
| <span class="kw">let </span>precision = <span class="macro-nonterminal">$fraction_bits </span>+ <span class="number">1</span>; |
| <span class="kw">let </span>scale = <span class="number">1.0 </span>/ ((<span class="number">1 </span><span class="kw">as </span><span class="macro-nonterminal">$u_scalar </span><< precision) <span class="kw">as </span><span class="macro-nonterminal">$f_scalar</span>); |
| |
| <span class="kw">let </span>value: <span class="macro-nonterminal">$uty </span>= rng.gen(); |
| <span class="kw">let </span>value = value >> (float_size - precision); |
| <span class="comment">// Add 1 to shift up; will not overflow because of right-shift: |
| </span>scale * <span class="macro-nonterminal">$ty::cast_from_int</span>(value + <span class="number">1</span>) |
| } |
| } |
| |
| <span class="kw">impl </span>Distribution<<span class="macro-nonterminal">$ty</span>> <span class="kw">for </span>Open01 { |
| <span class="kw">fn </span>sample<R: Rng + <span class="question-mark">?</span>Sized>(<span class="kw-2">&</span><span class="self">self</span>, rng: <span class="kw-2">&mut </span>R) -> <span class="macro-nonterminal">$ty </span>{ |
| <span class="comment">// Transmute-based method; 23/52 random bits; (0, 1) interval. |
| // We use the most significant bits because for simple RNGs |
| // those are usually more random. |
| </span><span class="kw">use </span>core::<span class="macro-nonterminal">$f_scalar::EPSILON</span>; |
| <span class="kw">let </span>float_size = mem::size_of::<<span class="macro-nonterminal">$f_scalar</span>>() <span class="kw">as </span>u32 * <span class="number">8</span>; |
| |
| <span class="kw">let </span>value: <span class="macro-nonterminal">$uty </span>= rng.gen(); |
| <span class="kw">let </span>fraction = value >> (float_size - <span class="macro-nonterminal">$fraction_bits</span>); |
| fraction.into_float_with_exponent(<span class="number">0</span>) - (<span class="number">1.0 </span>- EPSILON / <span class="number">2.0</span>) |
| } |
| } |
| } |
| } |
| |
| <span class="macro">float_impls! </span>{ f32, u32, f32, u32, <span class="number">23</span>, <span class="number">127 </span>} |
| <span class="macro">float_impls! </span>{ f64, u64, f64, u64, <span class="number">52</span>, <span class="number">1023 </span>} |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"simd_support"</span>)] |
| </span><span class="macro">float_impls! </span>{ f32x2, u32x2, f32, u32, <span class="number">23</span>, <span class="number">127 </span>} |
| <span class="attribute">#[cfg(feature = <span class="string">"simd_support"</span>)] |
| </span><span class="macro">float_impls! </span>{ f32x4, u32x4, f32, u32, <span class="number">23</span>, <span class="number">127 </span>} |
| <span class="attribute">#[cfg(feature = <span class="string">"simd_support"</span>)] |
| </span><span class="macro">float_impls! </span>{ f32x8, u32x8, f32, u32, <span class="number">23</span>, <span class="number">127 </span>} |
| <span class="attribute">#[cfg(feature = <span class="string">"simd_support"</span>)] |
| </span><span class="macro">float_impls! </span>{ f32x16, u32x16, f32, u32, <span class="number">23</span>, <span class="number">127 </span>} |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"simd_support"</span>)] |
| </span><span class="macro">float_impls! </span>{ f64x2, u64x2, f64, u64, <span class="number">52</span>, <span class="number">1023 </span>} |
| <span class="attribute">#[cfg(feature = <span class="string">"simd_support"</span>)] |
| </span><span class="macro">float_impls! </span>{ f64x4, u64x4, f64, u64, <span class="number">52</span>, <span class="number">1023 </span>} |
| <span class="attribute">#[cfg(feature = <span class="string">"simd_support"</span>)] |
| </span><span class="macro">float_impls! </span>{ f64x8, u64x8, f64, u64, <span class="number">52</span>, <span class="number">1023 </span>} |
| |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>tests { |
| <span class="kw">use super</span>::<span class="kw-2">*</span>; |
| <span class="kw">use </span><span class="kw">crate</span>::rngs::mock::StepRng; |
| |
| <span class="kw">const </span>EPSILON32: f32 = ::core::f32::EPSILON; |
| <span class="kw">const </span>EPSILON64: f64 = ::core::f64::EPSILON; |
| |
| <span class="macro">macro_rules! </span>test_f32 { |
| (<span class="macro-nonterminal">$fnn</span>:ident, <span class="macro-nonterminal">$ty</span>:ident, <span class="macro-nonterminal">$ZERO</span>:expr, <span class="macro-nonterminal">$EPSILON</span>:expr) => { |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span><span class="macro-nonterminal">$fnn</span>() { |
| <span class="comment">// Standard |
| </span><span class="kw">let </span><span class="kw-2">mut </span>zeros = StepRng::new(<span class="number">0</span>, <span class="number">0</span>); |
| <span class="macro">assert_eq!</span>(zeros.gen::<<span class="macro-nonterminal">$ty</span>>(), <span class="macro-nonterminal">$ZERO</span>); |
| <span class="kw">let </span><span class="kw-2">mut </span>one = StepRng::new(<span class="number">1 </span><< <span class="number">8 </span>| <span class="number">1 </span><< (<span class="number">8 </span>+ <span class="number">32</span>), <span class="number">0</span>); |
| <span class="macro">assert_eq!</span>(one.gen::<<span class="macro-nonterminal">$ty</span>>(), <span class="macro-nonterminal">$EPSILON </span>/ <span class="number">2.0</span>); |
| <span class="kw">let </span><span class="kw-2">mut </span>max = StepRng::new(!<span class="number">0</span>, <span class="number">0</span>); |
| <span class="macro">assert_eq!</span>(max.gen::<<span class="macro-nonterminal">$ty</span>>(), <span class="number">1.0 </span>- <span class="macro-nonterminal">$EPSILON </span>/ <span class="number">2.0</span>); |
| |
| <span class="comment">// OpenClosed01 |
| </span><span class="kw">let </span><span class="kw-2">mut </span>zeros = StepRng::new(<span class="number">0</span>, <span class="number">0</span>); |
| <span class="macro">assert_eq!</span>(zeros.sample::<<span class="macro-nonterminal">$ty</span>, <span class="kw">_</span>>(OpenClosed01), <span class="number">0.0 </span>+ <span class="macro-nonterminal">$EPSILON </span>/ <span class="number">2.0</span>); |
| <span class="kw">let </span><span class="kw-2">mut </span>one = StepRng::new(<span class="number">1 </span><< <span class="number">8 </span>| <span class="number">1 </span><< (<span class="number">8 </span>+ <span class="number">32</span>), <span class="number">0</span>); |
| <span class="macro">assert_eq!</span>(one.sample::<<span class="macro-nonterminal">$ty</span>, <span class="kw">_</span>>(OpenClosed01), <span class="macro-nonterminal">$EPSILON</span>); |
| <span class="kw">let </span><span class="kw-2">mut </span>max = StepRng::new(!<span class="number">0</span>, <span class="number">0</span>); |
| <span class="macro">assert_eq!</span>(max.sample::<<span class="macro-nonterminal">$ty</span>, <span class="kw">_</span>>(OpenClosed01), <span class="macro-nonterminal">$ZERO </span>+ <span class="number">1.0</span>); |
| |
| <span class="comment">// Open01 |
| </span><span class="kw">let </span><span class="kw-2">mut </span>zeros = StepRng::new(<span class="number">0</span>, <span class="number">0</span>); |
| <span class="macro">assert_eq!</span>(zeros.sample::<<span class="macro-nonterminal">$ty</span>, <span class="kw">_</span>>(Open01), <span class="number">0.0 </span>+ <span class="macro-nonterminal">$EPSILON </span>/ <span class="number">2.0</span>); |
| <span class="kw">let </span><span class="kw-2">mut </span>one = StepRng::new(<span class="number">1 </span><< <span class="number">9 </span>| <span class="number">1 </span><< (<span class="number">9 </span>+ <span class="number">32</span>), <span class="number">0</span>); |
| <span class="macro">assert_eq!</span>(one.sample::<<span class="macro-nonterminal">$ty</span>, <span class="kw">_</span>>(Open01), <span class="macro-nonterminal">$EPSILON </span>/ <span class="number">2.0 </span>* <span class="number">3.0</span>); |
| <span class="kw">let </span><span class="kw-2">mut </span>max = StepRng::new(!<span class="number">0</span>, <span class="number">0</span>); |
| <span class="macro">assert_eq!</span>(max.sample::<<span class="macro-nonterminal">$ty</span>, <span class="kw">_</span>>(Open01), <span class="number">1.0 </span>- <span class="macro-nonterminal">$EPSILON </span>/ <span class="number">2.0</span>); |
| } |
| }; |
| } |
| <span class="macro">test_f32! </span>{ f32_edge_cases, f32, <span class="number">0.0</span>, EPSILON32 } |
| <span class="attribute">#[cfg(feature = <span class="string">"simd_support"</span>)] |
| </span><span class="macro">test_f32! </span>{ f32x2_edge_cases, f32x2, f32x2::splat(<span class="number">0.0</span>), f32x2::splat(EPSILON32) } |
| <span class="attribute">#[cfg(feature = <span class="string">"simd_support"</span>)] |
| </span><span class="macro">test_f32! </span>{ f32x4_edge_cases, f32x4, f32x4::splat(<span class="number">0.0</span>), f32x4::splat(EPSILON32) } |
| <span class="attribute">#[cfg(feature = <span class="string">"simd_support"</span>)] |
| </span><span class="macro">test_f32! </span>{ f32x8_edge_cases, f32x8, f32x8::splat(<span class="number">0.0</span>), f32x8::splat(EPSILON32) } |
| <span class="attribute">#[cfg(feature = <span class="string">"simd_support"</span>)] |
| </span><span class="macro">test_f32! </span>{ f32x16_edge_cases, f32x16, f32x16::splat(<span class="number">0.0</span>), f32x16::splat(EPSILON32) } |
| |
| <span class="macro">macro_rules! </span>test_f64 { |
| (<span class="macro-nonterminal">$fnn</span>:ident, <span class="macro-nonterminal">$ty</span>:ident, <span class="macro-nonterminal">$ZERO</span>:expr, <span class="macro-nonterminal">$EPSILON</span>:expr) => { |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span><span class="macro-nonterminal">$fnn</span>() { |
| <span class="comment">// Standard |
| </span><span class="kw">let </span><span class="kw-2">mut </span>zeros = StepRng::new(<span class="number">0</span>, <span class="number">0</span>); |
| <span class="macro">assert_eq!</span>(zeros.gen::<<span class="macro-nonterminal">$ty</span>>(), <span class="macro-nonterminal">$ZERO</span>); |
| <span class="kw">let </span><span class="kw-2">mut </span>one = StepRng::new(<span class="number">1 </span><< <span class="number">11</span>, <span class="number">0</span>); |
| <span class="macro">assert_eq!</span>(one.gen::<<span class="macro-nonterminal">$ty</span>>(), <span class="macro-nonterminal">$EPSILON </span>/ <span class="number">2.0</span>); |
| <span class="kw">let </span><span class="kw-2">mut </span>max = StepRng::new(!<span class="number">0</span>, <span class="number">0</span>); |
| <span class="macro">assert_eq!</span>(max.gen::<<span class="macro-nonterminal">$ty</span>>(), <span class="number">1.0 </span>- <span class="macro-nonterminal">$EPSILON </span>/ <span class="number">2.0</span>); |
| |
| <span class="comment">// OpenClosed01 |
| </span><span class="kw">let </span><span class="kw-2">mut </span>zeros = StepRng::new(<span class="number">0</span>, <span class="number">0</span>); |
| <span class="macro">assert_eq!</span>(zeros.sample::<<span class="macro-nonterminal">$ty</span>, <span class="kw">_</span>>(OpenClosed01), <span class="number">0.0 </span>+ <span class="macro-nonterminal">$EPSILON </span>/ <span class="number">2.0</span>); |
| <span class="kw">let </span><span class="kw-2">mut </span>one = StepRng::new(<span class="number">1 </span><< <span class="number">11</span>, <span class="number">0</span>); |
| <span class="macro">assert_eq!</span>(one.sample::<<span class="macro-nonterminal">$ty</span>, <span class="kw">_</span>>(OpenClosed01), <span class="macro-nonterminal">$EPSILON</span>); |
| <span class="kw">let </span><span class="kw-2">mut </span>max = StepRng::new(!<span class="number">0</span>, <span class="number">0</span>); |
| <span class="macro">assert_eq!</span>(max.sample::<<span class="macro-nonterminal">$ty</span>, <span class="kw">_</span>>(OpenClosed01), <span class="macro-nonterminal">$ZERO </span>+ <span class="number">1.0</span>); |
| |
| <span class="comment">// Open01 |
| </span><span class="kw">let </span><span class="kw-2">mut </span>zeros = StepRng::new(<span class="number">0</span>, <span class="number">0</span>); |
| <span class="macro">assert_eq!</span>(zeros.sample::<<span class="macro-nonterminal">$ty</span>, <span class="kw">_</span>>(Open01), <span class="number">0.0 </span>+ <span class="macro-nonterminal">$EPSILON </span>/ <span class="number">2.0</span>); |
| <span class="kw">let </span><span class="kw-2">mut </span>one = StepRng::new(<span class="number">1 </span><< <span class="number">12</span>, <span class="number">0</span>); |
| <span class="macro">assert_eq!</span>(one.sample::<<span class="macro-nonterminal">$ty</span>, <span class="kw">_</span>>(Open01), <span class="macro-nonterminal">$EPSILON </span>/ <span class="number">2.0 </span>* <span class="number">3.0</span>); |
| <span class="kw">let </span><span class="kw-2">mut </span>max = StepRng::new(!<span class="number">0</span>, <span class="number">0</span>); |
| <span class="macro">assert_eq!</span>(max.sample::<<span class="macro-nonterminal">$ty</span>, <span class="kw">_</span>>(Open01), <span class="number">1.0 </span>- <span class="macro-nonterminal">$EPSILON </span>/ <span class="number">2.0</span>); |
| } |
| }; |
| } |
| <span class="macro">test_f64! </span>{ f64_edge_cases, f64, <span class="number">0.0</span>, EPSILON64 } |
| <span class="attribute">#[cfg(feature = <span class="string">"simd_support"</span>)] |
| </span><span class="macro">test_f64! </span>{ f64x2_edge_cases, f64x2, f64x2::splat(<span class="number">0.0</span>), f64x2::splat(EPSILON64) } |
| <span class="attribute">#[cfg(feature = <span class="string">"simd_support"</span>)] |
| </span><span class="macro">test_f64! </span>{ f64x4_edge_cases, f64x4, f64x4::splat(<span class="number">0.0</span>), f64x4::splat(EPSILON64) } |
| <span class="attribute">#[cfg(feature = <span class="string">"simd_support"</span>)] |
| </span><span class="macro">test_f64! </span>{ f64x8_edge_cases, f64x8, f64x8::splat(<span class="number">0.0</span>), f64x8::splat(EPSILON64) } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>value_stability() { |
| <span class="kw">fn </span>test_samples<T: Copy + core::fmt::Debug + PartialEq, D: Distribution<T>>( |
| distr: <span class="kw-2">&</span>D, zero: T, expected: <span class="kw-2">&</span>[T], |
| ) { |
| <span class="kw">let </span><span class="kw-2">mut </span>rng = <span class="kw">crate</span>::test::rng(<span class="number">0x6f44f5646c2a7334</span>); |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [zero; <span class="number">3</span>]; |
| <span class="kw">for </span>x <span class="kw">in </span><span class="kw-2">&mut </span>buf { |
| <span class="kw-2">*</span>x = rng.sample(<span class="kw-2">&</span>distr); |
| } |
| <span class="macro">assert_eq!</span>(<span class="kw-2">&</span>buf, expected); |
| } |
| |
| test_samples(<span class="kw-2">&</span>Standard, <span class="number">0f32</span>, <span class="kw-2">&</span>[<span class="number">0.0035963655</span>, <span class="number">0.7346052</span>, <span class="number">0.09778172</span>]); |
| test_samples(<span class="kw-2">&</span>Standard, <span class="number">0f64</span>, <span class="kw-2">&</span>[ |
| <span class="number">0.7346051961657583</span>, |
| <span class="number">0.20298547462974248</span>, |
| <span class="number">0.8166436635290655</span>, |
| ]); |
| |
| test_samples(<span class="kw-2">&</span>OpenClosed01, <span class="number">0f32</span>, <span class="kw-2">&</span>[<span class="number">0.003596425</span>, <span class="number">0.73460525</span>, <span class="number">0.09778178</span>]); |
| test_samples(<span class="kw-2">&</span>OpenClosed01, <span class="number">0f64</span>, <span class="kw-2">&</span>[ |
| <span class="number">0.7346051961657584</span>, |
| <span class="number">0.2029854746297426</span>, |
| <span class="number">0.8166436635290656</span>, |
| ]); |
| |
| test_samples(<span class="kw-2">&</span>Open01, <span class="number">0f32</span>, <span class="kw-2">&</span>[<span class="number">0.0035963655</span>, <span class="number">0.73460525</span>, <span class="number">0.09778172</span>]); |
| test_samples(<span class="kw-2">&</span>Open01, <span class="number">0f64</span>, <span class="kw-2">&</span>[ |
| <span class="number">0.7346051961657584</span>, |
| <span class="number">0.20298547462974248</span>, |
| <span class="number">0.8166436635290656</span>, |
| ]); |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"simd_support"</span>)] |
| </span>{ |
| <span class="comment">// We only test a sub-set of types here. Values are identical to |
| // non-SIMD types; we assume this pattern continues across all |
| // SIMD types. |
| |
| </span>test_samples(<span class="kw-2">&</span>Standard, f32x2::new(<span class="number">0.0</span>, <span class="number">0.0</span>), <span class="kw-2">&</span>[ |
| f32x2::new(<span class="number">0.0035963655</span>, <span class="number">0.7346052</span>), |
| f32x2::new(<span class="number">0.09778172</span>, <span class="number">0.20298547</span>), |
| f32x2::new(<span class="number">0.34296435</span>, <span class="number">0.81664366</span>), |
| ]); |
| |
| test_samples(<span class="kw-2">&</span>Standard, f64x2::new(<span class="number">0.0</span>, <span class="number">0.0</span>), <span class="kw-2">&</span>[ |
| f64x2::new(<span class="number">0.7346051961657583</span>, <span class="number">0.20298547462974248</span>), |
| f64x2::new(<span class="number">0.8166436635290655</span>, <span class="number">0.7423708925400552</span>), |
| f64x2::new(<span class="number">0.16387782224016323</span>, <span class="number">0.9087068770169618</span>), |
| ]); |
| } |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="rand" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |