blob: 8f916d42f5980c5884c38f67fcd5fa069d90c98f [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/git/checkouts/incubator-teaclave-crates-c8106113f74feefc/ede1f68/rand/src/rng.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>rng.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>
<span id="366">366</span>
<span id="367">367</span>
<span id="368">368</span>
<span id="369">369</span>
<span id="370">370</span>
<span id="371">371</span>
<span id="372">372</span>
<span id="373">373</span>
<span id="374">374</span>
<span id="375">375</span>
<span id="376">376</span>
<span id="377">377</span>
<span id="378">378</span>
<span id="379">379</span>
<span id="380">380</span>
<span id="381">381</span>
<span id="382">382</span>
<span id="383">383</span>
<span id="384">384</span>
<span id="385">385</span>
<span id="386">386</span>
<span id="387">387</span>
<span id="388">388</span>
<span id="389">389</span>
<span id="390">390</span>
<span id="391">391</span>
<span id="392">392</span>
<span id="393">393</span>
<span id="394">394</span>
<span id="395">395</span>
<span id="396">396</span>
<span id="397">397</span>
<span id="398">398</span>
<span id="399">399</span>
<span id="400">400</span>
<span id="401">401</span>
<span id="402">402</span>
<span id="403">403</span>
<span id="404">404</span>
<span id="405">405</span>
<span id="406">406</span>
<span id="407">407</span>
<span id="408">408</span>
<span id="409">409</span>
<span id="410">410</span>
<span id="411">411</span>
<span id="412">412</span>
<span id="413">413</span>
<span id="414">414</span>
<span id="415">415</span>
<span id="416">416</span>
<span id="417">417</span>
<span id="418">418</span>
<span id="419">419</span>
<span id="420">420</span>
<span id="421">421</span>
<span id="422">422</span>
<span id="423">423</span>
<span id="424">424</span>
<span id="425">425</span>
<span id="426">426</span>
<span id="427">427</span>
<span id="428">428</span>
<span id="429">429</span>
<span id="430">430</span>
<span id="431">431</span>
<span id="432">432</span>
<span id="433">433</span>
<span id="434">434</span>
<span id="435">435</span>
<span id="436">436</span>
<span id="437">437</span>
<span id="438">438</span>
<span id="439">439</span>
<span id="440">440</span>
<span id="441">441</span>
<span id="442">442</span>
<span id="443">443</span>
<span id="444">444</span>
<span id="445">445</span>
<span id="446">446</span>
<span id="447">447</span>
<span id="448">448</span>
<span id="449">449</span>
<span id="450">450</span>
<span id="451">451</span>
<span id="452">452</span>
<span id="453">453</span>
<span id="454">454</span>
<span id="455">455</span>
<span id="456">456</span>
<span id="457">457</span>
<span id="458">458</span>
<span id="459">459</span>
<span id="460">460</span>
<span id="461">461</span>
<span id="462">462</span>
<span id="463">463</span>
<span id="464">464</span>
<span id="465">465</span>
<span id="466">466</span>
<span id="467">467</span>
<span id="468">468</span>
<span id="469">469</span>
<span id="470">470</span>
<span id="471">471</span>
<span id="472">472</span>
<span id="473">473</span>
<span id="474">474</span>
<span id="475">475</span>
<span id="476">476</span>
<span id="477">477</span>
<span id="478">478</span>
<span id="479">479</span>
<span id="480">480</span>
<span id="481">481</span>
<span id="482">482</span>
<span id="483">483</span>
<span id="484">484</span>
<span id="485">485</span>
<span id="486">486</span>
<span id="487">487</span>
<span id="488">488</span>
<span id="489">489</span>
<span id="490">490</span>
<span id="491">491</span>
<span id="492">492</span>
<span id="493">493</span>
<span id="494">494</span>
<span id="495">495</span>
<span id="496">496</span>
<span id="497">497</span>
<span id="498">498</span>
<span id="499">499</span>
<span id="500">500</span>
<span id="501">501</span>
<span id="502">502</span>
<span id="503">503</span>
<span id="504">504</span>
<span id="505">505</span>
<span id="506">506</span>
<span id="507">507</span>
<span id="508">508</span>
<span id="509">509</span>
<span id="510">510</span>
<span id="511">511</span>
<span id="512">512</span>
<span id="513">513</span>
<span id="514">514</span>
<span id="515">515</span>
<span id="516">516</span>
<span id="517">517</span>
<span id="518">518</span>
<span id="519">519</span>
<span id="520">520</span>
<span id="521">521</span>
<span id="522">522</span>
<span id="523">523</span>
<span id="524">524</span>
<span id="525">525</span>
<span id="526">526</span>
<span id="527">527</span>
<span id="528">528</span>
<span id="529">529</span>
<span id="530">530</span>
<span id="531">531</span>
<span id="532">532</span>
<span id="533">533</span>
<span id="534">534</span>
<span id="535">535</span>
<span id="536">536</span>
<span id="537">537</span>
<span id="538">538</span>
<span id="539">539</span>
<span id="540">540</span>
<span id="541">541</span>
<span id="542">542</span>
<span id="543">543</span>
<span id="544">544</span>
<span id="545">545</span>
<span id="546">546</span>
<span id="547">547</span>
<span id="548">548</span>
<span id="549">549</span>
<span id="550">550</span>
<span id="551">551</span>
<span id="552">552</span>
<span id="553">553</span>
<span id="554">554</span>
<span id="555">555</span>
<span id="556">556</span>
<span id="557">557</span>
<span id="558">558</span>
<span id="559">559</span>
<span id="560">560</span>
<span id="561">561</span>
<span id="562">562</span>
<span id="563">563</span>
<span id="564">564</span>
<span id="565">565</span>
<span id="566">566</span>
<span id="567">567</span>
<span id="568">568</span>
<span id="569">569</span>
<span id="570">570</span>
<span id="571">571</span>
<span id="572">572</span>
<span id="573">573</span>
<span id="574">574</span>
<span id="575">575</span>
<span id="576">576</span>
<span id="577">577</span>
<span id="578">578</span>
<span id="579">579</span>
<span id="580">580</span>
<span id="581">581</span>
<span id="582">582</span>
<span id="583">583</span>
<span id="584">584</span>
<span id="585">585</span>
<span id="586">586</span>
<span id="587">587</span>
<span id="588">588</span>
<span id="589">589</span>
<span id="590">590</span>
<span id="591">591</span>
<span id="592">592</span>
<span id="593">593</span>
<span id="594">594</span>
<span id="595">595</span>
<span id="596">596</span>
<span id="597">597</span>
<span id="598">598</span>
<span id="599">599</span>
<span id="600">600</span>
</pre><pre class="rust"><code><span class="comment">// Copyright 2018 Developers of the Rand project.
// Copyright 2013-2017 The Rust Project Developers.
//
// Licensed under the Apache License, Version 2.0 &lt;LICENSE-APACHE or
// https://www.apache.org/licenses/LICENSE-2.0&gt; or the MIT license
// &lt;LICENSE-MIT or https://opensource.org/licenses/MIT&gt;, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
</span><span class="doccomment">//! [`Rng`] trait
</span><span class="kw">use </span>rand_core::{Error, RngCore};
<span class="kw">use </span><span class="kw">crate</span>::distributions::uniform::{SampleRange, SampleUniform};
<span class="kw">use </span><span class="kw">crate</span>::distributions::{<span class="self">self</span>, Distribution, Standard};
<span class="kw">use </span>core::num::Wrapping;
<span class="kw">use </span>core::{mem, slice};
<span class="doccomment">/// An automatically-implemented extension trait on [`RngCore`] providing high-level
/// generic methods for sampling values and other convenience methods.
///
/// This is the primary trait to use when generating random values.
///
/// # Generic usage
///
/// The basic pattern is `fn foo&lt;R: Rng + ?Sized&gt;(rng: &amp;mut R)`. Some
/// things are worth noting here:
///
/// - Since `Rng: RngCore` and every `RngCore` implements `Rng`, it makes no
/// difference whether we use `R: Rng` or `R: RngCore`.
/// - The `+ ?Sized` un-bounding allows functions to be called directly on
/// type-erased references; i.e. `foo(r)` where `r: &amp;mut dyn RngCore`. Without
/// this it would be necessary to write `foo(&amp;mut r)`.
///
/// An alternative pattern is possible: `fn foo&lt;R: Rng&gt;(rng: R)`. This has some
/// trade-offs. It allows the argument to be consumed directly without a `&amp;mut`
/// (which is how `from_rng(thread_rng())` works); also it still works directly
/// on references (including type-erased references). Unfortunately within the
/// function `foo` it is not known whether `rng` is a reference type or not,
/// hence many uses of `rng` require an extra reference, either explicitly
/// (`distr.sample(&amp;mut rng)`) or implicitly (`rng.gen()`); one may hope the
/// optimiser can remove redundant references later.
///
/// Example:
///
/// ```
/// # use rand::thread_rng;
/// use rand::Rng;
///
/// fn foo&lt;R: Rng + ?Sized&gt;(rng: &amp;mut R) -&gt; f32 {
/// rng.gen()
/// }
///
/// # let v = foo(&amp;mut thread_rng());
/// ```
</span><span class="kw">pub trait </span>Rng: RngCore {
<span class="doccomment">/// Return a random value supporting the [`Standard`] distribution.
///
/// # Example
///
/// ```
/// use rand::{thread_rng, Rng};
///
/// let mut rng = thread_rng();
/// let x: u32 = rng.gen();
/// println!(&quot;{}&quot;, x);
/// println!(&quot;{:?}&quot;, rng.gen::&lt;(f64, bool)&gt;());
/// ```
///
/// # Arrays and tuples
///
/// The `rng.gen()` method is able to generate arrays (up to 32 elements)
/// and tuples (up to 12 elements), so long as all element types can be
/// generated.
/// When using `rustc` ≥ 1.51, enable the `min_const_gen` feature to support
/// arrays larger than 32 elements.
///
/// For arrays of integers, especially for those with small element types
/// (&lt; 64 bit), it will likely be faster to instead use [`Rng::fill`].
///
/// ```
/// use rand::{thread_rng, Rng};
///
/// let mut rng = thread_rng();
/// let tuple: (u8, i32, char) = rng.gen(); // arbitrary tuple support
///
/// let arr1: [f32; 32] = rng.gen(); // array construction
/// let mut arr2 = [0u8; 128];
/// rng.fill(&amp;mut arr2); // array fill
/// ```
///
/// [`Standard`]: distributions::Standard
</span><span class="attribute">#[inline]
</span><span class="kw">fn </span>gen&lt;T&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; T
<span class="kw">where </span>Standard: Distribution&lt;T&gt; {
Standard.sample(<span class="self">self</span>)
}
<span class="doccomment">/// Generate a random value in the given range.
///
/// This function is optimised for the case that only a single sample is
/// made from the given range. See also the [`Uniform`] distribution
/// type which may be faster if sampling from the same range repeatedly.
///
/// Only `gen_range(low..high)` and `gen_range(low..=high)` are supported.
///
/// # Panics
///
/// Panics if the range is empty.
///
/// # Example
///
/// ```
/// use rand::{thread_rng, Rng};
///
/// let mut rng = thread_rng();
///
/// // Exclusive range
/// let n: u32 = rng.gen_range(0..10);
/// println!(&quot;{}&quot;, n);
/// let m: f64 = rng.gen_range(-40.0..1.3e5);
/// println!(&quot;{}&quot;, m);
///
/// // Inclusive range
/// let n: u32 = rng.gen_range(0..=10);
/// println!(&quot;{}&quot;, n);
/// ```
///
/// [`Uniform`]: distributions::uniform::Uniform
</span><span class="kw">fn </span>gen_range&lt;T, R&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, range: R) -&gt; T
<span class="kw">where
</span>T: SampleUniform,
R: SampleRange&lt;T&gt;
{
<span class="macro">assert!</span>(!range.is_empty(), <span class="string">&quot;cannot sample empty range&quot;</span>);
range.sample_single(<span class="self">self</span>)
}
<span class="doccomment">/// Sample a new value, using the given distribution.
///
/// ### Example
///
/// ```
/// use rand::{thread_rng, Rng};
/// use rand::distributions::Uniform;
///
/// let mut rng = thread_rng();
/// let x = rng.sample(Uniform::new(10u32, 15));
/// // Type annotation requires two types, the type and distribution; the
/// // distribution can be inferred.
/// let y = rng.sample::&lt;u16, _&gt;(Uniform::new(10, 15));
/// ```
</span><span class="kw">fn </span>sample&lt;T, D: Distribution&lt;T&gt;&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, distr: D) -&gt; T {
distr.sample(<span class="self">self</span>)
}
<span class="doccomment">/// Create an iterator that generates values using the given distribution.
///
/// Note that this function takes its arguments by value. This works since
/// `(&amp;mut R): Rng where R: Rng` and
/// `(&amp;D): Distribution where D: Distribution`,
/// however borrowing is not automatic hence `rng.sample_iter(...)` may
/// need to be replaced with `(&amp;mut rng).sample_iter(...)`.
///
/// # Example
///
/// ```
/// use rand::{thread_rng, Rng};
/// use rand::distributions::{Alphanumeric, Uniform, Standard};
///
/// let mut rng = thread_rng();
///
/// // Vec of 16 x f32:
/// let v: Vec&lt;f32&gt; = (&amp;mut rng).sample_iter(Standard).take(16).collect();
///
/// // String:
/// let s: String = (&amp;mut rng).sample_iter(Alphanumeric)
/// .take(7)
/// .map(char::from)
/// .collect();
///
/// // Combined values
/// println!(&quot;{:?}&quot;, (&amp;mut rng).sample_iter(Standard).take(5)
/// .collect::&lt;Vec&lt;(f64, bool)&gt;&gt;());
///
/// // Dice-rolling:
/// let die_range = Uniform::new_inclusive(1, 6);
/// let mut roll_die = (&amp;mut rng).sample_iter(die_range);
/// while roll_die.next().unwrap() != 6 {
/// println!(&quot;Not a 6; rolling again!&quot;);
/// }
/// ```
</span><span class="kw">fn </span>sample_iter&lt;T, D&gt;(<span class="self">self</span>, distr: D) -&gt; distributions::DistIter&lt;D, <span class="self">Self</span>, T&gt;
<span class="kw">where
</span>D: Distribution&lt;T&gt;,
<span class="self">Self</span>: Sized,
{
distr.sample_iter(<span class="self">self</span>)
}
<span class="doccomment">/// Fill any type implementing [`Fill`] with random data
///
/// The distribution is expected to be uniform with portable results, but
/// this cannot be guaranteed for third-party implementations.
///
/// This is identical to [`try_fill`] except that it panics on error.
///
/// # Example
///
/// ```
/// use rand::{thread_rng, Rng};
///
/// let mut arr = [0i8; 20];
/// thread_rng().fill(&amp;mut arr[..]);
/// ```
///
/// [`fill_bytes`]: RngCore::fill_bytes
/// [`try_fill`]: Rng::try_fill
</span><span class="kw">fn </span>fill&lt;T: Fill + <span class="question-mark">?</span>Sized&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, dest: <span class="kw-2">&amp;mut </span>T) {
dest.try_fill(<span class="self">self</span>).unwrap_or_else(|<span class="kw">_</span>| <span class="macro">panic!</span>(<span class="string">&quot;Rng::fill failed&quot;</span>))
}
<span class="doccomment">/// Fill any type implementing [`Fill`] with random data
///
/// The distribution is expected to be uniform with portable results, but
/// this cannot be guaranteed for third-party implementations.
///
/// This is identical to [`fill`] except that it forwards errors.
///
/// # Example
///
/// ```
/// # use rand::Error;
/// use rand::{thread_rng, Rng};
///
/// # fn try_inner() -&gt; Result&lt;(), Error&gt; {
/// let mut arr = [0u64; 4];
/// thread_rng().try_fill(&amp;mut arr[..])?;
/// # Ok(())
/// # }
///
/// # try_inner().unwrap()
/// ```
///
/// [`try_fill_bytes`]: RngCore::try_fill_bytes
/// [`fill`]: Rng::fill
</span><span class="kw">fn </span>try_fill&lt;T: Fill + <span class="question-mark">?</span>Sized&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, dest: <span class="kw-2">&amp;mut </span>T) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
dest.try_fill(<span class="self">self</span>)
}
<span class="doccomment">/// Return a bool with a probability `p` of being true.
///
/// See also the [`Bernoulli`] distribution, which may be faster if
/// sampling from the same probability repeatedly.
///
/// # Example
///
/// ```
/// use rand::{thread_rng, Rng};
///
/// let mut rng = thread_rng();
/// println!(&quot;{}&quot;, rng.gen_bool(1.0 / 3.0));
/// ```
///
/// # Panics
///
/// If `p &lt; 0` or `p &gt; 1`.
///
/// [`Bernoulli`]: distributions::Bernoulli
</span><span class="attribute">#[inline]
</span><span class="kw">fn </span>gen_bool(<span class="kw-2">&amp;mut </span><span class="self">self</span>, p: f64) -&gt; bool {
<span class="kw">let </span>d = distributions::Bernoulli::new(p).unwrap();
<span class="self">self</span>.sample(d)
}
<span class="doccomment">/// Return a bool with a probability of `numerator/denominator` of being
/// true. I.e. `gen_ratio(2, 3)` has chance of 2 in 3, or about 67%, of
/// returning true. If `numerator == denominator`, then the returned value
/// is guaranteed to be `true`. If `numerator == 0`, then the returned
/// value is guaranteed to be `false`.
///
/// See also the [`Bernoulli`] distribution, which may be faster if
/// sampling from the same `numerator` and `denominator` repeatedly.
///
/// # Panics
///
/// If `denominator == 0` or `numerator &gt; denominator`.
///
/// # Example
///
/// ```
/// use rand::{thread_rng, Rng};
///
/// let mut rng = thread_rng();
/// println!(&quot;{}&quot;, rng.gen_ratio(2, 3));
/// ```
///
/// [`Bernoulli`]: distributions::Bernoulli
</span><span class="attribute">#[inline]
</span><span class="kw">fn </span>gen_ratio(<span class="kw-2">&amp;mut </span><span class="self">self</span>, numerator: u32, denominator: u32) -&gt; bool {
<span class="kw">let </span>d = distributions::Bernoulli::from_ratio(numerator, denominator).unwrap();
<span class="self">self</span>.sample(d)
}
}
<span class="kw">impl</span>&lt;R: RngCore + <span class="question-mark">?</span>Sized&gt; Rng <span class="kw">for </span>R {}
<span class="doccomment">/// Types which may be filled with random data
///
/// This trait allows arrays to be efficiently filled with random data.
///
/// Implementations are expected to be portable across machines unless
/// clearly documented otherwise (see the
/// [Chapter on Portability](https://rust-random.github.io/book/portability.html)).
</span><span class="kw">pub trait </span>Fill {
<span class="doccomment">/// Fill self with random data
</span><span class="kw">fn </span>try_fill&lt;R: Rng + <span class="question-mark">?</span>Sized&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, rng: <span class="kw-2">&amp;mut </span>R) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt;;
}
<span class="macro">macro_rules! </span>impl_fill_each {
() =&gt; {};
(<span class="macro-nonterminal">$t</span>:ty) =&gt; {
<span class="kw">impl </span>Fill <span class="kw">for </span>[<span class="macro-nonterminal">$t</span>] {
<span class="kw">fn </span>try_fill&lt;R: Rng + <span class="question-mark">?</span>Sized&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, rng: <span class="kw-2">&amp;mut </span>R) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
<span class="kw">for </span>elt <span class="kw">in </span><span class="self">self</span>.iter_mut() {
<span class="kw-2">*</span>elt = rng.gen();
}
<span class="prelude-val">Ok</span>(())
}
}
};
(<span class="macro-nonterminal">$t</span>:ty, $(<span class="macro-nonterminal">$tt</span>:ty,)<span class="kw-2">*</span>) =&gt; {
<span class="macro">impl_fill_each!</span>(<span class="macro-nonterminal">$t</span>);
<span class="macro">impl_fill_each!</span>($(<span class="macro-nonterminal">$tt</span>,)<span class="kw-2">*</span>);
};
}
<span class="macro">impl_fill_each!</span>(bool, char, f32, f64,);
<span class="kw">impl </span>Fill <span class="kw">for </span>[u8] {
<span class="kw">fn </span>try_fill&lt;R: Rng + <span class="question-mark">?</span>Sized&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, rng: <span class="kw-2">&amp;mut </span>R) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
rng.try_fill_bytes(<span class="self">self</span>)
}
}
<span class="macro">macro_rules! </span>impl_fill {
() =&gt; {};
(<span class="macro-nonterminal">$t</span>:ty) =&gt; {
<span class="kw">impl </span>Fill <span class="kw">for </span>[<span class="macro-nonterminal">$t</span>] {
<span class="attribute">#[inline(never)] </span><span class="comment">// in micro benchmarks, this improves performance
</span><span class="kw">fn </span>try_fill&lt;R: Rng + <span class="question-mark">?</span>Sized&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, rng: <span class="kw-2">&amp;mut </span>R) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
<span class="kw">if </span><span class="self">self</span>.len() &gt; <span class="number">0 </span>{
rng.try_fill_bytes(<span class="kw">unsafe </span>{
slice::from_raw_parts_mut(<span class="self">self</span>.as_mut_ptr()
<span class="kw">as </span><span class="kw-2">*mut </span>u8,
<span class="self">self</span>.len() * mem::size_of::&lt;<span class="macro-nonterminal">$t</span>&gt;()
)
})<span class="question-mark">?</span>;
<span class="kw">for </span>x <span class="kw">in </span><span class="self">self </span>{
<span class="kw-2">*</span>x = x.to_le();
}
}
<span class="prelude-val">Ok</span>(())
}
}
<span class="kw">impl </span>Fill <span class="kw">for </span>[Wrapping&lt;<span class="macro-nonterminal">$t</span>&gt;] {
<span class="attribute">#[inline(never)]
</span><span class="kw">fn </span>try_fill&lt;R: Rng + <span class="question-mark">?</span>Sized&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, rng: <span class="kw-2">&amp;mut </span>R) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
<span class="kw">if </span><span class="self">self</span>.len() &gt; <span class="number">0 </span>{
rng.try_fill_bytes(<span class="kw">unsafe </span>{
slice::from_raw_parts_mut(<span class="self">self</span>.as_mut_ptr()
<span class="kw">as </span><span class="kw-2">*mut </span>u8,
<span class="self">self</span>.len() * mem::size_of::&lt;<span class="macro-nonterminal">$t</span>&gt;()
)
})<span class="question-mark">?</span>;
<span class="kw">for </span>x <span class="kw">in </span><span class="self">self </span>{
<span class="kw-2">*</span>x = Wrapping(x.<span class="number">0</span>.to_le());
}
}
<span class="prelude-val">Ok</span>(())
}
}
};
(<span class="macro-nonterminal">$t</span>:ty, $(<span class="macro-nonterminal">$tt</span>:ty,)<span class="kw-2">*</span>) =&gt; {
<span class="macro">impl_fill!</span>(<span class="macro-nonterminal">$t</span>);
<span class="comment">// TODO: this could replace above impl once Rust #32463 is fixed
// impl_fill!(Wrapping&lt;$t&gt;);
</span><span class="macro">impl_fill!</span>($(<span class="macro-nonterminal">$tt</span>,)<span class="kw-2">*</span>);
}
}
<span class="macro">impl_fill!</span>(u16, u32, u64, usize, u128,);
<span class="macro">impl_fill!</span>(i8, i16, i32, i64, isize, i128,);
<span class="attribute">#[cfg_attr(doc_cfg, doc(cfg(feature = <span class="string">&quot;min_const_gen&quot;</span>)))]
#[cfg(feature = <span class="string">&quot;min_const_gen&quot;</span>)]
</span><span class="kw">impl</span>&lt;T, <span class="kw">const </span>N: usize&gt; Fill <span class="kw">for </span>[T; N]
<span class="kw">where </span>[T]: Fill
{
<span class="kw">fn </span>try_fill&lt;R: Rng + <span class="question-mark">?</span>Sized&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, rng: <span class="kw-2">&amp;mut </span>R) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
<span class="self">self</span>[..].try_fill(rng)
}
}
<span class="attribute">#[cfg(not(feature = <span class="string">&quot;min_const_gen&quot;</span>))]
</span><span class="macro">macro_rules! </span>impl_fill_arrays {
(<span class="macro-nonterminal">$n</span>:expr,) =&gt; {};
(<span class="macro-nonterminal">$n</span>:expr, <span class="macro-nonterminal">$N</span>:ident) =&gt; {
<span class="kw">impl</span>&lt;T&gt; Fill <span class="kw">for </span>[T; <span class="macro-nonterminal">$n</span>] <span class="kw">where </span>[T]: Fill {
<span class="kw">fn </span>try_fill&lt;R: Rng + <span class="question-mark">?</span>Sized&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, rng: <span class="kw-2">&amp;mut </span>R) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
<span class="self">self</span>[..].try_fill(rng)
}
}
};
(<span class="macro-nonterminal">$n</span>:expr, <span class="macro-nonterminal">$N</span>:ident, $(<span class="macro-nonterminal">$NN</span>:ident,)<span class="kw-2">*</span>) =&gt; {
<span class="macro">impl_fill_arrays!</span>(<span class="macro-nonterminal">$n</span>, <span class="macro-nonterminal">$N</span>);
<span class="macro">impl_fill_arrays!</span>(<span class="macro-nonterminal">$n </span>- <span class="number">1</span>, $(<span class="macro-nonterminal">$NN</span>,)<span class="kw-2">*</span>);
};
(!div <span class="macro-nonterminal">$n</span>:expr,) =&gt; {};
(!div <span class="macro-nonterminal">$n</span>:expr, <span class="macro-nonterminal">$N</span>:ident, $(<span class="macro-nonterminal">$NN</span>:ident,)<span class="kw-2">*</span>) =&gt; {
<span class="macro">impl_fill_arrays!</span>(<span class="macro-nonterminal">$n</span>, <span class="macro-nonterminal">$N</span>);
<span class="macro">impl_fill_arrays!</span>(!div <span class="macro-nonterminal">$n </span>/ <span class="number">2</span>, $(<span class="macro-nonterminal">$NN</span>,)<span class="kw-2">*</span>);
};
}
<span class="attribute">#[cfg(not(feature = <span class="string">&quot;min_const_gen&quot;</span>))]
#[rustfmt::skip]
</span><span class="macro">impl_fill_arrays!</span>(<span class="number">32</span>, N,N,N,N,N,N,N,N,N,N,N,N,N,N,N,N,N,N,N,N,N,N,N,N,N,N,N,N,N,N,N,N,N,);
<span class="attribute">#[cfg(not(feature = <span class="string">&quot;min_const_gen&quot;</span>))]
</span><span class="macro">impl_fill_arrays!</span>(!div <span class="number">4096</span>, N,N,N,N,N,N,N,);
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>test {
<span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="kw">use </span><span class="kw">crate</span>::test::rng;
<span class="kw">use </span><span class="kw">crate</span>::rngs::mock::StepRng;
<span class="attribute">#[cfg(feature = <span class="string">&quot;alloc&quot;</span>)] </span><span class="kw">use </span>alloc::boxed::Box;
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_fill_bytes_default() {
<span class="kw">let </span><span class="kw-2">mut </span>r = StepRng::new(<span class="number">0x11_22_33_44_55_66_77_88</span>, <span class="number">0</span>);
<span class="comment">// check every remainder mod 8, both in small and big vectors.
</span><span class="kw">let </span>lengths = [<span class="number">0</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>, <span class="number">80</span>, <span class="number">81</span>, <span class="number">82</span>, <span class="number">83</span>, <span class="number">84</span>, <span class="number">85</span>, <span class="number">86</span>, <span class="number">87</span>];
<span class="kw">for </span><span class="kw-2">&amp;</span>n <span class="kw">in </span>lengths.iter() {
<span class="kw">let </span><span class="kw-2">mut </span>buffer = [<span class="number">0u8</span>; <span class="number">87</span>];
<span class="kw">let </span>v = <span class="kw-2">&amp;mut </span>buffer[<span class="number">0</span>..n];
r.fill_bytes(v);
<span class="comment">// use this to get nicer error messages.
</span><span class="kw">for </span>(i, <span class="kw-2">&amp;</span>byte) <span class="kw">in </span>v.iter().enumerate() {
<span class="kw">if </span>byte == <span class="number">0 </span>{
<span class="macro">panic!</span>(<span class="string">&quot;byte {} of {} is zero&quot;</span>, i, n)
}
}
}
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_fill() {
<span class="kw">let </span>x = <span class="number">9041086907909331047</span>; <span class="comment">// a random u64
</span><span class="kw">let </span><span class="kw-2">mut </span>rng = StepRng::new(x, <span class="number">0</span>);
<span class="comment">// Convert to byte sequence and back to u64; byte-swap twice if BE.
</span><span class="kw">let </span><span class="kw-2">mut </span>array = [<span class="number">0u64</span>; <span class="number">2</span>];
rng.fill(<span class="kw-2">&amp;mut </span>array[..]);
<span class="macro">assert_eq!</span>(array, [x, x]);
<span class="macro">assert_eq!</span>(rng.next_u64(), x);
<span class="comment">// Convert to bytes then u32 in LE order
</span><span class="kw">let </span><span class="kw-2">mut </span>array = [<span class="number">0u32</span>; <span class="number">2</span>];
rng.fill(<span class="kw-2">&amp;mut </span>array[..]);
<span class="macro">assert_eq!</span>(array, [x <span class="kw">as </span>u32, (x &gt;&gt; <span class="number">32</span>) <span class="kw">as </span>u32]);
<span class="macro">assert_eq!</span>(rng.next_u32(), x <span class="kw">as </span>u32);
<span class="comment">// Check equivalence using wrapped arrays
</span><span class="kw">let </span><span class="kw-2">mut </span>warray = [Wrapping(<span class="number">0u32</span>); <span class="number">2</span>];
rng.fill(<span class="kw-2">&amp;mut </span>warray[..]);
<span class="macro">assert_eq!</span>(array[<span class="number">0</span>], warray[<span class="number">0</span>].<span class="number">0</span>);
<span class="macro">assert_eq!</span>(array[<span class="number">1</span>], warray[<span class="number">1</span>].<span class="number">0</span>);
<span class="comment">// Check equivalence for generated floats
</span><span class="kw">let </span><span class="kw-2">mut </span>array = [<span class="number">0f32</span>; <span class="number">2</span>];
rng.fill(<span class="kw-2">&amp;mut </span>array);
<span class="kw">let </span>gen: [f32; <span class="number">2</span>] = rng.gen();
<span class="macro">assert_eq!</span>(array, gen);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_fill_empty() {
<span class="kw">let </span><span class="kw-2">mut </span>array = [<span class="number">0u32</span>; <span class="number">0</span>];
<span class="kw">let </span><span class="kw-2">mut </span>rng = StepRng::new(<span class="number">0</span>, <span class="number">1</span>);
rng.fill(<span class="kw-2">&amp;mut </span>array);
rng.fill(<span class="kw-2">&amp;mut </span>array[..]);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_gen_range_int() {
<span class="kw">let </span><span class="kw-2">mut </span>r = rng(<span class="number">101</span>);
<span class="kw">for _ in </span><span class="number">0</span>..<span class="number">1000 </span>{
<span class="kw">let </span>a = r.gen_range(-<span class="number">4711</span>..<span class="number">17</span>);
<span class="macro">assert!</span>((-<span class="number">4711</span>..<span class="number">17</span>).contains(<span class="kw-2">&amp;</span>a));
<span class="kw">let </span>a: i8 = r.gen_range(-<span class="number">3</span>..<span class="number">42</span>);
<span class="macro">assert!</span>((-<span class="number">3</span>..<span class="number">42</span>).contains(<span class="kw-2">&amp;</span>a));
<span class="kw">let </span>a: u16 = r.gen_range(<span class="number">10</span>..<span class="number">99</span>);
<span class="macro">assert!</span>((<span class="number">10</span>..<span class="number">99</span>).contains(<span class="kw-2">&amp;</span>a));
<span class="kw">let </span>a: i32 = r.gen_range(-<span class="number">100</span>..<span class="number">2000</span>);
<span class="macro">assert!</span>((-<span class="number">100</span>..<span class="number">2000</span>).contains(<span class="kw-2">&amp;</span>a));
<span class="kw">let </span>a: u32 = r.gen_range(<span class="number">12</span>..=<span class="number">24</span>);
<span class="macro">assert!</span>((<span class="number">12</span>..=<span class="number">24</span>).contains(<span class="kw-2">&amp;</span>a));
<span class="macro">assert_eq!</span>(r.gen_range(<span class="number">0u32</span>..<span class="number">1</span>), <span class="number">0u32</span>);
<span class="macro">assert_eq!</span>(r.gen_range(-<span class="number">12i64</span>..-<span class="number">11</span>), -<span class="number">12i64</span>);
<span class="macro">assert_eq!</span>(r.gen_range(<span class="number">3_000_000</span>..<span class="number">3_000_001</span>), <span class="number">3_000_000</span>);
}
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_gen_range_float() {
<span class="kw">let </span><span class="kw-2">mut </span>r = rng(<span class="number">101</span>);
<span class="kw">for _ in </span><span class="number">0</span>..<span class="number">1000 </span>{
<span class="kw">let </span>a = r.gen_range(-<span class="number">4.5</span>..<span class="number">1.7</span>);
<span class="macro">assert!</span>((-<span class="number">4.5</span>..<span class="number">1.7</span>).contains(<span class="kw-2">&amp;</span>a));
<span class="kw">let </span>a = r.gen_range(-<span class="number">1.1</span>..=-<span class="number">0.3</span>);
<span class="macro">assert!</span>((-<span class="number">1.1</span>..=-<span class="number">0.3</span>).contains(<span class="kw-2">&amp;</span>a));
<span class="macro">assert_eq!</span>(r.gen_range(<span class="number">0.0f32</span>..=<span class="number">0.0</span>), <span class="number">0.</span>);
<span class="macro">assert_eq!</span>(r.gen_range(-<span class="number">11.0</span>..=-<span class="number">11.0</span>), -<span class="number">11.</span>);
<span class="macro">assert_eq!</span>(r.gen_range(<span class="number">3_000_000.0</span>..=<span class="number">3_000_000.0</span>), <span class="number">3_000_000.</span>);
}
}
<span class="attribute">#[test]
#[should_panic]
</span><span class="kw">fn </span>test_gen_range_panic_int() {
<span class="attribute">#![allow(clippy::reversed_empty_ranges)]
</span><span class="kw">let </span><span class="kw-2">mut </span>r = rng(<span class="number">102</span>);
r.gen_range(<span class="number">5</span>..-<span class="number">2</span>);
}
<span class="attribute">#[test]
#[should_panic]
</span><span class="kw">fn </span>test_gen_range_panic_usize() {
<span class="attribute">#![allow(clippy::reversed_empty_ranges)]
</span><span class="kw">let </span><span class="kw-2">mut </span>r = rng(<span class="number">103</span>);
r.gen_range(<span class="number">5</span>..<span class="number">2</span>);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_gen_bool() {
<span class="attribute">#![allow(clippy::bool_assert_comparison)]
</span><span class="kw">let </span><span class="kw-2">mut </span>r = rng(<span class="number">105</span>);
<span class="kw">for _ in </span><span class="number">0</span>..<span class="number">5 </span>{
<span class="macro">assert_eq!</span>(r.gen_bool(<span class="number">0.0</span>), <span class="bool-val">false</span>);
<span class="macro">assert_eq!</span>(r.gen_bool(<span class="number">1.0</span>), <span class="bool-val">true</span>);
}
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_rng_trait_object() {
<span class="kw">use </span><span class="kw">crate</span>::distributions::{Distribution, Standard};
<span class="kw">let </span><span class="kw-2">mut </span>rng = rng(<span class="number">109</span>);
<span class="kw">let </span><span class="kw-2">mut </span>r = <span class="kw-2">&amp;mut </span>rng <span class="kw">as </span><span class="kw-2">&amp;mut </span><span class="kw">dyn </span>RngCore;
r.next_u32();
r.gen::&lt;i32&gt;();
<span class="macro">assert_eq!</span>(r.gen_range(<span class="number">0</span>..<span class="number">1</span>), <span class="number">0</span>);
<span class="kw">let </span>_c: u8 = Standard.sample(<span class="kw-2">&amp;mut </span>r);
}
<span class="attribute">#[test]
#[cfg(feature = <span class="string">&quot;alloc&quot;</span>)]
</span><span class="kw">fn </span>test_rng_boxed_trait() {
<span class="kw">use </span><span class="kw">crate</span>::distributions::{Distribution, Standard};
<span class="kw">let </span>rng = rng(<span class="number">110</span>);
<span class="kw">let </span><span class="kw-2">mut </span>r = Box::new(rng) <span class="kw">as </span>Box&lt;<span class="kw">dyn </span>RngCore&gt;;
r.next_u32();
r.gen::&lt;i32&gt;();
<span class="macro">assert_eq!</span>(r.gen_range(<span class="number">0</span>..<span class="number">1</span>), <span class="number">0</span>);
<span class="kw">let </span>_c: u8 = Standard.sample(<span class="kw-2">&amp;mut </span>r);
}
<span class="attribute">#[test]
#[cfg_attr(miri, ignore)] </span><span class="comment">// Miri is too slow
</span><span class="kw">fn </span>test_gen_ratio_average() {
<span class="kw">const </span>NUM: u32 = <span class="number">3</span>;
<span class="kw">const </span>DENOM: u32 = <span class="number">10</span>;
<span class="kw">const </span>N: u32 = <span class="number">100_000</span>;
<span class="kw">let </span><span class="kw-2">mut </span>sum: u32 = <span class="number">0</span>;
<span class="kw">let </span><span class="kw-2">mut </span>rng = rng(<span class="number">111</span>);
<span class="kw">for _ in </span><span class="number">0</span>..N {
<span class="kw">if </span>rng.gen_ratio(NUM, DENOM) {
sum += <span class="number">1</span>;
}
}
<span class="comment">// Have Binomial(N, NUM/DENOM) distribution
</span><span class="kw">let </span>expected = (NUM * N) / DENOM; <span class="comment">// exact integer
</span><span class="macro">assert!</span>(((sum - expected) <span class="kw">as </span>i32).abs() &lt; <span class="number">500</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>