269 lines
25 KiB
HTML
269 lines
25 KiB
HTML
<!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 of the Rust file `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/num-bigint-0.4.6/src/lib.rs`."><title>lib.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="num_bigint" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">num_bigint/</div>lib.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="comment">// Copyright 2013-2014 The Rust Project Developers. See the COPYRIGHT
|
|
<a href=#2 id=2 data-nosnippet>2</a>// file at the top-level directory of this distribution and at
|
|
<a href=#3 id=3 data-nosnippet>3</a>// http://rust-lang.org/COPYRIGHT.
|
|
<a href=#4 id=4 data-nosnippet>4</a>//
|
|
<a href=#5 id=5 data-nosnippet>5</a>// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
|
|
<a href=#6 id=6 data-nosnippet>6</a>// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
|
|
<a href=#7 id=7 data-nosnippet>7</a>// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
|
|
<a href=#8 id=8 data-nosnippet>8</a>// option. This file may not be copied, modified, or distributed
|
|
<a href=#9 id=9 data-nosnippet>9</a>// except according to those terms.
|
|
<a href=#10 id=10 data-nosnippet>10</a>
|
|
<a href=#11 id=11 data-nosnippet>11</a></span><span class="doccomment">//! Big Integer Types for Rust
|
|
<a href=#12 id=12 data-nosnippet>12</a>//!
|
|
<a href=#13 id=13 data-nosnippet>13</a>//! * A [`BigUint`] is unsigned and represented as a vector of digits.
|
|
<a href=#14 id=14 data-nosnippet>14</a>//! * A [`BigInt`] is signed and is a combination of [`BigUint`] and [`Sign`].
|
|
<a href=#15 id=15 data-nosnippet>15</a>//!
|
|
<a href=#16 id=16 data-nosnippet>16</a>//! Common numerical operations are overloaded, so we can treat them
|
|
<a href=#17 id=17 data-nosnippet>17</a>//! the same way we treat other numbers.
|
|
<a href=#18 id=18 data-nosnippet>18</a>//!
|
|
<a href=#19 id=19 data-nosnippet>19</a>//! ## Example
|
|
<a href=#20 id=20 data-nosnippet>20</a>//!
|
|
<a href=#21 id=21 data-nosnippet>21</a>//! ```rust
|
|
<a href=#22 id=22 data-nosnippet>22</a>//! # fn main() {
|
|
<a href=#23 id=23 data-nosnippet>23</a>//! use num_bigint::BigUint;
|
|
<a href=#24 id=24 data-nosnippet>24</a>//! use num_traits::One;
|
|
<a href=#25 id=25 data-nosnippet>25</a>//!
|
|
<a href=#26 id=26 data-nosnippet>26</a>//! // Calculate large fibonacci numbers.
|
|
<a href=#27 id=27 data-nosnippet>27</a>//! fn fib(n: usize) -> BigUint {
|
|
<a href=#28 id=28 data-nosnippet>28</a>//! let mut f0 = BigUint::ZERO;
|
|
<a href=#29 id=29 data-nosnippet>29</a>//! let mut f1 = BigUint::one();
|
|
<a href=#30 id=30 data-nosnippet>30</a>//! for _ in 0..n {
|
|
<a href=#31 id=31 data-nosnippet>31</a>//! let f2 = f0 + &f1;
|
|
<a href=#32 id=32 data-nosnippet>32</a>//! f0 = f1;
|
|
<a href=#33 id=33 data-nosnippet>33</a>//! f1 = f2;
|
|
<a href=#34 id=34 data-nosnippet>34</a>//! }
|
|
<a href=#35 id=35 data-nosnippet>35</a>//! f0
|
|
<a href=#36 id=36 data-nosnippet>36</a>//! }
|
|
<a href=#37 id=37 data-nosnippet>37</a>//!
|
|
<a href=#38 id=38 data-nosnippet>38</a>//! // This is a very large number.
|
|
<a href=#39 id=39 data-nosnippet>39</a>//! println!("fib(1000) = {}", fib(1000));
|
|
<a href=#40 id=40 data-nosnippet>40</a>//! # }
|
|
<a href=#41 id=41 data-nosnippet>41</a>//! ```
|
|
<a href=#42 id=42 data-nosnippet>42</a>//!
|
|
<a href=#43 id=43 data-nosnippet>43</a>//! It's easy to generate large random numbers:
|
|
<a href=#44 id=44 data-nosnippet>44</a>//!
|
|
<a href=#45 id=45 data-nosnippet>45</a>//! ```rust,ignore
|
|
<a href=#46 id=46 data-nosnippet>46</a>//! use num_bigint::{ToBigInt, RandBigInt};
|
|
<a href=#47 id=47 data-nosnippet>47</a>//!
|
|
<a href=#48 id=48 data-nosnippet>48</a>//! let mut rng = rand::thread_rng();
|
|
<a href=#49 id=49 data-nosnippet>49</a>//! let a = rng.gen_bigint(1000);
|
|
<a href=#50 id=50 data-nosnippet>50</a>//!
|
|
<a href=#51 id=51 data-nosnippet>51</a>//! let low = -10000.to_bigint().unwrap();
|
|
<a href=#52 id=52 data-nosnippet>52</a>//! let high = 10000.to_bigint().unwrap();
|
|
<a href=#53 id=53 data-nosnippet>53</a>//! let b = rng.gen_bigint_range(&low, &high);
|
|
<a href=#54 id=54 data-nosnippet>54</a>//!
|
|
<a href=#55 id=55 data-nosnippet>55</a>//! // Probably an even larger number.
|
|
<a href=#56 id=56 data-nosnippet>56</a>//! println!("{}", a * b);
|
|
<a href=#57 id=57 data-nosnippet>57</a>//! ```
|
|
<a href=#58 id=58 data-nosnippet>58</a>//!
|
|
<a href=#59 id=59 data-nosnippet>59</a>//! See the "Features" section for instructions for enabling random number generation.
|
|
<a href=#60 id=60 data-nosnippet>60</a>//!
|
|
<a href=#61 id=61 data-nosnippet>61</a>//! ## Features
|
|
<a href=#62 id=62 data-nosnippet>62</a>//!
|
|
<a href=#63 id=63 data-nosnippet>63</a>//! The `std` crate feature is enabled by default, which enables [`std::error::Error`]
|
|
<a href=#64 id=64 data-nosnippet>64</a>//! implementations and some internal use of floating point approximations. This can be disabled by
|
|
<a href=#65 id=65 data-nosnippet>65</a>//! depending on `num-bigint` with `default-features = false`. Either way, the `alloc` crate is
|
|
<a href=#66 id=66 data-nosnippet>66</a>//! always required for heap allocation of the `BigInt`/`BigUint` digits.
|
|
<a href=#67 id=67 data-nosnippet>67</a>//!
|
|
<a href=#68 id=68 data-nosnippet>68</a>//! ### Random Generation
|
|
<a href=#69 id=69 data-nosnippet>69</a>//!
|
|
<a href=#70 id=70 data-nosnippet>70</a>//! `num-bigint` supports the generation of random big integers when the `rand`
|
|
<a href=#71 id=71 data-nosnippet>71</a>//! feature is enabled. To enable it include rand as
|
|
<a href=#72 id=72 data-nosnippet>72</a>//!
|
|
<a href=#73 id=73 data-nosnippet>73</a>//! ```toml
|
|
<a href=#74 id=74 data-nosnippet>74</a>//! rand = "0.8"
|
|
<a href=#75 id=75 data-nosnippet>75</a>//! num-bigint = { version = "0.4", features = ["rand"] }
|
|
<a href=#76 id=76 data-nosnippet>76</a>//! ```
|
|
<a href=#77 id=77 data-nosnippet>77</a>//!
|
|
<a href=#78 id=78 data-nosnippet>78</a>//! Note that you must use the version of `rand` that `num-bigint` is compatible
|
|
<a href=#79 id=79 data-nosnippet>79</a>//! with: `0.8`.
|
|
<a href=#80 id=80 data-nosnippet>80</a>//!
|
|
<a href=#81 id=81 data-nosnippet>81</a>//! ### Arbitrary Big Integers
|
|
<a href=#82 id=82 data-nosnippet>82</a>//!
|
|
<a href=#83 id=83 data-nosnippet>83</a>//! `num-bigint` supports `arbitrary` and `quickcheck` features to implement
|
|
<a href=#84 id=84 data-nosnippet>84</a>//! [`arbitrary::Arbitrary`] and [`quickcheck::Arbitrary`], respectively, for both `BigInt` and
|
|
<a href=#85 id=85 data-nosnippet>85</a>//! `BigUint`. These are useful for fuzzing and other forms of randomized testing.
|
|
<a href=#86 id=86 data-nosnippet>86</a>//!
|
|
<a href=#87 id=87 data-nosnippet>87</a>//! ### Serialization
|
|
<a href=#88 id=88 data-nosnippet>88</a>//!
|
|
<a href=#89 id=89 data-nosnippet>89</a>//! The `serde` feature adds implementations of [`Serialize`][serde::Serialize] and
|
|
<a href=#90 id=90 data-nosnippet>90</a>//! [`Deserialize`][serde::Deserialize] for both `BigInt` and `BigUint`. Their serialized data is
|
|
<a href=#91 id=91 data-nosnippet>91</a>//! generated portably, regardless of platform differences like the internal digit size.
|
|
<a href=#92 id=92 data-nosnippet>92</a>//!
|
|
<a href=#93 id=93 data-nosnippet>93</a>//!
|
|
<a href=#94 id=94 data-nosnippet>94</a>//! ## Compatibility
|
|
<a href=#95 id=95 data-nosnippet>95</a>//!
|
|
<a href=#96 id=96 data-nosnippet>96</a>//! The `num-bigint` crate is tested for rustc 1.60 and greater.
|
|
<a href=#97 id=97 data-nosnippet>97</a>
|
|
<a href=#98 id=98 data-nosnippet>98</a></span><span class="attr">#![cfg_attr(docsrs, feature(doc_cfg))]
|
|
<a href=#99 id=99 data-nosnippet>99</a>#![doc(html_root_url = <span class="string">"https://docs.rs/num-bigint/0.4"</span>)]
|
|
<a href=#100 id=100 data-nosnippet>100</a>#![warn(rust_2018_idioms)]
|
|
<a href=#101 id=101 data-nosnippet>101</a>#![no_std]
|
|
<a href=#102 id=102 data-nosnippet>102</a>
|
|
<a href=#103 id=103 data-nosnippet>103</a>#[macro_use]
|
|
<a href=#104 id=104 data-nosnippet>104</a></span><span class="kw">extern crate </span>alloc;
|
|
<a href=#105 id=105 data-nosnippet>105</a>
|
|
<a href=#106 id=106 data-nosnippet>106</a><span class="attr">#[cfg(feature = <span class="string">"std"</span>)]
|
|
<a href=#107 id=107 data-nosnippet>107</a></span><span class="kw">extern crate </span>std;
|
|
<a href=#108 id=108 data-nosnippet>108</a>
|
|
<a href=#109 id=109 data-nosnippet>109</a><span class="kw">use </span>core::fmt;
|
|
<a href=#110 id=110 data-nosnippet>110</a>
|
|
<a href=#111 id=111 data-nosnippet>111</a><span class="attr">#[macro_use]
|
|
<a href=#112 id=112 data-nosnippet>112</a></span><span class="kw">mod </span>macros;
|
|
<a href=#113 id=113 data-nosnippet>113</a>
|
|
<a href=#114 id=114 data-nosnippet>114</a><span class="kw">mod </span>bigint;
|
|
<a href=#115 id=115 data-nosnippet>115</a><span class="kw">mod </span>bigrand;
|
|
<a href=#116 id=116 data-nosnippet>116</a><span class="kw">mod </span>biguint;
|
|
<a href=#117 id=117 data-nosnippet>117</a>
|
|
<a href=#118 id=118 data-nosnippet>118</a><span class="attr">#[cfg(target_pointer_width = <span class="string">"32"</span>)]
|
|
<a href=#119 id=119 data-nosnippet>119</a></span><span class="kw">type </span>UsizePromotion = u32;
|
|
<a href=#120 id=120 data-nosnippet>120</a><span class="attr">#[cfg(target_pointer_width = <span class="string">"64"</span>)]
|
|
<a href=#121 id=121 data-nosnippet>121</a></span><span class="kw">type </span>UsizePromotion = u64;
|
|
<a href=#122 id=122 data-nosnippet>122</a>
|
|
<a href=#123 id=123 data-nosnippet>123</a><span class="attr">#[cfg(target_pointer_width = <span class="string">"32"</span>)]
|
|
<a href=#124 id=124 data-nosnippet>124</a></span><span class="kw">type </span>IsizePromotion = i32;
|
|
<a href=#125 id=125 data-nosnippet>125</a><span class="attr">#[cfg(target_pointer_width = <span class="string">"64"</span>)]
|
|
<a href=#126 id=126 data-nosnippet>126</a></span><span class="kw">type </span>IsizePromotion = i64;
|
|
<a href=#127 id=127 data-nosnippet>127</a>
|
|
<a href=#128 id=128 data-nosnippet>128</a><span class="attr">#[derive(Debug, Clone, PartialEq, Eq)]
|
|
<a href=#129 id=129 data-nosnippet>129</a></span><span class="kw">pub struct </span>ParseBigIntError {
|
|
<a href=#130 id=130 data-nosnippet>130</a> kind: BigIntErrorKind,
|
|
<a href=#131 id=131 data-nosnippet>131</a>}
|
|
<a href=#132 id=132 data-nosnippet>132</a>
|
|
<a href=#133 id=133 data-nosnippet>133</a><span class="attr">#[derive(Debug, Clone, PartialEq, Eq)]
|
|
<a href=#134 id=134 data-nosnippet>134</a></span><span class="kw">enum </span>BigIntErrorKind {
|
|
<a href=#135 id=135 data-nosnippet>135</a> Empty,
|
|
<a href=#136 id=136 data-nosnippet>136</a> InvalidDigit,
|
|
<a href=#137 id=137 data-nosnippet>137</a>}
|
|
<a href=#138 id=138 data-nosnippet>138</a>
|
|
<a href=#139 id=139 data-nosnippet>139</a><span class="kw">impl </span>ParseBigIntError {
|
|
<a href=#140 id=140 data-nosnippet>140</a> <span class="kw">fn </span>__description(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>str {
|
|
<a href=#141 id=141 data-nosnippet>141</a> <span class="kw">use </span><span class="kw">crate</span>::BigIntErrorKind::<span class="kw-2">*</span>;
|
|
<a href=#142 id=142 data-nosnippet>142</a> <span class="kw">match </span><span class="self">self</span>.kind {
|
|
<a href=#143 id=143 data-nosnippet>143</a> Empty => <span class="string">"cannot parse integer from empty string"</span>,
|
|
<a href=#144 id=144 data-nosnippet>144</a> InvalidDigit => <span class="string">"invalid digit found in string"</span>,
|
|
<a href=#145 id=145 data-nosnippet>145</a> }
|
|
<a href=#146 id=146 data-nosnippet>146</a> }
|
|
<a href=#147 id=147 data-nosnippet>147</a>
|
|
<a href=#148 id=148 data-nosnippet>148</a> <span class="kw">fn </span>empty() -> <span class="self">Self </span>{
|
|
<a href=#149 id=149 data-nosnippet>149</a> ParseBigIntError {
|
|
<a href=#150 id=150 data-nosnippet>150</a> kind: BigIntErrorKind::Empty,
|
|
<a href=#151 id=151 data-nosnippet>151</a> }
|
|
<a href=#152 id=152 data-nosnippet>152</a> }
|
|
<a href=#153 id=153 data-nosnippet>153</a>
|
|
<a href=#154 id=154 data-nosnippet>154</a> <span class="kw">fn </span>invalid() -> <span class="self">Self </span>{
|
|
<a href=#155 id=155 data-nosnippet>155</a> ParseBigIntError {
|
|
<a href=#156 id=156 data-nosnippet>156</a> kind: BigIntErrorKind::InvalidDigit,
|
|
<a href=#157 id=157 data-nosnippet>157</a> }
|
|
<a href=#158 id=158 data-nosnippet>158</a> }
|
|
<a href=#159 id=159 data-nosnippet>159</a>}
|
|
<a href=#160 id=160 data-nosnippet>160</a>
|
|
<a href=#161 id=161 data-nosnippet>161</a><span class="kw">impl </span>fmt::Display <span class="kw">for </span>ParseBigIntError {
|
|
<a href=#162 id=162 data-nosnippet>162</a> <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result {
|
|
<a href=#163 id=163 data-nosnippet>163</a> <span class="self">self</span>.__description().fmt(f)
|
|
<a href=#164 id=164 data-nosnippet>164</a> }
|
|
<a href=#165 id=165 data-nosnippet>165</a>}
|
|
<a href=#166 id=166 data-nosnippet>166</a>
|
|
<a href=#167 id=167 data-nosnippet>167</a><span class="attr">#[cfg(feature = <span class="string">"std"</span>)]
|
|
<a href=#168 id=168 data-nosnippet>168</a>#[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"std"</span>)))]
|
|
<a href=#169 id=169 data-nosnippet>169</a></span><span class="kw">impl </span>std::error::Error <span class="kw">for </span>ParseBigIntError {
|
|
<a href=#170 id=170 data-nosnippet>170</a> <span class="kw">fn </span>description(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>str {
|
|
<a href=#171 id=171 data-nosnippet>171</a> <span class="self">self</span>.__description()
|
|
<a href=#172 id=172 data-nosnippet>172</a> }
|
|
<a href=#173 id=173 data-nosnippet>173</a>}
|
|
<a href=#174 id=174 data-nosnippet>174</a>
|
|
<a href=#175 id=175 data-nosnippet>175</a><span class="doccomment">/// The error type returned when a checked conversion regarding big integer fails.
|
|
<a href=#176 id=176 data-nosnippet>176</a></span><span class="attr">#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
|
<a href=#177 id=177 data-nosnippet>177</a></span><span class="kw">pub struct </span>TryFromBigIntError<T> {
|
|
<a href=#178 id=178 data-nosnippet>178</a> original: T,
|
|
<a href=#179 id=179 data-nosnippet>179</a>}
|
|
<a href=#180 id=180 data-nosnippet>180</a>
|
|
<a href=#181 id=181 data-nosnippet>181</a><span class="kw">impl</span><T> TryFromBigIntError<T> {
|
|
<a href=#182 id=182 data-nosnippet>182</a> <span class="kw">fn </span>new(original: T) -> <span class="self">Self </span>{
|
|
<a href=#183 id=183 data-nosnippet>183</a> TryFromBigIntError { original }
|
|
<a href=#184 id=184 data-nosnippet>184</a> }
|
|
<a href=#185 id=185 data-nosnippet>185</a>
|
|
<a href=#186 id=186 data-nosnippet>186</a> <span class="kw">fn </span>__description(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>str {
|
|
<a href=#187 id=187 data-nosnippet>187</a> <span class="string">"out of range conversion regarding big integer attempted"
|
|
<a href=#188 id=188 data-nosnippet>188</a> </span>}
|
|
<a href=#189 id=189 data-nosnippet>189</a>
|
|
<a href=#190 id=190 data-nosnippet>190</a> <span class="doccomment">/// Extract the original value, if available. The value will be available
|
|
<a href=#191 id=191 data-nosnippet>191</a> /// if the type before conversion was either [`BigInt`] or [`BigUint`].
|
|
<a href=#192 id=192 data-nosnippet>192</a> </span><span class="kw">pub fn </span>into_original(<span class="self">self</span>) -> T {
|
|
<a href=#193 id=193 data-nosnippet>193</a> <span class="self">self</span>.original
|
|
<a href=#194 id=194 data-nosnippet>194</a> }
|
|
<a href=#195 id=195 data-nosnippet>195</a>}
|
|
<a href=#196 id=196 data-nosnippet>196</a>
|
|
<a href=#197 id=197 data-nosnippet>197</a><span class="attr">#[cfg(feature = <span class="string">"std"</span>)]
|
|
<a href=#198 id=198 data-nosnippet>198</a>#[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"std"</span>)))]
|
|
<a href=#199 id=199 data-nosnippet>199</a></span><span class="kw">impl</span><T> std::error::Error <span class="kw">for </span>TryFromBigIntError<T>
|
|
<a href=#200 id=200 data-nosnippet>200</a><span class="kw">where
|
|
<a href=#201 id=201 data-nosnippet>201</a> </span>T: fmt::Debug,
|
|
<a href=#202 id=202 data-nosnippet>202</a>{
|
|
<a href=#203 id=203 data-nosnippet>203</a> <span class="kw">fn </span>description(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>str {
|
|
<a href=#204 id=204 data-nosnippet>204</a> <span class="self">self</span>.__description()
|
|
<a href=#205 id=205 data-nosnippet>205</a> }
|
|
<a href=#206 id=206 data-nosnippet>206</a>}
|
|
<a href=#207 id=207 data-nosnippet>207</a>
|
|
<a href=#208 id=208 data-nosnippet>208</a><span class="kw">impl</span><T> fmt::Display <span class="kw">for </span>TryFromBigIntError<T> {
|
|
<a href=#209 id=209 data-nosnippet>209</a> <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result {
|
|
<a href=#210 id=210 data-nosnippet>210</a> <span class="self">self</span>.__description().fmt(f)
|
|
<a href=#211 id=211 data-nosnippet>211</a> }
|
|
<a href=#212 id=212 data-nosnippet>212</a>}
|
|
<a href=#213 id=213 data-nosnippet>213</a>
|
|
<a href=#214 id=214 data-nosnippet>214</a><span class="kw">pub use </span><span class="kw">crate</span>::biguint::BigUint;
|
|
<a href=#215 id=215 data-nosnippet>215</a><span class="kw">pub use </span><span class="kw">crate</span>::biguint::ToBigUint;
|
|
<a href=#216 id=216 data-nosnippet>216</a><span class="kw">pub use </span><span class="kw">crate</span>::biguint::U32Digits;
|
|
<a href=#217 id=217 data-nosnippet>217</a><span class="kw">pub use </span><span class="kw">crate</span>::biguint::U64Digits;
|
|
<a href=#218 id=218 data-nosnippet>218</a>
|
|
<a href=#219 id=219 data-nosnippet>219</a><span class="kw">pub use </span><span class="kw">crate</span>::bigint::BigInt;
|
|
<a href=#220 id=220 data-nosnippet>220</a><span class="kw">pub use </span><span class="kw">crate</span>::bigint::Sign;
|
|
<a href=#221 id=221 data-nosnippet>221</a><span class="kw">pub use </span><span class="kw">crate</span>::bigint::ToBigInt;
|
|
<a href=#222 id=222 data-nosnippet>222</a>
|
|
<a href=#223 id=223 data-nosnippet>223</a><span class="attr">#[cfg(feature = <span class="string">"rand"</span>)]
|
|
<a href=#224 id=224 data-nosnippet>224</a>#[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"rand"</span>)))]
|
|
<a href=#225 id=225 data-nosnippet>225</a></span><span class="kw">pub use </span><span class="kw">crate</span>::bigrand::{RandBigInt, RandomBits, UniformBigInt, UniformBigUint};
|
|
<a href=#226 id=226 data-nosnippet>226</a>
|
|
<a href=#227 id=227 data-nosnippet>227</a><span class="kw">mod </span>big_digit {
|
|
<a href=#228 id=228 data-nosnippet>228</a> <span class="comment">// A [`BigDigit`] is a [`BigUint`]'s composing element.
|
|
<a href=#229 id=229 data-nosnippet>229</a> </span><span class="macro">cfg_digit!</span>(
|
|
<a href=#230 id=230 data-nosnippet>230</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">type </span>BigDigit = u32;
|
|
<a href=#231 id=231 data-nosnippet>231</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">type </span>BigDigit = u64;
|
|
<a href=#232 id=232 data-nosnippet>232</a> );
|
|
<a href=#233 id=233 data-nosnippet>233</a>
|
|
<a href=#234 id=234 data-nosnippet>234</a> <span class="comment">// A [`DoubleBigDigit`] is the internal type used to do the computations. Its
|
|
<a href=#235 id=235 data-nosnippet>235</a> // size is the double of the size of [`BigDigit`].
|
|
<a href=#236 id=236 data-nosnippet>236</a> </span><span class="macro">cfg_digit!</span>(
|
|
<a href=#237 id=237 data-nosnippet>237</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">type </span>DoubleBigDigit = u64;
|
|
<a href=#238 id=238 data-nosnippet>238</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">type </span>DoubleBigDigit = u128;
|
|
<a href=#239 id=239 data-nosnippet>239</a> );
|
|
<a href=#240 id=240 data-nosnippet>240</a>
|
|
<a href=#241 id=241 data-nosnippet>241</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const </span>BITS: u8 = BigDigit::BITS <span class="kw">as </span>u8;
|
|
<a href=#242 id=242 data-nosnippet>242</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const </span>HALF_BITS: u8 = BITS / <span class="number">2</span>;
|
|
<a href=#243 id=243 data-nosnippet>243</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const </span>HALF: BigDigit = (<span class="number">1 </span><< HALF_BITS) - <span class="number">1</span>;
|
|
<a href=#244 id=244 data-nosnippet>244</a>
|
|
<a href=#245 id=245 data-nosnippet>245</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const </span>MAX: BigDigit = BigDigit::MAX;
|
|
<a href=#246 id=246 data-nosnippet>246</a> <span class="kw">const </span>LO_MASK: DoubleBigDigit = MAX <span class="kw">as </span>DoubleBigDigit;
|
|
<a href=#247 id=247 data-nosnippet>247</a>
|
|
<a href=#248 id=248 data-nosnippet>248</a> <span class="attr">#[inline]
|
|
<a href=#249 id=249 data-nosnippet>249</a> </span><span class="kw">fn </span>get_hi(n: DoubleBigDigit) -> BigDigit {
|
|
<a href=#250 id=250 data-nosnippet>250</a> (n >> BITS) <span class="kw">as </span>BigDigit
|
|
<a href=#251 id=251 data-nosnippet>251</a> }
|
|
<a href=#252 id=252 data-nosnippet>252</a> <span class="attr">#[inline]
|
|
<a href=#253 id=253 data-nosnippet>253</a> </span><span class="kw">fn </span>get_lo(n: DoubleBigDigit) -> BigDigit {
|
|
<a href=#254 id=254 data-nosnippet>254</a> (n & LO_MASK) <span class="kw">as </span>BigDigit
|
|
<a href=#255 id=255 data-nosnippet>255</a> }
|
|
<a href=#256 id=256 data-nosnippet>256</a>
|
|
<a href=#257 id=257 data-nosnippet>257</a> <span class="doccomment">/// Split one [`DoubleBigDigit`] into two [`BigDigit`]s.
|
|
<a href=#258 id=258 data-nosnippet>258</a> </span><span class="attr">#[inline]
|
|
<a href=#259 id=259 data-nosnippet>259</a> </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>from_doublebigdigit(n: DoubleBigDigit) -> (BigDigit, BigDigit) {
|
|
<a href=#260 id=260 data-nosnippet>260</a> (get_hi(n), get_lo(n))
|
|
<a href=#261 id=261 data-nosnippet>261</a> }
|
|
<a href=#262 id=262 data-nosnippet>262</a>
|
|
<a href=#263 id=263 data-nosnippet>263</a> <span class="doccomment">/// Join two [`BigDigit`]s into one [`DoubleBigDigit`].
|
|
<a href=#264 id=264 data-nosnippet>264</a> </span><span class="attr">#[inline]
|
|
<a href=#265 id=265 data-nosnippet>265</a> </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>to_doublebigdigit(hi: BigDigit, lo: BigDigit) -> DoubleBigDigit {
|
|
<a href=#266 id=266 data-nosnippet>266</a> DoubleBigDigit::from(lo) | (DoubleBigDigit::from(hi) << BITS)
|
|
<a href=#267 id=267 data-nosnippet>267</a> }
|
|
<a href=#268 id=268 data-nosnippet>268</a>}
|
|
</code></pre></div></section></main></body></html> |