trait.Sample.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154
  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 `Sample` trait in crate `rand`.">
  8. <meta name="keywords" content="rust, rustlang, rust-lang, Sample">
  9. <title>rand::distributions::Sample - 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 Sample</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.sample">sample</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../index.html'>rand</a>::<wbr><a href='index.html'>distributions</a></p><script>window.sidebarCurrent = {name: 'Sample', 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 href='index.html'>distributions</a>::<wbr><a class="trait" href=''>Sample</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/distributions/mod.rs.html#44-48' title='goto source code'>[src]</a></span></h1>
  52. <pre class='rust trait'>pub trait Sample&lt;Support&gt; {
  53. fn <a href='#tymethod.sample' class='fnname'>sample</a>&lt;R:&nbsp;<a class="trait" href="../../rand/trait.Rng.html" title="trait rand::Rng">Rng</a>&gt;(&amp;mut self, rng: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>R) -&gt; Support;
  54. }</pre><div class='docblock'><p>Types that can be used to create a random instance of <code>Support</code>.</p>
  55. </div>
  56. <h2 id='required-methods' class='small-section-header'>
  57. Required Methods<a href='#required-methods' class='anchor'></a>
  58. </h2>
  59. <div class='methods'>
  60. <h3 id='tymethod.sample' class='method'><span id='sample.v' class='invisible'><code>fn <a href='#tymethod.sample' class='fnname'>sample</a>&lt;R:&nbsp;<a class="trait" href="../../rand/trait.Rng.html" title="trait rand::Rng">Rng</a>&gt;(&amp;mut self, rng: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>R) -&gt; Support</code></span></h3><div class='docblock'><p>Generate a random value of <code>Support</code>, using <code>rng</code> as the
  61. source of randomness.</p>
  62. </div></div>
  63. <h2 id='implementors' class='small-section-header'>
  64. Implementors<a href='#implementors' class='anchor'></a>
  65. </h2>
  66. <ul class='item-list' id='implementors-list'>
  67. <li><div class='out-of-band'><a class='srclink' href='../../src/rand/distributions/range.rs.html#65-68' title='goto source code'>[src]</a></div><code>impl&lt;Sup:&nbsp;<a class="trait" href="../../rand/distributions/range/trait.SampleRange.html" title="trait rand::distributions::range::SampleRange">SampleRange</a>&gt; Sample&lt;Sup&gt; for <a class="struct" href="../../rand/distributions/range/struct.Range.html" title="struct rand::distributions::range::Range">Range</a>&lt;Sup&gt;</code></li>
  68. <li><div class='out-of-band'><a class='srclink' href='../../src/rand/distributions/gamma.rs.html#136-138' title='goto source code'>[src]</a></div><code>impl Sample&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>&gt; for <a class="struct" href="../../rand/distributions/gamma/struct.Gamma.html" title="struct rand::distributions::gamma::Gamma">Gamma</a></code></li>
  69. <li><div class='out-of-band'><a class='srclink' href='../../src/rand/distributions/gamma.rs.html#227-229' title='goto source code'>[src]</a></div><code>impl Sample&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>&gt; for <a class="struct" href="../../rand/distributions/gamma/struct.ChiSquared.html" title="struct rand::distributions::gamma::ChiSquared">ChiSquared</a></code></li>
  70. <li><div class='out-of-band'><a class='srclink' href='../../src/rand/distributions/gamma.rs.html#281-283' title='goto source code'>[src]</a></div><code>impl Sample&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>&gt; for <a class="struct" href="../../rand/distributions/gamma/struct.FisherF.html" title="struct rand::distributions::gamma::FisherF">FisherF</a></code></li>
  71. <li><div class='out-of-band'><a class='srclink' href='../../src/rand/distributions/gamma.rs.html#319-321' title='goto source code'>[src]</a></div><code>impl Sample&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>&gt; for <a class="struct" href="../../rand/distributions/gamma/struct.StudentT.html" title="struct rand::distributions::gamma::StudentT">StudentT</a></code></li>
  72. <li><div class='out-of-band'><a class='srclink' href='../../src/rand/distributions/normal.rs.html#113-115' title='goto source code'>[src]</a></div><code>impl Sample&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>&gt; for <a class="struct" href="../../rand/distributions/normal/struct.Normal.html" title="struct rand::distributions::normal::Normal">Normal</a></code></li>
  73. <li><div class='out-of-band'><a class='srclink' href='../../src/rand/distributions/normal.rs.html#157-159' title='goto source code'>[src]</a></div><code>impl Sample&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>&gt; for <a class="struct" href="../../rand/distributions/normal/struct.LogNormal.html" title="struct rand::distributions::normal::LogNormal">LogNormal</a></code></li>
  74. <li><div class='out-of-band'><a class='srclink' href='../../src/rand/distributions/exponential.rs.html#90-92' title='goto source code'>[src]</a></div><code>impl Sample&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>&gt; for <a class="struct" href="../../rand/distributions/exponential/struct.Exp.html" title="struct rand::distributions::exponential::Exp">Exp</a></code></li>
  75. <li><div class='out-of-band'><a class='srclink' href='../../src/rand/distributions/mod.rs.html#75-77' title='goto source code'>[src]</a></div><code>impl&lt;Sup:&nbsp;<a class="trait" href="../../rand/trait.Rand.html" title="trait rand::Rand">Rand</a>&gt; Sample&lt;Sup&gt; for <a class="struct" href="../../rand/distributions/struct.RandSample.html" title="struct rand::distributions::RandSample">RandSample</a>&lt;Sup&gt;</code></li>
  76. <li><div class='out-of-band'><a class='srclink' href='../../src/rand/distributions/mod.rs.html#168-170' title='goto source code'>[src]</a></div><code>impl&lt;'a, T:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>&gt; Sample&lt;T&gt; for <a class="struct" href="../../rand/distributions/struct.WeightedChoice.html" title="struct rand::distributions::WeightedChoice">WeightedChoice</a>&lt;'a, T&gt;</code></li>
  77. </ul><script type="text/javascript" async
  78. src="../../implementors/rand/distributions/trait.Sample.js">
  79. </script></section>
  80. <section id='search' class="content hidden"></section>
  81. <section class="footer"></section>
  82. <aside id="help" class="hidden">
  83. <div>
  84. <h1 class="hidden">Help</h1>
  85. <div class="shortcuts">
  86. <h2>Keyboard Shortcuts</h2>
  87. <dl>
  88. <dt><kbd>?</kbd></dt>
  89. <dd>Show this help dialog</dd>
  90. <dt><kbd>S</kbd></dt>
  91. <dd>Focus the search field</dd>
  92. <dt><kbd>↑</kbd></dt>
  93. <dd>Move up in search results</dd>
  94. <dt><kbd>↓</kbd></dt>
  95. <dd>Move down in search results</dd>
  96. <dt><kbd>↹</kbd></dt>
  97. <dd>Switch tab</dd>
  98. <dt><kbd>&#9166;</kbd></dt>
  99. <dd>Go to active search result</dd>
  100. <dt><kbd>+</kbd></dt>
  101. <dd>Expand all sections</dd>
  102. <dt><kbd>-</kbd></dt>
  103. <dd>Collapse all sections</dd>
  104. </dl>
  105. </div>
  106. <div class="infos">
  107. <h2>Search Tricks</h2>
  108. <p>
  109. Prefix searches with a type followed by a colon (e.g.
  110. <code>fn:</code>) to restrict the search to a given type.
  111. </p>
  112. <p>
  113. Accepted types are: <code>fn</code>, <code>mod</code>,
  114. <code>struct</code>, <code>enum</code>,
  115. <code>trait</code>, <code>type</code>, <code>macro</code>,
  116. and <code>const</code>.
  117. </p>
  118. <p>
  119. Search functions by type signature (e.g.
  120. <code>vec -> usize</code> or <code>* -> vec</code>)
  121. </p>
  122. </div>
  123. </div>
  124. </aside>
  125. <script>
  126. window.rootPath = "../../";
  127. window.currentCrate = "rand";
  128. </script>
  129. <script src="../../main.js"></script>
  130. <script defer src="../../search-index.js"></script>
  131. </body>
  132. </html>