Home Explore Help
Sign In
RONCC
/
HPC-Tools-for-Quantum-Computing
Watch 1
Star 0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: e971e022d2
Branches Tags
HPC-Tools-fo...
/
doc
/
num
/
index.html

index.html 24 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378 
  1. <!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` crate."><meta name="keywords" content="rust, rustlang, rust-lang, num"><title>num - 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></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</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="#traits">Traits</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'num', 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"><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='in-band'>Crate <a class="mod" href=''>num</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/lib.rs.html#11-113' title='goto source code'>[src]</a></span></h1><div class='docblock'><p>A collection of numeric types and traits for Rust.</p>
    2. 

  2. <p>This includes new types for big integers, rationals, and complex numbers,
    3. 

  3. new traits for generic programming on numeric properties like <code>Integer</code>,
    4. 

  4. and generic range iterators.</p>
    5. 

  5. <h2 id="example" class="section-header"><a href="#example">Example</a></h2>
    6. 

  6. <p>This example uses the BigRational type and <a href="https://en.wikipedia.org/wiki/Methods_of_computing_square_roots#Babylonian_method">Newton's method</a> to
    7. 

  7. approximate a square root to arbitrary precision:</p>
    8. 

  8. 

  9. <pre class="rust rust-example-rendered">
    10. 

  10. <span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">num</span>;
    11. 

  11. 

  12. <span class="kw">use</span> <span class="ident">num</span>::<span class="ident">FromPrimitive</span>;
    13. 

  13. <span class="kw">use</span> <span class="ident">num</span>::<span class="ident">bigint</span>::<span class="ident">BigInt</span>;
    14. 

  14. <span class="kw">use</span> <span class="ident">num</span>::<span class="ident">rational</span>::{<span class="ident">Ratio</span>, <span class="ident">BigRational</span>};
    15. 

  15. 

  16. <span class="kw">fn</span> <span class="ident">approx_sqrt</span>(<span class="ident">number</span>: <span class="ident">u64</span>, <span class="ident">iterations</span>: <span class="ident">usize</span>) <span class="op">-&gt;</span> <span class="ident">BigRational</span> {
    17. 

  17.     <span class="kw">let</span> <span class="ident">start</span>: <span class="ident">Ratio</span><span class="op">&lt;</span><span class="ident">BigInt</span><span class="op">&gt;</span> <span class="op">=</span> <span class="ident">Ratio</span>::<span class="ident">from_integer</span>(<span class="ident">FromPrimitive</span>::<span class="ident">from_u64</span>(<span class="ident">number</span>).<span class="ident">unwrap</span>());
    18. 

  18.     <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">approx</span> <span class="op">=</span> <span class="ident">start</span>.<span class="ident">clone</span>();
    19. 

  19. 

  20.     <span class="kw">for</span> <span class="kw">_</span> <span class="kw">in</span> <span class="number">0</span>..<span class="ident">iterations</span> {
    21. 

  21.         <span class="ident">approx</span> <span class="op">=</span> (<span class="kw-2">&amp;</span><span class="ident">approx</span> <span class="op">+</span> (<span class="kw-2">&amp;</span><span class="ident">start</span> <span class="op">/</span> <span class="kw-2">&amp;</span><span class="ident">approx</span>)) <span class="op">/</span>
    22. 

  22.             <span class="ident">Ratio</span>::<span class="ident">from_integer</span>(<span class="ident">FromPrimitive</span>::<span class="ident">from_u64</span>(<span class="number">2</span>).<span class="ident">unwrap</span>());
    23. 

  23.     }
    24. 

  24. 

  25.     <span class="ident">approx</span>
    26. 

  26. }
    27. 

  27. 

  28. <span class="kw">fn</span> <span class="ident">main</span>() {
    29. 

  29.     <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{}&quot;</span>, <span class="ident">approx_sqrt</span>(<span class="number">10</span>, <span class="number">4</span>)); <span class="comment">// prints 4057691201/1283082416</span>
    30. 

  30. }
    31. 

  31. </pre>
    32. 

  32. <h2 id="compatibility" class="section-header"><a href="#compatibility">Compatibility</a></h2>
    33. 

  33. <p>The <code>num</code> crate is tested for rustc 1.8 and greater.</p>
    34. 

  34. </div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
    35. 

  35. <table>
    36. 

  36.                        <tr class=' module-item'>
    37. 

  37.                            <td><a class="mod" href="bigint/index.html"
    38. 

  38.                                   title='mod num::bigint'>bigint</a></td>
    39. 

  39.                            <td class='docblock-short'>
    40. 

  40.                                 
    41. 

  41.                            </td>
    42. 

  42.                        </tr>
    43. 

  43.                        <tr class=' module-item'>
    44. 

  44.                            <td><a class="mod" href="cast/index.html"
    45. 

  45.                                   title='mod num::cast'>cast</a></td>
    46. 

  46.                            <td class='docblock-short'>
    47. 

  47.                                 
    48. 

  48.                            </td>
    49. 

  49.                        </tr>
    50. 

  50.                        <tr class=' module-item'>
    51. 

  51.                            <td><a class="mod" href="complex/index.html"
    52. 

  52.                                   title='mod num::complex'>complex</a></td>
    53. 

  53.                            <td class='docblock-short'>
    54. 

  54.                                 
    55. 

  55.                            </td>
    56. 

  56.                        </tr>
    57. 

  57.                        <tr class=' module-item'>
    58. 

  58.                            <td><a class="mod" href="integer/index.html"
    59. 

  59.                                   title='mod num::integer'>integer</a></td>
    60. 

  60.                            <td class='docblock-short'>
    61. 

  61.                                 
    62. 

  62.                            </td>
    63. 

  63.                        </tr>
    64. 

  64.                        <tr class=' module-item'>
    65. 

  65.                            <td><a class="mod" href="iter/index.html"
    66. 

  66.                                   title='mod num::iter'>iter</a></td>
    67. 

  67.                            <td class='docblock-short'>
    68. 

  68.                                 
    69. 

  69.                            </td>
    70. 

  70.                        </tr>
    71. 

  71.                        <tr class=' module-item'>
    72. 

  72.                            <td><a class="mod" href="pow/index.html"
    73. 

  73.                                   title='mod num::pow'>pow</a></td>
    74. 

  74.                            <td class='docblock-short'>
    75. 

  75.                                 
    76. 

  76.                            </td>
    77. 

  77.                        </tr>
    78. 

  78.                        <tr class=' module-item'>
    79. 

  79.                            <td><a class="mod" href="rational/index.html"
    80. 

  80.                                   title='mod num::rational'>rational</a></td>
    81. 

  81.                            <td class='docblock-short'>
    82. 

  82.                                 
    83. 

  83.                            </td>
    84. 

  84.                        </tr>
    85. 

  85.                        <tr class=' module-item'>
    86. 

  86.                            <td><a class="mod" href="traits/index.html"
    87. 

  87.                                   title='mod num::traits'>traits</a></td>
    88. 

  88.                            <td class='docblock-short'>
    89. 

  89.                                 
    90. 

  90.                            </td>
    91. 

  91.                        </tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
    92. 

  92. <table>
    93. 

  93.                        <tr class=' module-item'>
    94. 

  94.                            <td><a class="struct" href="struct.BigInt.html"
    95. 

  95.                                   title='struct num::BigInt'>BigInt</a></td>
    96. 

  96.                            <td class='docblock-short'>
    97. 

  97.                                 <p>A big signed integer type.</p>
    98. 

  98. 

  99.                            </td>
    100. 

  100.                        </tr>
    101. 

  101.                        <tr class=' module-item'>
    102. 

  102.                            <td><a class="struct" href="struct.BigUint.html"
    103. 

  103.                                   title='struct num::BigUint'>BigUint</a></td>
    104. 

  104.                            <td class='docblock-short'>
    105. 

  105.                                 <p>A big unsigned integer type.</p>
    106. 

  106. 

  107.                            </td>
    108. 

  108.                        </tr>
    109. 

  109.                        <tr class=' module-item'>
    110. 

  110.                            <td><a class="struct" href="struct.Complex.html"
    111. 

  111.                                   title='struct num::Complex'>Complex</a></td>
    112. 

  112.                            <td class='docblock-short'>
    113. 

  113.                                 <p>A complex number in Cartesian form.</p>
    114. 

  114. 

  115.                            </td>
    116. 

  116.                        </tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
    117. 

  117. <table>
    118. 

  118.                        <tr class=' module-item'>
    119. 

  119.                            <td><a class="trait" href="trait.Bounded.html"
    120. 

  120.                                   title='trait num::Bounded'>Bounded</a></td>
    121. 

  121.                            <td class='docblock-short'>
    122. 

  122.                                 <p>Numbers which have upper and lower bounds</p>
    123. 

  123. 

  124.                            </td>
    125. 

  125.                        </tr>
    126. 

  126.                        <tr class=' module-item'>
    127. 

  127.                            <td><a class="trait" href="trait.CheckedAdd.html"
    128. 

  128.                                   title='trait num::CheckedAdd'>CheckedAdd</a></td>
    129. 

  129.                            <td class='docblock-short'>
    130. 

  130.                                 <p>Performs addition that returns <code>None</code> instead of wrapping around on
    131. 

  131. overflow.</p>
    132. 

  132. 

  133.                            </td>
    134. 

  134.                        </tr>
    135. 

  135.                        <tr class=' module-item'>
    136. 

  136.                            <td><a class="trait" href="trait.CheckedDiv.html"
    137. 

  137.                                   title='trait num::CheckedDiv'>CheckedDiv</a></td>
    138. 

  138.                            <td class='docblock-short'>
    139. 

  139.                                 <p>Performs division that returns <code>None</code> instead of panicking on division by zero and instead of
    140. 

  140. wrapping around on underflow and overflow.</p>
    141. 

  141. 

  142.                            </td>
    143. 

  143.                        </tr>
    144. 

  144.                        <tr class=' module-item'>
    145. 

  145.                            <td><a class="trait" href="trait.CheckedMul.html"
    146. 

  146.                                   title='trait num::CheckedMul'>CheckedMul</a></td>
    147. 

  147.                            <td class='docblock-short'>
    148. 

  148.                                 <p>Performs multiplication that returns <code>None</code> instead of wrapping around on underflow or
    149. 

  149. overflow.</p>
    150. 

  150. 

  151.                            </td>
    152. 

  152.                        </tr>
    153. 

  153.                        <tr class=' module-item'>
    154. 

  154.                            <td><a class="trait" href="trait.CheckedSub.html"
    155. 

  155.                                   title='trait num::CheckedSub'>CheckedSub</a></td>
    156. 

  156.                            <td class='docblock-short'>
    157. 

  157.                                 <p>Performs subtraction that returns <code>None</code> instead of wrapping around on underflow.</p>
    158. 

  158. 

  159.                            </td>
    160. 

  160.                        </tr>
    161. 

  161.                        <tr class=' module-item'>
    162. 

  162.                            <td><a class="trait" href="trait.Float.html"
    163. 

  163.                                   title='trait num::Float'>Float</a></td>
    164. 

  164.                            <td class='docblock-short'>
    165. 

  165.                                 <p>Generic trait for floating point numbers</p>
    166. 

  166. 

  167.                            </td>
    168. 

  168.                        </tr>
    169. 

  169.                        <tr class=' module-item'>
    170. 

  170.                            <td><a class="trait" href="trait.FromPrimitive.html"
    171. 

  171.                                   title='trait num::FromPrimitive'>FromPrimitive</a></td>
    172. 

  172.                            <td class='docblock-short'>
    173. 

  173.                                 <p>A generic trait for converting a number to a value.</p>
    174. 

  174. 

  175.                            </td>
    176. 

  176.                        </tr>
    177. 

  177.                        <tr class=' module-item'>
    178. 

  178.                            <td><a class="trait" href="trait.Integer.html"
    179. 

  179.                                   title='trait num::Integer'>Integer</a></td>
    180. 

  180.                            <td class='docblock-short'>
    181. 

  181.                                 
    182. 

  182.                            </td>
    183. 

  183.                        </tr>
    184. 

  184.                        <tr class=' module-item'>
    185. 

  185.                            <td><a class="trait" href="trait.Num.html"
    186. 

  186.                                   title='trait num::Num'>Num</a></td>
    187. 

  187.                            <td class='docblock-short'>
    188. 

  188.                                 <p>The base trait for numeric types, covering <code>0</code> and <code>1</code> values,
    189. 

  189. comparisons, basic numeric operations, and string conversion.</p>
    190. 

  190. 

  191.                            </td>
    192. 

  192.                        </tr>
    193. 

  193.                        <tr class=' module-item'>
    194. 

  194.                            <td><a class="trait" href="trait.NumCast.html"
    195. 

  195.                                   title='trait num::NumCast'>NumCast</a></td>
    196. 

  196.                            <td class='docblock-short'>
    197. 

  197.                                 <p>An interface for casting between machine scalars.</p>
    198. 

  198. 

  199.                            </td>
    200. 

  200.                        </tr>
    201. 

  201.                        <tr class=' module-item'>
    202. 

  202.                            <td><a class="trait" href="trait.One.html"
    203. 

  203.                                   title='trait num::One'>One</a></td>
    204. 

  204.                            <td class='docblock-short'>
    205. 

  205.                                 <p>Defines a multiplicative identity element for <code>Self</code>.</p>
    206. 

  206. 

  207.                            </td>
    208. 

  208.                        </tr>
    209. 

  209.                        <tr class=' module-item'>
    210. 

  210.                            <td><a class="trait" href="trait.PrimInt.html"
    211. 

  211.                                   title='trait num::PrimInt'>PrimInt</a></td>
    212. 

  212.                            <td class='docblock-short'>
    213. 

  213.                                 
    214. 

  214.                            </td>
    215. 

  215.                        </tr>
    216. 

  216.                        <tr class=' module-item'>
    217. 

  217.                            <td><a class="trait" href="trait.Saturating.html"
    218. 

  218.                                   title='trait num::Saturating'>Saturating</a></td>
    219. 

  219.                            <td class='docblock-short'>
    220. 

  220.                                 <p>Saturating math operations</p>
    221. 

  221. 

  222.                            </td>
    223. 

  223.                        </tr>
    224. 

  224.                        <tr class=' module-item'>
    225. 

  225.                            <td><a class="trait" href="trait.Signed.html"
    226. 

  226.                                   title='trait num::Signed'>Signed</a></td>
    227. 

  227.                            <td class='docblock-short'>
    228. 

  228.                                 <p>Useful functions for signed numbers (i.e. numbers that can be negative).</p>
    229. 

  229. 

  230.                            </td>
    231. 

  231.                        </tr>
    232. 

  232.                        <tr class=' module-item'>
    233. 

  233.                            <td><a class="trait" href="trait.ToPrimitive.html"
    234. 

  234.                                   title='trait num::ToPrimitive'>ToPrimitive</a></td>
    235. 

  235.                            <td class='docblock-short'>
    236. 

  236.                                 <p>A generic trait for converting a value to a number.</p>
    237. 

  237. 

  238.                            </td>
    239. 

  239.                        </tr>
    240. 

  240.                        <tr class=' module-item'>
    241. 

  241.                            <td><a class="trait" href="trait.Unsigned.html"
    242. 

  242.                                   title='trait num::Unsigned'>Unsigned</a></td>
    243. 

  243.                            <td class='docblock-short'>
    244. 

  244.                                 <p>A trait for values which cannot be negative</p>
    245. 

  245. 

  246.                            </td>
    247. 

  247.                        </tr>
    248. 

  248.                        <tr class=' module-item'>
    249. 

  249.                            <td><a class="trait" href="trait.Zero.html"
    250. 

  250.                                   title='trait num::Zero'>Zero</a></td>
    251. 

  251.                            <td class='docblock-short'>
    252. 

  252.                                 <p>Defines an additive identity element for <code>Self</code>.</p>
    253. 

  253. 

  254.                            </td>
    255. 

  255.                        </tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
    256. 

  256. <table>
    257. 

  257.                        <tr class=' module-item'>
    258. 

  258.                            <td><a class="fn" href="fn.abs.html"
    259. 

  259.                                   title='fn num::abs'>abs</a></td>
    260. 

  260.                            <td class='docblock-short'>
    261. 

  261.                                 <p>Computes the absolute value.</p>
    262. 

  262. 

  263.                            </td>
    264. 

  264.                        </tr>
    265. 

  265.                        <tr class=' module-item'>
    266. 

  266.                            <td><a class="fn" href="fn.abs_sub.html"
    267. 

  267.                                   title='fn num::abs_sub'>abs_sub</a></td>
    268. 

  268.                            <td class='docblock-short'>
    269. 

  269.                                 <p>The positive difference of two numbers.</p>
    270. 

  270. 

  271.                            </td>
    272. 

  272.                        </tr>
    273. 

  273.                        <tr class=' module-item'>
    274. 

  274.                            <td><a class="fn" href="fn.cast.html"
    275. 

  275.                                   title='fn num::cast'>cast</a></td>
    276. 

  276.                            <td class='docblock-short'>
    277. 

  277.                                 <p>Cast from one machine scalar to another.</p>
    278. 

  278. 

  279.                            </td>
    280. 

  280.                        </tr>
    281. 

  281.                        <tr class=' module-item'>
    282. 

  282.                            <td><a class="fn" href="fn.checked_pow.html"
    283. 

  283.                                   title='fn num::checked_pow'>checked_pow</a></td>
    284. 

  284.                            <td class='docblock-short'>
    285. 

  285.                                 <p>Raises a value to the power of exp, returning <code>None</code> if an overflow occurred.</p>
    286. 

  286. 

  287.                            </td>
    288. 

  288.                        </tr>
    289. 

  289.                        <tr class=' module-item'>
    290. 

  290.                            <td><a class="fn" href="fn.clamp.html"
    291. 

  291.                                   title='fn num::clamp'>clamp</a></td>
    292. 

  292.                            <td class='docblock-short'>
    293. 

  293.                                 <p>A value bounded by a minimum and a maximum</p>
    294. 

  294. 

  295.                            </td>
    296. 

  296.                        </tr>
    297. 

  297.                        <tr class=' module-item'>
    298. 

  298.                            <td><a class="fn" href="fn.one.html"
    299. 

  299.                                   title='fn num::one'>one</a></td>
    300. 

  300.                            <td class='docblock-short'>
    301. 

  301.                                 <p>Returns the multiplicative identity, <code>1</code>.</p>
    302. 

  302. 

  303.                            </td>
    304. 

  304.                        </tr>
    305. 

  305.                        <tr class=' module-item'>
    306. 

  306.                            <td><a class="fn" href="fn.pow.html"
    307. 

  307.                                   title='fn num::pow'>pow</a></td>
    308. 

  308.                            <td class='docblock-short'>
    309. 

  309.                                 <p>Raises a value to the power of exp, using exponentiation by squaring.</p>
    310. 

  310. 

  311.                            </td>
    312. 

  312.                        </tr>
    313. 

  313.                        <tr class=' module-item'>
    314. 

  314.                            <td><a class="fn" href="fn.range.html"
    315. 

  315.                                   title='fn num::range'>range</a></td>
    316. 

  316.                            <td class='docblock-short'>
    317. 

  317.                                 <p>Returns an iterator over the given range [start, stop) (that is, starting
    318. 

  318. at start (inclusive), and ending at stop (exclusive)).</p>
    319. 

  319. 

  320.                            </td>
    321. 

  321.                        </tr>
    322. 

  322.                        <tr class=' module-item'>
    323. 

  323.                            <td><a class="fn" href="fn.range_inclusive.html"
    324. 

  324.                                   title='fn num::range_inclusive'>range_inclusive</a></td>
    325. 

  325.                            <td class='docblock-short'>
    326. 

  326.                                 <p>Return an iterator over the range [start, stop]</p>
    327. 

  327. 

  328.                            </td>
    329. 

  329.                        </tr>
    330. 

  330.                        <tr class=' module-item'>
    331. 

  331.                            <td><a class="fn" href="fn.range_step.html"
    332. 

  332.                                   title='fn num::range_step'>range_step</a></td>
    333. 

  333.                            <td class='docblock-short'>
    334. 

  334.                                 <p>Return an iterator over the range [start, stop) by <code>step</code>. It handles overflow by stopping.</p>
    335. 

  335. 

  336.                            </td>
    337. 

  337.                        </tr>
    338. 

  338.                        <tr class=' module-item'>
    339. 

  339.                            <td><a class="fn" href="fn.range_step_inclusive.html"
    340. 

  340.                                   title='fn num::range_step_inclusive'>range_step_inclusive</a></td>
    341. 

  341.                            <td class='docblock-short'>
    342. 

  342.                                 <p>Return an iterator over the range [start, stop] by <code>step</code>. It handles overflow by stopping.</p>
    343. 

  343. 

  344.                            </td>
    345. 

  345.                        </tr>
    346. 

  346.                        <tr class=' module-item'>
    347. 

  347.                            <td><a class="fn" href="fn.signum.html"
    348. 

  348.                                   title='fn num::signum'>signum</a></td>
    349. 

  349.                            <td class='docblock-short'>
    350. 

  350.                                 <p>Returns the sign of the number.</p>
    351. 

  351. 

  352.                            </td>
    353. 

  353.                        </tr>
    354. 

  354.                        <tr class=' module-item'>
    355. 

  355.                            <td><a class="fn" href="fn.zero.html"
    356. 

  356.                                   title='fn num::zero'>zero</a></td>
    357. 

  357.                            <td class='docblock-short'>
    358. 

  358.                                 <p>Returns the additive identity, <code>0</code>.</p>
    359. 

  359. 

  360.                            </td>
    361. 

  361.                        </tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
    362. 

  362. <table>
    363. 

  363.                        <tr class=' module-item'>
    364. 

  364.                            <td><a class="type" href="type.BigRational.html"
    365. 

  365.                                   title='type num::BigRational'>BigRational</a></td>
    366. 

  366.                            <td class='docblock-short'>
    367. 

  367.                                 <p>Alias for arbitrary precision rationals.</p>
    368. 

  368. 

  369.                            </td>
    370. 

  370.                        </tr>
    371. 

  371.                        <tr class=' module-item'>
    372. 

  372.                            <td><a class="type" href="type.Rational.html"
    373. 

  373.                                   title='type num::Rational'>Rational</a></td>
    374. 

  374.                            <td class='docblock-short'>
    375. 

  375.                                 <p>Alias for a <code>Ratio</code> of machine-sized integers.</p>
    376. 

  376. 

  377.                            </td>
    378. 

  378.                        </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";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
    379.