| <!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="Range that supports generating a single sample efficiently."><meta name="keywords" content="rust, rustlang, rust-lang, SampleRange"><title>SampleRange in rand::distributions::uniform - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><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="../../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script src="../../../crates.js"></script><script defer src="../../../main.js"></script> |
| <noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="shortcut icon" href="https://www.rust-lang.org/favicon.ico"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a class="sidebar-logo" 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><h2 class="location">Trait SampleRange</h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><div class="sidebar-links"><a href="#tymethod.is_empty">is_empty</a><a href="#tymethod.sample_single">sample_single</a></div><h3 class="sidebar-title"><a href="#foreign-impls">Implementations on Foreign Types</a></h3><div class="sidebar-links"><a href="#impl-SampleRange%3CT%3E-for-Range%3CT%3E">Range<T></a><a href="#impl-SampleRange%3CT%3E-for-RangeInclusive%3CT%3E">RangeInclusive<T></a></div><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div><h2 class="location">Other items in<br><a href="../../index.html">rand</a>::<wbr><a href="../index.html">distributions</a>::<wbr><a href="index.html">uniform</a></h2><div id="sidebar-vars" data-name="SampleRange" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../../rand/index.html"><img src="https://www.rust-lang.org/logos/rust-logo-128x128-blk.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><div> |
| <input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../../../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"> |
| <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="#">SampleRange</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"> |
| <a class="srclink" href="../../../src/rand/distributions/uniform.rs.html#349-355" title="goto source code">source</a> · |
| <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div> |
| <div class="docblock item-decl"><pre class="rust trait"><code>pub trait SampleRange<T> { |
| fn <a href="#tymethod.sample_single" class="fnname">sample_single</a><R: <a class="trait" href="../../trait.RngCore.html" title="trait rand::RngCore">RngCore</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) -> T; |
| <div class="item-spacer"></div> fn <a href="#tymethod.is_empty" class="fnname">is_empty</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>; |
| }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Range that supports generating a single sample efficiently.</p> |
| <p>Any type implementing this trait can be used to specify the sampled range |
| for <code>Rng::gen_range</code>.</p> |
| </div></details><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="tymethod.sample_single" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/rand/distributions/uniform.rs.html#351" title="goto source code">source</a></div><h4 class="code-header">fn <a href="#tymethod.sample_single" class="fnname">sample_single</a><R: <a class="trait" href="../../trait.RngCore.html" title="trait rand::RngCore">RngCore</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) -> T</h4></div></summary><div class="docblock"><p>Generate a sample from the given range.</p> |
| </div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.is_empty" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/rand/distributions/uniform.rs.html#354" title="goto source code">source</a></div><h4 class="code-header">fn <a href="#tymethod.is_empty" class="fnname">is_empty</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class="docblock"><p>Check whether the range is empty.</p> |
| </div></details></div><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-SampleRange%3CT%3E-for-Range%3CT%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/rand/distributions/uniform.rs.html#357-367" title="goto source code">source</a></div><a href="#impl-SampleRange%3CT%3E-for-Range%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T: <a class="trait" href="trait.SampleUniform.html" title="trait rand::distributions::uniform::SampleUniform">SampleUniform</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a>> <a class="trait" href="trait.SampleRange.html" title="trait rand::distributions::uniform::SampleRange">SampleRange</a><T> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/ops/range/struct.Range.html" title="struct core::ops::range::Range">Range</a><T></h3></div></summary><div class="impl-items"><div id="method.sample_single" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/rand/distributions/uniform.rs.html#359-361" title="goto source code">source</a></div><a href="#method.sample_single" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.sample_single" class="fnname">sample_single</a><R: <a class="trait" href="../../trait.RngCore.html" title="trait rand::RngCore">RngCore</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) -> T</h4></div><div id="method.is_empty" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/rand/distributions/uniform.rs.html#364-366" title="goto source code">source</a></div><a href="#method.is_empty" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.is_empty" class="fnname">is_empty</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></div></details><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-SampleRange%3CT%3E-for-RangeInclusive%3CT%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/rand/distributions/uniform.rs.html#369-379" title="goto source code">source</a></div><a href="#impl-SampleRange%3CT%3E-for-RangeInclusive%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T: <a class="trait" href="trait.SampleUniform.html" title="trait rand::distributions::uniform::SampleUniform">SampleUniform</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a>> <a class="trait" href="trait.SampleRange.html" title="trait rand::distributions::uniform::SampleRange">SampleRange</a><T> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/ops/range/struct.RangeInclusive.html" title="struct core::ops::range::RangeInclusive">RangeInclusive</a><T></h3></div></summary><div class="impl-items"><div id="method.sample_single-1" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/rand/distributions/uniform.rs.html#371-373" title="goto source code">source</a></div><a href="#method.sample_single-1" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.sample_single" class="fnname">sample_single</a><R: <a class="trait" href="../../trait.RngCore.html" title="trait rand::RngCore">RngCore</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) -> T</h4></div><div id="method.is_empty-1" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/rand/distributions/uniform.rs.html#376-378" title="goto source code">source</a></div><a href="#method.is_empty-1" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.is_empty" class="fnname">is_empty</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"></div><script type="text/javascript" src="../../../implementors/rand/distributions/uniform/trait.SampleRange.js" async></script></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="rand" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.60.0-nightly (1bd4fdc94 2022-01-12)" ></div> |
| </body></html> |
