|
|
<!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_integer` crate."><meta name="keywords" content="rust, rustlang, rust-lang, num_integer"><title>num_integer - 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><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></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">☰</div><a href='../num_integer/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate num_integer</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all num_integer's items</p></a><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'num_integer', 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"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><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='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../src/num_integer/lib.rs.html#11-1340' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>num_integer</a></span></h1><div class='docblock'><p>Integer trait and functions.</p>
|
|
|
<h2 id="compatibility" class="section-header"><a href="#compatibility">Compatibility</a></h2>
|
|
|
<p>The <code>num-integer</code> crate is tested for rustc 1.8 and greater.</p>
|
|
|
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="struct" href="struct.ExtendedGcd.html" title='num_integer::ExtendedGcd struct'>ExtendedGcd</a></td><td class='docblock-short'><p>Greatest common divisor and Bézout coefficients</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.IterBinomial.html" title='num_integer::IterBinomial struct'>IterBinomial</a></td><td class='docblock-short'><p>An iterator over binomial coefficients.</p>
|
|
|
</td></tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="trait" href="trait.Integer.html" title='num_integer::Integer trait'>Integer</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="trait" href="trait.Roots.html" title='num_integer::Roots trait'>Roots</a></td><td class='docblock-short'><p>Provides methods to compute an integer's square root, cube root,
|
|
|
and arbitrary <code>n</code>th root.</p>
|
|
|
</td></tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="fn" href="fn.binomial.html" title='num_integer::binomial fn'>binomial</a></td><td class='docblock-short'><p>Calculate the binomial coefficient.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.cbrt.html" title='num_integer::cbrt fn'>cbrt</a></td><td class='docblock-short'><p>Returns the truncated principal cube root of an integer --
|
|
|
see <a href="trait.Roots.html#method.cbrt">Roots::cbrt</a>.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.div_ceil.html" title='num_integer::div_ceil fn'>div_ceil</a></td><td class='docblock-short'><p>Ceiled integer division</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.div_floor.html" title='num_integer::div_floor fn'>div_floor</a></td><td class='docblock-short'><p>Floored integer division</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.div_mod_floor.html" title='num_integer::div_mod_floor fn'>div_mod_floor</a></td><td class='docblock-short'><p>Simultaneous floored integer division and modulus</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.div_rem.html" title='num_integer::div_rem fn'>div_rem</a></td><td class='docblock-short'><p>Simultaneous integer division and modulus</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.gcd.html" title='num_integer::gcd fn'>gcd</a></td><td class='docblock-short'><p>Calculates the Greatest Common Divisor (GCD) of the number and <code>other</code>. The
|
|
|
result is always positive.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.gcd_lcm.html" title='num_integer::gcd_lcm fn'>gcd_lcm</a></td><td class='docblock-short'><p>Calculates the Greatest Common Divisor (GCD) and
|
|
|
Lowest Common Multiple (LCM) of the number and <code>other</code>.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.lcm.html" title='num_integer::lcm fn'>lcm</a></td><td class='docblock-short'><p>Calculates the Lowest Common Multiple (LCM) of the number and <code>other</code>.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.mod_floor.html" title='num_integer::mod_floor fn'>mod_floor</a></td><td class='docblock-short'><p>Floored integer modulus</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.multinomial.html" title='num_integer::multinomial fn'>multinomial</a></td><td class='docblock-short'><p>Calculate the multinomial coefficient.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.nth_root.html" title='num_integer::nth_root fn'>nth_root</a></td><td class='docblock-short'><p>Returns the truncated principal <code>n</code>th root of an integer --
|
|
|
see <a href="trait.Roots.html#tymethod.nth_root">Roots::nth_root</a>.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.sqrt.html" title='num_integer::sqrt fn'>sqrt</a></td><td class='docblock-short'><p>Returns the truncated principal square root of an integer --
|
|
|
see <a href="trait.Roots.html#method.sqrt">Roots::sqrt</a>.</p>
|
|
|
</td></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>⏎</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_integer";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |
