hobokenchicken/GopherGate
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
f1d5ba78697fd8e95bb41fbc6d9ce4123eeaa1b4
GopherGate/target/doc/rand/distr/weighted/struct.WeightedIndex.html
hobokenchicken 49701c85ad Adding large folders
2026-02-26 12:00:21 -05:00

137 lines
60 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!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."><title>WeightedIndex in rand::distr::weighted - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="rand" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-263c88ec.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]--><rustdoc-topbar><h2><a href="#">WeightedIndex</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../../../rand/index.html"><img src="https://www.rust-lang.org/logos/rust-logo-128x128-blk.png" alt="logo"></a><h2><a href="../../../rand/index.html">rand</a><span class="version">0.9.2</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Weighted<wbr>Index</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#performance" title="Performance">Performance</a></li><li><a href="#example" title="Example">Example</a></li></ul><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.new" title="new">new</a></li><li><a href="#method.total_weight" title="total_weight">total_weight</a></li><li><a href="#method.update_weights" title="update_weights">update_weights</a></li><li><a href="#method.weight" title="weight">weight</a></li><li><a href="#method.weights" title="weights">weights</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Clone-for-WeightedIndex%3CX%3E" title="Clone">Clone</a></li><li><a href="#impl-Debug-for-WeightedIndex%3CX%3E" title="Debug">Debug</a></li><li><a href="#impl-Distribution%3Cusize%3E-for-WeightedIndex%3CX%3E" title="Distribution&#60;usize&#62;">Distribution&#60;usize&#62;</a></li><li><a href="#impl-PartialEq-for-WeightedIndex%3CX%3E" title="PartialEq">PartialEq</a></li><li><a href="#impl-StructuralPartialEq-for-WeightedIndex%3CX%3E" title="StructuralPartialEq">StructuralPartialEq</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-WeightedIndex%3CX%3E" title="Freeze">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-WeightedIndex%3CX%3E" title="RefUnwindSafe">RefUnwindSafe</a></li><li><a href="#impl-Send-for-WeightedIndex%3CX%3E" title="Send">Send</a></li><li><a href="#impl-Sync-for-WeightedIndex%3CX%3E" title="Sync">Sync</a></li><li><a href="#impl-Unpin-for-WeightedIndex%3CX%3E" title="Unpin">Unpin</a></li><li><a href="#impl-UnwindSafe-for-WeightedIndex%3CX%3E" title="UnwindSafe">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T" title="Any">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T" title="Borrow&#60;T&#62;">Borrow&#60;T&#62;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T" title="BorrowMut&#60;T&#62;">BorrowMut&#60;T&#62;</a></li><li><a href="#impl-CloneToUninit-for-T" title="CloneToUninit">CloneToUninit</a></li><li><a href="#impl-From%3CT%3E-for-T" title="From&#60;T&#62;">From&#60;T&#62;</a></li><li><a href="#impl-Into%3CU%3E-for-T" title="Into&#60;U&#62;">Into&#60;U&#62;</a></li><li><a href="#impl-ToOwned-for-T" title="ToOwned">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-T" title="TryFrom&#60;U&#62;">TryFrom&#60;U&#62;</a></li><li><a href="#impl-TryInto%3CU%3E-for-T" title="TryInto&#60;U&#62;">TryInto&#60;U&#62;</a></li><li><a href="#impl-VZip%3CV%3E-for-T" title="VZip&#60;V&#62;">VZip&#60;V&#62;</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In rand::<wbr>distr::<wbr>weighted</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../index.html">rand</a>::<wbr><a href="../index.html">distr</a>::<wbr><a href="index.html">weighted</a></div><h1>Struct <span class="struct">Weighted<wbr>Index</span>&nbsp;<button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../../src/rand/distr/weighted/weighted_index.rs.html#81-85">Source</a> </span></div><pre class="rust item-decl"><code>pub struct WeightedIndex&lt;X: <a class="trait" href="../uniform/trait.SampleUniform.html" title="trait rand::distr::uniform::SampleUniform">SampleUniform</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a>&gt; { <span class="comment">/* private fields */</span> }</code></pre><details class="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
weight of the element. The weights can use any type <code>X</code> for which an
implementation of <a href="../struct.Uniform.html" title="struct rand::distr::Uniform"><code>Uniform&lt;X&gt;</code></a> exists. The implementation guarantees that
elements with zero weight are never picked, even when the weights are
floating point numbers.</p>
<h2 id="performance"><a class="doc-anchor" href="#performance">§</a>Performance</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.
See also <a href="https://docs.rs/rand_distr/latest/rand_distr/weighted/index.html"><code>rand_distr::weighted</code></a> for alternative implementations supporting
potentially-faster sampling or a more easily modifiable tree structure.</p>
<p>A <code>WeightedIndex&lt;X&gt;</code> contains a <code>Vec&lt;X&gt;</code> and a <a href="../struct.Uniform.html" title="struct rand::distr::Uniform"><code>Uniform&lt;X&gt;</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&lt;X&gt;</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 an instance of <code>X::Sampler</code>, this might cause additional allocations,
though for primitive types, <a href="../struct.Uniform.html" title="struct rand::distr::Uniform"><code>Uniform&lt;X&gt;</code></a> doesn’t allocate any memory.</p>
<p>Sampling from <code>WeightedIndex</code> will result in a single call to
<code>Uniform&lt;X&gt;::sample</code> (method of the <a href="../trait.Distribution.html" title="trait rand::distr::Distribution"><code>Distribution</code></a> trait), which typically
will request a single value from the underlying <a href="../../trait.RngCore.html" title="trait rand::RngCore"><code>RngCore</code></a>, though the
exact number depends on the implementation of <code>Uniform&lt;X&gt;::sample</code>.</p>
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</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::distr::weighted::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">&amp;</span>weights).unwrap();
<span class="kw">let </span><span class="kw-2">mut </span>rng = rand::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">&amp;mut </span>rng)]);
}
<span class="kw">let </span>items = [(<span class="string">'a'</span>, <span class="number">0.0</span>), (<span class="string">'b'</span>, <span class="number">3.0</span>), (<span class="string">'c'</span>, <span class="number">7.0</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">&amp;mut </span>rng)].<span class="number">0</span>);
}</code></pre></div></div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-WeightedIndex%3CX%3E" class="impl"><a class="src rightside" href="../../../src/rand/distr/weighted/weighted_index.rs.html#87-240">Source</a><a href="#impl-WeightedIndex%3CX%3E" class="anchor">§</a><h3 class="code-header">impl&lt;X: <a class="trait" href="../uniform/trait.SampleUniform.html" title="trait rand::distr::uniform::SampleUniform">SampleUniform</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a>&gt; <a class="struct" href="struct.WeightedIndex.html" title="struct rand::distr::weighted::WeightedIndex">WeightedIndex</a>&lt;X&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.new" class="method"><a class="src rightside" href="../../../src/rand/distr/weighted/weighted_index.rs.html#99-137">Source</a><h4 class="code-header">pub fn <a href="#method.new" class="fn">new</a>&lt;I&gt;(weights: I) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="struct.WeightedIndex.html" title="struct rand::distr::weighted::WeightedIndex">WeightedIndex</a>&lt;X&gt;, <a class="enum" href="enum.Error.html" title="enum rand::distr::weighted::Error">Error</a>&gt;<div class="where">where
I: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>,
I::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>: <a class="trait" href="../uniform/trait.SampleBorrow.html" title="trait rand::distr::uniform::SampleBorrow">SampleBorrow</a>&lt;X&gt;,
X: <a class="trait" href="trait.Weight.html" title="trait rand::distr::weighted::Weight">Weight</a>,</div></h4></section></summary><div class="docblock"><p>Creates a new a <code>WeightedIndex</code> <a href="../trait.Distribution.html" title="trait rand::distr::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" title="struct rand::distr::Uniform"><code>Uniform&lt;X&gt;</code></a> exists.</p>
<p>Error cases:</p>
<ul>
<li><a href="enum.Error.html#variant.InvalidInput" title="variant rand::distr::weighted::Error::InvalidInput"><code>Error::InvalidInput</code></a> when the iterator <code>weights</code> is empty.</li>
<li><a href="enum.Error.html#variant.InvalidWeight" title="variant rand::distr::weighted::Error::InvalidWeight"><code>Error::InvalidWeight</code></a> when a weight is not-a-number or negative.</li>
<li><a href="enum.Error.html#variant.InsufficientNonZero" title="variant rand::distr::weighted::Error::InsufficientNonZero"><code>Error::InsufficientNonZero</code></a> when the sum of all weights is zero.</li>
<li><a href="enum.Error.html#variant.Overflow" title="variant rand::distr::weighted::Error::Overflow"><code>Error::Overflow</code></a> when the sum of all weights overflows.</li>
</ul>
</div></details><details class="toggle method-toggle" open><summary><section id="method.update_weights" class="method"><a class="src rightside" href="../../../src/rand/distr/weighted/weighted_index.rs.html#159-239">Source</a><h4 class="code-header">pub fn <a href="#method.update_weights" class="fn">update_weights</a>(
&amp;mut self,
new_weights: &amp;[(<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&amp;X</a>)],
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.unit.html">()</a>, <a class="enum" href="enum.Error.html" title="enum rand::distr::weighted::Error">Error</a>&gt;<div class="where">where
X: for&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/ops/arith/trait.AddAssign.html" title="trait core::ops::arith::AddAssign">AddAssign</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&amp;'a X</a>&gt; + for&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/ops/arith/trait.SubAssign.html" title="trait core::ops::arith::SubAssign">SubAssign</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&amp;'a X</a>&gt; + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/default/trait.Default.html" title="trait core::default::Default">Default</a>,</div></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. Error cases:</p>
<ul>
<li><a href="enum.Error.html#variant.InvalidInput" title="variant rand::distr::weighted::Error::InvalidInput"><code>Error::InvalidInput</code></a> when <code>new_weights</code> are not ordered by
index or an index is too large.</li>
<li><a href="enum.Error.html#variant.InvalidWeight" title="variant rand::distr::weighted::Error::InvalidWeight"><code>Error::InvalidWeight</code></a> when a weight is not-a-number or negative.</li>
<li><a href="enum.Error.html#variant.InsufficientNonZero" title="variant rand::distr::weighted::Error::InsufficientNonZero"><code>Error::InsufficientNonZero</code></a> when the sum of all weights is zero.
Note that due to floating-point loss of precision, this case is not
always correctly detected; usage of a fixed-point weight type may be
preferred.</li>
</ul>
<p>Updates take <code>O(N)</code> time. If you need to frequently update weights, consider
<a href="https://docs.rs/rand_distr/*/rand_distr/weighted_tree/index.html"><code>rand_distr::weighted_tree</code></a>
as an alternative where an update is <code>O(log N)</code>.</p>
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-WeightedIndex%3CX%3E-1" class="impl"><a class="src rightside" href="../../../src/rand/distr/weighted/weighted_index.rs.html#291-356">Source</a><a href="#impl-WeightedIndex%3CX%3E-1" class="anchor">§</a><h3 class="code-header">impl&lt;X: <a class="trait" href="../uniform/trait.SampleUniform.html" title="trait rand::distr::uniform::SampleUniform">SampleUniform</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>&gt; <a class="struct" href="struct.WeightedIndex.html" title="struct rand::distr::weighted::WeightedIndex">WeightedIndex</a>&lt;X&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.weight" class="method"><a class="src rightside" href="../../../src/rand/distr/weighted/weighted_index.rs.html#308-324">Source</a><h4 class="code-header">pub fn <a href="#method.weight" class="fn">weight</a>(&amp;self, index: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;X&gt;<div class="where">where
X: for&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/ops/arith/trait.SubAssign.html" title="trait core::ops::arith::SubAssign">SubAssign</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&amp;'a X</a>&gt;,</div></h4></section></summary><div class="docblock"><p>Returns the weight at the given index, if it exists.</p>
<p>If the index is out of bounds, this will return <code>None</code>.</p>
<h5 id="example-1"><a class="doc-anchor" href="#example-1">§</a>Example</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>rand::distr::weighted::WeightedIndex;
<span class="kw">let </span>weights = [<span class="number">0</span>, <span class="number">1</span>, <span class="number">2</span>];
<span class="kw">let </span>dist = WeightedIndex::new(<span class="kw-2">&amp;</span>weights).unwrap();
<span class="macro">assert_eq!</span>(dist.weight(<span class="number">0</span>), <span class="prelude-val">Some</span>(<span class="number">0</span>));
<span class="macro">assert_eq!</span>(dist.weight(<span class="number">1</span>), <span class="prelude-val">Some</span>(<span class="number">1</span>));
<span class="macro">assert_eq!</span>(dist.weight(<span class="number">2</span>), <span class="prelude-val">Some</span>(<span class="number">2</span>));
<span class="macro">assert_eq!</span>(dist.weight(<span class="number">3</span>), <span class="prelude-val">None</span>);</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.weights" class="method"><a class="src rightside" href="../../../src/rand/distr/weighted/weighted_index.rs.html#342-350">Source</a><h4 class="code-header">pub fn <a href="#method.weights" class="fn">weights</a>(&amp;self) -&gt; WeightedIndexIter&lt;'_, X&gt;<div class="where">where
X: for&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/ops/arith/trait.SubAssign.html" title="trait core::ops::arith::SubAssign">SubAssign</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&amp;'a X</a>&gt;,</div></h4></section></summary><div class="docblock"><p>Returns a lazy-loading iterator containing the current weights of this distribution.</p>
<p>If this distribution has not been updated since its creation, this will return the
same weights as were passed to <code>new</code>.</p>
<h5 id="example-2"><a class="doc-anchor" href="#example-2">§</a>Example</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>rand::distr::weighted::WeightedIndex;
<span class="kw">let </span>weights = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>];
<span class="kw">let </span><span class="kw-2">mut </span>dist = WeightedIndex::new(<span class="kw-2">&amp;</span>weights).unwrap();
<span class="macro">assert_eq!</span>(dist.weights().collect::&lt;Vec&lt;<span class="kw">_</span>&gt;&gt;(), <span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>]);
dist.update_weights(<span class="kw-2">&amp;</span>[(<span class="number">0</span>, <span class="kw-2">&amp;</span><span class="number">2</span>)]).unwrap();
<span class="macro">assert_eq!</span>(dist.weights().collect::&lt;Vec&lt;<span class="kw">_</span>&gt;&gt;(), <span class="macro">vec!</span>[<span class="number">2</span>, <span class="number">2</span>, <span class="number">3</span>]);</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.total_weight" class="method"><a class="src rightside" href="../../../src/rand/distr/weighted/weighted_index.rs.html#353-355">Source</a><h4 class="code-header">pub fn <a href="#method.total_weight" class="fn">total_weight</a>(&amp;self) -&gt; X</h4></section></summary><div class="docblock"><p>Returns the sum of all weights in this distribution.</p>
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Clone-for-WeightedIndex%3CX%3E" class="impl"><a class="src rightside" href="../../../src/rand/distr/weighted/weighted_index.rs.html#79">Source</a><a href="#impl-Clone-for-WeightedIndex%3CX%3E" class="anchor">§</a><h3 class="code-header">impl&lt;X: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> + <a class="trait" href="../uniform/trait.SampleUniform.html" title="trait rand::distr::uniform::SampleUniform">SampleUniform</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a>&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="struct.WeightedIndex.html" title="struct rand::distr::weighted::WeightedIndex">WeightedIndex</a>&lt;X&gt;<div class="where">where
X::<a class="associatedtype" href="../uniform/trait.SampleUniform.html#associatedtype.Sampler" title="type rand::distr::uniform::SampleUniform::Sampler">Sampler</a>: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl"><a class="src rightside" href="../../../src/rand/distr/weighted/weighted_index.rs.html#79">Source</a><a href="#method.clone" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html#tymethod.clone" class="fn">clone</a>(&amp;self) -&gt; <a class="struct" href="struct.WeightedIndex.html" title="struct rand::distr::weighted::WeightedIndex">WeightedIndex</a>&lt;X&gt;</h4></section></summary><div class='docblock'>Returns a duplicate of the value. <a href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html#tymethod.clone">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.93.1/src/core/clone.rs.html#245-247">Source</a></span><a href="#method.clone_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html#method.clone_from" class="fn">clone_from</a>(&amp;mut self, source: &amp;Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html#method.clone_from">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-WeightedIndex%3CX%3E" class="impl"><a class="src rightside" href="../../../src/rand/distr/weighted/weighted_index.rs.html#79">Source</a><a href="#impl-Debug-for-WeightedIndex%3CX%3E" class="anchor">§</a><h3 class="code-header">impl&lt;X: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="../uniform/trait.SampleUniform.html" title="trait rand::distr::uniform::SampleUniform">SampleUniform</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a>&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.WeightedIndex.html" title="struct rand::distr::weighted::WeightedIndex">WeightedIndex</a>&lt;X&gt;<div class="where">where
X::<a class="associatedtype" href="../uniform/trait.SampleUniform.html#associatedtype.Sampler" title="type rand::distr::uniform::SampleUniform::Sampler">Sampler</a>: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../../../src/rand/distr/weighted/weighted_index.rs.html#79">Source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>&lt;'_&gt;) -&gt; <a class="type" href="https://doc.rust-lang.org/1.93.1/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Distribution%3Cusize%3E-for-WeightedIndex%3CX%3E" class="impl"><a class="src rightside" href="../../../src/rand/distr/weighted/weighted_index.rs.html#358-368">Source</a><a href="#impl-Distribution%3Cusize%3E-for-WeightedIndex%3CX%3E" class="anchor">§</a><h3 class="code-header">impl&lt;X&gt; <a class="trait" href="../trait.Distribution.html" title="trait rand::distr::Distribution">Distribution</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>&gt; for <a class="struct" href="struct.WeightedIndex.html" title="struct rand::distr::weighted::WeightedIndex">WeightedIndex</a>&lt;X&gt;<div class="where">where
X: <a class="trait" href="../uniform/trait.SampleUniform.html" title="trait rand::distr::uniform::SampleUniform">SampleUniform</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.sample" class="method trait-impl"><a class="src rightside" href="../../../src/rand/distr/weighted/weighted_index.rs.html#362-367">Source</a><a href="#method.sample" class="anchor">§</a><h4 class="code-header">fn <a href="../trait.Distribution.html#tymethod.sample" class="fn">sample</a>&lt;R: <a class="trait" href="../../trait.Rng.html" title="trait rand::Rng">Rng</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>&gt;(&amp;self, rng: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&amp;mut R</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a></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="toggle method-toggle" open><summary><section id="method.sample_iter" class="method trait-impl"><a class="src rightside" href="../../../src/rand/distr/distribution.rs.html#72-82">Source</a><a href="#method.sample_iter" class="anchor">§</a><h4 class="code-header">fn <a href="../trait.Distribution.html#method.sample_iter" class="fn">sample_iter</a>&lt;R&gt;(self, rng: R) -&gt; <a class="struct" href="../struct.Iter.html" title="struct rand::distr::Iter">Iter</a>&lt;Self, R, T&gt; <a href="#" class="tooltip" data-notable-ty="Iter&lt;Self, R, T&gt;">ⓘ</a><div class="where">where
R: <a class="trait" href="../../trait.Rng.html" title="trait rand::Rng">Rng</a>,
Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></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="toggle method-toggle" open><summary><section id="method.map" class="method trait-impl"><a class="src rightside" href="../../../src/rand/distr/distribution.rs.html#97-107">Source</a><a href="#method.map" class="anchor">§</a><h4 class="code-header">fn <a href="../trait.Distribution.html#method.map" class="fn">map</a>&lt;F, S&gt;(self, func: F) -&gt; <a class="struct" href="../struct.Map.html" title="struct rand::distr::Map">Map</a>&lt;Self, F, T, S&gt;<div class="where">where
F: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(T) -&gt; S,
Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Map sampled values to type <code>S</code> <a href="../trait.Distribution.html#method.map">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-PartialEq-for-WeightedIndex%3CX%3E" class="impl"><a class="src rightside" href="../../../src/rand/distr/weighted/weighted_index.rs.html#79">Source</a><a href="#impl-PartialEq-for-WeightedIndex%3CX%3E" class="anchor">§</a><h3 class="code-header">impl&lt;X: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> + <a class="trait" href="../uniform/trait.SampleUniform.html" title="trait rand::distr::uniform::SampleUniform">SampleUniform</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a>&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> for <a class="struct" href="struct.WeightedIndex.html" title="struct rand::distr::weighted::WeightedIndex">WeightedIndex</a>&lt;X&gt;<div class="where">where
X::<a class="associatedtype" href="../uniform/trait.SampleUniform.html#associatedtype.Sampler" title="type rand::distr::uniform::SampleUniform::Sampler">Sampler</a>: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.eq" class="method trait-impl"><a class="src rightside" href="../../../src/rand/distr/weighted/weighted_index.rs.html#79">Source</a><a href="#method.eq" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.PartialEq.html#tymethod.eq" class="fn">eq</a>(&amp;self, other: &amp;<a class="struct" href="struct.WeightedIndex.html" title="struct rand::distr::weighted::WeightedIndex">WeightedIndex</a>&lt;X&gt;) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>Tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>.</div></details><details class="toggle method-toggle" open><summary><section id="method.ne" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.93.1/src/core/cmp.rs.html#264">Source</a></span><a href="#method.ne" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.PartialEq.html#method.ne" class="fn">ne</a>(&amp;self, other: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&amp;Rhs</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>Tests for <code>!=</code>. The default implementation is almost always sufficient,
and should not be overridden without very good reason.</div></details></div></details><section id="impl-StructuralPartialEq-for-WeightedIndex%3CX%3E" class="impl"><a class="src rightside" href="../../../src/rand/distr/weighted/weighted_index.rs.html#79">Source</a><a href="#impl-StructuralPartialEq-for-WeightedIndex%3CX%3E" class="anchor">§</a><h3 class="code-header">impl&lt;X: <a class="trait" href="../uniform/trait.SampleUniform.html" title="trait rand::distr::uniform::SampleUniform">SampleUniform</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a>&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.StructuralPartialEq.html" title="trait core::marker::StructuralPartialEq">StructuralPartialEq</a> for <a class="struct" href="struct.WeightedIndex.html" title="struct rand::distr::weighted::WeightedIndex">WeightedIndex</a>&lt;X&gt;</h3></section></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-WeightedIndex%3CX%3E" class="impl"><a href="#impl-Freeze-for-WeightedIndex%3CX%3E" class="anchor">§</a><h3 class="code-header">impl&lt;X&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.WeightedIndex.html" title="struct rand::distr::weighted::WeightedIndex">WeightedIndex</a>&lt;X&gt;<div class="where">where
X: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a>,
&lt;X as <a class="trait" href="../uniform/trait.SampleUniform.html" title="trait rand::distr::uniform::SampleUniform">SampleUniform</a>&gt;::<a class="associatedtype" href="../uniform/trait.SampleUniform.html#associatedtype.Sampler" title="type rand::distr::uniform::SampleUniform::Sampler">Sampler</a>: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a>,</div></h3></section><section id="impl-RefUnwindSafe-for-WeightedIndex%3CX%3E" class="impl"><a href="#impl-RefUnwindSafe-for-WeightedIndex%3CX%3E" class="anchor">§</a><h3 class="code-header">impl&lt;X&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.WeightedIndex.html" title="struct rand::distr::weighted::WeightedIndex">WeightedIndex</a>&lt;X&gt;<div class="where">where
X: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a>,
&lt;X as <a class="trait" href="../uniform/trait.SampleUniform.html" title="trait rand::distr::uniform::SampleUniform">SampleUniform</a>&gt;::<a class="associatedtype" href="../uniform/trait.SampleUniform.html#associatedtype.Sampler" title="type rand::distr::uniform::SampleUniform::Sampler">Sampler</a>: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a>,</div></h3></section><section id="impl-Send-for-WeightedIndex%3CX%3E" class="impl"><a href="#impl-Send-for-WeightedIndex%3CX%3E" class="anchor">§</a><h3 class="code-header">impl&lt;X&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.WeightedIndex.html" title="struct rand::distr::weighted::WeightedIndex">WeightedIndex</a>&lt;X&gt;<div class="where">where
X: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,
&lt;X as <a class="trait" href="../uniform/trait.SampleUniform.html" title="trait rand::distr::uniform::SampleUniform">SampleUniform</a>&gt;::<a class="associatedtype" href="../uniform/trait.SampleUniform.html#associatedtype.Sampler" title="type rand::distr::uniform::SampleUniform::Sampler">Sampler</a>: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</div></h3></section><section id="impl-Sync-for-WeightedIndex%3CX%3E" class="impl"><a href="#impl-Sync-for-WeightedIndex%3CX%3E" class="anchor">§</a><h3 class="code-header">impl&lt;X&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.WeightedIndex.html" title="struct rand::distr::weighted::WeightedIndex">WeightedIndex</a>&lt;X&gt;<div class="where">where
X: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,
&lt;X as <a class="trait" href="../uniform/trait.SampleUniform.html" title="trait rand::distr::uniform::SampleUniform">SampleUniform</a>&gt;::<a class="associatedtype" href="../uniform/trait.SampleUniform.html#associatedtype.Sampler" title="type rand::distr::uniform::SampleUniform::Sampler">Sampler</a>: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,</div></h3></section><section id="impl-Unpin-for-WeightedIndex%3CX%3E" class="impl"><a href="#impl-Unpin-for-WeightedIndex%3CX%3E" class="anchor">§</a><h3 class="code-header">impl&lt;X&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.WeightedIndex.html" title="struct rand::distr::weighted::WeightedIndex">WeightedIndex</a>&lt;X&gt;<div class="where">where
X: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,
&lt;X as <a class="trait" href="../uniform/trait.SampleUniform.html" title="trait rand::distr::uniform::SampleUniform">SampleUniform</a>&gt;::<a class="associatedtype" href="../uniform/trait.SampleUniform.html#associatedtype.Sampler" title="type rand::distr::uniform::SampleUniform::Sampler">Sampler</a>: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h3></section><section id="impl-UnwindSafe-for-WeightedIndex%3CX%3E" class="impl"><a href="#impl-UnwindSafe-for-WeightedIndex%3CX%3E" class="anchor">§</a><h3 class="code-header">impl&lt;X&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.WeightedIndex.html" title="struct rand::distr::weighted::WeightedIndex">WeightedIndex</a>&lt;X&gt;<div class="where">where
X: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a>,
&lt;X as <a class="trait" href="../uniform/trait.SampleUniform.html" title="trait rand::distr::uniform::SampleUniform">SampleUniform</a>&gt;::<a class="associatedtype" href="../uniform/trait.SampleUniform.html#associatedtype.Sampler" title="type rand::distr::uniform::SampleUniform::Sampler">Sampler</a>: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a>,</div></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/any.rs.html#138">Source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/any.rs.html#139">Source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.93.1/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#212">Source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a>&lt;T&gt; for T<div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#214">Source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&amp;T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#221">Source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a>&lt;T&gt; for T<div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#222">Source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&amp;mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CloneToUninit-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/clone.rs.html#547">Source</a><a href="#impl-CloneToUninit-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/clone/trait.CloneToUninit.html" title="trait core::clone::CloneToUninit">CloneToUninit</a> for T<div class="where">where
T: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone_to_uninit" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/clone.rs.html#549">Source</a><a href="#method.clone_to_uninit" class="anchor">§</a><h4 class="code-header">unsafe fn <a href="https://doc.rust-lang.org/1.93.1/core/clone/trait.CloneToUninit.html#tymethod.clone_to_uninit" class="fn">clone_to_uninit</a>(&amp;self, dest: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.pointer.html">*mut </a><a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>)</h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>clone_to_uninit</code>)</span></div></span><div class='docblock'>Performs copy-assignment from <code>self</code> to <code>dest</code>. <a href="https://doc.rust-lang.org/1.93.1/core/clone/trait.CloneToUninit.html#tymethod.clone_to_uninit">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#785">Source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#788">Source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -&gt; T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#767-769">Source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#777">Source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -&gt; 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><a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for U</code> chooses to do.</p>
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ToOwned-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/alloc/borrow.rs.html#85-87">Source</a><a href="#impl-ToOwned-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T<div class="where">where
T: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/alloc/borrow.rs.html#89">Source</a><a href="#associatedtype.Owned" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.93.1/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'>The resulting type after obtaining ownership.</div></details><details class="toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/alloc/borrow.rs.html#90">Source</a><a href="#method.to_owned" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fn">to_owned</a>(&amp;self) -&gt; T</h4></section></summary><div class='docblock'>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/1.93.1/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/alloc/borrow.rs.html#94">Source</a><a href="#method.clone_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/alloc/borrow/trait.ToOwned.html#method.clone_into" class="fn">clone_into</a>(&amp;self, target: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&amp;mut T</a>)</h4></section></summary><div class='docblock'>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/1.93.1/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#827-829">Source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#831">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#834">Source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, &lt;T as <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#811-813">Source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#815">Source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = &lt;U as <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#818">Source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;U, &lt;U as <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-VZip%3CV%3E-for-T" class="impl"><a class="src rightside" href="../../../src/ppv_lite86/types.rs.html#221-223">Source</a><a href="#impl-VZip%3CV%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;V, T&gt; <a class="trait" href="../../../ppv_lite86/types/trait.VZip.html" title="trait ppv_lite86::types::VZip">VZip</a>&lt;V&gt; for T<div class="where">where
V: <a class="trait" href="../../../ppv_lite86/types/trait.MultiLane.html" title="trait ppv_lite86::types::MultiLane">MultiLane</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><section id="method.vzip" class="method trait-impl"><a class="src 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="fn">vzip</a>(self) -&gt; V</h4></section></div></details></div><script type="text/json" id="notable-traits-data">{"Iter<Self, R, T>":"<h3>Notable traits for <code><a class=\"struct\" href=\"../struct.Iter.html\" title=\"struct rand::distr::Iter\">Iter</a>&lt;D, R, T&gt;</code></h3><pre><code><div class=\"where\">impl&lt;D, R, T&gt; <a class=\"trait\" href=\"https://doc.rust-lang.org/1.93.1/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a> for <a class=\"struct\" href=\"../struct.Iter.html\" title=\"struct rand::distr::Iter\">Iter</a>&lt;D, R, T&gt;<div class=\"where\">where\n D: <a class=\"trait\" href=\"../trait.Distribution.html\" title=\"trait rand::distr::Distribution\">Distribution</a>&lt;T&gt;,\n R: <a class=\"trait\" href=\"../../trait.Rng.html\" title=\"trait rand::Rng\">Rng</a>,</div></div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/1.93.1/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item\" class=\"associatedtype\">Item</a> = T;</div>"}</script></section></div></main></body></html>
Reference in New Issue View Git Blame Copy Permalink