blob: 51b98f5660b024a98a3430c02828d776130341fb [file] [log] [blame]
<!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="Sampling from random distributions."><meta name="keywords" content="rust, rustlang, rust-lang, distributions"><title>sgx_rand::distributions - 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="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc mod"><!--[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">&#9776;</button><a class="sidebar-logo" href="../../sgx_rand/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../sgx_rand/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Module distributions</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li></ul></section></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">Module <a href="../index.html">sgx_rand</a>::<wbr><a class="mod" href="#">distributions</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/sgx_rand/distributions/mod.rs.html#18-302">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Sampling from random distributions.</p>
<p>This is a generalization of <code>Rand</code> to allow parameters to control the
exact properties of the generated values, e.g. the mean and standard
deviation of a normal distribution. The <code>Sample</code> trait is the most
general, and allows for generating values that change some state
internally. The <code>IndependentSample</code> trait is for generating values
that do not need to record state.</p>
</div></details><h2 id="reexports" class="small-section-header"><a href="#reexports">Re-exports</a></h2><div class="item-table"><div class="item-row"><div class="item-left import-item" id="reexport.Exp"><code>pub use self::exponential::<a class="struct" href="exponential/struct.Exp.html" title="struct sgx_rand::distributions::exponential::Exp">Exp</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.ChiSquared"><code>pub use self::gamma::<a class="struct" href="gamma/struct.ChiSquared.html" title="struct sgx_rand::distributions::gamma::ChiSquared">ChiSquared</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.FisherF"><code>pub use self::gamma::<a class="struct" href="gamma/struct.FisherF.html" title="struct sgx_rand::distributions::gamma::FisherF">FisherF</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.Gamma"><code>pub use self::gamma::<a class="struct" href="gamma/struct.Gamma.html" title="struct sgx_rand::distributions::gamma::Gamma">Gamma</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.StudentT"><code>pub use self::gamma::<a class="struct" href="gamma/struct.StudentT.html" title="struct sgx_rand::distributions::gamma::StudentT">StudentT</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.LogNormal"><code>pub use self::normal::<a class="struct" href="normal/struct.LogNormal.html" title="struct sgx_rand::distributions::normal::LogNormal">LogNormal</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.Normal"><code>pub use self::normal::<a class="struct" href="normal/struct.Normal.html" title="struct sgx_rand::distributions::normal::Normal">Normal</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.Range"><code>pub use self::range::<a class="struct" href="range/struct.Range.html" title="struct sgx_rand::distributions::range::Range">Range</a>;</code></div></div></div><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="exponential/index.html" title="sgx_rand::distributions::exponential mod">exponential</a></div><div class="item-right docblock-short">The exponential distribution.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="gamma/index.html" title="sgx_rand::distributions::gamma mod">gamma</a></div><div class="item-right docblock-short">The Gamma and derived distributions.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="normal/index.html" title="sgx_rand::distributions::normal mod">normal</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="range/index.html" title="sgx_rand::distributions::range mod">range</a></div><div class="item-right docblock-short">Generating numbers between two others.</div></div></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.RandSample.html" title="sgx_rand::distributions::RandSample struct">RandSample</a></div><div class="item-right docblock-short">A wrapper for generating types that implement <code>Rand</code> via the
<code>Sample</code> &amp; <code>IndependentSample</code> traits.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Weighted.html" title="sgx_rand::distributions::Weighted struct">Weighted</a></div><div class="item-right docblock-short">A value with a particular weight for use with <code>WeightedChoice</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.WeightedChoice.html" title="sgx_rand::distributions::WeightedChoice struct">WeightedChoice</a></div><div class="item-right docblock-short">A distribution that selects from a finite collection of weighted items.</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.IndependentSample.html" title="sgx_rand::distributions::IndependentSample trait">IndependentSample</a></div><div class="item-right docblock-short"><code>Sample</code>s that do not require keeping track of state.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Sample.html" title="sgx_rand::distributions::Sample trait">Sample</a></div><div class="item-right docblock-short">Types that can be used to create a random instance of <code>Support</code>.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="sgx_rand" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>