mitchellhansen
/
Trac3r-rust
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
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.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'da836f318e'
${ noResults }
Trac3r-rust/doc/num_bigint/index.html

63 lines
12 KiB
Raw Blame History Escape

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="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="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../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">&#9776;</div><a href='../num_bigint/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate num_bigint</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all num_bigint's items</p></a><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"><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'>&#x2212;</span>]</a></span><a class='srclink' href='../src/num_bigint/lib.rs.html#11-156' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>num_bigint</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>
<div class="example-wrap"><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">-</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">_</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></div>
<p>It's easy to generate large random numbers:</p>
<div class="example-wrap"><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></div>
<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='num_bigint::big_digit mod'>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='num_bigint::BigInt struct'>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='num_bigint::BigUint struct'>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='num_bigint::ParseBigIntError enum'>ParseBigIntError</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="enum" href="enum.Sign.html" title='num_bigint::Sign enum'>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='num_bigint::ZERO_BIG_DIGIT constant'>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='num_bigint::RandBigInt trait'>RandBigInt</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="trait" href="trait.ToBigInt.html" title='num_bigint::ToBigInt trait'>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='num_bigint::ToBigUint trait'>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='num_bigint::BigDigit type'>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='num_bigint::DoubleBigDigit type'>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><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 = "num_bigint";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
Reference in new issue View Git Blame Copy Permalink