| <!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 collection of numeric types and traits for Rust."><meta name="keywords" content="rust, rustlang, rust-lang, num"><title>num - 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" 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="../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/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><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><h2 class="location"><a href="#">Crate num</a></h2><div class="sidebar-elems"><ul class="block"><li class="version">Version 0.3.1</li><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><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></section></div></nav><main><div class="width-limiter"><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"><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="main-heading"><h1 class="fqn">Crate <a class="mod" href="#">num</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></h1><span class="out-of-band"><a class="srclink" href="../src/num/lib.rs.html#11-106">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 collection of numeric types and traits for Rust.</p> |
| <p>This includes new types for big integers, rationals, and complex numbers, |
| new traits for generic programming on numeric properties like <code>Integer</code>, |
| and generic range iterators.</p> |
| <h3 id="example"><a href="#example">Example</a></h3> |
| <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 |
| approximate a square root to arbitrary precision:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code> |
| <span class="kw">use </span>num::FromPrimitive; |
| <span class="kw">use </span>num::bigint::BigInt; |
| <span class="kw">use </span>num::rational::{Ratio, BigRational}; |
| |
| <span class="kw">fn </span>approx_sqrt(number: u64, iterations: usize) -> BigRational { |
| <span class="kw">let </span>start: Ratio<BigInt> = Ratio::from_integer(FromPrimitive::from_u64(number).unwrap()); |
| <span class="kw">let </span><span class="kw-2">mut </span>approx = start.clone(); |
| |
| <span class="kw">for _ in </span><span class="number">0</span>..iterations { |
| approx = (<span class="kw-2">&</span>approx + (<span class="kw-2">&</span>start / <span class="kw-2">&</span>approx)) / |
| Ratio::from_integer(FromPrimitive::from_u64(<span class="number">2</span>).unwrap()); |
| } |
| |
| approx |
| } |
| |
| <span class="kw">fn </span>main() { |
| <span class="macro">println!</span>(<span class="string">"{}"</span>, approx_sqrt(<span class="number">10</span>, <span class="number">4</span>)); <span class="comment">// prints 4057691201/1283082416 |
| </span>} |
| </code></pre></div> |
| <h3 id="compatibility"><a href="#compatibility">Compatibility</a></h3> |
| <p>The <code>num</code> crate is tested for rustc 1.31 and greater.</p> |
| </div></details><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="bigint/index.html" title="num::bigint mod">bigint</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="cast/index.html" title="num::cast mod">cast</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="complex/index.html" title="num::complex mod">complex</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="integer/index.html" title="num::integer mod">integer</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="iter/index.html" title="num::iter mod">iter</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="pow/index.html" title="num::pow mod">pow</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="rational/index.html" title="num::rational mod">rational</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="traits/index.html" title="num::traits mod">traits</a></div></div></div><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 struct">BigInt</a></div><div class="item-right docblock-short">A big signed integer type.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.BigUint.html" title="num::BigUint struct">BigUint</a></div><div class="item-right docblock-short">A big unsigned integer type.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Complex.html" title="num::Complex struct">Complex</a></div><div class="item-right docblock-short">A complex number in Cartesian form.</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.Bounded.html" title="num::Bounded trait">Bounded</a></div><div class="item-right docblock-short">Numbers which have upper and lower bounds</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.CheckedAdd.html" title="num::CheckedAdd trait">CheckedAdd</a></div><div class="item-right docblock-short">Performs addition that returns <code>None</code> instead of wrapping around on |
| overflow.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.CheckedDiv.html" title="num::CheckedDiv trait">CheckedDiv</a></div><div class="item-right docblock-short">Performs division that returns <code>None</code> instead of panicking on division by zero and instead of |
| wrapping around on underflow and overflow.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.CheckedMul.html" title="num::CheckedMul trait">CheckedMul</a></div><div class="item-right docblock-short">Performs multiplication that returns <code>None</code> instead of wrapping around on underflow or |
| overflow.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.CheckedSub.html" title="num::CheckedSub trait">CheckedSub</a></div><div class="item-right docblock-short">Performs subtraction that returns <code>None</code> instead of wrapping around on underflow.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Float.html" title="num::Float trait">Float</a></div><div class="item-right docblock-short">Generic trait for floating point numbers</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.FromPrimitive.html" title="num::FromPrimitive trait">FromPrimitive</a></div><div class="item-right docblock-short">A generic trait for converting a number to a value.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Integer.html" title="num::Integer trait">Integer</a></div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Num.html" title="num::Num trait">Num</a></div><div class="item-right docblock-short">The base trait for numeric types, covering <code>0</code> and <code>1</code> values, |
| comparisons, basic numeric operations, and string conversion.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.NumCast.html" title="num::NumCast trait">NumCast</a></div><div class="item-right docblock-short">An interface for casting between machine scalars.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.One.html" title="num::One trait">One</a></div><div class="item-right docblock-short">Defines a multiplicative identity element for <code>Self</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.PrimInt.html" title="num::PrimInt trait">PrimInt</a></div><div class="item-right docblock-short">Generic trait for primitive integers.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Saturating.html" title="num::Saturating trait">Saturating</a></div><div class="item-right docblock-short">Saturating math operations. Deprecated, use <code>SaturatingAdd</code>, <code>SaturatingSub</code> and |
| <code>SaturatingMul</code> instead.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Signed.html" title="num::Signed trait">Signed</a></div><div class="item-right docblock-short">Useful functions for signed numbers (i.e. numbers that can be negative).</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.ToPrimitive.html" title="num::ToPrimitive trait">ToPrimitive</a></div><div class="item-right docblock-short">A generic trait for converting a value to a number.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Unsigned.html" title="num::Unsigned trait">Unsigned</a></div><div class="item-right docblock-short">A trait for values which cannot be negative</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Zero.html" title="num::Zero trait">Zero</a></div><div class="item-right docblock-short">Defines an additive identity element for <code>Self</code>.</div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.abs.html" title="num::abs fn">abs</a></div><div class="item-right docblock-short">Computes the absolute value.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.abs_sub.html" title="num::abs_sub fn">abs_sub</a></div><div class="item-right docblock-short">The positive difference of two numbers.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.cast.html" title="num::cast fn">cast</a></div><div class="item-right docblock-short">Cast from one machine scalar to another.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.checked_pow.html" title="num::checked_pow fn">checked_pow</a></div><div class="item-right docblock-short">Raises a value to the power of exp, returning <code>None</code> if an overflow occurred.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.clamp.html" title="num::clamp fn">clamp</a></div><div class="item-right docblock-short">A value bounded by a minimum and a maximum</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.one.html" title="num::one fn">one</a></div><div class="item-right docblock-short">Returns the multiplicative identity, <code>1</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.pow.html" title="num::pow fn">pow</a></div><div class="item-right docblock-short">Raises a value to the power of exp, using exponentiation by squaring.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.range.html" title="num::range fn">range</a></div><div class="item-right docblock-short">Returns an iterator over the given range [start, stop) (that is, starting |
| at start (inclusive), and ending at stop (exclusive)).</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.range_inclusive.html" title="num::range_inclusive fn">range_inclusive</a></div><div class="item-right docblock-short">Return an iterator over the range [start, stop]</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.range_step.html" title="num::range_step fn">range_step</a></div><div class="item-right docblock-short">Return an iterator over the range [start, stop) by <code>step</code>. It handles overflow by stopping.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.range_step_inclusive.html" title="num::range_step_inclusive fn">range_step_inclusive</a></div><div class="item-right docblock-short">Return an iterator over the range [start, stop] by <code>step</code>. It handles overflow by stopping.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.signum.html" title="num::signum fn">signum</a></div><div class="item-right docblock-short">Returns the sign of the number.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.zero.html" title="num::zero fn">zero</a></div><div class="item-right docblock-short">Returns the additive identity, <code>0</code>.</div></div></div><h2 id="types" class="small-section-header"><a href="#types">Type Definitions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="type" href="type.BigRational.html" title="num::BigRational type">BigRational</a></div><div class="item-right docblock-short">Alias for arbitrary precision rationals.</div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.Rational.html" title="num::Rational type">Rational</a></div><div class="item-right docblock-short">Alias for a <code>Ratio</code> of machine-sized integers.</div></div></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> |
