|
|
<!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 `rand_pcg` crate."><meta name="keywords" content="rust, rustlang, rust-lang, rand_pcg"><title>rand_pcg - 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 mod"><!--[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_pcg/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'>Crate rand_pcg</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all rand_pcg's items</p></a><div class="block items"><ul><li><a href="#reexports">Re-exports</a></li><li><a href="#structs">Structs</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'rand_pcg', ty: 'mod', relpath: '../'};</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_pcg/lib.rs.html#9-48' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>rand_pcg</a></span></h1><div class='docblock'><p>The PCG random number generators.</p>
|
|
|
<p>This is a native Rust implementation of a small selection of PCG generators.
|
|
|
The primary goal of this crate is simple, minimal, well-tested code; in
|
|
|
other words it is explicitly not a goal to re-implement all of PCG.</p>
|
|
|
<p>This crate provides:</p>
|
|
|
<ul>
|
|
|
<li><code>Pcg32</code> aka <code>Lcg64Xsh32</code>, officially known as <code>pcg32</code>, a general
|
|
|
purpose RNG. This is a good choice on both 32-bit and 64-bit CPUs
|
|
|
(for 32-bit output).</li>
|
|
|
<li><code>Pcg64Mcg</code> aka <code>Mcg128Xsl64</code>, officially known as <code>mcg_xsl_rr_128_64</code>,
|
|
|
a general purpose RNG using 128-bit multiplications. This has poor
|
|
|
performance on 32-bit CPUs but is a good choice on 64-bit CPUs for
|
|
|
both 32-bit and 64-bit output. (Note: this RNG is only available using
|
|
|
Rust 1.26 or later.)</li>
|
|
|
</ul>
|
|
|
<p>Both of these use 16 bytes of state and 128-bit seeds, and are considered
|
|
|
value-stable (i.e. any change affecting the output given a fixed seed would
|
|
|
be considered a breaking change to the crate).</p>
|
|
|
</div><h2 id='reexports' class='section-header'><a href="#reexports">Re-exports</a></h2>
|
|
|
<table><tr><td><code>pub extern crate <a class="mod" href="../rand_core/index.html" title="mod rand_core">rand_core</a>;</code></td></tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="struct" href="struct.Lcg64Xsh32.html" title='rand_pcg::Lcg64Xsh32 struct'>Lcg64Xsh32</a></td><td class='docblock-short'><p>A PCG random number generator (XSH RR 64/32 (LCG) variant).</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Mcg128Xsl64.html" title='rand_pcg::Mcg128Xsl64 struct'>Mcg128Xsl64</a></td><td class='docblock-short'><p>A PCG random number generator (XSL 128/64 (MCG) variant).</p>
|
|
|
</td></tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="type" href="type.Pcg32.html" title='rand_pcg::Pcg32 type'>Pcg32</a></td><td class='docblock-short'><p><code>Lcg64Xsh32</code> is also officially known as <code>pcg32</code>.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="type" href="type.Pcg64Mcg.html" title='rand_pcg::Pcg64Mcg type'>Pcg64Mcg</a></td><td class='docblock-short'><p>A friendly name for <code>Mcg128Xsl64</code>.</p>
|
|
|
</td></tr></table></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_pcg";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |
