| <!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_distr::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" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="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="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../rand_distr/index.html"><div class="logo-container"><img src="https://www.rust-lang.org/logos/rust-logo-128x128-blk.png" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rand_distr/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"><a href="#">SampleRange</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.is_empty">is_empty</a></li><li><a href="#tymethod.sample_single">sample_single</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-SampleRange%3CT%3E-for-Range%3CT%3E">Range<T></a></li><li><a href="#impl-SampleRange%3CT%3E-for-RangeInclusive%3CT%3E">RangeInclusive<T></a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In rand_distr::uniform</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Trait <a href="../index.html">rand_distr</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></h1><span class="out-of-band"><a class="srclink" href="../../src/rand/distributions/uniform.rs.html#349">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust trait"><code>pub trait SampleRange<T> { |
| fn <a href="#tymethod.sample_single" class="fnname">sample_single</a><R>(self, rng: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>R) -> T<br> <span class="where">where<br> R: <a class="trait" href="../../rand_core/trait.RngCore.html" title="trait rand_core::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></span>; |
| <span class="item-spacer"></span> 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 method-toggle" open><summary><section id="tymethod.sample_single" class="method has-srclink"><a class="srclink rightside" href="../../src/rand/distributions/uniform.rs.html#351">source</a><h4 class="code-header">fn <a href="#tymethod.sample_single" class="fnname">sample_single</a><R>(self, rng: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>R) -> T<span class="where fmt-newline">where<br> R: <a class="trait" href="../../rand_core/trait.RngCore.html" title="trait rand_core::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>,</span></h4></section></summary><div class="docblock"><p>Generate a sample from the given range.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.is_empty" class="method has-srclink"><a class="srclink rightside" href="../../src/rand/distributions/uniform.rs.html#354">source</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></section></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><section id="impl-SampleRange%3CT%3E-for-RangeInclusive%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/rand/distributions/uniform.rs.html#369">source</a><a href="#impl-SampleRange%3CT%3E-for-RangeInclusive%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="trait.SampleRange.html" title="trait rand_distr::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><span class="where fmt-newline">where<br> T: <a class="trait" href="trait.SampleUniform.html" title="trait rand_distr::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><T>,</span></h3></section></summary><div class="impl-items"><section id="method.sample_single" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/rand/distributions/uniform.rs.html#371">source</a><a href="#method.sample_single" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.sample_single" class="fnname">sample_single</a><R>(self, rng: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>R) -> T<span class="where fmt-newline">where<br> R: <a class="trait" href="../../rand_core/trait.RngCore.html" title="trait rand_core::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>,</span></h4></section><section id="method.is_empty" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/rand/distributions/uniform.rs.html#376">source</a><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></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-SampleRange%3CT%3E-for-Range%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/rand/distributions/uniform.rs.html#357">source</a><a href="#impl-SampleRange%3CT%3E-for-Range%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="trait.SampleRange.html" title="trait rand_distr::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><span class="where fmt-newline">where<br> T: <a class="trait" href="trait.SampleUniform.html" title="trait rand_distr::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><T>,</span></h3></section></summary><div class="impl-items"><section id="method.sample_single-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/rand/distributions/uniform.rs.html#359">source</a><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>(self, rng: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>R) -> T<span class="where fmt-newline">where<br> R: <a class="trait" href="../../rand_core/trait.RngCore.html" title="trait rand_core::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>,</span></h4></section><section id="method.is_empty-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/rand/distributions/uniform.rs.html#364">source</a><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></section></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"></div><script src="../../implementors/rand/distributions/uniform/trait.SampleRange.js" data-ignore-extern-crates="core" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rand_distr" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
