37 lines
110 KiB
HTML
37 lines
110 KiB
HTML
|
<!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 `UniformSampler` trait in crate `rand`."><meta name="keywords" content="rust, rustlang, rust-lang, UniformSampler"><title>rand::distributions::uniform::UniformSampler - 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><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="shortcut icon" href="https://www.rust-lang.org/favicon.ico"><style type="text/css">#crate-search{background-image:url("../../../down-arrow.svg");}</style></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">☰</div><a 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><p class='location'>Trait UniformSampler</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.X">X</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.new">new</a><a href="#tymethod.new_inclusive">new_inclusive</a><a href="#tymethod.sample">sample</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.sample_single">sample_single</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: 'UniformSampler', 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"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><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='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../../../src/rand/distributions/uniform.rs.html#221-262' title='goto source code'>[src]</a></span><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=''>UniformSampler</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait UniformSampler: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
|||
|
|
type <a href='#associatedtype.X' class="type">X</a>;
|
|||
|
|
fn <a href='#tymethod.new' class='fnname'>new</a><B1, B2>(low: B1, high: B2) -> Self<br> <span class="where">where<br> B1: <a class="trait" href="../../../rand/distributions/uniform/trait.SampleBorrow.html" title="trait rand::distributions::uniform::SampleBorrow">SampleBorrow</a><Self::<a class="type" href="../../../rand/distributions/uniform/trait.UniformSampler.html#associatedtype.X" title="type rand::distributions::uniform::UniformSampler::X">X</a>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,<br> B2: <a class="trait" href="../../../rand/distributions/uniform/trait.SampleBorrow.html" title="trait rand::distributions::uniform::SampleBorrow">SampleBorrow</a><Self::<a class="type" href="../../../rand/distributions/uniform/trait.UniformSampler.html#associatedtype.X" title="type rand::distributions::uniform::UniformSampler::X">X</a>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.new_inclusive' class='fnname'>new_inclusive</a><B1, B2>(low: B1, high: B2) -> Self<br> <span class="where">where<br> B1: <a class="trait" href="../../../rand/distributions/uniform/trait.SampleBorrow.html" title="trait rand::distributions::uniform::SampleBorrow">SampleBorrow</a><Self::<a class="type" href="../../../rand/distributions/uniform/trait.UniformSampler.html#associatedtype.X" title="type rand::distributions::uniform::UniformSampler::X">X</a>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,<br> B2: <a class="trait" href="../../../rand/distributions/uniform/trait.SampleBorrow.html" title="trait rand::distributions::uniform::SampleBorrow">SampleBorrow</a><Self::<a class="type" href="../../../rand/distributions/uniform/trait.UniformSampler.html#associatedtype.X" title="type rand::distributions::uniform::UniformSampler::X">X</a>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.sample' class='fnname'>sample</a><R: <a class="trait" href="../../../rand/trait.Rng.html" title="trait rand::Rng">Rng</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(&self, rng: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>R) -> Self::<a class="type" href="../../../rand/distributions/uniform/trait.UniformSampler.html#associatedtype.X" title="type rand::distributions::uniform::UniformSampler::X">X</a>;
|
|||
|
|
|
|||
|
|
fn <a href='#method.sample_single' class='fnname'>sample_single</a><R: <a class="trait" href="../../../rand/trait.Rng.html" title="trait rand::Rng">Rng</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, B1, B2>(<br> low: B1, <br> high: B2, <br> rng: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>R<br> ) -> Self::<a class="type" href="../../../rand/distributions/uniform/trait.UniformSampler.html#associatedtype.X" title="type rand::distributions::uniform::UniformSampler::X">X</a><br> <span class="where">where<br> B1: <a class="trait" href="../../../rand/distributions/uniform/trait.SampleBorrow.html" title="trait rand::distributions::uniform::SampleBorrow">SampleBorrow</a><Self::<a class="type" href="../../../rand/distributions/uniform/trait.UniformSampler.html#associatedtype.X" title="type rand::distributions::uniform::UniformSampler::X">X</a>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,<br> B2: <a class="trait" href="../../../rand/distributions/uniform/trait.SampleBorrow.html" title="trait rand::distributions::uniform::SampleBorrow">SampleBorrow</a><Self::<a class="type" href="../../../rand/distributions/uniform/trait.UniformSampler.html#associatedtype.X" title="type rand::distributions::uniform::UniformSampler::X">X</a>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span>,
|
|||
|
|
{ ... }
|
|||
|
|
}</pre></div><div class='docblock'><p>Helper trait handling actual uniform sampling.</p>
|
|||
|
|
<p>See the <a href="crate::distributions::uniform">module documentation</a> on how to implement [<code>Uniform</code>] range
|
|||
|
|
sampling for a custom type.</p>
|
|||
|
|
<p>Implementation of <a href="UniformSampler::sample_single"><code>sample_single</code></a> is optional, and is only useful when
|
|||
|
|
the implementation can be faster than <code>Self::new(low, high).sample(rng)</code>.</p>
|
|||
|
|
</div>
|
|||
|
|
<h2 id='associated-types' class='small-section-header'>Associated Types<a href='#associated-types' class='anchor'></a></h2><div class='methods'><h3 id='associatedtype.X' class='method'><code id='X.t'>type <a href='#associatedtype.X' class="type">X</a></code></h3><div class='docblock'><p>The type sampled by this implementation.</p>
|
|||
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|||
|
|
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.new' class='method'><code id='new.v'>fn <a href='#tymethod.new' class='fnname'>new</a><B1, B2>(low: B1, high: B2) -> Self <span class="where fmt-newline">where<br> B1: <a class="trait" href="../../../rand/distributions/uniform/trait.SampleBorrow.html" title="trait rand::distributions::uniform::SampleBorrow">SampleBorrow</a><Self::<a class="type" href="../../../rand/distributions/uniform/trait.UniformSampler.html#associatedtype.X" title="type rand::distributions::uniform::UniformSampler::X">X</a>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,<br> B2: <a class="trait" href="../../../rand/distributions/uniform/trait.SampleBorrow.html" title="trait rand::distributions::uniform::SampleBorrow">SampleBorrow</a><Self::<a class="type" href="../../../rand/distributions/uniform/trait.UniformSampler.html#associatedtype.X" title="type rand::distributions::uniform::UniformSampler::X">X</a>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></h3><div class='docblock'><p>Construct self, with inclusive lower bound and exclusive upper bound
|
|||
|
|
<code>[low, high)</code>.</p>
|
|||
|
|
<p>Usually users should not call this directly but instead use
|
|||
|
|
<code>Uniform::new</code>, which asserts that <code>low < high</code> before calling this.</p>
|
|||
|
|
</div><h3 id='tymethod.new_inclusive' class='method'><code id='new_inclusive.v'>fn <a href='#tymethod.new_inclusive' class='fnname'>new_inclusive</a><B1, B2>(low: B1, high: B2) -> Self <span class="where fmt-newline">where<br> B1: <a class="trait" href="../../../rand/distributions/uniform/trait.SampleBorrow.html" title="trait rand::distributions::uniform::SampleBorrow">SampleBorrow</a><Self::<a class="type" href="../../../rand/distributions/uniform/trait.UniformSampler.html#associatedtype.X" title="type rand::distributions::uniform::UniformSampler::X">X</a>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,<br> B2: <a class="trait" href="../../../rand/distributions/uniform/trait.SampleBorrow.html" title="trait rand::distributions::uniform::SampleBorrow">SampleBorrow</a><Self::<a class="type" href="../../../rand/distributions/uniform/trait.UniformSampler.html#associatedtype.X" title="type rand::distributions::uniform::UniformSampler::X">X</a>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></h3><div class='docblock'><p>Construct self, with inclusive bounds <code>[low, high]</code>.</p>
|
|||
|
|
<p>Usually users should not call this directly but instead use
|
|||
|
|
<code>Uniform::new_inclusive</code>, which asserts that <code>low <= high</code> before
|
|||
|
|
calling this.</p>
|
|||
|
|
</div><h3 id='tymethod.sample' class='method'><code id='sample.v'>fn <a href='#tymethod.sample' class='fnname'>sample</a><R: <a class="trait" href="../../../rand/trait.Rng.html" title="trait rand::Rng">Rng</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(&self, rng: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>R) -> Self::<a class="type" href="../../../rand/distributions/uniform/trait.UniformSampler.html#associatedtype.X" title="type rand::distributions::uniform::UniformSampler::X">X</a></code></h3><div class='docblock'><p>Sample a value.</p>
|
|||
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|||
|
|
<h2 id='provided-methods' class='small-section-header'>Provided methods<a href='#provided-methods' class='anchor'></a></h2><div class='methods'><h3 id='method.sample_single' class='method'><code id='sample_single.v'>fn <a href='#method.sample_single' class='fnname'>sample_single</a><R: <a class="trait" href="../../../rand/trait.Rng.html" title="trait rand::Rng">Rng</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, B1, B2>(<br> low: B1, <br> high: B2, <br> rng: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>R<br>) -> Self::<a class="type" href="../../../rand/distributions/uniform/trait.UniformSampler.html#associatedtype.X" title="type rand::distributions::uniform::UniformSampler::X">X</a> <span class="where fmt-newline">where<br> B1: <a class="trait" href="../../../rand/distributions/uniform/trait.SampleBorrow.html" title="trait rand::distributions::uniform::SampleBorrow">SampleBorrow</a><Self::<a class="type" href="../../../rand/distributions/uniform/trait.UniformSampler.html#associatedtype.X" title="type rand::distributions::uniform::UniformSampler::X">X</a>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,<br> B2: <a class="trait" href="../../../rand/distributions/uniform/trait.SampleBorrow.html" title="trait rand::distributions::uniform::SampleBorrow">SampleBorrow</a><Self::<a class="type" href="../../../rand/distributions/uniform/trait.UniformSampler.html#associatedtype.X" title="type rand::distributions::uniform::UniformSampler::X">X</a>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></h3><div class='docblock'><p>Sample a single value uniformly from a range with inclusive lower bound
|
|||
|
|
and exclusive upper bound <code>[low, high)</code>.</p>
|
|||
|
|
<p>By default this is implemented using
|
|||
|
|
<code>UniformSampler::new(low, high).sample(rng)</code>. However, for some types
|
|||
|
|
more optimal implementations for single usage may be provided via this
|
|||
|
|
method (which is the case for integers and floats).
|
|||
|
|
Results may not be identical.</p>
|
|||
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|||
|
|
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'><h3 id='impl-UniformSampler' class='impl'><code class='in-band'>impl UniformSampler for <a class="struct" href="../../../rand/distributions/uniform/struct.UniformDuration.html" title="struct rand::distributions::uniform::UniformDuration">UniformDuration</a></code><a href='#impl-UniformSampler' class='anchor'></a><a class='srclink' href='../../../src/rand/distributions/uniform.rs.html#839-928' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.X-1' class="type"><code id='X.t-1'>type <a href='#associatedtype.X-1' class="type">X</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a></code></h4><h4 id='method.new' class="method hidden"><code id='new.v-1'>fn <a href='#method.new' class='fnname'>new</a><B1, B2>(low_b: B1, high_b: B2) -> Self <span class="where fmt-newline">where<br> B1: <a class="trait" href="../../../rand/distributions/uniform/trait.SampleBorrow.html" title="trait rand::distributions::uniform::SampleBorrow">SampleBorrow</a><Self::<a class="type" href="../../../rand/distributions/uniform/trait.UniformSampler.html#associatedtype.X" title="type rand::distributions::uniform::UniformSampler::X">X</a>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,<br> B2: <a class="trait" href="../../../rand/distributions/uniform/trait.SampleBorrow.html" title="trait rand::distributions::uniform::SampleBorrow">SampleBorrow</a><Self::<a class="type" href="../../../rand/distributions/uniform/trait.UniformSampler.html#associatedtype.X" title="type rand::distributions::uniform::UniformSampler::X">X</a>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a class='srclink' href='../../../src/rand/distributions/uniform.rs.html#843-851' title='goto source code'>[src]</a></h4><h4 id='method.new_inclusive' class="method hidden"><code id='new_inclusive.v-1'>fn <a href='#method.new_inclusive' class='fnname'>new_inclusive</a><B1, B2>(low_b: B1, high_b: B2) -> Self <span class="where fmt-newline">where<br> B1: <a class="trait" href="../../../rand/distributions/uniform/trait.SampleBorrow.html" title="trait rand::distributions::uniform::SampleBorrow">SampleBorrow</a><Self::<a class="type" href="../../../rand/distributions/uniform/trait.UniformSampler.html#associatedtype.X" title="type rand::distributions::uniform::UniformSampler::X">X</a>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,<br> B2: <a class="trait" href="../../../rand/distributions/uniform/trait.SampleBorrow.html" title="trait rand::distributions::uniform::SampleBorrow">SampleBorrow</a><Self::<a class="type" href="../../../rand/distributions/uniform/trait.UniformSampler.html#associatedtype.X" title="type rand::distributions::uniform::UniformSampler::X">X</a>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a class='srclink' href='../../../src/rand/distributions/uniform.rs.html#854-901' title='goto source code'>[src]</a></h4><h4 id='method.sample' class="method hidden"><code id='sample.v-1'>fn <a href='#method.sample' class='fnname'>sample</a><R: <a class="trait" href="../../../rand/trait.Rng.html" title="trait rand::Rng">Rng</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(&self, rng: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </
|
|||
|
|
src="../../../implementors/rand/distributions/uniform/trait.UniformSampler.js">
|
|||
|
|
</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>⏎</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>
|