trait.SampleUniform.html 22 KB

12345678910111213141516171819202122232425262728293031323334353637
  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 `SampleUniform` trait in crate `rand`."><meta name="keywords" content="rust, rustlang, rust-lang, SampleUniform"><title>rand::distributions::uniform::SampleUniform - 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 trait"><!--[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'>Trait SampleUniform</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.Sampler">Sampler</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-SampleUniform">i8</a><a href="#impl-SampleUniform">i16</a><a href="#impl-SampleUniform">i32</a><a href="#impl-SampleUniform">i64</a><a href="#impl-SampleUniform">isize</a><a href="#impl-SampleUniform">u8</a><a href="#impl-SampleUniform">u16</a><a href="#impl-SampleUniform">u32</a><a href="#impl-SampleUniform">u64</a><a href="#impl-SampleUniform">usize</a><a href="#impl-SampleUniform">f32</a><a href="#impl-SampleUniform">f64</a><a href="#impl-SampleUniform">Duration</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>::<wbr><a href='index.html'>uniform</a></p><script>window.sidebarCurrent = {name: 'SampleUniform', ty: 'trait', 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'>Trait <a href='../../index.html'>rand</a>::<wbr><a href='../index.html'>distributions</a>::<wbr><a href='index.html'>uniform</a>::<wbr><a class="trait" href=''>SampleUniform</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/distributions/uniform.rs.html#184-187' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust trait'>pub trait SampleUniform: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
  2. type <a href='#associatedtype.Sampler' class="type">Sampler</a>: <a class="trait" href="../../../rand/distributions/uniform/trait.UniformSampler.html" title="trait rand::distributions::uniform::UniformSampler">UniformSampler</a>&lt;X = Self&gt;;
  3. }</pre></div><div class='docblock'><p>Helper trait for creating objects using the correct implementation of
  4. <a href="trait.UniformSampler.html"><code>UniformSampler</code></a> for the sampling type.</p>
  5. <p>See the <a href="index.html">module documentation</a> on how to implement <a href="struct.Uniform.html"><code>Uniform</code></a> range
  6. sampling for a custom type.</p>
  7. </div>
  8. <h2 id='associated-types' class='small-section-header'>
  9. Associated Types<a href='#associated-types' class='anchor'></a>
  10. </h2>
  11. <div class='methods'>
  12. <h3 id='associatedtype.Sampler' class='method'><span id='Sampler.t' class='invisible'><code>type <a href='#associatedtype.Sampler' class="type">Sampler</a>: <a class="trait" href="../../../rand/distributions/uniform/trait.UniformSampler.html" title="trait rand::distributions::uniform::UniformSampler">UniformSampler</a>&lt;X = Self&gt;</code></span></h3><div class='docblock'><p>The <code>UniformSampler</code> implementation supporting type <code>X</code>.</p>
  13. </div></div>
  14. <h2 id='foreign-impls' class='small-section-header'>
  15. Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a>
  16. </h2>
  17. <h3 id='impl-SampleUniform' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../../rand/distributions/uniform/trait.SampleUniform.html" title="trait rand::distributions::uniform::SampleUniform">SampleUniform</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a></code><a href='#impl-SampleUniform' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/rand/distributions/uniform.rs.html#300-302' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='associatedtype.Sampler-1' class="type"><span id='Sampler.t-1' class='invisible'><code>type <a href='#associatedtype.Sampler' class="type">Sampler</a> = <a class="struct" href="../../../rand/distributions/uniform/struct.UniformInt.html" title="struct rand::distributions::uniform::UniformInt">UniformInt</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a>&gt;</code></span></h4>
  18. </div></span><h3 id='impl-SampleUniform-1' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../../rand/distributions/uniform/trait.SampleUniform.html" title="trait rand::distributions::uniform::SampleUniform">SampleUniform</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a></code><a href='#impl-SampleUniform-1' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/rand/distributions/uniform.rs.html#300-302' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='associatedtype.Sampler-2' class="type"><span id='Sampler.t-2' class='invisible'><code>type <a href='#associatedtype.Sampler' class="type">Sampler</a> = <a class="struct" href="../../../rand/distributions/uniform/struct.UniformInt.html" title="struct rand::distributions::uniform::UniformInt">UniformInt</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a>&gt;</code></span></h4>
  19. </div></span><h3 id='impl-SampleUniform-2' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../../rand/distributions/uniform/trait.SampleUniform.html" title="trait rand::distributions::uniform::SampleUniform">SampleUniform</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a></code><a href='#impl-SampleUniform-2' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/rand/distributions/uniform.rs.html#300-302' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='associatedtype.Sampler-3' class="type"><span id='Sampler.t-3' class='invisible'><code>type <a href='#associatedtype.Sampler' class="type">Sampler</a> = <a class="struct" href="../../../rand/distributions/uniform/struct.UniformInt.html" title="struct rand::distributions::uniform::UniformInt">UniformInt</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>&gt;</code></span></h4>
  20. </div></span><h3 id='impl-SampleUniform-3' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../../rand/distributions/uniform/trait.SampleUniform.html" title="trait rand::distributions::uniform::SampleUniform">SampleUniform</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a></code><a href='#impl-SampleUniform-3' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/rand/distributions/uniform.rs.html#300-302' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='associatedtype.Sampler-4' class="type"><span id='Sampler.t-4' class='invisible'><code>type <a href='#associatedtype.Sampler' class="type">Sampler</a> = <a class="struct" href="../../../rand/distributions/uniform/struct.UniformInt.html" title="struct rand::distributions::uniform::UniformInt">UniformInt</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>&gt;</code></span></h4>
  21. </div></span><h3 id='impl-SampleUniform-4' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../../rand/distributions/uniform/trait.SampleUniform.html" title="trait rand::distributions::uniform::SampleUniform">SampleUniform</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a></code><a href='#impl-SampleUniform-4' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/rand/distributions/uniform.rs.html#300-302' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='associatedtype.Sampler-5' class="type"><span id='Sampler.t-5' class='invisible'><code>type <a href='#associatedtype.Sampler' class="type">Sampler</a> = <a class="struct" href="../../../rand/distributions/uniform/struct.UniformInt.html" title="struct rand::distributions::uniform::UniformInt">UniformInt</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a>&gt;</code></span></h4>
  22. </div></span><h3 id='impl-SampleUniform-5' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../../rand/distributions/uniform/trait.SampleUniform.html" title="trait rand::distributions::uniform::SampleUniform">SampleUniform</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a></code><a href='#impl-SampleUniform-5' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/rand/distributions/uniform.rs.html#300-302' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='associatedtype.Sampler-6' class="type"><span id='Sampler.t-6' class='invisible'><code>type <a href='#associatedtype.Sampler' class="type">Sampler</a> = <a class="struct" href="../../../rand/distributions/uniform/struct.UniformInt.html" title="struct rand::distributions::uniform::UniformInt">UniformInt</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>&gt;</code></span></h4>
  23. </div></span><h3 id='impl-SampleUniform-6' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../../rand/distributions/uniform/trait.SampleUniform.html" title="trait rand::distributions::uniform::SampleUniform">SampleUniform</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a></code><a href='#impl-SampleUniform-6' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/rand/distributions/uniform.rs.html#300-302' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='associatedtype.Sampler-7' class="type"><span id='Sampler.t-7' class='invisible'><code>type <a href='#associatedtype.Sampler' class="type">Sampler</a> = <a class="struct" href="../../../rand/distributions/uniform/struct.UniformInt.html" title="struct rand::distributions::uniform::UniformInt">UniformInt</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a>&gt;</code></span></h4>
  24. </div></span><h3 id='impl-SampleUniform-7' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../../rand/distributions/uniform/trait.SampleUniform.html" title="trait rand::distributions::uniform::SampleUniform">SampleUniform</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code><a href='#impl-SampleUniform-7' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/rand/distributions/uniform.rs.html#300-302' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='associatedtype.Sampler-8' class="type"><span id='Sampler.t-8' class='invisible'><code>type <a href='#associatedtype.Sampler' class="type">Sampler</a> = <a class="struct" href="../../../rand/distributions/uniform/struct.UniformInt.html" title="struct rand::distributions::uniform::UniformInt">UniformInt</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>&gt;</code></span></h4>
  25. </div></span><h3 id='impl-SampleUniform-8' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../../rand/distributions/uniform/trait.SampleUniform.html" title="trait rand::distributions::uniform::SampleUniform">SampleUniform</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a></code><a href='#impl-SampleUniform-8' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/rand/distributions/uniform.rs.html#300-302' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='associatedtype.Sampler-9' class="type"><span id='Sampler.t-9' class='invisible'><code>type <a href='#associatedtype.Sampler' class="type">Sampler</a> = <a class="struct" href="../../../rand/distributions/uniform/struct.UniformInt.html" title="struct rand::distributions::uniform::UniformInt">UniformInt</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>&gt;</code></span></h4>
  26. </div></span><h3 id='impl-SampleUniform-9' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../../rand/distributions/uniform/trait.SampleUniform.html" title="trait rand::distributions::uniform::SampleUniform">SampleUniform</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a href='#impl-SampleUniform-9' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/rand/distributions/uniform.rs.html#300-302' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='associatedtype.Sampler-10' class="type"><span id='Sampler.t-10' class='invisible'><code>type <a href='#associatedtype.Sampler' class="type">Sampler</a> = <a class="struct" href="../../../rand/distributions/uniform/struct.UniformInt.html" title="struct rand::distributions::uniform::UniformInt">UniformInt</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>&gt;</code></span></h4>
  27. </div></span><h3 id='impl-SampleUniform-10' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../../rand/distributions/uniform/trait.SampleUniform.html" title="trait rand::distributions::uniform::SampleUniform">SampleUniform</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a></code><a href='#impl-SampleUniform-10' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/rand/distributions/uniform.rs.html#528-530' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='associatedtype.Sampler-11' class="type"><span id='Sampler.t-11' class='invisible'><code>type <a href='#associatedtype.Sampler' class="type">Sampler</a> = <a class="struct" href="../../../rand/distributions/uniform/struct.UniformFloat.html" title="struct rand::distributions::uniform::UniformFloat">UniformFloat</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a>&gt;</code></span></h4>
  28. </div></span><h3 id='impl-SampleUniform-11' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../../rand/distributions/uniform/trait.SampleUniform.html" title="trait rand::distributions::uniform::SampleUniform">SampleUniform</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a></code><a href='#impl-SampleUniform-11' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/rand/distributions/uniform.rs.html#528-530' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='associatedtype.Sampler-12' class="type"><span id='Sampler.t-12' class='invisible'><code>type <a href='#associatedtype.Sampler' class="type">Sampler</a> = <a class="struct" href="../../../rand/distributions/uniform/struct.UniformFloat.html" title="struct rand::distributions::uniform::UniformFloat">UniformFloat</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>&gt;</code></span></h4>
  29. </div></span><h3 id='impl-SampleUniform-12' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../../rand/distributions/uniform/trait.SampleUniform.html" title="trait rand::distributions::uniform::SampleUniform">SampleUniform</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a></code><a href='#impl-SampleUniform-12' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/rand/distributions/uniform.rs.html#618-620' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='associatedtype.Sampler-13' class="type"><span id='Sampler.t-13' class='invisible'><code>type <a href='#associatedtype.Sampler' class="type">Sampler</a> = <a class="struct" href="../../../rand/distributions/uniform/struct.UniformDuration.html" title="struct rand::distributions::uniform::UniformDuration">UniformDuration</a></code></span></h4>
  30. </div></span>
  31. <h2 id='implementors' class='small-section-header'>
  32. Implementors<a href='#implementors' class='anchor'></a>
  33. </h2>
  34. <ul class='item-list' id='implementors-list'>
  35. </ul><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
  36. src="../../../implementors/rand/distributions/uniform/trait.SampleUniform.js">
  37. </script></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>