| <!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/rand-0.8.5/src/distributions/other.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>other.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> |
| <span id="313">313</span> |
| <span id="314">314</span> |
| <span id="315">315</span> |
| <span id="316">316</span> |
| <span id="317">317</span> |
| <span id="318">318</span> |
| <span id="319">319</span> |
| <span id="320">320</span> |
| <span id="321">321</span> |
| <span id="322">322</span> |
| <span id="323">323</span> |
| <span id="324">324</span> |
| <span id="325">325</span> |
| <span id="326">326</span> |
| <span id="327">327</span> |
| <span id="328">328</span> |
| <span id="329">329</span> |
| <span id="330">330</span> |
| <span id="331">331</span> |
| <span id="332">332</span> |
| <span id="333">333</span> |
| <span id="334">334</span> |
| <span id="335">335</span> |
| <span id="336">336</span> |
| <span id="337">337</span> |
| <span id="338">338</span> |
| <span id="339">339</span> |
| <span id="340">340</span> |
| <span id="341">341</span> |
| <span id="342">342</span> |
| <span id="343">343</span> |
| <span id="344">344</span> |
| <span id="345">345</span> |
| <span id="346">346</span> |
| <span id="347">347</span> |
| <span id="348">348</span> |
| <span id="349">349</span> |
| <span id="350">350</span> |
| <span id="351">351</span> |
| <span id="352">352</span> |
| <span id="353">353</span> |
| <span id="354">354</span> |
| <span id="355">355</span> |
| <span id="356">356</span> |
| <span id="357">357</span> |
| <span id="358">358</span> |
| <span id="359">359</span> |
| <span id="360">360</span> |
| <span id="361">361</span> |
| <span id="362">362</span> |
| <span id="363">363</span> |
| <span id="364">364</span> |
| <span id="365">365</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">//! The implementations of the `Standard` distribution for other built-in types. |
| |
| </span><span class="kw">use </span>core::char; |
| <span class="kw">use </span>core::num::Wrapping; |
| <span class="attribute">#[cfg(feature = <span class="string">"alloc"</span>)] |
| </span><span class="kw">use </span>alloc::string::String; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::distributions::{Distribution, Standard, Uniform}; |
| <span class="attribute">#[cfg(feature = <span class="string">"alloc"</span>)] |
| </span><span class="kw">use </span><span class="kw">crate</span>::distributions::DistString; |
| <span class="kw">use </span><span class="kw">crate</span>::Rng; |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"serde1"</span>)] |
| </span><span class="kw">use </span>serde::{Serialize, Deserialize}; |
| <span class="attribute">#[cfg(feature = <span class="string">"min_const_gen"</span>)] |
| </span><span class="kw">use </span>core::mem::{<span class="self">self</span>, MaybeUninit}; |
| |
| |
| <span class="comment">// ----- Sampling distributions ----- |
| |
| </span><span class="doccomment">/// Sample a `u8`, uniformly distributed over ASCII letters and numbers: |
| /// a-z, A-Z and 0-9. |
| /// |
| /// # Example |
| /// |
| /// ``` |
| /// use rand::{Rng, thread_rng}; |
| /// use rand::distributions::Alphanumeric; |
| /// |
| /// let mut rng = thread_rng(); |
| /// let chars: String = (0..7).map(|_| rng.sample(Alphanumeric) as char).collect(); |
| /// println!("Random chars: {}", chars); |
| /// ``` |
| /// |
| /// The [`DistString`] trait provides an easier method of generating |
| /// a random `String`, and offers more efficient allocation: |
| /// ``` |
| /// use rand::distributions::{Alphanumeric, DistString}; |
| /// let string = Alphanumeric.sample_string(&mut rand::thread_rng(), 16); |
| /// println!("Random string: {}", string); |
| /// ``` |
| /// |
| /// # Passwords |
| /// |
| /// Users sometimes ask whether it is safe to use a string of random characters |
| /// as a password. In principle, all RNGs in Rand implementing `CryptoRng` are |
| /// suitable as a source of randomness for generating passwords (if they are |
| /// properly seeded), but it is more conservative to only use randomness |
| /// directly from the operating system via the `getrandom` crate, or the |
| /// corresponding bindings of a crypto library. |
| /// |
| /// When generating passwords or keys, it is important to consider the threat |
| /// model and in some cases the memorability of the password. This is out of |
| /// scope of the Rand project, and therefore we defer to the following |
| /// references: |
| /// |
| /// - [Wikipedia article on Password Strength](https://en.wikipedia.org/wiki/Password_strength) |
| /// - [Diceware for generating memorable passwords](https://en.wikipedia.org/wiki/Diceware) |
| </span><span class="attribute">#[derive(Debug, Clone, Copy)] |
| #[cfg_attr(feature = <span class="string">"serde1"</span>, derive(Serialize, Deserialize))] |
| </span><span class="kw">pub struct </span>Alphanumeric; |
| |
| |
| <span class="comment">// ----- Implementations of distributions ----- |
| |
| </span><span class="kw">impl </span>Distribution<char> <span class="kw">for </span>Standard { |
| <span class="attribute">#[inline] |
| </span><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) -> char { |
| <span class="comment">// A valid `char` is either in the interval `[0, 0xD800)` or |
| // `(0xDFFF, 0x11_0000)`. All `char`s must therefore be in |
| // `[0, 0x11_0000)` but not in the "gap" `[0xD800, 0xDFFF]` which is |
| // reserved for surrogates. This is the size of that gap. |
| </span><span class="kw">const </span>GAP_SIZE: u32 = <span class="number">0xDFFF </span>- <span class="number">0xD800 </span>+ <span class="number">1</span>; |
| |
| <span class="comment">// Uniform::new(0, 0x11_0000 - GAP_SIZE) can also be used but it |
| // seemed slower. |
| </span><span class="kw">let </span>range = Uniform::new(GAP_SIZE, <span class="number">0x11_0000</span>); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>n = range.sample(rng); |
| <span class="kw">if </span>n <= <span class="number">0xDFFF </span>{ |
| n -= GAP_SIZE; |
| } |
| <span class="kw">unsafe </span>{ char::from_u32_unchecked(n) } |
| } |
| } |
| |
| <span class="doccomment">/// Note: the `String` is potentially left with excess capacity; optionally the |
| /// user may call `string.shrink_to_fit()` afterwards. |
| </span><span class="attribute">#[cfg(feature = <span class="string">"alloc"</span>)] |
| </span><span class="kw">impl </span>DistString <span class="kw">for </span>Standard { |
| <span class="kw">fn </span>append_string<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, s: <span class="kw-2">&mut </span>String, len: usize) { |
| <span class="comment">// A char is encoded with at most four bytes, thus this reservation is |
| // guaranteed to be sufficient. We do not shrink_to_fit afterwards so |
| // that repeated usage on the same `String` buffer does not reallocate. |
| </span>s.reserve(<span class="number">4 </span>* len); |
| s.extend(Distribution::<char>::sample_iter(<span class="self">self</span>, rng).take(len)); |
| } |
| } |
| |
| <span class="kw">impl </span>Distribution<u8> <span class="kw">for </span>Alphanumeric { |
| <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) -> u8 { |
| <span class="kw">const </span>RANGE: u32 = <span class="number">26 </span>+ <span class="number">26 </span>+ <span class="number">10</span>; |
| <span class="kw">const </span>GEN_ASCII_STR_CHARSET: <span class="kw-2">&</span>[u8] = <span class="string">b"ABCDEFGHIJKLMNOPQRSTUVWXYZ\ |
| abcdefghijklmnopqrstuvwxyz\ |
| 0123456789"</span>; |
| <span class="comment">// We can pick from 62 characters. This is so close to a power of 2, 64, |
| // that we can do better than `Uniform`. Use a simple bitshift and |
| // rejection sampling. We do not use a bitmask, because for small RNGs |
| // the most significant bits are usually of higher quality. |
| </span><span class="kw">loop </span>{ |
| <span class="kw">let </span>var = rng.next_u32() >> (<span class="number">32 </span>- <span class="number">6</span>); |
| <span class="kw">if </span>var < RANGE { |
| <span class="kw">return </span>GEN_ASCII_STR_CHARSET[var <span class="kw">as </span>usize]; |
| } |
| } |
| } |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"alloc"</span>)] |
| </span><span class="kw">impl </span>DistString <span class="kw">for </span>Alphanumeric { |
| <span class="kw">fn </span>append_string<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, string: <span class="kw-2">&mut </span>String, len: usize) { |
| <span class="kw">unsafe </span>{ |
| <span class="kw">let </span>v = string.as_mut_vec(); |
| v.extend(<span class="self">self</span>.sample_iter(rng).take(len)); |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>Distribution<bool> <span class="kw">for </span>Standard { |
| <span class="attribute">#[inline] |
| </span><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) -> bool { |
| <span class="comment">// We can compare against an arbitrary bit of an u32 to get a bool. |
| // Because the least significant bits of a lower quality RNG can have |
| // simple patterns, we compare against the most significant bit. This is |
| // easiest done using a sign test. |
| </span>(rng.next_u32() <span class="kw">as </span>i32) < <span class="number">0 |
| </span>} |
| } |
| |
| <span class="macro">macro_rules! </span>tuple_impl { |
| <span class="comment">// use variables to indicate the arity of the tuple |
| </span>($(<span class="macro-nonterminal">$tyvar</span>:ident),* ) => { |
| <span class="comment">// the trailing commas are for the 1 tuple |
| </span><span class="kw">impl</span>< $( <span class="macro-nonterminal">$tyvar </span>),* > |
| Distribution<( $( <span class="macro-nonterminal">$tyvar </span>),* , )> |
| <span class="kw">for </span>Standard |
| <span class="kw">where </span>$( Standard: Distribution<<span class="macro-nonterminal">$tyvar</span>> ),* |
| { |
| <span class="attribute">#[inline] |
| </span><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">$tyvar </span>),* , ) { |
| ( |
| <span class="comment">// use the $tyvar's to get the appropriate number of |
| // repeats (they're not actually needed) |
| </span>$( |
| _rng.gen::<<span class="macro-nonterminal">$tyvar</span>>() |
| ),* |
| , |
| ) |
| } |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>Distribution<()> <span class="kw">for </span>Standard { |
| <span class="attribute">#[allow(clippy::unused_unit)] |
| #[inline] |
| </span><span class="kw">fn </span>sample<R: Rng + <span class="question-mark">?</span>Sized>(<span class="kw-2">&</span><span class="self">self</span>, <span class="kw">_</span>: <span class="kw-2">&mut </span>R) -> () { |
| () |
| } |
| } |
| <span class="macro">tuple_impl! </span>{A} |
| <span class="macro">tuple_impl! </span>{A, B} |
| <span class="macro">tuple_impl! </span>{A, B, C} |
| <span class="macro">tuple_impl! </span>{A, B, C, D} |
| <span class="macro">tuple_impl! </span>{A, B, C, D, E} |
| <span class="macro">tuple_impl! </span>{A, B, C, D, E, F} |
| <span class="macro">tuple_impl! </span>{A, B, C, D, E, F, G} |
| <span class="macro">tuple_impl! </span>{A, B, C, D, E, F, G, H} |
| <span class="macro">tuple_impl! </span>{A, B, C, D, E, F, G, H, I} |
| <span class="macro">tuple_impl! </span>{A, B, C, D, E, F, G, H, I, J} |
| <span class="macro">tuple_impl! </span>{A, B, C, D, E, F, G, H, I, J, K} |
| <span class="macro">tuple_impl! </span>{A, B, C, D, E, F, G, H, I, J, K, L} |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"min_const_gen"</span>)] |
| #[cfg_attr(doc_cfg, doc(cfg(feature = <span class="string">"min_const_gen"</span>)))] |
| </span><span class="kw">impl</span><T, <span class="kw">const </span>N: usize> Distribution<[T; N]> <span class="kw">for </span>Standard |
| <span class="kw">where </span>Standard: Distribution<T> |
| { |
| <span class="attribute">#[inline] |
| </span><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) -> [T; N] { |
| <span class="kw">let </span><span class="kw-2">mut </span>buff: [MaybeUninit<T>; N] = <span class="kw">unsafe </span>{ MaybeUninit::uninit().assume_init() }; |
| |
| <span class="kw">for </span>elem <span class="kw">in </span><span class="kw-2">&mut </span>buff { |
| <span class="kw-2">*</span>elem = MaybeUninit::new(_rng.gen()); |
| } |
| |
| <span class="kw">unsafe </span>{ mem::transmute_copy::<<span class="kw">_</span>, <span class="kw">_</span>>(<span class="kw-2">&</span>buff) } |
| } |
| } |
| |
| <span class="attribute">#[cfg(not(feature = <span class="string">"min_const_gen"</span>))] |
| </span><span class="macro">macro_rules! </span>array_impl { |
| <span class="comment">// recursive, given at least one type parameter: |
| </span>{<span class="macro-nonterminal">$n</span>:expr, <span class="macro-nonterminal">$t</span>:ident, $(<span class="macro-nonterminal">$ts</span>:ident,)<span class="kw-2">*</span>} => { |
| <span class="macro">array_impl!</span>{(<span class="macro-nonterminal">$n </span>- <span class="number">1</span>), $(<span class="macro-nonterminal">$ts</span>,)<span class="kw-2">*</span>} |
| |
| <span class="kw">impl</span><T> Distribution<[T; <span class="macro-nonterminal">$n</span>]> <span class="kw">for </span>Standard <span class="kw">where </span>Standard: Distribution<T> { |
| <span class="attribute">#[inline] |
| </span><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) -> [T; <span class="macro-nonterminal">$n</span>] { |
| [_rng.gen::<<span class="macro-nonterminal">$t</span>>(), $(_rng.gen::<<span class="macro-nonterminal">$ts</span>>()),<span class="kw-2">*</span>] |
| } |
| } |
| }; |
| <span class="comment">// empty case: |
| </span>{<span class="macro-nonterminal">$n</span>:expr,} => { |
| <span class="kw">impl</span><T> Distribution<[T; <span class="macro-nonterminal">$n</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) -> [T; <span class="macro-nonterminal">$n</span>] { [] } |
| } |
| }; |
| } |
| |
| <span class="attribute">#[cfg(not(feature = <span class="string">"min_const_gen"</span>))] |
| </span><span class="macro">array_impl! </span>{<span class="number">32</span>, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T,} |
| |
| <span class="kw">impl</span><T> Distribution<<span class="prelude-ty">Option</span><T>> <span class="kw">for </span>Standard |
| <span class="kw">where </span>Standard: Distribution<T> |
| { |
| <span class="attribute">#[inline] |
| </span><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="prelude-ty">Option</span><T> { |
| <span class="comment">// UFCS is needed here: https://github.com/rust-lang/rust/issues/24066 |
| </span><span class="kw">if </span>rng.gen::<bool>() { |
| <span class="prelude-val">Some</span>(rng.gen()) |
| } <span class="kw">else </span>{ |
| <span class="prelude-val">None |
| </span>} |
| } |
| } |
| |
| <span class="kw">impl</span><T> Distribution<Wrapping<T>> <span class="kw">for </span>Standard |
| <span class="kw">where </span>Standard: Distribution<T> |
| { |
| <span class="attribute">#[inline] |
| </span><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) -> Wrapping<T> { |
| Wrapping(rng.gen()) |
| } |
| } |
| |
| |
| <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>::RngCore; |
| <span class="attribute">#[cfg(feature = <span class="string">"alloc"</span>)] </span><span class="kw">use </span>alloc::string::String; |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_misc() { |
| <span class="kw">let </span>rng: <span class="kw-2">&mut </span><span class="kw">dyn </span>RngCore = <span class="kw-2">&mut </span><span class="kw">crate</span>::test::rng(<span class="number">820</span>); |
| |
| rng.sample::<char, <span class="kw">_</span>>(Standard); |
| rng.sample::<bool, <span class="kw">_</span>>(Standard); |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"alloc"</span>)] |
| #[test] |
| </span><span class="kw">fn </span>test_chars() { |
| <span class="kw">use </span>core::iter; |
| <span class="kw">let </span><span class="kw-2">mut </span>rng = <span class="kw">crate</span>::test::rng(<span class="number">805</span>); |
| |
| <span class="comment">// Test by generating a relatively large number of chars, so we also |
| // take the rejection sampling path. |
| </span><span class="kw">let </span>word: String = iter::repeat(()) |
| .map(|()| rng.gen::<char>()) |
| .take(<span class="number">1000</span>) |
| .collect(); |
| <span class="macro">assert!</span>(!word.is_empty()); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_alphanumeric() { |
| <span class="kw">let </span><span class="kw-2">mut </span>rng = <span class="kw">crate</span>::test::rng(<span class="number">806</span>); |
| |
| <span class="comment">// Test by generating a relatively large number of chars, so we also |
| // take the rejection sampling path. |
| </span><span class="kw">let </span><span class="kw-2">mut </span>incorrect = <span class="bool-val">false</span>; |
| <span class="kw">for _ in </span><span class="number">0</span>..<span class="number">100 </span>{ |
| <span class="kw">let </span>c: char = rng.sample(Alphanumeric).into(); |
| incorrect |= !((<span class="string">'0'</span>..=<span class="string">'9'</span>).contains(<span class="kw-2">&</span>c) || |
| (<span class="string">'A'</span>..=<span class="string">'Z'</span>).contains(<span class="kw-2">&</span>c) || |
| (<span class="string">'a'</span>..=<span class="string">'z'</span>).contains(<span class="kw-2">&</span>c) ); |
| } |
| <span class="macro">assert!</span>(!incorrect); |
| } |
| |
| <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">807</span>); |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [zero; <span class="number">5</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="string">'a'</span>, <span class="kw-2">&</span>[ |
| <span class="string">'\u{8cdac}'</span>, |
| <span class="string">'\u{a346a}'</span>, |
| <span class="string">'\u{80120}'</span>, |
| <span class="string">'\u{ed692}'</span>, |
| <span class="string">'\u{35888}'</span>, |
| ]); |
| test_samples(<span class="kw-2">&</span>Alphanumeric, <span class="number">0</span>, <span class="kw-2">&</span>[<span class="number">104</span>, <span class="number">109</span>, <span class="number">101</span>, <span class="number">51</span>, <span class="number">77</span>]); |
| test_samples(<span class="kw-2">&</span>Standard, <span class="bool-val">false</span>, <span class="kw-2">&</span>[<span class="bool-val">true</span>, <span class="bool-val">true</span>, <span class="bool-val">false</span>, <span class="bool-val">true</span>, <span class="bool-val">false</span>]); |
| test_samples(<span class="kw-2">&</span>Standard, <span class="prelude-val">None </span><span class="kw">as </span><span class="prelude-ty">Option</span><bool>, <span class="kw-2">&</span>[ |
| <span class="prelude-val">Some</span>(<span class="bool-val">true</span>), |
| <span class="prelude-val">None</span>, |
| <span class="prelude-val">Some</span>(<span class="bool-val">false</span>), |
| <span class="prelude-val">None</span>, |
| <span class="prelude-val">Some</span>(<span class="bool-val">false</span>), |
| ]); |
| test_samples(<span class="kw-2">&</span>Standard, Wrapping(<span class="number">0i32</span>), <span class="kw-2">&</span>[ |
| Wrapping(-<span class="number">2074640887</span>), |
| Wrapping(-<span class="number">1719949321</span>), |
| Wrapping(<span class="number">2018088303</span>), |
| Wrapping(-<span class="number">547181756</span>), |
| Wrapping(<span class="number">838957336</span>), |
| ]); |
| |
| <span class="comment">// We test only sub-sets of tuple and array impls |
| </span>test_samples(<span class="kw-2">&</span>Standard, (), <span class="kw-2">&</span>[(), (), (), (), ()]); |
| test_samples(<span class="kw-2">&</span>Standard, (<span class="bool-val">false</span>,), <span class="kw-2">&</span>[ |
| (<span class="bool-val">true</span>,), |
| (<span class="bool-val">true</span>,), |
| (<span class="bool-val">false</span>,), |
| (<span class="bool-val">true</span>,), |
| (<span class="bool-val">false</span>,), |
| ]); |
| test_samples(<span class="kw-2">&</span>Standard, (<span class="bool-val">false</span>, <span class="bool-val">false</span>), <span class="kw-2">&</span>[ |
| (<span class="bool-val">true</span>, <span class="bool-val">true</span>), |
| (<span class="bool-val">false</span>, <span class="bool-val">true</span>), |
| (<span class="bool-val">false</span>, <span class="bool-val">false</span>), |
| (<span class="bool-val">true</span>, <span class="bool-val">false</span>), |
| (<span class="bool-val">false</span>, <span class="bool-val">false</span>), |
| ]); |
| |
| test_samples(<span class="kw-2">&</span>Standard, [<span class="number">0u8</span>; <span class="number">0</span>], <span class="kw-2">&</span>[[], [], [], [], []]); |
| test_samples(<span class="kw-2">&</span>Standard, [<span class="number">0u8</span>; <span class="number">3</span>], <span class="kw-2">&</span>[ |
| [<span class="number">9</span>, <span class="number">247</span>, <span class="number">111</span>], |
| [<span class="number">68</span>, <span class="number">24</span>, <span class="number">13</span>], |
| [<span class="number">174</span>, <span class="number">19</span>, <span class="number">194</span>], |
| [<span class="number">172</span>, <span class="number">69</span>, <span class="number">213</span>], |
| [<span class="number">149</span>, <span class="number">207</span>, <span class="number">29</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> |
