<!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 `WeightedChoice` struct in crate `rand`.">
<meta name="keywords" content="rust, rustlang, rust-lang, WeightedChoice">
<title>rand::distributions::WeightedChoice - 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 struct">
<!--[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'>Struct WeightedChoice</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Sample%3CT%3E">Sample<T></a><a href="#impl-IndependentSample%3CT%3E">IndependentSample<T></a></div></div><p class='location'><a href='../index.html'>rand</a>::<wbr><a href='index.html'>distributions</a></p><script>window.sidebarCurrent = {name: 'WeightedChoice', ty: 'struct', 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'>Struct <a href='../index.html'>rand</a>::<wbr><a href='index.html'>distributions</a>::<wbr><a class="struct" href=''>WeightedChoice</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#126-129' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct WeightedChoice<'a, T: 'a> { /* fields omitted */ }</pre><div class='docblock'><p>A distribution that selects from a finite collection of weighted items.</p>
<p>Each item has an associated weight that influences how likely it
is to be chosen: higher weight is more likely.</p>
<p>The <code>Clone</code> restriction is a limitation of the <code>Sample</code> and
<code>IndependentSample</code> traits. Note that <code>&T</code> is (cheaply) <code>Clone</code> for
all <code>T</code>, as is <code>u32</code>, so one can store references or indices into
another vector.</p>
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">rand</span>::<span class="ident">distributions</span>::{<span class="ident">Weighted</span>, <span class="ident">WeightedChoice</span>, <span class="ident">IndependentSample</span>};
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">items</span> <span class="op">=</span> <span class="macro">vec</span><span class="macro">!</span>(<span class="ident">Weighted</span> { <span class="ident">weight</span>: <span class="number">2</span>, <span class="ident">item</span>: <span class="string">'a'</span> },
<span class="ident">Weighted</span> { <span class="ident">weight</span>: <span class="number">4</span>, <span class="ident">item</span>: <span class="string">'b'</span> },
<span class="ident">Weighted</span> { <span class="ident">weight</span>: <span class="number">1</span>, <span class="ident">item</span>: <span class="string">'c'</span> });
<span class="kw">let</span> <span class="ident">wc</span> <span class="op">=</span> <span class="ident">WeightedChoice</span>::<span class="ident">new</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">items</span>);
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">rng</span> <span class="op">=</span> <span class="ident">rand</span>::<span class="ident">thread_rng</span>();
<span class="kw">for</span> _ <span class="kw">in</span> <span class="number">0</span>..<span class="number">16</span> {
<span class="comment">// on average prints 'a' 4 times, 'b' 8 and 'c' twice.</span>
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"{}"</span>, <span class="ident">wc</span>.<span class="ident">ind_sample</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">rng</span>));
}</pre>
</div>
<h2 id='methods' class='small-section-header'>
Methods<a href='#methods' class='anchor'></a>
</h2>
<h3 id='impl' class='impl'><span class='in-band'><code>impl<'a, T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>> <a class="struct" href="../../rand/distributions/struct.WeightedChoice.html" title="struct rand::distributions::WeightedChoice">WeightedChoice</a><'a, T></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/distributions/mod.rs.html#131-166' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>pub fn <a href='#method.new' class='fnname'>new</a>(items: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a mut [</a><a class="struct" href="../../rand/distributions/struct.Weighted.html" title="struct rand::distributions::Weighted">Weighted</a><T><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="struct" href="../../rand/distributions/struct.WeightedChoice.html" title="struct rand::distributions::WeightedChoice">WeightedChoice</a><'a, T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/distributions/mod.rs.html#139-165' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Create a new <code>WeightedChoice</code>.</p>
<p>Panics if:</p>
<ul>
<li><code>items</code> is empty</li>
<li>the total weight is 0</li>
<li>the total weight is larger than a <code>u32</code> can contain.</li>
</ul>
</div></div>
<h2 id='implementations' class='small-section-header'>
Trait Implementations<a href='#implementations' class='anchor'></a>
</h2>
<h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl<'a, T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + 'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../rand/distributions/struct.WeightedChoice.html" title="struct rand::distributions::WeightedChoice">WeightedChoice</a><'a, T></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/distributions/mod.rs.html#125' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, __arg_0: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/distributions/mod.rs.html#125' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></div><h3 id='impl-Sample%3CT%3E' class='impl'><span class='in-band'><code>impl<'a, T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>> <a class="trait" href="../../rand/distributions/trait.Sample.html" title="trait rand::distributions::Sample">Sample</a><T> for <a class="struct" href="../../rand/distributions/struct.WeightedChoice.html" title="struct rand::distributions::WeightedChoice">WeightedChoice</a><'a, T></code><a href='#impl-Sample%3CT%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/distributions/mod.rs.html#168-170' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.sample' class="method"><span id='sample.v' class='invisible'><code>fn <a href='../../rand/distributions/trait.Sample.html#tymethod.sample' class='fnname'>sample</a><R: <a class="trait" href="../../rand/trait.Rng.html" title="trait rand::Rng">Rng</a>>(&mut self, rng: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>R) -> T</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/distributions/mod.rs.html#169' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Generate a random value of <code>Support</code>, using <code>rng</code> as the source of randomness. <a href="../../rand/distributions/trait.Sample.html#tymethod.sample">Read more</a></p>
</div></div><h3 id='impl-IndependentSample%3CT%3E' class='impl'><span class='in-band'><code>impl<'a, T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>> <a class="trait" href="../../rand/distributions/trait.IndependentSample.html" title="trait rand::distributions::IndependentSample">IndependentSample</a><T> for <a class="struct" href="../../rand/distributions/struct.WeightedChoice.html" title="struct rand::distributions::WeightedChoice">WeightedChoice</a><'a, T></code><a href='#impl-IndependentSample%3CT%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/distributions/mod.rs.html#172-213' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.ind_sample' class="method"><span id='ind_sample.v' class='invisible'><code>fn <a href='../../rand/distributions/trait.IndependentSample.html#tymethod.ind_sample' class='fnname'>ind_sample</a><R: <a class="trait" href="../../rand/trait.Rng.html" title="trait rand::Rng">Rng</a>>(&self, rng: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>R) -> T</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/distributions/mod.rs.html#173-212' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Generate a random value.</p>
</div></div></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>