|
|
|
|
|
<!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 `SampleRange` trait in crate `rand`."><meta name="keywords" content="rust, rustlang, rust-lang, SampleRange"><title>rand::distributions::range::SampleRange - 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 SampleRange</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.construct_range">construct_range</a><a href="#tymethod.sample_range">sample_range</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-SampleRange-for-f32">f32</a><a href="#impl-SampleRange-for-f64">f64</a><a href="#impl-SampleRange-for-i16">i16</a><a href="#impl-SampleRange-for-i32">i32</a><a href="#impl-SampleRange-for-i64">i64</a><a href="#impl-SampleRange-for-i8">i8</a><a href="#impl-SampleRange-for-isize">isize</a><a href="#impl-SampleRange-for-u16">u16</a><a href="#impl-SampleRange-for-u32">u32</a><a href="#impl-SampleRange-for-u64">u64</a><a href="#impl-SampleRange-for-u8">u8</a><a href="#impl-SampleRange-for-usize">usize</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'>range</a></p><script>window.sidebarCurrent = {name: 'SampleRange', 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/range.rs.html#78-88' 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'>range</a>::<wbr><a class="trait" href=''>SampleRange</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait SampleRange: <a class="trait" href="https://doc.rust-lang.org/nightly/core/
|
|
|
|
|
|
fn <a href='#tymethod.construct_range' class='fnname'>construct_range</a>(low: Self, high: Self) -> <a class="struct" href="../../../rand/distributions/range/struct.Range.html" title="struct rand::distributions::range::Range">Range</a><Self>;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.sample_range' class='fnname'>sample_range</a><R: <a class="trait" href="../../../rand/trait.Rng.html" title="trait rand::Rng">Rng</a>>(r: &<a class="struct" href="../../../rand/distributions/range/struct.Range.html" title="struct rand::distributions::range::Range">Range</a><Self>, rng: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>R) -> Self;
|
|
|
|
|
|
}</pre></div><div class='docblock'><p>The helper trait for types that have a sensible way to sample
|
|
|
|
|
|
uniformly between two values. This should not be used directly,
|
|
|
|
|
|
and is only to facilitate <code>Range</code>.</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.construct_range' class='method'><code id='construct_range.v'>fn <a href='#tymethod.construct_range' class='fnname'>construct_range</a>(low: Self, high: Self) -> <a class="struct" href="../../../rand/distributions/range/struct.Range.html" title="struct rand::distributions::range::Range">Range</a><Self></code></h3><div class='docblock'><p>Construct the <code>Range</code> object that <code>sample_range</code>
|
|
|
|
|
|
requires. This should not ever be called directly, only via
|
|
|
|
|
|
<code>Range::new</code>, which will check that <code>low < high</code>, so this
|
|
|
|
|
|
function doesn't have to repeat the check.</p>
|
|
|
|
|
|
</div><h3 id='tymethod.sample_range' class='method'><code id='sample_range.v'>fn <a href='#tymethod.sample_range' class='fnname'>sample_range</a><R: <a class="trait" href="../../../rand/trait.Rng.html" title="trait rand::Rng">Rng</a>>(r: &<a class="struct" href="../../../rand/distributions/range/struct.Range.html" title="struct rand::distributions::range::Range">Range</a><Self>, rng: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>R) -> Self</code></h3><div class='docblock'><p>Sample a value from the given <code>Range</code> with the given <code>Rng</code> as
|
|
|
|
|
|
a source of randomness.</p>
|
|
|
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
|
|
|
<h2 id='foreign-impls' class='small-section-header'>Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a></h2><h3 id='impl-SampleRange-for-i8' class='impl'><code class='in-band'>impl <a class="trait" href="../../../rand/distributions/range/trait.SampleRange.html" title="trait rand::distributions::range::SampleRange">SampleRange</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a></code><a href='#impl-SampleRange-for-i8' class='anchor'></a><a class='srclink' href='../../../src/rand/distributions/range.rs.html#92-131' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.construct_range' class="method hidden"><code id='construct_range.v-1'>fn <a href='#method.construct_range' class='fnname'>construct_range</a>(low: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a>, high: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a>) -> <a class="struct" href="../../../rand/distributions/range/struct.Range.html" title="struct rand::distributions::range::Range">Range</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a>></code><a class='srclink' href='../../../src/rand/distributions/range.rs.html#100-115' title='goto source code'>[src]</a></h4><h4 id='method.sample_range' class="method hidden"><code id='sample_range.v-1'>fn <a href='#method.sample_range' class='fnname'>sample_range</a><R: <a class="trait" href="../../../rand/trait.Rng.html" title="trait rand::Rng">Rng</a>>(r: &<a class="struct" href="../../../rand/distributions/range/struct.Range.html" title="struct rand::distributions::range::Range">Range</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a>>, rng: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>R) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a></code><a class='srclink' href='../../../src/rand/distributions/range.rs.html#118-130' title='goto source code'>[src]</a></h4></div><h3 id='impl-SampleRange-for-i16' class='impl'><code class='in-band'>impl <a class="trait" href="../../../rand/distributions/range/trait.SampleRange.html" title="trait rand::distributions::range::SampleRange">SampleRange</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a></code><a href='#impl-SampleRange-for-i16' class='anchor'></a><a class='srclink' href='../../../src/rand/distributions/range.rs.html#92-131' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.construct_range-1' class="method hidden"><code id='construct_range.v-2'>fn <a href='#method.construct_range' class='fnname'>construct_range</a>(low: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a>, high: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a>) -> <a class="struct" href="../../../rand/distributions/range/struct.Range.html" title="struct rand::distributions::range::Range">Range</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a>></code><a class='srclink' href='../../../src/rand/distributions/range.rs.html#100-115' title='goto source code'>[src]</a></h4><h4 id='method.sample_range-1' class="method hidden"><code id='sample_range.v-2'>fn <a href='#method.sample_range' class='fnname'>sample_range</a><R: <a class="trait" href="../../../rand/trait.Rng.html" title="trait rand::Rng">Rng</a>>(r: &<a class="struct" href="../../../rand/distributions/range/struct.Range.html" title="struct rand::distributions::range::Range">Range</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a>>, rng: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>R) -> <a class="primitive" hre
|
|
|
|
|
|
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
|
|
|
|
|
src="../../../implementors/rand/distributions/range/trait.SampleRange.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>
|
