owoify/target/doc/rand/distributions/uniform/trait.SampleUniform.html

13 lines
21 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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><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">&#9776;</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 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-for-Duration">Duration</a><a href="#impl-SampleUniform-for-f32">f32</a><a href="#impl-SampleUniform-for-f64">f64</a><a href="#impl-SampleUniform-for-i128">i128</a><a href="#impl-SampleUniform-for-i16">i16</a><a href="#impl-SampleUniform-for-i32">i32</a><a href="#impl-SampleUniform-for-i64">i64</a><a href="#impl-SampleUniform-for-i8">i8</a><a href="#impl-SampleUniform-for-isize">isize</a><a href="#impl-SampleUniform-for-u128">u128</a><a href="#impl-SampleUniform-for-u16">u16</a><a href="#impl-SampleUniform-for-u32">u32</a><a href="#impl-SampleUniform-for-u64">u64</a><a href="#impl-SampleUniform-for-u8">u8</a><a href="#impl-SampleUniform-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'>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"><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'>&#x2212;</span>]</a></span><a class='srclink' href='../../../src/rand/distributions/uniform.rs.html#206-209' 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=''>SampleUniform</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><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> {
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;;
}</pre></div><div class='docblock'><p>Helper trait for creating objects using the correct implementation of
[<code>UniformSampler</code>] for the sampling type.</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>
</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.Sampler' class='method'><code id='Sampler.t'>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></h3><div class='docblock'><p>The <code>UniformSampler</code> implementation supporting type <code>X</code>.</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-SampleUniform-for-i8' class='impl'><code class='in-band'>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-for-i8' class='anchor'></a><a class='srclink' href='../../../src/rand/distributions/uniform.rs.html#344-346' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Sampler-1' class="type"><code id='Sampler.t-1'>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></h4></div><h3 id='impl-SampleUniform-for-i16' class='impl'><code class='in-band'>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-for-i16' class='anchor'></a><a class='srclink' href='../../../src/rand/distributions/uniform.rs.html#344-346' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Sampler-2' class="type"><code id='Sampler.t-2'>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></h4></div><h3 id='impl-SampleUniform-for-i32' class='impl'><code class='in-band'>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-for-i32' class='anchor'></a><a class='srclink' href='../../../src/rand/distributions/uniform.rs.html#344-346' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Sampler-3' class="type"><code id='Sampler.t-3'>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></h4></div><h3 id='impl-SampleUniform-for-i64' class='impl'><code class='in-band'>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-for-i64' class='anchor'></a><a class='srclink' href='../../../src/rand/distributions/uniform.rs.html#344-346' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Sampler-4' class="type"><code id='Sampler.t-4'>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></h4></div><h3 id='impl-SampleUniform-for-i128' class='impl'><code class='in-band'>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.i128.html">i128</a></code><a href='#impl-SampleUniform-for-i128' class='anchor'></a><a class='srclink' href='../../../src/rand/distributions/uniform.rs.html#344-346' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Sampler-5' class="type"><code id='Sampler.t-5'>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.i128.html">i128</a>&gt;</code></h4></div><h3 id='impl-SampleUniform-for-isize' class='impl'><code class='in-band'>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-for-isize' class='anchor'></a><a class='srclink' href='../../../src/rand/distributions/uniform.rs.html#344-346' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Sampler-6' class="type"><code id='Sampler.t-6'>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></h4></div><h3 id='impl-SampleUniform-for-u8' class='impl'><code class='in-band'>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-for-u8' class='anchor'></a><a class='srclink' href='../../../src/rand/distributions/uniform.rs.html#344-346' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Sampler-7' class="type"><code id='Sampler.t-7'>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></h4></div><h3 id='impl-SampleUniform-for-u16' class='impl'><code class='in-band'>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-for-u16' class='anchor'></a><a class='srclink' href='../../../src/rand/distributions/uniform.rs.html#344-346' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Sampler-8' class="type"><code id='Sampler.t-8'>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></h4></div><h3 id='impl-SampleUniform-for-u32' class='impl'><code class='in-band'>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-for-u32' class='anchor'></a><a class='srclink' href='../../../src/rand/distributions/uniform.rs.html#344-346' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Sampler-9' class="type"><code id='Sampler.t-9'>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></h4></div><h3 id='impl-SampleUniform-for-u64' class='impl'><code class='in-band'>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-for-u64' class='anchor'></a><a class='srclink' href='../../../src/rand/distributions/uniform.rs.html#344-346' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Sampler-10' class="type"><code id='Sampler.t-10'>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></h4></div><h3 id='impl-SampleUniform-for-usize' class='impl'><code class='in-band'>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-for-usize' class='anchor'></a><a class='srclink' href='../../../src/rand/distributions/uniform.rs.html#344-346' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Sampler-11' class="type"><code id='Sampler.t-11'>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></h4></div><h3 id='impl-SampleUniform-for-u128' class='impl'><code class='in-band'>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.u128.html">u128</a></code><a href='#impl-SampleUniform-for-u128' class='anchor'></a><a class='srclink' href='../../../src/rand/distributions/uniform.rs.html#344-346' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Sampler-12' class="type"><code id='Sampler.t-12'>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.u128.html">u128</a>&gt;</code></h4></div><h3 id='impl-SampleUniform-for-f32' class='impl'><code class='in-band'>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-for-f32' class='anchor'></a><a class='srclink' href='../../../src/rand/distributions/uniform.rs.html#639-641' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Sampler-13' class="type"><code id='Sampler.t-13'>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></h4></div><h3 id='impl-SampleUniform-for-f64' class='impl'><code class='in-band'>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-for-f64' class='anchor'></a><a class='srclink' href='../../../src/rand/distributions/uniform.rs.html#639-641' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Sampler-14' class="type"><code id='Sampler.t-14'>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></h4></div><h3 id='impl-SampleUniform-for-Duration' class='impl'><code class='in-band'>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-for-Duration' class='anchor'></a><a class='srclink' href='../../../src/rand/distributions/uniform.rs.html#835-837' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Sampler-15' class="type"><code id='Sampler.t-15'>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></h4></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'></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/uniform/trait.SampleUniform.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>&#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>