24 lines
41 KiB
HTML
24 lines
41 KiB
HTML
|
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `Weight` trait in crate `rand`."><meta name="keywords" content="rust, rustlang, rust-lang, Weight"><title>rand::distributions::weighted::alias_method::Weight - Rust</title><link rel="stylesheet" type="text/css" href="../../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../../dark.css"><link rel="stylesheet" type="text/css" href="../../../../light.css" id="themeStyle"><script src="../../../../storage.js"></script><noscript><link rel="stylesheet" href="../../../../noscript.css"></noscript><link rel="shortcut icon" href="https://www.rust-lang.org/favicon.ico"><style type="text/css">#crate-search{background-image:url("../../../../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../../../rand/index.html'><div class='logo-container'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk.png' alt='logo'></div></a><p class='location'>Trait Weight</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-const">Associated Constants</a><div class="sidebar-links"><a href="#associatedconstant.MAX">MAX</a><a href="#associatedconstant.ZERO">ZERO</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.try_from_u32_lossy">try_from_u32_lossy</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.sum">sum</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-Weight-for-f32">f32</a><a href="#impl-Weight-for-f64">f64</a><a href="#impl-Weight-for-i128">i128</a><a href="#impl-Weight-for-i16">i16</a><a href="#impl-Weight-for-i32">i32</a><a href="#impl-Weight-for-i64">i64</a><a href="#impl-Weight-for-i8">i8</a><a href="#impl-Weight-for-isize">isize</a><a href="#impl-Weight-for-u128">u128</a><a href="#impl-Weight-for-u16">u16</a><a href="#impl-Weight-for-u32">u32</a><a href="#impl-Weight-for-u64">u64</a><a href="#impl-Weight-for-u8">u8</a><a href="#impl-Weight-for-usize">usize</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../../../index.html'>rand</a>::<wbr><a href='../../index.html'>distributions</a>::<wbr><a href='../index.html'>weighted</a>::<wbr><a href='index.html'>alias_method</a></p><script>window.sidebarCurrent = {name: 'Weight', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../../../settings.html"><img src="../../../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../../../../src/rand/distributions/weighted/alias_method.rs.html#272-302' title=
|
|||
|
|
const <a href='#associatedconstant.MAX' class="constant"><b>MAX</b></a>: Self;
|
|||
|
|
const <a href='#associatedconstant.ZERO' class="constant"><b>ZERO</b></a>: Self;
|
|||
|
|
|
|||
|
|
fn <a href='#tymethod.try_from_u32_lossy' class='fnname'>try_from_u32_lossy</a>(n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self>;
|
|||
|
|
|
|||
|
|
fn <a href='#method.sum' class='fnname'>sum</a>(values: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[Self]</a>) -> Self { ... }
|
|||
|
|
}</pre></div><div class='docblock'><p>Trait that must be implemented for weights, that are used with
|
|||
|
|
[<code>WeightedIndex</code>]. Currently no guarantees on the correctness of
|
|||
|
|
[<code>WeightedIndex</code>] are given for custom implementations of this trait.</p>
|
|||
|
|
</div>
|
|||
|
|
<h2 id='associated-const' class='small-section-header'>Associated Constants<a href='#associated-const' class='anchor'></a></h2><div class='methods'><h3 id='associatedconstant.MAX' class='method'><code id='MAX.v'>const <a href='#associatedconstant.MAX' class="constant"><b>MAX</b></a>: Self</code></h3><div class='docblock'><p>Maximum number representable by <code>Self</code>.</p>
|
|||
|
|
</div><h3 id='associatedconstant.ZERO' class='method'><code id='ZERO.v'>const <a href='#associatedconstant.ZERO' class="constant"><b>ZERO</b></a>: Self</code></h3><div class='docblock'><p>Element of <code>Self</code> equivalent to 0.</p>
|
|||
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|||
|
|
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.try_from_u32_lossy' class='method'><code id='try_from_u32_lossy.v'>fn <a href='#tymethod.try_from_u32_lossy' class='fnname'>try_from_u32_lossy</a>(n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self></code></h3><div class='docblock'><p>Produce an instance of <code>Self</code> from a <code>u32</code> value, or return <code>None</code> if
|
|||
|
|
out of range. Loss of precision (where <code>Self</code> is a floating point type)
|
|||
|
|
is acceptable.</p>
|
|||
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|||
|
|
<h2 id='provided-methods' class='small-section-header'>Provided methods<a href='#provided-methods' class='anchor'></a></h2><div class='methods'><h3 id='method.sum' class='method'><code id='sum.v'>fn <a href='#method.sum' class='fnname'>sum</a>(values: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[Self]</a>) -> Self</code></h3><div class='docblock'><p>Sums all values in slice <code>values</code>.</p>
|
|||
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|||
|
|
<h2 id='foreign-impls' class='small-section-header'>Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a></h2><h3 id='impl-Weight-for-f64' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../rand/distributions/weighted/alias_method/trait.Weight.html" title="trait rand::distributions::weighted::alias_method::Weight">Weight</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a></code><a href='#impl-Weight-for-f64' class='anchor'></a><a class='srclink' href='../../../../src/rand/distributions/weighted/alias_method.rs.html#306-317' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedconstant.MAX-1' class="associatedconstant hidden"><code id='MAX.v-1'>const <a href='#associatedconstant.MAX' class="constant"><b>MAX</b></a>: Self</code><a class='srclink' href='../../../../src/rand/distributions/weighted/alias_method.rs.html#307' title='goto source code'>[src]</a></h4><h4 id='associatedconstant.ZERO-1' class="associatedconstant hidden"><code id='ZERO.v-1'>const <a href='#associatedconstant.ZERO' class="constant"><b>ZERO</b></a>: Self</code><a class='srclink' href='../../../../src/rand/distributions/weighted/alias_method.rs.html#308' title='goto source code'>[src]</a></h4><h4 id='method.try_from_u32_lossy' class="method hidden"><code id='try_from_u32_lossy.v-1'>fn <a href='#method.try_from_u32_lossy' class='fnname'>try_from_u32_lossy</a>(n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self></code><a class='srclink' href='../../../../src/rand/distributions/weighted/alias_method.rs.html#310-312' title='goto source code'>[src]</a></h4><h4 id='method.sum-1' class="method hidden"><code id='sum.v-1'>fn <a href='#method.sum' class='fnname'>sum</a>(values: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[Self]</a>) -> Self</code><a class='srclink' href='../../../../src/rand/distributions/weighted/alias_method.rs.html#314-316' title='goto source code'>[src]</a></h4></div><h3 id='impl-Weight-for-f32' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../rand/distributions/weighted/alias_method/trait.Weight.html" title="trait rand::distributions::weighted::alias_method::Weight">Weight</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a></code><a href='#impl-Weight-for-f32' class='anchor'></a><a class='srclink' href='../../../../src/rand/distributions/weighted/alias_method.rs.html#306-317' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedconstant.MAX-2' class="associatedconstant hidden"><code id='MAX.v-2'>const <a href='#associatedconstant.MAX' class="constant"><b>MAX</b></a>: Self</code><a class='srclink' href='../../../../src/rand/distributions/weighted/alias_method.rs.html#307' title='goto source code'>[src]</a></h4><h4 id='associatedconstant.ZERO-2' class="associatedconstant hidden"><code id='ZERO.v-2'>const <a href='#associatedconstant.ZERO' class="constant"><b>ZERO</b></a>: Self</code><a class='srclink' href='../../../../src/rand/distributions/weighted/alias_method.rs.html#308' title='goto source code'>[src]</a></h4><h4 id='method.try_from_u32_lossy-1' class="method hidden"><code id='try_from_u32_lossy.v-2'>fn <a href='#method.try_from_u32_lossy' class='fnname'>try_from_u32_lossy</a>(n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self></code><a class='srclink' href='../../../../src/rand/distributions/weighted/alias_method.rs.html#310-312' title='goto source code'>[src]</a></h4><h4 id='method.sum-2' class="method hidden"><code id='sum.v-2'>fn <a href='#method.sum' class='fnname'>sum
|
|||
|
|
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
|||
|
|
src="../../../../implementors/rand/distributions/weighted/alias_method/trait.Weight.js">
|
|||
|
|
</script></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../../../";window.currentCrate = "rand";</script><script src="../../../../aliases.js"></script><script src="../../../../main.js"></script><script defer src="../../../../search-index.js"></script></body></html>
|