154 lines
11 KiB
HTML
154 lines
11 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 `Sample` trait in crate `rand`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, Sample">
|
|||
|
|
|
|||
|
|
<title>rand::distributions::Sample - 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="../../main.css" id="themeStyle">
|
|||
|
|
<script src="../../storage.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="shortcut icon" href="https://www.rust-lang.org/favicon.ico">
|
|||
|
|
|
|||
|
|
</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'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk.png' alt='logo' width='100'></a>
|
|||
|
|
<p class='location'>Trait Sample</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.sample">sample</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></p><script>window.sidebarCurrent = {name: 'Sample', 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">
|
|||
|
|
<input class="search-input" name="search"
|
|||
|
|
autocomplete="off"
|
|||
|
|
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
|||
|
|
type="search">
|
|||
|
|
</div>
|
|||
|
|
</form>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<section id='main' class="content">
|
|||
|
|
<h1 class='fqn'><span class='in-band'>Trait <a href='../index.html'>rand</a>::<wbr><a href='index.html'>distributions</a>::<wbr><a class="trait" href=''>Sample</a></span><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/mod.rs.html#44-48' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<pre class='rust trait'>pub trait Sample<Support> {
|
|||
|
|
fn <a href='#tymethod.sample' class='fnname'>sample</a><R>(&mut self, rng: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>R) -> Support<br> <span class="where">where<br> R: <a class="trait" href="../../rand/trait.Rng.html" title="trait rand::Rng">Rng</a></span>;
|
|||
|
|
}</pre><div class='docblock'><p>Types that can be used to create a random instance of <code>Support</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.sample' class='method'><span id='sample.v' class='invisible'><code>fn <a href='#tymethod.sample' class='fnname'>sample</a><R>(&mut self, rng: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>R) -> Support <span class="where fmt-newline">where<br> R: <a class="trait" href="../../rand/trait.Rng.html" title="trait rand::Rng">Rng</a>, </span></code></span></h3><div class='docblock'><p>Generate a random value of <code>Support</code>, using <code>rng</code> as the
|
|||
|
|
source of randomness.</p>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='implementors' class='small-section-header'>
|
|||
|
|
Implementors<a href='#implementors' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<ul class='item-list' id='implementors-list'>
|
|||
|
|
<li><div class='out-of-band'><a class='srclink' href='../../src/rand/distributions/range.rs.html#65-68' title='goto source code'>[src]</a></div><code>impl<Sup> Sample<Sup> for <a class="struct" href="../../rand/distributions/range/struct.Range.html" title="struct rand::distributions::range::Range">Range</a><Sup> <span class="where fmt-newline">where<br> Sup: <a class="trait" href="../../rand/distributions/range/trait.SampleRange.html" title="trait rand::distributions::range::SampleRange">SampleRange</a>, </span></code></li>
|
|||
|
|
<li><div class='out-of-band'><a class='srclink' href='../../src/rand/distributions/gamma.rs.html#281-283' title='goto source code'>[src]</a></div><code>impl Sample<<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>> for <a class="struct" href="../../rand/distributions/gamma/struct.FisherF.html" title="struct rand::distributions::gamma::FisherF">FisherF</a></code></li>
|
|||
|
|
<li><div class='out-of-band'><a class='srclink' href='../../src/rand/distributions/mod.rs.html#168-170' title='goto source code'>[src]</a></div><code>impl<'a, T> Sample<T> for <a class="struct" href="../../rand/distributions/struct.WeightedChoice.html" title="struct rand::distributions::WeightedChoice">WeightedChoice</a><'a, T> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span></code></li>
|
|||
|
|
<li><div class='out-of-band'><a class='srclink' href='../../src/rand/distributions/gamma.rs.html#319-321' title='goto source code'>[src]</a></div><code>impl Sample<<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>> for <a class="struct" href="../../rand/distributions/gamma/struct.StudentT.html" title="struct rand::distributions::gamma::StudentT">StudentT</a></code></li>
|
|||
|
|
<li><div class='out-of-band'><a class='srclink' href='../../src/rand/distributions/gamma.rs.html#136-138' title='goto source code'>[src]</a></div><code>impl Sample<<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>> for <a class="struct" href="../../rand/distributions/gamma/struct.Gamma.html" title="struct rand::distributions::gamma::Gamma">Gamma</a></code></li>
|
|||
|
|
<li><div class='out-of-band'><a class='srclink' href='../../src/rand/distributions/mod.rs.html#75-77' title='goto source code'>[src]</a></div><code>impl<Sup> Sample<Sup> for <a class="struct" href="../../rand/distributions/struct.RandSample.html" title="struct rand::distributions::RandSample">RandSample</a><Sup> <span class="where fmt-newline">where<br> Sup: <a class="trait" href="../../rand/trait.Rand.html" title="trait rand::Rand">Rand</a>, </span></code></li>
|
|||
|
|
<li><div class='out-of-band'><a class='srclink' href='../../src/rand/distributions/normal.rs.html#113-115' title='goto source code'>[src]</a></div><code>impl Sample<<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>> for <a class="struct" href="../../rand/distributions/normal/struct.Normal.html" title="struct rand::distributions::normal::Normal">Normal</a></code></li>
|
|||
|
|
<li><div class='out-of-band'><a class='srclink' href='../../src/rand/distributions/exponential.rs.html#90-92' title='goto source code'>[src]</a></div><code>impl Sample<<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>> for <a class="struct" href="../../rand/distributions/exponential/struct.Exp.html" title="struct rand::distributions::exponential::Exp">Exp</a></code></li>
|
|||
|
|
<li><div class='out-of-band'><a class='srclink' href='../../src/rand/distributions/normal.rs.html#157-159' title='goto source code'>[src]</a></div><code>impl Sample<<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>> for <a class="struct" href="../../rand/distributions/normal/struct.LogNormal.html" title="struct rand::distributions::normal::LogNormal">LogNormal</a></code></li>
|
|||
|
|
<li><div class='out-of-band'><a class='srclink' href='../../src/rand/distributions/gamma.rs.html#227-229' title='goto source code'>[src]</a></div><code>impl Sample<<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>> for <a class="struct" href="../../rand/distributions/gamma/struct.ChiSquared.html" title="struct rand::distributions::gamma::ChiSquared">ChiSquared</a></code></li>
|
|||
|
|
</ul><script type="text/javascript" async
|
|||
|
|
src="../../implementors/rand/distributions/trait.Sample.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>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</aside>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script>
|
|||
|
|
window.rootPath = "../../";
|
|||
|
|
window.currentCrate = "rand";
|
|||
|
|
</script>
|
|||
|
|
<script src="../../main.js"></script>
|
|||
|
|
<script defer src="../../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|