| <!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="A distribution using weighted sampling of discrete items"><meta name="keywords" content="rust, rustlang, rust-lang, WeightedIndex"><title>WeightedIndex in rand::distributions::weighted - 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 struct"><!--[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/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/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="#">WeightedIndex</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.new">new</a></li><li><a href="#method.update_weights">update_weights</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Clone-for-WeightedIndex%3CX%3E">Clone</a></li><li><a href="#impl-Debug-for-WeightedIndex%3CX%3E">Debug</a></li><li><a href="#impl-Distribution%3Cusize%3E-for-WeightedIndex%3CX%3E">Distribution<usize></a></li><li><a href="#impl-PartialEq%3CWeightedIndex%3CX%3E%3E-for-WeightedIndex%3CX%3E">PartialEq<WeightedIndex<X>></a></li><li><a href="#impl-StructuralPartialEq-for-WeightedIndex%3CX%3E">StructuralPartialEq</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-WeightedIndex%3CX%3E">RefUnwindSafe</a></li><li><a href="#impl-Send-for-WeightedIndex%3CX%3E">Send</a></li><li><a href="#impl-Sync-for-WeightedIndex%3CX%3E">Sync</a></li><li><a href="#impl-Unpin-for-WeightedIndex%3CX%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-WeightedIndex%3CX%3E">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-WeightedIndex%3CX%3E">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-WeightedIndex%3CX%3E">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-WeightedIndex%3CX%3E">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-WeightedIndex%3CX%3E">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-WeightedIndex%3CX%3E">Into<U></a></li><li><a href="#impl-ToOwned-for-WeightedIndex%3CX%3E">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-WeightedIndex%3CX%3E">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-WeightedIndex%3CX%3E">TryInto<U></a></li><li><a href="#impl-VZip%3CV%3E-for-WeightedIndex%3CX%3E">VZip<V></a></li></ul></section><h2><a href="index.html">In rand::distributions::weighted</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">Struct <a href="../../index.html">rand</a>::<wbr><a href="../index.html">distributions</a>::<wbr><a href="index.html">weighted</a>::<wbr><a class="struct" href="#">WeightedIndex</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/weighted_index.rs.html#81-85">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 struct"><code>pub struct WeightedIndex<X: <a class="trait" href="../uniform/trait.SampleUniform.html" title="trait rand::distributions::uniform::SampleUniform">SampleUniform</a> + PartialOrd> { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A distribution using weighted sampling of discrete items</p> |
| <p>Sampling a <code>WeightedIndex</code> distribution returns the index of a randomly |
| selected element from the iterator used when the <code>WeightedIndex</code> was |
| created. The chance of a given element being picked is proportional to the |
| value of the element. The weights can use any type <code>X</code> for which an |
| implementation of <a href="../struct.Uniform.html"><code>Uniform<X></code></a> exists.</p> |
| <h2 id="performance"><a href="#performance">Performance</a></h2> |
| <p>Time complexity of sampling from <code>WeightedIndex</code> is <code>O(log N)</code> where |
| <code>N</code> is the number of weights. As an alternative, |
| <a href="https://docs.rs/rand_distr/*/rand_distr/weighted_alias/index.html"><code>rand_distr::weighted_alias</code></a> |
| supports <code>O(1)</code> sampling, but with much higher initialisation cost.</p> |
| <p>A <code>WeightedIndex<X></code> contains a <code>Vec<X></code> and a <a href="../struct.Uniform.html"><code>Uniform<X></code></a> and so its |
| size is the sum of the size of those objects, possibly plus some alignment.</p> |
| <p>Creating a <code>WeightedIndex<X></code> will allocate enough space to hold <code>N - 1</code> |
| weights of type <code>X</code>, where <code>N</code> is the number of weights. However, since |
| <code>Vec</code> doesn’t guarantee a particular growth strategy, additional memory |
| might be allocated but not used. Since the <code>WeightedIndex</code> object also |
| contains, this might cause additional allocations, though for primitive |
| types, <a href="../struct.Uniform.html"><code>Uniform<X></code></a> doesn’t allocate any memory.</p> |
| <p>Sampling from <code>WeightedIndex</code> will result in a single call to |
| <code>Uniform<X>::sample</code> (method of the <a href="../trait.Distribution.html" title="Distribution"><code>Distribution</code></a> trait), which typically |
| will request a single value from the underlying <a href="../../trait.RngCore.html"><code>RngCore</code></a>, though the |
| exact number depends on the implementation of <code>Uniform<X>::sample</code>.</p> |
| <h2 id="example"><a href="#example">Example</a></h2> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>rand::prelude::<span class="kw-2">*</span>; |
| <span class="kw">use </span>rand::distributions::WeightedIndex; |
| |
| <span class="kw">let </span>choices = [<span class="string">'a'</span>, <span class="string">'b'</span>, <span class="string">'c'</span>]; |
| <span class="kw">let </span>weights = [<span class="number">2</span>, <span class="number">1</span>, <span class="number">1</span>]; |
| <span class="kw">let </span>dist = WeightedIndex::new(<span class="kw-2">&</span>weights).unwrap(); |
| <span class="kw">let </span><span class="kw-2">mut </span>rng = thread_rng(); |
| <span class="kw">for _ in </span><span class="number">0</span>..<span class="number">100 </span>{ |
| <span class="comment">// 50% chance to print 'a', 25% chance to print 'b', 25% chance to print 'c' |
| </span><span class="macro">println!</span>(<span class="string">"{}"</span>, choices[dist.sample(<span class="kw-2">&mut </span>rng)]); |
| } |
| |
| <span class="kw">let </span>items = [(<span class="string">'a'</span>, <span class="number">0</span>), (<span class="string">'b'</span>, <span class="number">3</span>), (<span class="string">'c'</span>, <span class="number">7</span>)]; |
| <span class="kw">let </span>dist2 = WeightedIndex::new(items.iter().map(|item| item.<span class="number">1</span>)).unwrap(); |
| <span class="kw">for _ in </span><span class="number">0</span>..<span class="number">100 </span>{ |
| <span class="comment">// 0% chance to print 'a', 30% chance to print 'b', 70% chance to print 'c' |
| </span><span class="macro">println!</span>(<span class="string">"{}"</span>, items[dist2.sample(<span class="kw-2">&mut </span>rng)].<span class="number">0</span>); |
| }</code></pre></div> |
| </div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-WeightedIndex%3CX%3E" class="impl has-srclink"><a class="srclink rightside" href="../../../src/rand/distributions/weighted_index.rs.html#87-221">source</a><a href="#impl-WeightedIndex%3CX%3E" class="anchor"></a><h3 class="code-header">impl<X: <a class="trait" href="../uniform/trait.SampleUniform.html" title="trait rand::distributions::uniform::SampleUniform">SampleUniform</a> + PartialOrd> <a class="struct" href="struct.WeightedIndex.html" title="struct rand::distributions::weighted::WeightedIndex">WeightedIndex</a><X></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new" class="method has-srclink"><a class="srclink rightside" href="../../../src/rand/distributions/weighted_index.rs.html#96-131">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a><I>(weights: I) -> Result<<a class="struct" href="struct.WeightedIndex.html" title="struct rand::distributions::weighted::WeightedIndex">WeightedIndex</a><X>, <a class="enum" href="enum.WeightedError.html" title="enum rand::distributions::weighted::WeightedError">WeightedError</a>><span class="where fmt-newline">where<br> I: IntoIterator,<br> I::Item: <a class="trait" href="../uniform/trait.SampleBorrow.html" title="trait rand::distributions::uniform::SampleBorrow">SampleBorrow</a><X>,<br> X: for<'a> AddAssign<&'a X> + Clone + Default,</span></h4></section></summary><div class="docblock"><p>Creates a new a <code>WeightedIndex</code> <a href="../trait.Distribution.html" title="Distribution"><code>Distribution</code></a> using the values |
| in <code>weights</code>. The weights can use any type <code>X</code> for which an |
| implementation of <a href="../struct.Uniform.html"><code>Uniform<X></code></a> exists.</p> |
| <p>Returns an error if the iterator is empty, if any weight is <code>< 0</code>, or |
| if its total value is 0.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.update_weights" class="method has-srclink"><a class="srclink rightside" href="../../../src/rand/distributions/weighted_index.rs.html#142-220">source</a><h4 class="code-header">pub fn <a href="#method.update_weights" class="fnname">update_weights</a>(<br> &mut self,<br> new_weights: &[(usize, &X)]<br>) -> Result<(), <a class="enum" href="enum.WeightedError.html" title="enum rand::distributions::weighted::WeightedError">WeightedError</a>><span class="where fmt-newline">where<br> X: for<'a> AddAssign<&'a X> + for<'a> SubAssign<&'a X> + Clone + Default,</span></h4></section></summary><div class="docblock"><p>Update a subset of weights, without changing the number of weights.</p> |
| <p><code>new_weights</code> must be sorted by the index.</p> |
| <p>Using this method instead of <code>new</code> might be more efficient if only a small number of |
| weights is modified. No allocations are performed, unless the weight type <code>X</code> uses |
| allocation internally.</p> |
| <p>In case of error, <code>self</code> is not modified.</p> |
| </div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Clone-for-WeightedIndex%3CX%3E" class="impl has-srclink"><a class="srclink rightside" href="../../../src/rand/distributions/weighted_index.rs.html#78">source</a><a href="#impl-Clone-for-WeightedIndex%3CX%3E" class="anchor"></a><h3 class="code-header">impl<X: Clone + <a class="trait" href="../uniform/trait.SampleUniform.html" title="trait rand::distributions::uniform::SampleUniform">SampleUniform</a> + PartialOrd> Clone for <a class="struct" href="struct.WeightedIndex.html" title="struct rand::distributions::weighted::WeightedIndex">WeightedIndex</a><X><span class="where fmt-newline">where<br> X::<a class="associatedtype" href="../uniform/trait.SampleUniform.html#associatedtype.Sampler" title="type rand::distributions::uniform::SampleUniform::Sampler">Sampler</a>: Clone,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/rand/distributions/weighted_index.rs.html#78">source</a><a href="#method.clone" class="anchor"></a><h4 class="code-header">fn <a class="fnname">clone</a>(&self) -> <a class="struct" href="struct.WeightedIndex.html" title="struct rand::distributions::weighted::WeightedIndex">WeightedIndex</a><X></h4></section></summary><div class='docblock'>Returns a copy of the value. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><a href="#method.clone_from" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">clone_from</a>(&mut self, source: &Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-WeightedIndex%3CX%3E" class="impl has-srclink"><a class="srclink rightside" href="../../../src/rand/distributions/weighted_index.rs.html#78">source</a><a href="#impl-Debug-for-WeightedIndex%3CX%3E" class="anchor"></a><h3 class="code-header">impl<X: Debug + <a class="trait" href="../uniform/trait.SampleUniform.html" title="trait rand::distributions::uniform::SampleUniform">SampleUniform</a> + PartialOrd> Debug for <a class="struct" href="struct.WeightedIndex.html" title="struct rand::distributions::weighted::WeightedIndex">WeightedIndex</a><X><span class="where fmt-newline">where<br> X::<a class="associatedtype" href="../uniform/trait.SampleUniform.html#associatedtype.Sampler" title="type rand::distributions::uniform::SampleUniform::Sampler">Sampler</a>: Debug,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/rand/distributions/weighted_index.rs.html#78">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a class="fnname">fmt</a>(&self, f: &mut Formatter<'_>) -> Result</h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Distribution%3Cusize%3E-for-WeightedIndex%3CX%3E" class="impl has-srclink"><a class="srclink rightside" href="../../../src/rand/distributions/weighted_index.rs.html#223-240">source</a><a href="#impl-Distribution%3Cusize%3E-for-WeightedIndex%3CX%3E" class="anchor"></a><h3 class="code-header">impl<X> <a class="trait" href="../trait.Distribution.html" title="trait rand::distributions::Distribution">Distribution</a><usize> for <a class="struct" href="struct.WeightedIndex.html" title="struct rand::distributions::weighted::WeightedIndex">WeightedIndex</a><X><span class="where fmt-newline">where<br> X: <a class="trait" href="../uniform/trait.SampleUniform.html" title="trait rand::distributions::uniform::SampleUniform">SampleUniform</a> + PartialOrd,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.sample" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/rand/distributions/weighted_index.rs.html#226-239">source</a><a href="#method.sample" class="anchor"></a><h4 class="code-header">fn <a href="../trait.Distribution.html#tymethod.sample" class="fnname">sample</a><R: <a class="trait" href="../../trait.Rng.html" title="trait rand::Rng">Rng</a> + ?Sized>(&self, rng: &mut R) -> usize</h4></section></summary><div class='docblock'>Generate a random value of <code>T</code>, using <code>rng</code> as the source of randomness.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.sample_iter" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/rand/distributions/distribution.rs.html#73-83">source</a><a href="#method.sample_iter" class="anchor"></a><h4 class="code-header">fn <a href="../trait.Distribution.html#method.sample_iter" class="fnname">sample_iter</a><R>(self, rng: R) -> <a class="struct" href="../struct.DistIter.html" title="struct rand::distributions::DistIter">DistIter</a><Self, R, T><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<span class="notable-traits-tooltiptext"><span class="docblock"><span class="notable">Notable traits for <a class="struct" href="../struct.DistIter.html" title="struct rand::distributions::DistIter">DistIter</a><D, R, T></span><code class="content"><span class="where fmt-newline">impl<D, R, T> Iterator for <a class="struct" href="../struct.DistIter.html" title="struct rand::distributions::DistIter">DistIter</a><D, R, T><span class="where fmt-newline">where<br> D: <a class="trait" href="../trait.Distribution.html" title="trait rand::distributions::Distribution">Distribution</a><T>,<br> R: <a class="trait" href="../../trait.Rng.html" title="trait rand::Rng">Rng</a>,</span></span><span class="where fmt-newline"> type <a class="associatedtype">Item</a> = T;</span></code></span></span></span></span><span class="where fmt-newline">where<br> R: <a class="trait" href="../../trait.Rng.html" title="trait rand::Rng">Rng</a>,<br> Self: Sized,</span></h4></section></summary><div class='docblock'>Create an iterator that generates random values of <code>T</code>, using <code>rng</code> as |
| the source of randomness. <a href="../trait.Distribution.html#method.sample_iter">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.map" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/rand/distributions/distribution.rs.html#102-112">source</a><a href="#method.map" class="anchor"></a><h4 class="code-header">fn <a href="../trait.Distribution.html#method.map" class="fnname">map</a><F, S>(self, func: F) -> <a class="struct" href="../struct.DistMap.html" title="struct rand::distributions::DistMap">DistMap</a><Self, F, T, S><span class="where fmt-newline">where<br> F: Fn(T) -> S,<br> Self: Sized,</span></h4></section></summary><div class='docblock'>Create a distribution of values of ‘S’ by mapping the output of <code>Self</code> |
| through the closure <code>F</code> <a href="../trait.Distribution.html#method.map">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-PartialEq%3CWeightedIndex%3CX%3E%3E-for-WeightedIndex%3CX%3E" class="impl has-srclink"><a class="srclink rightside" href="../../../src/rand/distributions/weighted_index.rs.html#78">source</a><a href="#impl-PartialEq%3CWeightedIndex%3CX%3E%3E-for-WeightedIndex%3CX%3E" class="anchor"></a><h3 class="code-header">impl<X: PartialEq + <a class="trait" href="../uniform/trait.SampleUniform.html" title="trait rand::distributions::uniform::SampleUniform">SampleUniform</a> + PartialOrd> PartialEq<<a class="struct" href="struct.WeightedIndex.html" title="struct rand::distributions::weighted::WeightedIndex">WeightedIndex</a><X>> for <a class="struct" href="struct.WeightedIndex.html" title="struct rand::distributions::weighted::WeightedIndex">WeightedIndex</a><X><span class="where fmt-newline">where<br> X::<a class="associatedtype" href="../uniform/trait.SampleUniform.html#associatedtype.Sampler" title="type rand::distributions::uniform::SampleUniform::Sampler">Sampler</a>: PartialEq,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.eq" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/rand/distributions/weighted_index.rs.html#78">source</a><a href="#method.eq" class="anchor"></a><h4 class="code-header">fn <a class="fnname">eq</a>(&self, other: &<a class="struct" href="struct.WeightedIndex.html" title="struct rand::distributions::weighted::WeightedIndex">WeightedIndex</a><X>) -> bool</h4></section></summary><div class='docblock'>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used |
| by <code>==</code>. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.ne" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><a href="#method.ne" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">ne</a>(&self, other: &Rhs) -> bool</h4></section></summary><div class='docblock'>This method tests for <code>!=</code>. The default implementation is almost always |
| sufficient, and should not be overridden without very good reason. <a>Read more</a></div></details></div></details><section id="impl-StructuralPartialEq-for-WeightedIndex%3CX%3E" class="impl has-srclink"><a class="srclink rightside" href="../../../src/rand/distributions/weighted_index.rs.html#78">source</a><a href="#impl-StructuralPartialEq-for-WeightedIndex%3CX%3E" class="anchor"></a><h3 class="code-header">impl<X: <a class="trait" href="../uniform/trait.SampleUniform.html" title="trait rand::distributions::uniform::SampleUniform">SampleUniform</a> + PartialOrd> StructuralPartialEq for <a class="struct" href="struct.WeightedIndex.html" title="struct rand::distributions::weighted::WeightedIndex">WeightedIndex</a><X></h3></section></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-WeightedIndex%3CX%3E" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-WeightedIndex%3CX%3E" class="anchor"></a><h3 class="code-header">impl<X> RefUnwindSafe for <a class="struct" href="struct.WeightedIndex.html" title="struct rand::distributions::weighted::WeightedIndex">WeightedIndex</a><X><span class="where fmt-newline">where<br> X: RefUnwindSafe,<br> <X as <a class="trait" href="../uniform/trait.SampleUniform.html" title="trait rand::distributions::uniform::SampleUniform">SampleUniform</a>>::<a class="associatedtype" href="../uniform/trait.SampleUniform.html#associatedtype.Sampler" title="type rand::distributions::uniform::SampleUniform::Sampler">Sampler</a>: RefUnwindSafe,</span></h3></section><section id="impl-Send-for-WeightedIndex%3CX%3E" class="impl has-srclink"><a href="#impl-Send-for-WeightedIndex%3CX%3E" class="anchor"></a><h3 class="code-header">impl<X> Send for <a class="struct" href="struct.WeightedIndex.html" title="struct rand::distributions::weighted::WeightedIndex">WeightedIndex</a><X><span class="where fmt-newline">where<br> X: Send,<br> <X as <a class="trait" href="../uniform/trait.SampleUniform.html" title="trait rand::distributions::uniform::SampleUniform">SampleUniform</a>>::<a class="associatedtype" href="../uniform/trait.SampleUniform.html#associatedtype.Sampler" title="type rand::distributions::uniform::SampleUniform::Sampler">Sampler</a>: Send,</span></h3></section><section id="impl-Sync-for-WeightedIndex%3CX%3E" class="impl has-srclink"><a href="#impl-Sync-for-WeightedIndex%3CX%3E" class="anchor"></a><h3 class="code-header">impl<X> Sync for <a class="struct" href="struct.WeightedIndex.html" title="struct rand::distributions::weighted::WeightedIndex">WeightedIndex</a><X><span class="where fmt-newline">where<br> X: Sync,<br> <X as <a class="trait" href="../uniform/trait.SampleUniform.html" title="trait rand::distributions::uniform::SampleUniform">SampleUniform</a>>::<a class="associatedtype" href="../uniform/trait.SampleUniform.html#associatedtype.Sampler" title="type rand::distributions::uniform::SampleUniform::Sampler">Sampler</a>: Sync,</span></h3></section><section id="impl-Unpin-for-WeightedIndex%3CX%3E" class="impl has-srclink"><a href="#impl-Unpin-for-WeightedIndex%3CX%3E" class="anchor"></a><h3 class="code-header">impl<X> Unpin for <a class="struct" href="struct.WeightedIndex.html" title="struct rand::distributions::weighted::WeightedIndex">WeightedIndex</a><X><span class="where fmt-newline">where<br> X: Unpin,<br> <X as <a class="trait" href="../uniform/trait.SampleUniform.html" title="trait rand::distributions::uniform::SampleUniform">SampleUniform</a>>::<a class="associatedtype" href="../uniform/trait.SampleUniform.html#associatedtype.Sampler" title="type rand::distributions::uniform::SampleUniform::Sampler">Sampler</a>: Unpin,</span></h3></section><section id="impl-UnwindSafe-for-WeightedIndex%3CX%3E" class="impl has-srclink"><a href="#impl-UnwindSafe-for-WeightedIndex%3CX%3E" class="anchor"></a><h3 class="code-header">impl<X> UnwindSafe for <a class="struct" href="struct.WeightedIndex.html" title="struct rand::distributions::weighted::WeightedIndex">WeightedIndex</a><X><span class="where fmt-newline">where<br> X: UnwindSafe,<br> <X as <a class="trait" href="../uniform/trait.SampleUniform.html" title="trait rand::distributions::uniform::SampleUniform">SampleUniform</a>>::<a class="associatedtype" href="../uniform/trait.SampleUniform.html#associatedtype.Sampler" title="type rand::distributions::uniform::SampleUniform::Sampler">Sampler</a>: UnwindSafe,</span></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-WeightedIndex%3CX%3E" class="impl has-srclink"><a href="#impl-Any-for-WeightedIndex%3CX%3E" class="anchor"></a><h3 class="code-header">impl<T> Any for T<span class="where fmt-newline">where<br> T: 'static + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a class="fnname">type_id</a>(&self) -> TypeId</h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-WeightedIndex%3CX%3E" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-WeightedIndex%3CX%3E" class="anchor"></a><h3 class="code-header">impl<T> Borrow<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow</a>(&self) -> &T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-WeightedIndex%3CX%3E" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-WeightedIndex%3CX%3E" class="anchor"></a><h3 class="code-header">impl<T> BorrowMut<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow_mut</a>(&mut self) -> &mut T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-WeightedIndex%3CX%3E" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-WeightedIndex%3CX%3E" class="anchor"></a><h3 class="code-header">impl<T> From<T> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-WeightedIndex%3CX%3E" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-WeightedIndex%3CX%3E" class="anchor"></a><h3 class="code-header">impl<T, U> Into<U> for T<span class="where fmt-newline">where<br> U: From<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p> |
| <p>That is, this conversion is whatever the implementation of |
| <code>[From]<T> for U</code> chooses to do.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-ToOwned-for-WeightedIndex%3CX%3E" class="impl has-srclink"><a href="#impl-ToOwned-for-WeightedIndex%3CX%3E" class="anchor"></a><h3 class="code-header">impl<T> ToOwned for T<span class="where fmt-newline">where<br> T: Clone,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Owned" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'>The resulting type after obtaining ownership.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl has-srclink"><a href="#method.to_owned" class="anchor"></a><h4 class="code-header">fn <a class="fnname">to_owned</a>(&self) -> T</h4></section></summary><div class='docblock'>Creates owned data from borrowed data, usually by cloning. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl has-srclink"><a href="#method.clone_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">clone_into</a>(&self, target: &mut T)</h4></section></summary><div class='docblock'>Uses borrowed data to replace owned data, usually by cloning. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-WeightedIndex%3CX%3E" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-WeightedIndex%3CX%3E" class="anchor"></a><h3 class="code-header">impl<T, U> TryFrom<U> for T<span class="where fmt-newline">where<br> U: Into<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = Infallible</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_from</a>(value: U) -> Result<T, <T as TryFrom<U>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-WeightedIndex%3CX%3E" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-WeightedIndex%3CX%3E" class="anchor"></a><h3 class="code-header">impl<T, U> TryInto<U> for T<span class="where fmt-newline">where<br> U: TryFrom<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = <U as TryFrom<T>>::Error</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_into</a>(self) -> Result<U, <U as TryFrom<T>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-VZip%3CV%3E-for-WeightedIndex%3CX%3E" class="impl has-srclink"><a class="srclink rightside" href="../../../src/ppv_lite86/types.rs.html#221">source</a><a href="#impl-VZip%3CV%3E-for-WeightedIndex%3CX%3E" class="anchor"></a><h3 class="code-header">impl<V, T> <a class="trait" href="../../../ppv_lite86/types/trait.VZip.html" title="trait ppv_lite86::types::VZip">VZip</a><V> for T<span class="where fmt-newline">where<br> V: <a class="trait" href="../../../ppv_lite86/types/trait.MultiLane.html" title="trait ppv_lite86::types::MultiLane">MultiLane</a><T>,</span></h3></section></summary><div class="impl-items"><section id="method.vzip" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/ppv_lite86/types.rs.html#226">source</a><a href="#method.vzip" class="anchor"></a><h4 class="code-header">fn <a href="../../../ppv_lite86/types/trait.VZip.html#tymethod.vzip" class="fnname">vzip</a>(self) -> V</h4></section></div></details></div></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.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
