<!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="Source to the Rust file `/Users/travis/.cargo/registry/src/github.com-1ecc6299db9ec823/num-bigint-0.1.43/src/lib.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>lib.rs.html -- source</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 source">
<!--[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">☰</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"><pre class="line-numbers"><span id="1"> 1</span>
<span id="2"> 2</span>
<span id="3"> 3</span>
<span id="4"> 4</span>
<span id="5"> 5</span>
<span id="6"> 6</span>
<span id="7"> 7</span>
<span id="8"> 8</span>
<span id="9"> 9</span>
<span id="10"> 10</span>
<span id="11"> 11</span>
<span id="12"> 12</span>
<span id="13"> 13</span>
<span id="14"> 14</span>
<span id="15"> 15</span>
<span id="16"> 16</span>
<span id="17"> 17</span>
<span id="18"> 18</span>
<span id="19"> 19</span>
<span id="20"> 20</span>
<span id="21"> 21</span>
<span id="22"> 22</span>
<span id="23"> 23</span>
<span id="24"> 24</span>
<span id="25"> 25</span>
<span id="26"> 26</span>
<span id="27"> 27</span>
<span id="28"> 28</span>
<span id="29"> 29</span>
<span id="30"> 30</span>
<span id="31"> 31</span>
<span id="32"> 32</span>
<span id="33"> 33</span>
<span id="34"> 34</span>
<span id="35"> 35</span>
<span id="36"> 36</span>
<span id="37"> 37</span>
<span id="38"> 38</span>
<span id="39"> 39</span>
<span id="40"> 40</span>
<span id="41"> 41</span>
<span id="42"> 42</span>
<span id="43"> 43</span>
<span id="44"> 44</span>
<span id="45"> 45</span>
<span id="46"> 46</span>
<span id="47"> 47</span>
<span id="48"> 48</span>
<span id="49"> 49</span>
<span id="50"> 50</span>
<span id="51"> 51</span>
<span id="52"> 52</span>
<span id="53"> 53</span>
<span id="54"> 54</span>
<span id="55"> 55</span>
<span id="56"> 56</span>
<span id="57"> 57</span>
<span id="58"> 58</span>
<span id="59"> 59</span>
<span id="60"> 60</span>
<span id="61"> 61</span>
<span id="62"> 62</span>
<span id="63"> 63</span>
<span id="64"> 64</span>
<span id="65"> 65</span>
<span id="66"> 66</span>
<span id="67"> 67</span>
<span id="68"> 68</span>
<span id="69"> 69</span>
<span id="70"> 70</span>
<span id="71"> 71</span>
<span id="72"> 72</span>
<span id="73"> 73</span>
<span id="74"> 74</span>
<span id="75"> 75</span>
<span id="76"> 76</span>
<span id="77"> 77</span>
<span id="78"> 78</span>
<span id="79"> 79</span>
<span id="80"> 80</span>
<span id="81"> 81</span>
<span id="82"> 82</span>
<span id="83"> 83</span>
<span id="84"> 84</span>
<span id="85"> 85</span>
<span id="86"> 86</span>
<span id="87"> 87</span>
<span id="88"> 88</span>
<span id="89"> 89</span>
<span id="90"> 90</span>
<span id="91"> 91</span>
<span id="92"> 92</span>
<span id="93"> 93</span>
<span id="94"> 94</span>
<span id="95"> 95</span>
<span id="96"> 96</span>
<span id="97"> 97</span>
<span id="98"> 98</span>
<span id="99"> 99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
</pre><pre class="rust ">
<span class="comment">// Copyright 2013-2014 The Rust Project Developers. See the COPYRIGHT</span>
<span class="comment">// file at the top-level directory of this distribution and at</span>
<span class="comment">// http://rust-lang.org/COPYRIGHT.</span>
<span class="comment">//</span>
<span class="comment">// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or</span>
<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license</span>
<span class="comment">// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your</span>
<span class="comment">// option. This file may not be copied, modified, or distributed</span>
<span class="comment">// except according to those terms.</span>
<span class="doccomment">//! A Big integer (signed version: `BigInt`, unsigned version: `BigUint`).</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! A `BigUint` is represented as a vector of `BigDigit`s.</span>
<span class="doccomment">//! A `BigInt` is a combination of `BigUint` and `Sign`.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Common numerical operations are overloaded, so we can treat them</span>
<span class="doccomment">//! the same way we treat other numbers.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ## Example</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ```rust</span>
<span class="doccomment">//! extern crate num_bigint;</span>
<span class="doccomment">//! extern crate num_traits;</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! # fn main() {</span>
<span class="doccomment">//! use num_bigint::BigUint;</span>
<span class="doccomment">//! use num_traits::{Zero, One};</span>
<span class="doccomment">//! use std::mem::replace;</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! // Calculate large fibonacci numbers.</span>
<span class="doccomment">//! fn fib(n: usize) -> BigUint {</span>
<span class="doccomment">//! let mut f0: BigUint = Zero::zero();</span>
<span class="doccomment">//! let mut f1: BigUint = One::one();</span>
<span class="doccomment">//! for _ in 0..n {</span>
<span class="doccomment">//! let f2 = f0 + &f1;</span>
<span class="doccomment">//! // This is a low cost way of swapping f0 with f1 and f1 with f2.</span>
<span class="doccomment">//! f0 = replace(&mut f1, f2);</span>
<span class="doccomment">//! }</span>
<span class="doccomment">//! f0</span>
<span class="doccomment">//! }</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! // This is a very large number.</span>
<span class="doccomment">//! println!("fib(1000) = {}", fib(1000));</span>
<span class="doccomment">//! # }</span>
<span class="doccomment">//! ```</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! It's easy to generate large random numbers:</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ```rust</span>
<span class="doccomment">//! extern crate rand;</span>
<span class="doccomment">//! extern crate num_bigint as bigint;</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! # #[cfg(feature = "rand")]</span>
<span class="doccomment">//! # fn main() {</span>
<span class="doccomment">//! use bigint::{ToBigInt, RandBigInt};</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! let mut rng = rand::thread_rng();</span>
<span class="doccomment">//! let a = rng.gen_bigint(1000);</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! let low = -10000.to_bigint().unwrap();</span>
<span class="doccomment">//! let high = 10000.to_bigint().unwrap();</span>
<span class="doccomment">//! let b = rng.gen_bigint_range(&low, &high);</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! // Probably an even larger number.</span>
<span class="doccomment">//! println!("{}", a * b);</span>
<span class="doccomment">//! # }</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! # #[cfg(not(feature = "rand"))]</span>
<span class="doccomment">//! # fn main() {</span>
<span class="doccomment">//! # }</span>
<span class="doccomment">//! ```</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ## Compatibility</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! The `num-bigint` crate is tested for rustc 1.8 and greater.</span>
<span class="attribute">#![<span class="ident">doc</span>(<span class="ident">html_root_url</span> <span class="op">=</span> <span class="string">"https://docs.rs/num-bigint/0.1"</span>)]</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rand"</span>, <span class="ident">test</span>))]</span>
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">rand</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rustc-serialize"</span>)]</span>
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">rustc_serialize</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"serde"</span>)]</span>
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">serde</span>;
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">num_integer</span> <span class="kw">as</span> <span class="ident">integer</span>;
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">num_traits</span> <span class="kw">as</span> <span class="ident">traits</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">error</span>::<span class="ident">Error</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">num</span>::<span class="ident">ParseIntError</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fmt</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">target_pointer_width</span> <span class="op">=</span> <span class="string">"32"</span>)]</span>
<span class="kw">type</span> <span class="ident">UsizePromotion</span> <span class="op">=</span> <span class="ident">u32</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">target_pointer_width</span> <span class="op">=</span> <span class="string">"64"</span>)]</span>
<span class="kw">type</span> <span class="ident">UsizePromotion</span> <span class="op">=</span> <span class="ident">u64</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">target_pointer_width</span> <span class="op">=</span> <span class="string">"32"</span>)]</span>
<span class="kw">type</span> <span class="ident">IsizePromotion</span> <span class="op">=</span> <span class="ident">i32</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">target_pointer_width</span> <span class="op">=</span> <span class="string">"64"</span>)]</span>
<span class="kw">type</span> <span class="ident">IsizePromotion</span> <span class="op">=</span> <span class="ident">i64</span>;
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">PartialEq</span>)]</span>
<span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">ParseBigIntError</span> {
<span class="ident">ParseInt</span>(<span class="ident">ParseIntError</span>),
<span class="ident">Other</span>,
}
<span class="kw">impl</span> <span class="ident">fmt</span>::<span class="ident">Display</span> <span class="kw">for</span> <span class="ident">ParseBigIntError</span> {
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span>) <span class="op">-></span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> {
<span class="kw">match</span> <span class="self">self</span> {
<span class="kw-2">&</span><span class="ident">ParseBigIntError</span>::<span class="ident">ParseInt</span>(<span class="kw-2">ref</span> <span class="ident">e</span>) <span class="op">=></span> <span class="ident">e</span>.<span class="ident">fmt</span>(<span class="ident">f</span>),
<span class="kw-2">&</span><span class="ident">ParseBigIntError</span>::<span class="ident">Other</span> <span class="op">=></span> <span class="string">"failed to parse provided string"</span>.<span class="ident">fmt</span>(<span class="ident">f</span>),
}
}
}
<span class="kw">impl</span> <span class="ident">Error</span> <span class="kw">for</span> <span class="ident">ParseBigIntError</span> {
<span class="kw">fn</span> <span class="ident">description</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="ident">str</span> {
<span class="string">"failed to parse bigint/biguint"</span>
}
}
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">ParseIntError</span><span class="op">></span> <span class="kw">for</span> <span class="ident">ParseBigIntError</span> {
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">err</span>: <span class="ident">ParseIntError</span>) <span class="op">-></span> <span class="ident">ParseBigIntError</span> {
<span class="ident">ParseBigIntError</span>::<span class="ident">ParseInt</span>(<span class="ident">err</span>)
}
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">hash</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
<span class="kw">fn</span> <span class="ident">hash</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">hash</span>::<span class="ident">Hash</span><span class="op">></span>(<span class="ident">x</span>: <span class="kw-2">&</span><span class="ident">T</span>) <span class="op">-></span> <span class="ident">u64</span> {
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">hash</span>::{<span class="ident">BuildHasher</span>, <span class="ident">Hasher</span>};
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">collections</span>::<span class="ident">hash_map</span>::<span class="ident">RandomState</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">hasher</span> <span class="op">=</span> <span class="op"><</span><span class="ident">RandomState</span> <span class="kw">as</span> <span class="ident">BuildHasher</span><span class="op">></span>::<span class="ident">Hasher</span>::<span class="ident">new</span>();
<span class="ident">x</span>.<span class="ident">hash</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">hasher</span>);
<span class="ident">hasher</span>.<span class="ident">finish</span>()
}
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
<span class="kw">mod</span> <span class="ident">macros</span>;
<span class="kw">mod</span> <span class="ident">biguint</span>;
<span class="kw">mod</span> <span class="ident">bigint</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">biguint</span>::<span class="ident">BigUint</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">biguint</span>::<span class="ident">ToBigUint</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">biguint</span>::<span class="ident">big_digit</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">biguint</span>::<span class="ident">big_digit</span>::{<span class="ident">BigDigit</span>, <span class="ident">DoubleBigDigit</span>, <span class="ident">ZERO_BIG_DIGIT</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">bigint</span>::<span class="ident">Sign</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">bigint</span>::<span class="ident">BigInt</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">bigint</span>::<span class="ident">ToBigInt</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">bigint</span>::<span class="ident">RandBigInt</span>;
</pre>
</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>⏎</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>