You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

57 lines
11 KiB

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

<!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="Utilities for random number generation"><meta name="keywords" content="rust, rustlang, rust-lang, rand"><title>rand - 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" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script src="../crates.js"></script><script defer src="../main.js"></script>
<noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" href="https://www.rust-lang.org/favicon.ico"></head><body class="rustdoc mod crate"><!--[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="../rand/index.html"><div class="logo-container"><img src="https://www.rust-lang.org/logos/rust-logo-128x128-blk.png" alt="logo"></div>
</a><h2 class="location"></h2>
</nav>
<nav class="sidebar"><a class="sidebar-logo" 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><h2 class="location"><a href="#">Crate rand</a></h2><div class="sidebar-elems"><div class="block"><ul><li class="version">Version 0.8.5</li><li><a id="all-types" href="all.html">All Items</a></li></div></ul><section><div class="block"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></div></section><div id="sidebar-vars" data-name="rand" data-ty="mod" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../rand/index.html">
<img src="https://www.rust-lang.org/logos/rust-logo-128x128-blk.png" alt="logo"></a><nav class="sub"><div class="theme-picker hidden"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="22" height="22" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><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"><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><div class="main-heading">
<h1 class="fqn"><span class="in-band">Crate <a class="mod" href="#">rand</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></span></h1><span class="out-of-band"><a class="srclink" href="../src/rand/lib.rs.html#10-214">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>Utilities for random number generation</p>
<p>Rand provides utilities to generate random numbers, to convert them to
useful types and distributions, and some randomness-related algorithms.</p>
<h2 id="quick-start"><a href="#quick-start">Quick Start</a></h2>
<p>To get you started quickly, the easiest and highest-level way to get
a random value is to use <a href="fn.random.html" title="random()"><code>random()</code></a>; alternatively you can use
<a href="fn.thread_rng.html" title="thread_rng()"><code>thread_rng()</code></a>. The <a href="trait.Rng.html" title="Rng"><code>Rng</code></a> trait provides a useful API on all RNGs, while
the <a href="distributions/index.html" title="distributions"><code>distributions</code></a> and <a href="seq/index.html" title="seq"><code>seq</code></a> modules provide further
functionality on top of RNGs.</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">rand::prelude</span>::<span class="kw-2">*</span>;
<span class="kw">if</span> <span class="ident">rand::random</span>() { <span class="comment">// generates a boolean</span>
<span class="comment">// Try printing a random unicode code point (probably a bad idea)!</span>
<span class="macro">println!</span>(<span class="string">&quot;char: {}&quot;</span>, <span class="ident">rand::random</span>::<span class="op">&lt;</span><span class="ident">char</span><span class="op">&gt;</span>());
}
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">rng</span> <span class="op">=</span> <span class="ident">rand::thread_rng</span>();
<span class="kw">let</span> <span class="ident">y</span>: <span class="ident">f64</span> <span class="op">=</span> <span class="ident">rng</span>.<span class="ident">gen</span>(); <span class="comment">// generates a float between 0 and 1</span>
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">nums</span>: <span class="ident">Vec</span><span class="op">&lt;</span><span class="ident">i32</span><span class="op">&gt;</span> <span class="op">=</span> (<span class="number">1</span>..<span class="number">100</span>).<span class="ident">collect</span>();
<span class="ident">nums</span>.<span class="ident">shuffle</span>(<span class="kw-2">&amp;mut</span> <span class="ident">rng</span>);</code></pre></div>
<h2 id="the-book"><a href="#the-book">The Book</a></h2>
<p>For the user guide and further documentation, please read
<a href="https://rust-random.github.io/book">The Rust Rand Book</a>.</p>
</div></details><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="distributions/index.html" title="rand::distributions mod">distributions</a></div><div class="item-right docblock-short"><p>Generating random samples from probability distributions</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="prelude/index.html" title="rand::prelude mod">prelude</a></div><div class="item-right docblock-short"><p>Convenience re-export of common members</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="rngs/index.html" title="rand::rngs mod">rngs</a></div><div class="item-right docblock-short"><p>Random number generators and adapters</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="seq/index.html" title="rand::seq mod">seq</a></div><div class="item-right docblock-short"><p>Sequence-related functionality</p>
</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.Error.html" title="rand::Error struct">Error</a></div><div class="item-right docblock-short"><p>Error type of random number generators</p>
</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.CryptoRng.html" title="rand::CryptoRng trait">CryptoRng</a></div><div class="item-right docblock-short"><p>A marker trait used to indicate that an <a href="trait.RngCore.html" title="RngCore"><code>RngCore</code></a> or <a href="../rand_core/block/trait.BlockRngCore.html"><code>BlockRngCore</code></a>
implementation is supposed to be cryptographically secure.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Fill.html" title="rand::Fill trait">Fill</a></div><div class="item-right docblock-short"><p>Types which may be filled with random data</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Rng.html" title="rand::Rng trait">Rng</a></div><div class="item-right docblock-short"><p>An automatically-implemented extension trait on <a href="trait.RngCore.html" title="RngCore"><code>RngCore</code></a> providing high-level
generic methods for sampling values and other convenience methods.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.RngCore.html" title="rand::RngCore trait">RngCore</a></div><div class="item-right docblock-short"><p>The core of a random number generator.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.SeedableRng.html" title="rand::SeedableRng trait">SeedableRng</a></div><div class="item-right docblock-short"><p>A random number generator that can be explicitly seeded.</p>
</div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.random.html" title="rand::random fn">random</a></div><div class="item-right docblock-short"><p>Generates a random value using the thread-local random number generator.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.thread_rng.html" title="rand::thread_rng fn">thread_rng</a></div><div class="item-right docblock-short"><p>Retrieve the lazily-initialized thread-local random number generator,
seeded by the system. Intended to be used in method chaining style,
e.g. <code>thread_rng().gen::&lt;i32&gt;()</code>, or cached locally, e.g.
<code>let mut rng = thread_rng();</code>. Invoked by the <code>Default</code> trait, making
<code>ThreadRng::default()</code> equivalent.</p>
</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="rand" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.62.1 (e092d0b6b 2022-07-16)" ></div>
</body></html>