trait.SeedableRng.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  6. <meta name="generator" content="rustdoc">
  7. <meta name="description" content="API documentation for the Rust `SeedableRng` trait in crate `rand`.">
  8. <meta name="keywords" content="rust, rustlang, rust-lang, SeedableRng">
  9. <title>rand::SeedableRng - Rust</title>
  10. <link rel="stylesheet" type="text/css" href="../normalize.css">
  11. <link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle">
  12. <link rel="stylesheet" type="text/css" href="../dark.css">
  13. <link rel="stylesheet" type="text/css" href="../main.css" id="themeStyle">
  14. <script src="../storage.js"></script>
  15. <link rel="shortcut icon" href="https://www.rust-lang.org/favicon.ico">
  16. </head>
  17. <body class="rustdoc trait">
  18. <!--[if lte IE 8]>
  19. <div class="warning">
  20. This old browser is unsupported and will most likely display funky
  21. things.
  22. </div>
  23. <![endif]-->
  24. <nav class="sidebar">
  25. <div class="sidebar-menu">&#9776;</div>
  26. <a href='../rand/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk.png' alt='logo' width='100'></a>
  27. <p class='location'>Trait SeedableRng</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.reseed">reseed</a><a href="#tymethod.from_seed">from_seed</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>rand</a></p><script>window.sidebarCurrent = {name: 'SeedableRng', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
  28. </nav>
  29. <div class="theme-picker">
  30. <button id="theme-picker" aria-label="Pick another theme!">
  31. <img src="../brush.svg" width="18" alt="Pick another theme!">
  32. </button>
  33. <div id="theme-choices"></div>
  34. </div>
  35. <script src="../theme.js"></script>
  36. <nav class="sub">
  37. <form class="search-form js-only">
  38. <div class="search-container">
  39. <input class="search-input" name="search"
  40. autocomplete="off"
  41. placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
  42. type="search">
  43. </div>
  44. </form>
  45. </nav>
  46. <section id='main' class="content">
  47. <h1 class='fqn'><span class='in-band'>Trait <a href='index.html'>rand</a>::<wbr><a class="trait" href=''>SeedableRng</a></span><span class='out-of-band'><span id='render-detail'>
  48. <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
  49. [<span class='inner'>&#x2212;</span>]
  50. </a>
  51. </span><a class='srclink' href='../src/rand/lib.rs.html#703-731' title='goto source code'>[src]</a></span></h1>
  52. <pre class='rust trait'>pub trait SeedableRng&lt;Seed&gt;: <a class="trait" href="../rand/trait.Rng.html" title="trait rand::Rng">Rng</a> {
  53. fn <a href='#tymethod.reseed' class='fnname'>reseed</a>(&amp;mut self, _: Seed);
  54. <div class='item-spacer'></div> fn <a href='#tymethod.from_seed' class='fnname'>from_seed</a>(seed: Seed) -&gt; Self;
  55. }</pre><div class='docblock'><p>A random number generator that can be explicitly seeded to produce
  56. the same stream of randomness multiple times.</p>
  57. </div>
  58. <h2 id='required-methods' class='small-section-header'>
  59. Required Methods<a href='#required-methods' class='anchor'></a>
  60. </h2>
  61. <div class='methods'>
  62. <h3 id='tymethod.reseed' class='method'><span id='reseed.v' class='invisible'><code>fn <a href='#tymethod.reseed' class='fnname'>reseed</a>(&amp;mut self, _: Seed)</code></span></h3><div class='docblock'><p>Reseed an RNG with the given seed.</p>
  63. <h1 id="example" class="section-header"><a href="#example">Example</a></h1>
  64. <pre class="rust rust-example-rendered">
  65. <span class="kw">use</span> <span class="ident">rand</span>::{<span class="ident">Rng</span>, <span class="ident">SeedableRng</span>, <span class="ident">StdRng</span>};
  66. <span class="kw">let</span> <span class="ident">seed</span>: <span class="kw-2">&amp;</span>[_] <span class="op">=</span> <span class="kw-2">&amp;</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>];
  67. <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">rng</span>: <span class="ident">StdRng</span> <span class="op">=</span> <span class="ident">SeedableRng</span>::<span class="ident">from_seed</span>(<span class="ident">seed</span>);
  68. <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{}&quot;</span>, <span class="ident">rng</span>.<span class="ident">gen</span>::<span class="op">&lt;</span><span class="ident">f64</span><span class="op">&gt;</span>());
  69. <span class="ident">rng</span>.<span class="ident">reseed</span>(<span class="kw-2">&amp;</span>[<span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>, <span class="number">8</span>]);
  70. <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{}&quot;</span>, <span class="ident">rng</span>.<span class="ident">gen</span>::<span class="op">&lt;</span><span class="ident">f64</span><span class="op">&gt;</span>());</pre>
  71. </div><h3 id='tymethod.from_seed' class='method'><span id='from_seed.v' class='invisible'><code>fn <a href='#tymethod.from_seed' class='fnname'>from_seed</a>(seed: Seed) -&gt; Self</code></span></h3><div class='docblock'><p>Create a new RNG with the given seed.</p>
  72. <h1 id="example-1" class="section-header"><a href="#example-1">Example</a></h1>
  73. <pre class="rust rust-example-rendered">
  74. <span class="kw">use</span> <span class="ident">rand</span>::{<span class="ident">Rng</span>, <span class="ident">SeedableRng</span>, <span class="ident">StdRng</span>};
  75. <span class="kw">let</span> <span class="ident">seed</span>: <span class="kw-2">&amp;</span>[_] <span class="op">=</span> <span class="kw-2">&amp;</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>];
  76. <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">rng</span>: <span class="ident">StdRng</span> <span class="op">=</span> <span class="ident">SeedableRng</span>::<span class="ident">from_seed</span>(<span class="ident">seed</span>);
  77. <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{}&quot;</span>, <span class="ident">rng</span>.<span class="ident">gen</span>::<span class="op">&lt;</span><span class="ident">f64</span><span class="op">&gt;</span>());</pre>
  78. </div></div>
  79. <h2 id='implementors' class='small-section-header'>
  80. Implementors<a href='#implementors' class='anchor'></a>
  81. </h2>
  82. <ul class='item-list' id='implementors-list'>
  83. <li><div class='out-of-band'><a class='srclink' href='../src/rand/reseeding.rs.html#81-99' title='goto source code'>[src]</a></div><code>impl&lt;S, R:&nbsp;<a class="trait" href="../rand/trait.SeedableRng.html" title="trait rand::SeedableRng">SeedableRng</a>&lt;S&gt;, Rsdr:&nbsp;<a class="trait" href="../rand/reseeding/trait.Reseeder.html" title="trait rand::reseeding::Reseeder">Reseeder</a>&lt;R&gt; + <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a>&gt; SeedableRng&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>Rsdr, S<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>&gt; for <a class="struct" href="../rand/reseeding/struct.ReseedingRng.html" title="struct rand::reseeding::ReseedingRng">ReseedingRng</a>&lt;R, Rsdr&gt;</code></li>
  84. <li><div class='out-of-band'><a class='srclink' href='../src/rand/prng/chacha.rs.html#201-222' title='goto source code'>[src]</a></div><code>impl&lt;'a&gt; SeedableRng&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>&gt; for <a class="struct" href="../rand/struct.ChaChaRng.html" title="struct rand::ChaChaRng">ChaChaRng</a></code></li>
  85. <li><div class='out-of-band'><a class='srclink' href='../src/rand/prng/isaac.rs.html#219-246' title='goto source code'>[src]</a></div><code>impl&lt;'a&gt; SeedableRng&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>&gt; for <a class="struct" href="../rand/struct.IsaacRng.html" title="struct rand::IsaacRng">IsaacRng</a></code></li>
  86. <li><div class='out-of-band'><a class='srclink' href='../src/rand/prng/isaac64.rs.html#217-244' title='goto source code'>[src]</a></div><code>impl&lt;'a&gt; SeedableRng&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>&gt; for <a class="struct" href="../rand/struct.Isaac64Rng.html" title="struct rand::Isaac64Rng">Isaac64Rng</a></code></li>
  87. <li><div class='out-of-band'><a class='srclink' href='../src/rand/prng/xorshift.rs.html#66-90' title='goto source code'>[src]</a></div><code>impl SeedableRng&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 4]</a>&gt; for <a class="struct" href="../rand/struct.XorShiftRng.html" title="struct rand::XorShiftRng">XorShiftRng</a></code></li>
  88. <li><div class='out-of-band'><a class='srclink' href='../src/rand/lib.rs.html#815-825' title='goto source code'>[src]</a></div><code>impl&lt;'a&gt; SeedableRng&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>&gt; for <a class="struct" href="../rand/struct.StdRng.html" title="struct rand::StdRng">StdRng</a></code></li>
  89. </ul><script type="text/javascript" async
  90. src="../implementors/rand/trait.SeedableRng.js">
  91. </script></section>
  92. <section id='search' class="content hidden"></section>
  93. <section class="footer"></section>
  94. <aside id="help" class="hidden">
  95. <div>
  96. <h1 class="hidden">Help</h1>
  97. <div class="shortcuts">
  98. <h2>Keyboard Shortcuts</h2>
  99. <dl>
  100. <dt><kbd>?</kbd></dt>
  101. <dd>Show this help dialog</dd>
  102. <dt><kbd>S</kbd></dt>
  103. <dd>Focus the search field</dd>
  104. <dt><kbd>↑</kbd></dt>
  105. <dd>Move up in search results</dd>
  106. <dt><kbd>↓</kbd></dt>
  107. <dd>Move down in search results</dd>
  108. <dt><kbd>↹</kbd></dt>
  109. <dd>Switch tab</dd>
  110. <dt><kbd>&#9166;</kbd></dt>
  111. <dd>Go to active search result</dd>
  112. <dt><kbd>+</kbd></dt>
  113. <dd>Expand all sections</dd>
  114. <dt><kbd>-</kbd></dt>
  115. <dd>Collapse all sections</dd>
  116. </dl>
  117. </div>
  118. <div class="infos">
  119. <h2>Search Tricks</h2>
  120. <p>
  121. Prefix searches with a type followed by a colon (e.g.
  122. <code>fn:</code>) to restrict the search to a given type.
  123. </p>
  124. <p>
  125. Accepted types are: <code>fn</code>, <code>mod</code>,
  126. <code>struct</code>, <code>enum</code>,
  127. <code>trait</code>, <code>type</code>, <code>macro</code>,
  128. and <code>const</code>.
  129. </p>
  130. <p>
  131. Search functions by type signature (e.g.
  132. <code>vec -> usize</code> or <code>* -> vec</code>)
  133. </p>
  134. </div>
  135. </div>
  136. </aside>
  137. <script>
  138. window.rootPath = "../";
  139. window.currentCrate = "rand";
  140. </script>
  141. <script src="../main.js"></script>
  142. <script defer src="../search-index.js"></script>
  143. </body>
  144. </html>