| <!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/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.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> |
| </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 <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">//! Utilities for random number generation |
| //! |
| //! Rand provides utilities to generate random numbers, to convert them to |
| //! useful types and distributions, and some randomness-related algorithms. |
| //! |
| //! # Quick Start |
| //! |
| //! To get you started quickly, the easiest and highest-level way to get |
| //! a random value is to use [`random()`]; alternatively you can use |
| //! [`thread_rng()`]. The [`Rng`] trait provides a useful API on all RNGs, while |
| //! the [`distributions`] and [`seq`] modules provide further |
| //! functionality on top of RNGs. |
| //! |
| //! ``` |
| //! use rand::prelude::*; |
| //! |
| //! if rand::random() { // generates a boolean |
| //! // Try printing a random unicode code point (probably a bad idea)! |
| //! println!("char: {}", rand::random::<char>()); |
| //! } |
| //! |
| //! let mut rng = rand::thread_rng(); |
| //! let y: f64 = rng.gen(); // generates a float between 0 and 1 |
| //! |
| //! let mut nums: Vec<i32> = (1..100).collect(); |
| //! nums.shuffle(&mut rng); |
| //! ``` |
| //! |
| //! # The Book |
| //! |
| //! For the user guide and further documentation, please read |
| //! [The Rust Rand Book](https://rust-random.github.io/book). |
| |
| </span><span class="attribute">#![doc( |
| html_logo_url = <span class="string">"https://www.rust-lang.org/logos/rust-logo-128x128-blk.png"</span>, |
| html_favicon_url = <span class="string">"https://www.rust-lang.org/favicon.ico"</span>, |
| html_root_url = <span class="string">"https://rust-random.github.io/rand/" |
| </span>)] |
| #![deny(missing_docs)] |
| #![deny(missing_debug_implementations)] |
| #![doc(test(attr(allow(unused_variables), deny(warnings))))] |
| #![no_std] |
| #![cfg_attr(feature = <span class="string">"simd_support"</span>, feature(stdsimd))] |
| #![cfg_attr(doc_cfg, feature(doc_cfg))] |
| #![allow( |
| clippy::float_cmp, |
| clippy::neg_cmp_op_on_partial_ord, |
| )] |
| |
| #[cfg(feature = <span class="string">"std"</span>)] </span><span class="kw">extern crate </span>std; |
| <span class="attribute">#[cfg(feature = <span class="string">"alloc"</span>)] </span><span class="kw">extern crate </span>alloc; |
| |
| <span class="attribute">#[allow(unused)] |
| </span><span class="macro">macro_rules! </span>trace { ($(<span class="macro-nonterminal">$x</span>:tt)<span class="kw-2">*</span>) => ( |
| <span class="attribute">#[cfg(feature = <span class="string">"log"</span>)] </span>{ |
| <span class="macro">log::trace!</span>($(<span class="macro-nonterminal">$x</span>)<span class="kw-2">*</span>) |
| } |
| ) } |
| <span class="attribute">#[allow(unused)] |
| </span><span class="macro">macro_rules! </span>debug { ($(<span class="macro-nonterminal">$x</span>:tt)<span class="kw-2">*</span>) => ( |
| <span class="attribute">#[cfg(feature = <span class="string">"log"</span>)] </span>{ |
| <span class="macro">log::debug!</span>($(<span class="macro-nonterminal">$x</span>)<span class="kw-2">*</span>) |
| } |
| ) } |
| <span class="attribute">#[allow(unused)] |
| </span><span class="macro">macro_rules! </span>info { ($(<span class="macro-nonterminal">$x</span>:tt)<span class="kw-2">*</span>) => ( |
| <span class="attribute">#[cfg(feature = <span class="string">"log"</span>)] </span>{ |
| <span class="macro">log::info!</span>($(<span class="macro-nonterminal">$x</span>)<span class="kw-2">*</span>) |
| } |
| ) } |
| <span class="attribute">#[allow(unused)] |
| </span><span class="macro">macro_rules! </span>warn { ($(<span class="macro-nonterminal">$x</span>:tt)<span class="kw-2">*</span>) => ( |
| <span class="attribute">#[cfg(feature = <span class="string">"log"</span>)] </span>{ |
| <span class="macro">log::warn!</span>($(<span class="macro-nonterminal">$x</span>)<span class="kw-2">*</span>) |
| } |
| ) } |
| <span class="attribute">#[allow(unused)] |
| </span><span class="macro">macro_rules! </span>error { ($(<span class="macro-nonterminal">$x</span>:tt)<span class="kw-2">*</span>) => ( |
| <span class="attribute">#[cfg(feature = <span class="string">"log"</span>)] </span>{ |
| <span class="macro">log::error!</span>($(<span class="macro-nonterminal">$x</span>)<span class="kw-2">*</span>) |
| } |
| ) } |
| |
| <span class="comment">// Re-exports from rand_core |
| </span><span class="kw">pub use </span>rand_core::{CryptoRng, Error, RngCore, SeedableRng}; |
| |
| <span class="comment">// Public modules |
| </span><span class="kw">pub mod </span>distributions; |
| <span class="kw">pub mod </span>prelude; |
| <span class="kw">mod </span>rng; |
| <span class="kw">pub mod </span>rngs; |
| <span class="kw">pub mod </span>seq; |
| |
| <span class="comment">// Public exports |
| </span><span class="attribute">#[cfg(all(feature = <span class="string">"std"</span>, feature = <span class="string">"std_rng"</span>))] |
| </span><span class="kw">pub use </span><span class="kw">crate</span>::rngs::thread::thread_rng; |
| <span class="kw">pub use </span>rng::{Fill, Rng}; |
| |
| <span class="attribute">#[cfg(all(feature = <span class="string">"std"</span>, feature = <span class="string">"std_rng"</span>))] |
| </span><span class="kw">use </span><span class="kw">crate</span>::distributions::{Distribution, Standard}; |
| |
| <span class="doccomment">/// Generates a random value using the thread-local random number generator. |
| /// |
| /// This is simply a shortcut for `thread_rng().gen()`. See [`thread_rng`] for |
| /// documentation of the entropy source and [`Standard`] for documentation of |
| /// distributions and type-specific generation. |
| /// |
| /// # Provided implementations |
| /// |
| /// The following types have provided implementations that |
| /// generate values with the following ranges and distributions: |
| /// |
| /// * Integers (`i32`, `u32`, `isize`, `usize`, etc.): Uniformly distributed |
| /// over all values of the type. |
| /// * `char`: Uniformly distributed over all Unicode scalar values, i.e. all |
| /// code points in the range `0...0x10_FFFF`, except for the range |
| /// `0xD800...0xDFFF` (the surrogate code points). This includes |
| /// unassigned/reserved code points. |
| /// * `bool`: Generates `false` or `true`, each with probability 0.5. |
| /// * Floating point types (`f32` and `f64`): Uniformly distributed in the |
| /// half-open range `[0, 1)`. See notes below. |
| /// * Wrapping integers (`Wrapping<T>`), besides the type identical to their |
| /// normal integer variants. |
| /// |
| /// Also supported is the generation of the following |
| /// compound types where all component types are supported: |
| /// |
| /// * Tuples (up to 12 elements): each element is generated sequentially. |
| /// * Arrays (up to 32 elements): each element is generated sequentially; |
| /// see also [`Rng::fill`] which supports arbitrary array length for integer |
| /// types and tends to be faster for `u32` and smaller types. |
| /// * `Option<T>` first generates a `bool`, and if true generates and returns |
| /// `Some(value)` where `value: T`, otherwise returning `None`. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// let x = rand::random::<u8>(); |
| /// println!("{}", x); |
| /// |
| /// let y = rand::random::<f64>(); |
| /// println!("{}", y); |
| /// |
| /// if rand::random() { // generates a boolean |
| /// println!("Better lucky than good!"); |
| /// } |
| /// ``` |
| /// |
| /// If you're calling `random()` in a loop, caching the generator as in the |
| /// following example can increase performance. |
| /// |
| /// ``` |
| /// use rand::Rng; |
| /// |
| /// let mut v = vec![1, 2, 3]; |
| /// |
| /// for x in v.iter_mut() { |
| /// *x = rand::random() |
| /// } |
| /// |
| /// // can be made faster by caching thread_rng |
| /// |
| /// let mut rng = rand::thread_rng(); |
| /// |
| /// for x in v.iter_mut() { |
| /// *x = rng.gen(); |
| /// } |
| /// ``` |
| /// |
| /// [`Standard`]: distributions::Standard |
| </span><span class="attribute">#[cfg(all(feature = <span class="string">"std"</span>, feature = <span class="string">"std_rng"</span>))] |
| #[cfg_attr(doc_cfg, doc(cfg(all(feature = <span class="string">"std"</span>, feature = <span class="string">"std_rng"</span>))))] |
| #[inline] |
| </span><span class="kw">pub fn </span>random<T>() -> T |
| <span class="kw">where </span>Standard: Distribution<T> { |
| thread_rng().gen() |
| } |
| |
| <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="doccomment">/// Construct a deterministic RNG with the given seed |
| </span><span class="kw">pub fn </span>rng(seed: u64) -> <span class="kw">impl </span>RngCore { |
| <span class="comment">// For tests, we want a statistically good, fast, reproducible RNG. |
| // PCG32 will do fine, and will be easy to embed if we ever need to. |
| </span><span class="kw">const </span>INC: u64 = <span class="number">11634580027462260723</span>; |
| rand_pcg::Pcg32::new(seed, INC) |
| } |
| |
| <span class="attribute">#[test] |
| #[cfg(all(feature = <span class="string">"std"</span>, feature = <span class="string">"std_rng"</span>))] |
| </span><span class="kw">fn </span>test_random() { |
| <span class="kw">let </span>_n: usize = random(); |
| <span class="kw">let </span>_f: f32 = random(); |
| <span class="kw">let </span>_o: <span class="prelude-ty">Option</span><<span class="prelude-ty">Option</span><i8>> = random(); |
| <span class="attribute">#[allow(clippy::type_complexity)] |
| </span><span class="kw">let </span>_many: ( |
| (), |
| (usize, isize, <span class="prelude-ty">Option</span><(u32, (bool,))>), |
| (u8, i8, u16, i16, u32, i32, u64, i64), |
| (f32, (f64, (f64,))), |
| ) = random(); |
| } |
| } |
| </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> |
