RONCC
/
HPC-Tools-for-Quantum-Computing


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156
							<!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 `RandBigInt` trait in crate `num_bigint`.">
    <meta name="keywords" content="rust, rustlang, rust-lang, RandBigInt">

    <title>num_bigint::RandBigInt - 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>
    

    
    
</head>
<body class="rustdoc trait">
    <!--[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>
        
        <p class='location'>Trait RandBigInt</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.gen_biguint">gen_biguint</a><a href="#tymethod.gen_bigint">gen_bigint</a><a href="#tymethod.gen_biguint_below">gen_biguint_below</a><a href="#tymethod.gen_biguint_range">gen_biguint_range</a><a href="#tymethod.gen_bigint_range">gen_bigint_range</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>num_bigint</a></p><script>window.sidebarCurrent = {name: 'RandBigInt', ty: 'trait', 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'>Trait <a href='index.html'>num_bigint</a>::<wbr><a class="trait" href=''>RandBigInt</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/num_bigint/bigint.rs.html#1285-1305' title='goto source code'>[src]</a></span></h1>
<pre class='rust trait'>pub trait RandBigInt {
    fn <a href='#tymethod.gen_biguint' class='fnname'>gen_biguint</a>(&amp;mut self, bit_size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -&gt; <a class="struct" href="../num_bigint/struct.BigUint.html" title="struct num_bigint::BigUint">BigUint</a>;
<div class='item-spacer'></div>    fn <a href='#tymethod.gen_bigint' class='fnname'>gen_bigint</a>(&amp;mut self, bit_size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -&gt; <a class="struct" href="../num_bigint/struct.BigInt.html" title="struct num_bigint::BigInt">BigInt</a>;
<div class='item-spacer'></div>    fn <a href='#tymethod.gen_biguint_below' class='fnname'>gen_biguint_below</a>(&amp;mut self, bound: &amp;<a class="struct" href="../num_bigint/struct.BigUint.html" title="struct num_bigint::BigUint">BigUint</a>) -&gt; <a class="struct" href="../num_bigint/struct.BigUint.html" title="struct num_bigint::BigUint">BigUint</a>;
<div class='item-spacer'></div>    fn <a href='#tymethod.gen_biguint_range' class='fnname'>gen_biguint_range</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lbound: &amp;<a class="struct" href="../num_bigint/struct.BigUint.html" title="struct num_bigint::BigUint">BigUint</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ubound: &amp;<a class="struct" href="../num_bigint/struct.BigUint.html" title="struct num_bigint::BigUint">BigUint</a><br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <a class="struct" href="../num_bigint/struct.BigUint.html" title="struct num_bigint::BigUint">BigUint</a>;
<div class='item-spacer'></div>    fn <a href='#tymethod.gen_bigint_range' class='fnname'>gen_bigint_range</a>(&amp;mut self, lbound: &amp;<a class="struct" href="../num_bigint/struct.BigInt.html" title="struct num_bigint::BigInt">BigInt</a>, ubound: &amp;<a class="struct" href="../num_bigint/struct.BigInt.html" title="struct num_bigint::BigInt">BigInt</a>) -&gt; <a class="struct" href="../num_bigint/struct.BigInt.html" title="struct num_bigint::BigInt">BigInt</a>;
}</pre>
            <h2 id='required-methods' class='small-section-header'>
              Required Methods<a href='#required-methods' class='anchor'></a>
            </h2>
            <div class='methods'>
        <h3 id='tymethod.gen_biguint' class='method'><span id='gen_biguint.v' class='invisible'><code>fn <a href='#tymethod.gen_biguint' class='fnname'>gen_biguint</a>(&amp;mut self, bit_size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -&gt; <a class="struct" href="../num_bigint/struct.BigUint.html" title="struct num_bigint::BigUint">BigUint</a></code></span></h3><div class='docblock'><p>Generate a random <code>BigUint</code> of the given bit size.</p>
</div><h3 id='tymethod.gen_bigint' class='method'><span id='gen_bigint.v' class='invisible'><code>fn <a href='#tymethod.gen_bigint' class='fnname'>gen_bigint</a>(&amp;mut self, bit_size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -&gt; <a class="struct" href="../num_bigint/struct.BigInt.html" title="struct num_bigint::BigInt">BigInt</a></code></span></h3><div class='docblock'><p>Generate a random BigInt of the given bit size.</p>
</div><h3 id='tymethod.gen_biguint_below' class='method'><span id='gen_biguint_below.v' class='invisible'><code>fn <a href='#tymethod.gen_biguint_below' class='fnname'>gen_biguint_below</a>(&amp;mut self, bound: &amp;<a class="struct" href="../num_bigint/struct.BigUint.html" title="struct num_bigint::BigUint">BigUint</a>) -&gt; <a class="struct" href="../num_bigint/struct.BigUint.html" title="struct num_bigint::BigUint">BigUint</a></code></span></h3><div class='docblock'><p>Generate a random <code>BigUint</code> less than the given bound. Fails
when the bound is zero.</p>
</div><h3 id='tymethod.gen_biguint_range' class='method'><span id='gen_biguint_range.v' class='invisible'><code>fn <a href='#tymethod.gen_biguint_range' class='fnname'>gen_biguint_range</a>(&amp;mut self, lbound: &amp;<a class="struct" href="../num_bigint/struct.BigUint.html" title="struct num_bigint::BigUint">BigUint</a>, ubound: &amp;<a class="struct" href="../num_bigint/struct.BigUint.html" title="struct num_bigint::BigUint">BigUint</a>) -&gt; <a class="struct" href="../num_bigint/struct.BigUint.html" title="struct num_bigint::BigUint">BigUint</a></code></span></h3><div class='docblock'><p>Generate a random <code>BigUint</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><h3 id='tymethod.gen_bigint_range' class='method'><span id='gen_bigint_range.v' class='invisible'><code>fn <a href='#tymethod.gen_bigint_range' class='fnname'>gen_bigint_range</a>(&amp;mut self, lbound: &amp;<a class="struct" href="../num_bigint/struct.BigInt.html" title="struct num_bigint::BigInt">BigInt</a>, ubound: &amp;<a class="struct" href="../num_bigint/struct.BigInt.html" title="struct num_bigint::BigInt">BigInt</a>) -&gt; <a class="struct" href="../num_bigint/struct.BigInt.html" title="struct num_bigint::BigInt">BigInt</a></code></span></h3><div class='docblock'><p>Generate a random <code>BigInt</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' class='small-section-header'>
          Implementors<a href='#implementors' class='anchor'></a>
        </h2>
        <ul class='item-list' id='implementors-list'>
    <li><div class='out-of-band'><a class='srclink' href='../src/num_bigint/bigint.rs.html#1308-1365' title='goto source code'>[src]</a></div><code>impl&lt;R:&nbsp;<a class="trait" href="../rand/trait.Rng.html" title="trait rand::Rng">Rng</a>&gt; RandBigInt for R</code></li>
</ul><script type="text/javascript" async
                         src="../implementors/num_bigint/trait.RandBigInt.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><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 = "num_bigint";
    </script>
    <script src="../main.js"></script>
    <script defer src="../search-index.js"></script>
</body>
</html>