148 lines
No EOL
8.5 KiB
HTML
148 lines
No EOL
8.5 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 `RandomInt` trait in crate `ramp`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, RandomInt">
|
||
|
||
<title>ramp::int::RandomInt - Rust</title>
|
||
|
||
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
|
||
<link rel="stylesheet" type="text/css" href="../../main.css">
|
||
|
||
|
||
|
||
|
||
</head>
|
||
<body class="rustdoc">
|
||
<!--[if lte IE 8]>
|
||
<div class="warning">
|
||
This old browser is unsupported and will most likely display funky
|
||
things.
|
||
</div>
|
||
<![endif]-->
|
||
|
||
|
||
|
||
<nav class="sidebar">
|
||
|
||
<p class='location'><a href='../index.html'>ramp</a>::<wbr><a href='index.html'>int</a></p><script>window.sidebarCurrent = {name: 'RandomInt', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script>
|
||
</nav>
|
||
|
||
<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 trait">
|
||
<h1 class='fqn'><span class='in-band'>Trait <a href='../index.html'>ramp</a>::<wbr><a href='index.html'>int</a>::<wbr><a class='trait' href=''>RandomInt</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'>−</span>]
|
||
</a>
|
||
</span><a id='src-3146' class='srclink' href='../../src/ramp/int.rs.html#3464-3476' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust trait'>pub trait RandomInt {
|
||
fn <a href='#tymethod.gen_uint' class='fnname'>gen_uint</a>(&mut self, bits: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.usize.html'>usize</a>) -> <a class='struct' href='../../ramp/int/struct.Int.html' title='ramp::int::Int'>Int</a>;
|
||
fn <a href='#tymethod.gen_int' class='fnname'>gen_int</a>(&mut self, bits: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.usize.html'>usize</a>) -> <a class='struct' href='../../ramp/int/struct.Int.html' title='ramp::int::Int'>Int</a>;
|
||
fn <a href='#tymethod.gen_uint_below' class='fnname'>gen_uint_below</a>(&mut self, bound: &<a class='struct' href='../../ramp/int/struct.Int.html' title='ramp::int::Int'>Int</a>) -> <a class='struct' href='../../ramp/int/struct.Int.html' title='ramp::int::Int'>Int</a>;
|
||
fn <a href='#tymethod.gen_int_range' class='fnname'>gen_int_range</a>(&mut self, lbound: &<a class='struct' href='../../ramp/int/struct.Int.html' title='ramp::int::Int'>Int</a>, ubound: &<a class='struct' href='../../ramp/int/struct.Int.html' title='ramp::int::Int'>Int</a>) -> <a class='struct' href='../../ramp/int/struct.Int.html' title='ramp::int::Int'>Int</a>;
|
||
}</pre><div class='docblock'><p>Trait for generating random <code>Int</code>.</p>
|
||
|
||
<h1 id='example' class='section-header'><a href='#example'>Example</a></h1>
|
||
<p>Generate a random <code>Int</code> of size <code>256</code> bits:</p>
|
||
|
||
<pre class='rust rust-example-rendered'>
|
||
<span class='kw'>extern</span> <span class='kw'>crate</span> <span class='ident'>rand</span>;
|
||
<span class='kw'>extern</span> <span class='kw'>crate</span> <span class='ident'>ramp</span>;
|
||
|
||
<span class='kw'>use</span> <span class='ident'>ramp</span>::<span class='ident'>RandomInt</span>;
|
||
|
||
<span class='kw'>fn</span> <span class='ident'>main</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</span>::<span class='ident'>thread_rng</span>();
|
||
<span class='kw'>let</span> <span class='ident'>big_i</span> <span class='op'>=</span> <span class='ident'>rng</span>.<span class='ident'>gen_int</span>(<span class='number'>256</span>);
|
||
}</pre>
|
||
</div>
|
||
<h2 id='required-methods'>Required Methods</h2>
|
||
<div class='methods'>
|
||
<h3 id='tymethod.gen_uint' class='method stab '><code>fn <a href='#tymethod.gen_uint' class='fnname'>gen_uint</a>(&mut self, bits: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.usize.html'>usize</a>) -> <a class='struct' href='../../ramp/int/struct.Int.html' title='ramp::int::Int'>Int</a></code></h3><div class='docblock'><p>Generate a random unsigned <code>Int</code> of given bit size.</p>
|
||
</div><h3 id='tymethod.gen_int' class='method stab '><code>fn <a href='#tymethod.gen_int' class='fnname'>gen_int</a>(&mut self, bits: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.usize.html'>usize</a>) -> <a class='struct' href='../../ramp/int/struct.Int.html' title='ramp::int::Int'>Int</a></code></h3><div class='docblock'><p>Generate a random <code>Int</code> of given bit size.</p>
|
||
</div><h3 id='tymethod.gen_uint_below' class='method stab '><code>fn <a href='#tymethod.gen_uint_below' class='fnname'>gen_uint_below</a>(&mut self, bound: &<a class='struct' href='../../ramp/int/struct.Int.html' title='ramp::int::Int'>Int</a>) -> <a class='struct' href='../../ramp/int/struct.Int.html' title='ramp::int::Int'>Int</a></code></h3><div class='docblock'><p>Generate a random unsigned <code>Int</code> less than the given bound.
|
||
Fails when the bound is zero or negative.</p>
|
||
</div><h3 id='tymethod.gen_int_range' class='method stab '><code>fn <a href='#tymethod.gen_int_range' class='fnname'>gen_int_range</a>(&mut self, lbound: &<a class='struct' href='../../ramp/int/struct.Int.html' title='ramp::int::Int'>Int</a>, ubound: &<a class='struct' href='../../ramp/int/struct.Int.html' title='ramp::int::Int'>Int</a>) -> <a class='struct' href='../../ramp/int/struct.Int.html' title='ramp::int::Int'>Int</a></code></h3><div class='docblock'><p>Generate a random <code>Int</code> within the given range.
|
||
The lower bound is inclusive; the upper bound is exclusive.
|
||
Fails when the upper bound is not greater than the lower bound.</p>
|
||
</div></div>
|
||
<h2 id='implementors'>Implementors</h2>
|
||
<ul class='item-list' id='implementors-list'>
|
||
<li><code>impl<R: <a class='trait' href='../../rand/trait.Rng.html' title='rand::Rng'>Rng</a>> RandomInt for R</code></li>
|
||
</ul><script type="text/javascript" async
|
||
src="../../implementors/ramp/int/trait.RandomInt.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>?</dt>
|
||
<dd>Show this help dialog</dd>
|
||
<dt>S</dt>
|
||
<dd>Focus the search field</dd>
|
||
<dt>⇤</dt>
|
||
<dd>Move up in search results</dd>
|
||
<dt>⇥</dt>
|
||
<dd>Move down in search results</dd>
|
||
<dt>⏎</dt>
|
||
<dd>Go to active search result</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 = "ramp";
|
||
window.playgroundUrl = "";
|
||
</script>
|
||
<script src="../../jquery.js"></script>
|
||
<script src="../../main.js"></script>
|
||
|
||
<script defer src="../../search-index.js"></script>
|
||
</body>
|
||
</html> |