RONCC
/
HPC-Tools-for-Quantum-Computing


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

    <title>num_bigint - 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 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">&#9776;</div>
        
        <p class='location'>Crate num_bigint</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#constants">Constants</a></li><li><a href="#traits">Traits</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'num_bigint', 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">
                <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'>Crate <a class="mod" href=''>num_bigint</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/lib.rs.html#11-156' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>A Big integer (signed version: <code>BigInt</code>, unsigned version: <code>BigUint</code>).</p>
<p>A <code>BigUint</code> is represented as a vector of <code>BigDigit</code>s.
A <code>BigInt</code> is a combination of <code>BigUint</code> and <code>Sign</code>.</p>
<p>Common numerical operations are overloaded, so we can treat them
the same way we treat other numbers.</p>
<h2 id="example" class="section-header"><a href="#example">Example</a></h2>
<pre class="rust rust-example-rendered">
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">num_bigint</span>;
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">num_traits</span>;

<span class="kw">use</span> <span class="ident">num_bigint</span>::<span class="ident">BigUint</span>;
<span class="kw">use</span> <span class="ident">num_traits</span>::{<span class="ident">Zero</span>, <span class="ident">One</span>};
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">mem</span>::<span class="ident">replace</span>;

<span class="comment">// Calculate large fibonacci numbers.</span>
<span class="kw">fn</span> <span class="ident">fib</span>(<span class="ident">n</span>: <span class="ident">usize</span>) <span class="op">-&gt;</span> <span class="ident">BigUint</span> {
    <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">f0</span>: <span class="ident">BigUint</span> <span class="op">=</span> <span class="ident">Zero</span>::<span class="ident">zero</span>();
    <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">f1</span>: <span class="ident">BigUint</span> <span class="op">=</span> <span class="ident">One</span>::<span class="ident">one</span>();
    <span class="kw">for</span> _ <span class="kw">in</span> <span class="number">0</span>..<span class="ident">n</span> {
        <span class="kw">let</span> <span class="ident">f2</span> <span class="op">=</span> <span class="ident">f0</span> <span class="op">+</span> <span class="kw-2">&amp;</span><span class="ident">f1</span>;
        <span class="comment">// This is a low cost way of swapping f0 with f1 and f1 with f2.</span>
        <span class="ident">f0</span> <span class="op">=</span> <span class="ident">replace</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">f1</span>, <span class="ident">f2</span>);
    }
    <span class="ident">f0</span>
}

<span class="comment">// This is a very large number.</span>
<span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;fib(1000) = {}&quot;</span>, <span class="ident">fib</span>(<span class="number">1000</span>));</pre>
<p>It's easy to generate large random numbers:</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">num_bigint</span> <span class="kw">as</span> <span class="ident">bigint</span>;

<span class="kw">use</span> <span class="ident">bigint</span>::{<span class="ident">ToBigInt</span>, <span class="ident">RandBigInt</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">a</span> <span class="op">=</span> <span class="ident">rng</span>.<span class="ident">gen_bigint</span>(<span class="number">1000</span>);

<span class="kw">let</span> <span class="ident">low</span> <span class="op">=</span> <span class="op">-</span><span class="number">10000</span>.<span class="ident">to_bigint</span>().<span class="ident">unwrap</span>();
<span class="kw">let</span> <span class="ident">high</span> <span class="op">=</span> <span class="number">10000</span>.<span class="ident">to_bigint</span>().<span class="ident">unwrap</span>();
<span class="kw">let</span> <span class="ident">b</span> <span class="op">=</span> <span class="ident">rng</span>.<span class="ident">gen_bigint_range</span>(<span class="kw-2">&amp;</span><span class="ident">low</span>, <span class="kw-2">&amp;</span><span class="ident">high</span>);

<span class="comment">// Probably an even larger number.</span>
<span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{}&quot;</span>, <span class="ident">a</span> <span class="op">*</span> <span class="ident">b</span>);
</pre>
<h2 id="compatibility" class="section-header"><a href="#compatibility">Compatibility</a></h2>
<p>The <code>num-bigint</code> crate is tested for rustc 1.8 and greater.</p>
</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
<table>
                       <tr class=' module-item'>
                           <td><a class="mod" href="big_digit/index.html"
                                  title='mod num_bigint::big_digit'>big_digit</a></td>
                           <td class='docblock-short'>
                                
                           </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.BigInt.html"
                                  title='struct num_bigint::BigInt'>BigInt</a></td>
                           <td class='docblock-short'>
                                <p>A big signed integer type.</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.BigUint.html"
                                  title='struct num_bigint::BigUint'>BigUint</a></td>
                           <td class='docblock-short'>
                                <p>A big unsigned integer type.</p>

                           </td>
                       </tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
<table>
                       <tr class=' module-item'>
                           <td><a class="enum" href="enum.ParseBigIntError.html"
                                  title='enum num_bigint::ParseBigIntError'>ParseBigIntError</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="enum" href="enum.Sign.html"
                                  title='enum num_bigint::Sign'>Sign</a></td>
                           <td class='docblock-short'>
                                <p>A Sign is a <code>BigInt</code>'s composing element.</p>

                           </td>
                       </tr></table><h2 id='constants' class='section-header'><a href="#constants">Constants</a></h2>
<table>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.ZERO_BIG_DIGIT.html"
                                  title='constant num_bigint::ZERO_BIG_DIGIT'>ZERO_BIG_DIGIT</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
<table>
                       <tr class=' module-item'>
                           <td><a class="trait" href="trait.RandBigInt.html"
                                  title='trait num_bigint::RandBigInt'>RandBigInt</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="trait" href="trait.ToBigInt.html"
                                  title='trait num_bigint::ToBigInt'>ToBigInt</a></td>
                           <td class='docblock-short'>
                                <p>A generic trait for converting a value to a <code>BigInt</code>.</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="trait" href="trait.ToBigUint.html"
                                  title='trait num_bigint::ToBigUint'>ToBigUint</a></td>
                           <td class='docblock-short'>
                                <p>A generic trait for converting a value to a <code>BigUint</code>.</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.BigDigit.html"
                                  title='type num_bigint::BigDigit'>BigDigit</a></td>
                           <td class='docblock-short'>
                                <p>A <code>BigDigit</code> is a <code>BigUint</code>'s composing element.</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="type" href="type.DoubleBigDigit.html"
                                  title='type num_bigint::DoubleBigDigit'>DoubleBigDigit</a></td>
                           <td class='docblock-short'>
                                <p>A <code>DoubleBigDigit</code> is the internal type used to do the computations.  Its
size is the double of the size of <code>BigDigit</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>&#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>