Startseite Erkunden Hilfe
Anmelden
RONCC
/
HPC-Tools-for-Quantum-Computing
Beobachten 1
Favorit hinzufügen 0
Fork 0
Dateien Issues 0 Pull-Requests 0 Wiki
Struktur: e971e022d2
Branches Tags
HPC-Tools-fo...
/
doc
/
rand
/
rngs
/
struct.SmallRng.html

struct.SmallRng.html 20 KB
Verlauf Originalformat

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758 
  1. <!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="API documentation for the Rust `SmallRng` struct in crate `rand`."><meta name="keywords" content="rust, rustlang, rust-lang, SmallRng"><title>rand::rngs::SmallRng - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><link rel="shortcut icon" href="https://www.rust-lang.org/favicon.ico"></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../../rand/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk.png' alt='logo' width='100'></a><p class='location'>Struct SmallRng</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a><a href="#impl-RngCore">RngCore</a><a href="#impl-SeedableRng">SeedableRng</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='../index.html'>rand</a>::<wbr><a href='index.html'>rngs</a></p><script>window.sidebarCurrent = {name: 'SmallRng', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Struct <a href='../index.html'>rand</a>::<wbr><a href='index.html'>rngs</a>::<wbr><a class="struct" href=''>SmallRng</a></span><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/rand/rngs/small.rs.html#69' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct SmallRng(_);</pre></div><div class='docblock'><p>An RNG recommended when small state, cheap initialization and good
    2. 

  2. performance are required. The PRNG algorithm in <code>SmallRng</code> is chosen to be
    3. 

  3. efficient on the current platform, <strong>without consideration for cryptography
    4. 

  4. or security</strong>. The size of its state is much smaller than for <a href="struct.StdRng.html"><code>StdRng</code></a>.</p>
    5. 

  5. <p>Reproducibility of output from this generator is however not required, thus
    6. 

  6. future library versions may use a different internal generator with
    7. 

  7. different output. Further, this generator may not be portable and can
    8. 

  8. produce different output depending on the architecture. If you require
    9. 

  9. reproducible output, use a named RNG, for example <a href="../prng/struct.XorShiftRng.html"><code>XorShiftRng</code></a>.</p>
    10. 

  10. <p>The current algorithm used on all platforms is <a href="../prng/struct.XorShiftRng.html">Xorshift</a>.</p>
    11. 

  11. <h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
    12. 

  12. <p>Initializing <code>SmallRng</code> with a random seed can be done using <a href="../trait.FromEntropy.html"><code>FromEntropy</code></a>:</p>
    13. 

  13. 

  14. <pre class="rust rust-example-rendered">
    15. 

  15. <span class="kw">use</span> <span class="ident">rand</span>::<span class="ident">FromEntropy</span>;
    16. 

  16. <span class="kw">use</span> <span class="ident">rand</span>::<span class="ident">rngs</span>::<span class="ident">SmallRng</span>;
    17. 

  17. 

  18. <span class="comment">// Create small, cheap to initialize and fast RNG with a random seed.</span>
    19. 

  19. <span class="comment">// The randomness is supplied by the operating system.</span>
    20. 

  20. <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">small_rng</span> <span class="op">=</span> <span class="ident">SmallRng</span>::<span class="ident">from_entropy</span>();</pre>
    21. 

  21. <p>When initializing a lot of <code>SmallRng</code>'s, using <a href="../fn.thread_rng.html"><code>thread_rng</code></a> can be more
    22. 

  22. efficient:</p>
    23. 

  23. 

  24. <pre class="rust rust-example-rendered">
    25. 

  25. <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">iter</span>;
    26. 

  26. <span class="kw">use</span> <span class="ident">rand</span>::{<span class="ident">SeedableRng</span>, <span class="ident">thread_rng</span>};
    27. 

  27. <span class="kw">use</span> <span class="ident">rand</span>::<span class="ident">rngs</span>::<span class="ident">SmallRng</span>;
    28. 

  28. 

  29. <span class="comment">// Create a big, expensive to initialize and slower, but unpredictable RNG.</span>
    30. 

  30. <span class="comment">// This is cached and done only once per thread.</span>
    31. 

  31. <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">thread_rng</span> <span class="op">=</span> <span class="ident">thread_rng</span>();
    32. 

  32. <span class="comment">// Create small, cheap to initialize and fast RNGs with random seeds.</span>
    33. 

  33. <span class="comment">// One can generally assume this won&#39;t fail.</span>
    34. 

  34. <span class="kw">let</span> <span class="ident">rngs</span>: <span class="ident">Vec</span><span class="op">&lt;</span><span class="ident">SmallRng</span><span class="op">&gt;</span> <span class="op">=</span> <span class="ident">iter</span>::<span class="ident">repeat</span>(())
    35. 

  35.     .<span class="ident">map</span>(<span class="op">|</span>()<span class="op">|</span> <span class="ident">SmallRng</span>::<span class="ident">from_rng</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">thread_rng</span>).<span class="ident">unwrap</span>())
    36. 

  36.     .<span class="ident">take</span>(<span class="number">10</span>)
    37. 

  37.     .<span class="ident">collect</span>();</pre>
    38. 

  38. </div>
    39. 

  39.                 <h2 id='implementations' class='small-section-header'>
    40. 

  40.                   Trait Implementations<a href='#implementations' class='anchor'></a>
    41. 

  41.                 </h2>
    42. 

  42.                 <div id='implementations-list'><h3 id='impl-Clone' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../rand/rngs/struct.SmallRng.html" title="struct rand::rngs::SmallRng">SmallRng</a></code><a href='#impl-Clone' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/rngs/small.rs.html#68' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class="struct" href="../../rand/rngs/struct.SmallRng.html" title="struct rand::rngs::SmallRng">SmallRng</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/rngs/small.rs.html#68' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
    43. 

  43. </div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#130-132' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
    44. 

  44. </div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../rand/rngs/struct.SmallRng.html" title="struct rand::rngs::SmallRng">SmallRng</a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/rngs/small.rs.html#68' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/rngs/small.rs.html#68' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
    45. 

  45. </div></div><h3 id='impl-RngCore' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../rand/trait.RngCore.html" title="trait rand::RngCore">RngCore</a> for <a class="struct" href="../../rand/rngs/struct.SmallRng.html" title="struct rand::rngs::SmallRng">SmallRng</a></code><a href='#impl-RngCore' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/rngs/small.rs.html#71-89' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.next_u32' class="method"><span id='next_u32.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../rand/trait.RngCore.html#tymethod.next_u32' class='fnname'>next_u32</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/rngs/small.rs.html#73-75' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Return the next random <code>u32</code>. <a href="../../rand/trait.RngCore.html#tymethod.next_u32">Read more</a></p>
    46. 

  46. </div><h4 id='method.next_u64' class="method"><span id='next_u64.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../rand/trait.RngCore.html#tymethod.next_u64' class='fnname'>next_u64</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/rngs/small.rs.html#78-80' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Return the next random <code>u64</code>. <a href="../../rand/trait.RngCore.html#tymethod.next_u64">Read more</a></p>
    47. 

  47. </div><h4 id='method.fill_bytes' class="method"><span id='fill_bytes.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../rand/trait.RngCore.html#tymethod.fill_bytes' class='fnname'>fill_bytes</a>(&amp;mut self, dest: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/rngs/small.rs.html#82-84' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Fill <code>dest</code> with random data. <a href="../../rand/trait.RngCore.html#tymethod.fill_bytes">Read more</a></p>
    48. 

  48. </div><h4 id='method.try_fill_bytes' class="method"><span id='try_fill_bytes.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../rand/trait.RngCore.html#tymethod.try_fill_bytes' class='fnname'>try_fill_bytes</a>(&amp;mut self, dest: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../../rand/struct.Error.html" title="struct rand::Error">Error</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/rngs/small.rs.html#86-88' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Fill <code>dest</code> entirely with random data. <a href="../../rand/trait.RngCore.html#tymethod.try_fill_bytes">Read more</a></p>
    49. 

  49. </div></div><h3 id='impl-SeedableRng' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../rand/trait.SeedableRng.html" title="trait rand::SeedableRng">SeedableRng</a> for <a class="struct" href="../../rand/rngs/struct.SmallRng.html" title="struct rand::rngs::SmallRng">SmallRng</a></code><a href='#impl-SeedableRng' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/rngs/small.rs.html#91-101' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Seed' class="type"><span id='Seed.t' class='invisible'><code>type <a href='../../rand/trait.SeedableRng.html#associatedtype.Seed' class="type">Seed</a> = &lt;<a class="struct" href="../../rand/prng/struct.XorShiftRng.html" title="struct rand::prng::XorShiftRng">XorShiftRng</a> as <a class="trait" href="../../rand/trait.SeedableRng.html" title="trait rand::SeedableRng">SeedableRng</a>&gt;::<a class="type" href="../../rand/trait.SeedableRng.html#associatedtype.Seed" title="type rand::SeedableRng::Seed">Seed</a></code></span></h4>
    50. 

  50. <div class='docblock'><p>Seed type, which is restricted to types mutably-dereferencable as <code>u8</code> arrays (we recommend <code>[u8; N]</code> for some <code>N</code>). <a href="../../rand/trait.SeedableRng.html#associatedtype.Seed">Read more</a></p>
    51. 

  51. </div><h4 id='method.from_seed' class="method"><span id='from_seed.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../rand/trait.SeedableRng.html#tymethod.from_seed' class='fnname'>from_seed</a>(seed: Self::<a class="type" href="../../rand/trait.SeedableRng.html#associatedtype.Seed" title="type rand::SeedableRng::Seed">Seed</a>) -&gt; Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/rngs/small.rs.html#94-96' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create a new PRNG using the given seed. <a href="../../rand/trait.SeedableRng.html#tymethod.from_seed">Read more</a></p>
    52. 

  52. </div><h4 id='method.from_rng' class="method"><span id='from_rng.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../rand/trait.SeedableRng.html#method.from_rng' class='fnname'>from_rng</a>&lt;R:&nbsp;<a class="trait" href="../../rand/trait.RngCore.html" title="trait rand::RngCore">RngCore</a>&gt;(rng: R) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;Self, <a class="struct" href="../../rand/struct.Error.html" title="struct rand::Error">Error</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/rngs/small.rs.html#98-100' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create a new PRNG seeded from another <code>Rng</code>. <a href="../../rand/trait.SeedableRng.html#method.from_rng">Read more</a></p>
    53. 

  53. </div></div></div>
    54. 

  54.                 <h2 id='synthetic-implementations' class='small-section-header'>
    55. 

  55.                   Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>
    56. 

  56.                 </h2>
    57. 

  57.                 <div id='synthetic-implementations-list'>
    58. 

  58.             <h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../rand/rngs/struct.SmallRng.html" title="struct rand::rngs::SmallRng">SmallRng</a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../rand/rngs/struct.SmallRng.html" title="struct rand::rngs::SmallRng">SmallRng</a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>&#9166;</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "rand";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
    59.