| <!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 `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/num-0.3.1/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.rs - source</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" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.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 source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../num/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../num/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><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"><a href="../../help.html">?</a></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><section id="main-content" class="content"><div class="example-wrap"><pre class="src-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> |
| </pre><pre class="rust"><code><span class="comment">// Copyright 2014-2016 The Rust Project Developers. See the COPYRIGHT |
| // file at the top-level directory of this distribution and at |
| // http://rust-lang.org/COPYRIGHT. |
| // |
| // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or |
| // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license |
| // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your |
| // option. This file may not be copied, modified, or distributed |
| // except according to those terms. |
| |
| </span><span class="doccomment">//! A collection of numeric types and traits for Rust. |
| //! |
| //! This includes new types for big integers, rationals, and complex numbers, |
| //! new traits for generic programming on numeric properties like `Integer`, |
| //! and generic range iterators. |
| //! |
| //! ## Example |
| //! |
| //! This example uses the BigRational type and [Newton's method][newt] to |
| //! approximate a square root to arbitrary precision: |
| //! |
| //! ``` |
| //! # #[cfg(any(feature = "alloc", feature = "std"))] |
| //! # mod test { |
| //! |
| //! use num::FromPrimitive; |
| //! use num::bigint::BigInt; |
| //! use num::rational::{Ratio, BigRational}; |
| //! |
| //! # pub |
| //! fn approx_sqrt(number: u64, iterations: usize) -> BigRational { |
| //! let start: Ratio<BigInt> = Ratio::from_integer(FromPrimitive::from_u64(number).unwrap()); |
| //! let mut approx = start.clone(); |
| //! |
| //! for _ in 0..iterations { |
| //! approx = (&approx + (&start / &approx)) / |
| //! Ratio::from_integer(FromPrimitive::from_u64(2).unwrap()); |
| //! } |
| //! |
| //! approx |
| //! } |
| //! # } |
| //! # #[cfg(not(any(feature = "alloc", feature = "std")))] |
| //! # mod test { pub fn approx_sqrt(n: u64, _: usize) -> u64 { n } } |
| //! # use crate::test::approx_sqrt; |
| //! |
| //! fn main() { |
| //! println!("{}", approx_sqrt(10, 4)); // prints 4057691201/1283082416 |
| //! } |
| //! |
| //! ``` |
| //! |
| //! [newt]: https://en.wikipedia.org/wiki/Methods_of_computing_square_roots#Babylonian_method |
| //! |
| //! ## Compatibility |
| //! |
| //! The `num` crate is tested for rustc 1.31 and greater. |
| |
| </span><span class="attribute">#![doc(html_root_url = <span class="string">"https://docs.rs/num/0.3"</span>)] |
| #![no_std] |
| |
| #[cfg(any(feature = <span class="string">"alloc"</span>, feature = <span class="string">"std"</span>))] |
| </span><span class="kw">pub use </span>num_bigint::{BigInt, BigUint}; |
| |
| <span class="kw">pub use </span>num_complex::Complex; |
| |
| <span class="attribute">#[cfg(any(feature = <span class="string">"alloc"</span>, feature = <span class="string">"std"</span>))] |
| </span><span class="kw">pub use </span>num_rational::BigRational; |
| <span class="kw">pub use </span>num_rational::Rational; |
| |
| <span class="kw">pub use </span>num_integer::Integer; |
| |
| <span class="kw">pub use </span>num_iter::{range, range_inclusive, range_step, range_step_inclusive}; |
| |
| <span class="attribute">#[cfg(any(feature = <span class="string">"libm"</span>, feature = <span class="string">"std"</span>))] |
| </span><span class="kw">pub use </span>num_traits::Float; |
| <span class="kw">pub use </span>num_traits::{ |
| abs, abs_sub, cast, checked_pow, clamp, one, pow, signum, zero, Bounded, CheckedAdd, |
| CheckedDiv, CheckedMul, CheckedSub, FromPrimitive, Num, NumCast, One, PrimInt, Saturating, |
| Signed, ToPrimitive, Unsigned, Zero, |
| }; |
| |
| <span class="attribute">#[cfg(any(feature = <span class="string">"alloc"</span>, feature = <span class="string">"std"</span>))] |
| </span><span class="kw">pub mod </span>bigint { |
| <span class="kw">pub use </span>num_bigint::<span class="kw-2">*</span>; |
| } |
| |
| <span class="kw">pub mod </span>complex { |
| <span class="kw">pub use </span>num_complex::<span class="kw-2">*</span>; |
| } |
| |
| <span class="kw">pub mod </span>integer { |
| <span class="kw">pub use </span>num_integer::<span class="kw-2">*</span>; |
| } |
| |
| <span class="kw">pub mod </span>iter { |
| <span class="kw">pub use </span>num_iter::<span class="kw-2">*</span>; |
| } |
| |
| <span class="kw">pub mod </span>traits { |
| <span class="kw">pub use </span>num_traits::<span class="kw-2">*</span>; |
| } |
| |
| <span class="kw">pub mod </span>rational { |
| <span class="kw">pub use </span>num_rational::<span class="kw-2">*</span>; |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="num" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
