mentat/rand/distributions/struct.Gamma.html
2018-08-22 17:04:13 +00:00

175 lines
No EOL
16 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="API documentation for the Rust `Gamma` struct in crate `rand`.">
<meta name="keywords" content="rust, rustlang, rust-lang, Gamma">
<title>rand::distributions::Gamma - Rust</title>
<link rel="stylesheet" type="text/css" href="../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle">
<link rel="stylesheet" type="text/css" href="../../dark.css">
<link rel="stylesheet" type="text/css" href="../../main.css" id="themeStyle">
<script src="../../storage.js"></script>
<link rel="shortcut icon" href="https://www.rust-lang.org/favicon.ico">
</head>
<body class="rustdoc struct">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<div class="sidebar-menu">&#9776;</div>
<a href='../../rand/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk.png' alt='logo' width='100'></a>
<p class='location'>Struct Gamma</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Copy">Copy</a><a href="#impl-IndependentSample%3Cf64%3E">IndependentSample&lt;f64&gt;</a><a href="#impl-Clone">Clone</a><a href="#impl-Sample%3Cf64%3E">Sample&lt;f64&gt;</a></div></div><p class='location'><a href='../index.html'>rand</a>::<wbr><a href='index.html'>distributions</a></p><script>window.sidebarCurrent = {name: 'Gamma', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
</nav>
<div class="theme-picker">
<button id="theme-picker" aria-label="Pick another theme!">
<img src="../../brush.svg" width="18" alt="Pick another theme!">
</button>
<div id="theme-choices"></div>
</div>
<script src="../../theme.js"></script>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press S to search, ? for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Struct <a href='../index.html'>rand</a>::<wbr><a href='index.html'>distributions</a>::<wbr><a class="struct" href=''>Gamma</a></span><span class='out-of-band'><span id='render-detail'>
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../../src/rand/distributions/gamma.rs.html#53-55' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct Gamma { /* fields omitted */ }</pre><div class='docblock'><p>The Gamma distribution <code>Gamma(shape, scale)</code> distribution.</p>
<p>The density function of this distribution is</p>
<pre><code class="language-text">f(x) = x^(k - 1) * exp(-x / θ) / (Γ(k) * θ^k)
</code></pre>
<p>where <code>Γ</code> is the Gamma function, <code>k</code> is the shape and <code>θ</code> is the
scale and both <code>k</code> and <code>θ</code> are strictly positive.</p>
<p>The algorithm used is that described by Marsaglia &amp; Tsang 2000[1],
falling back to directly sampling from an Exponential for <code>shape == 1</code>, and using the boosting technique described in [1] for
<code>shape &lt; 1</code>.</p>
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">rand</span>::<span class="ident">distributions</span>::{<span class="ident">IndependentSample</span>, <span class="ident">Gamma</span>};
<span class="kw">let</span> <span class="ident">gamma</span> <span class="op">=</span> <span class="ident">Gamma</span>::<span class="ident">new</span>(<span class="number">2.0</span>, <span class="number">5.0</span>);
<span class="kw">let</span> <span class="ident">v</span> <span class="op">=</span> <span class="ident">gamma</span>.<span class="ident">ind_sample</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">rand</span>::<span class="ident">thread_rng</span>());
<span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{} is from a Gamma(2, 5) distribution&quot;</span>, <span class="ident">v</span>);</pre>
<p>[1]: George Marsaglia and Wai Wan Tsang. 2000. &quot;A Simple Method
for Generating Gamma Variables&quot; <em>ACM Trans. Math. Softw.</em> 26, 3
(September 2000),
363-372. DOI:<a href="http://doi.acm.org/10.1145/358407.358414">10.1145/358407.358414</a></p>
</div>
<h2 id='methods' class='small-section-header'>
Methods<a href='#methods' class='anchor'></a>
</h2>
<h3 id='impl' class='impl'><span class='in-band'><code>impl <a class="struct" href="../../rand/distributions/gamma/struct.Gamma.html" title="struct rand::distributions::gamma::Gamma">Gamma</a></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/distributions/gamma.rs.html#95-114' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>pub fn <a href='#method.new' class='fnname'>new</a>(shape: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>, scale: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>) -&gt; <a class="struct" href="../../rand/distributions/gamma/struct.Gamma.html" title="struct rand::distributions::gamma::Gamma">Gamma</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/distributions/gamma.rs.html#101-113' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Construct an object representing the <code>Gamma(shape, scale)</code>
distribution.</p>
<p>Panics if <code>shape &lt;= 0</code> or <code>scale &lt;= 0</code>.</p>
</div></div>
<h2 id='implementations' class='small-section-header'>
Trait Implementations<a href='#implementations' class='anchor'></a>
</h2>
<h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../rand/distributions/gamma/struct.Gamma.html" title="struct rand::distributions::gamma::Gamma">Gamma</a></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/distributions/gamma.rs.html#52' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, __arg_0: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/distributions/gamma.rs.html#52' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></div><h3 id='impl-Copy' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="struct" href="../../rand/distributions/gamma/struct.Gamma.html" title="struct rand::distributions::gamma::Gamma">Gamma</a></code><a href='#impl-Copy' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/distributions/gamma.rs.html#52' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'></div><h3 id='impl-IndependentSample%3Cf64%3E' class='impl'><span class='in-band'><code>impl <a class="trait" href="../../rand/distributions/trait.IndependentSample.html" title="trait rand::distributions::IndependentSample">IndependentSample</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>&gt; for <a class="struct" href="../../rand/distributions/gamma/struct.Gamma.html" title="struct rand::distributions::gamma::Gamma">Gamma</a></code><a href='#impl-IndependentSample%3Cf64%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/distributions/gamma.rs.html#146-154' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.ind_sample' class="method"><span id='ind_sample.v' class='invisible'><code>fn <a href='../../rand/distributions/trait.IndependentSample.html#tymethod.ind_sample' class='fnname'>ind_sample</a>&lt;R&gt;(&amp;self, rng: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>R) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a> <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;R: <a class="trait" href="../../rand/trait.Rng.html" title="trait rand::Rng">Rng</a>,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/distributions/gamma.rs.html#147-153' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Generate a random value.</p>
</div></div><h3 id='impl-Clone' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../rand/distributions/gamma/struct.Gamma.html" title="struct rand::distributions::gamma::Gamma">Gamma</a></code><a href='#impl-Clone' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/distributions/gamma.rs.html#52' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class="struct" href="../../rand/distributions/gamma/struct.Gamma.html" title="struct rand::distributions::gamma::Gamma">Gamma</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/distributions/gamma.rs.html#52' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self)</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#112-114' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></div><h3 id='impl-Sample%3Cf64%3E' class='impl'><span class='in-band'><code>impl <a class="trait" href="../../rand/distributions/trait.Sample.html" title="trait rand::distributions::Sample">Sample</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>&gt; for <a class="struct" href="../../rand/distributions/gamma/struct.Gamma.html" title="struct rand::distributions::gamma::Gamma">Gamma</a></code><a href='#impl-Sample%3Cf64%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/distributions/gamma.rs.html#136-138' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.sample' class="method"><span id='sample.v' class='invisible'><code>fn <a href='../../rand/distributions/trait.Sample.html#tymethod.sample' class='fnname'>sample</a>&lt;R&gt;(&amp;mut self, rng: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>R) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a> <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;R: <a class="trait" href="../../rand/trait.Rng.html" title="trait rand::Rng">Rng</a>,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/distributions/gamma.rs.html#137' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Generate a random value of <code>Support</code>, using <code>rng</code> as the source of randomness. <a href="../../rand/distributions/trait.Sample.html#tymethod.sample">Read more</a></p>
</div></div></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>&#9166;</kbd></dt>
<dd>Go to active search result</dd>
<dt><kbd>+</kbd></dt>
<dd>Expand all sections</dd>
<dt><kbd>-</kbd></dt>
<dd>Collapse all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../../";
window.currentCrate = "rand";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>