forked from diesel-rs/diesel
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
76 lines (70 loc) · 12.4 KB
/
Copy pathindex.html
File metadata and controls
76 lines (70 loc) · 12.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
<!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="A Big integer (signed version: `BigInt`, unsigned version: `BigUint`)."><meta name="keywords" content="rust, rustlang, rust-lang, num_bigint"><title>num_bigint - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><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="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="../crates.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../num_bigint/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div>
</a><h2 class="location"></h2>
</nav>
<nav class="sidebar"><a class="sidebar-logo" href="../num_bigint/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div>
</a><h2 class="location"><a href="#">Crate num_bigint</a></h2><div class="sidebar-elems"><div class="block"><ul><li class="version">Version 0.4.3</li><li><a id="all-types" href="all.html">All Items</a></li></ul></div><section><div class="block"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li></ul></div></section></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../num_bigint/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1">
<a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div>
</div></form></nav></div><section id="main-content" class="content"><div class="main-heading">
<h1 class="fqn"><span class="in-band">Crate <a class="mod" href="#">num_bigint</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/num_bigint/lib.rs.html#11-294">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><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>
<h3 id="example"><a href="#example">Example</a></h3>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">num_bigint::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::mem::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="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::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::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">&</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">&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="string">"fib(1000) = {}"</span>, <span class="ident">fib</span>(<span class="number">1000</span>));</code></pre></div>
<p>It’s easy to generate large random numbers:</p>
<div class='information'><div class='tooltip ignore'>ⓘ</div></div><div class="example-wrap"><pre class="rust rust-example-rendered ignore"><code><span class="kw">use</span> <span class="ident">num_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::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">&</span><span class="ident">low</span>, <span class="kw-2">&</span><span class="ident">high</span>);
<span class="comment">// Probably an even larger number.</span>
<span class="macro">println!</span>(<span class="string">"{}"</span>, <span class="ident">a</span> <span class="op">*</span> <span class="ident">b</span>);</code></pre></div>
<p>See the “Features” section for instructions for enabling random number generation.</p>
<h3 id="features"><a href="#features">Features</a></h3>
<p>The <code>std</code> crate feature is enabled by default, and is mandatory before Rust
1.36 and the stabilized <code>alloc</code> crate. If you depend on <code>num-bigint</code> with
<code>default-features = false</code>, you must manually enable the <code>std</code> feature yourself
if your compiler is not new enough.</p>
<h4 id="random-generation"><a href="#random-generation">Random Generation</a></h4>
<p><code>num-bigint</code> supports the generation of random big integers when the <code>rand</code>
feature is enabled. To enable it include rand as</p>
<div class="example-wrap"><pre class="language-toml"><code>rand = "0.8"
num-bigint = { version = "0.4", features = ["rand"] }</code></pre></div>
<p>Note that you must use the version of <code>rand</code> that <code>num-bigint</code> is compatible
with: <code>0.8</code>.</p>
<h3 id="compatibility"><a href="#compatibility">Compatibility</a></h3>
<p>The <code>num-bigint</code> crate is tested for rustc 1.31 and greater.</p>
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.BigInt.html" title="num_bigint::BigInt struct">BigInt</a></div><div class="item-right docblock-short"><p>A big signed integer type.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.BigUint.html" title="num_bigint::BigUint struct">BigUint</a></div><div class="item-right docblock-short"><p>A big unsigned integer type.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ParseBigIntError.html" title="num_bigint::ParseBigIntError struct">ParseBigIntError</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TryFromBigIntError.html" title="num_bigint::TryFromBigIntError struct">TryFromBigIntError</a></div><div class="item-right docblock-short"><p>The error type returned when a checked conversion regarding big integer fails.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.U32Digits.html" title="num_bigint::U32Digits struct">U32Digits</a></div><div class="item-right docblock-short"><p>An iterator of <code>u32</code> digits representation of a <code>BigUint</code> or <code>BigInt</code>,
ordered least significant digit first.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.U64Digits.html" title="num_bigint::U64Digits struct">U64Digits</a></div><div class="item-right docblock-short"><p>An iterator of <code>u64</code> digits representation of a <code>BigUint</code> or <code>BigInt</code>,
ordered least significant digit first.</p>
</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Sign.html" title="num_bigint::Sign enum">Sign</a></div><div class="item-right docblock-short"><p>A Sign is a <code>BigInt</code>’s composing element.</p>
</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.ToBigInt.html" title="num_bigint::ToBigInt trait">ToBigInt</a></div><div class="item-right docblock-short"><p>A generic trait for converting a value to a <code>BigInt</code>. This may return
<code>None</code> when converting from <code>f32</code> or <code>f64</code>, and will always succeed
when converting from any integer or unsigned primitive, or <code>BigUint</code>.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.ToBigUint.html" title="num_bigint::ToBigUint trait">ToBigUint</a></div><div class="item-right docblock-short"><p>A generic trait for converting a value to a <code>BigUint</code>.</p>
</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="num_bigint" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0-nightly (495b21669 2022-07-03)" ></div>
</body></html>