| <!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="Integer trait and functions."><meta name="keywords" content="rust, rustlang, rust-lang, num_integer"><title>num_integer - 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_integer/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_integer/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_integer</a></h2><div class="sidebar-elems"><ul class="block"><li class="version">Version 0.1.45</li><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</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_integer</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_integer/lib.rs.html#11-1386">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>Integer trait and functions.</p> |
| <h3 id="compatibility"><a href="#compatibility">Compatibility</a></h3> |
| <p>The <code>num-integer</code> crate is tested for rustc 1.8 and greater.</p> |
| </div></details><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.ExtendedGcd.html" title="num_integer::ExtendedGcd struct">ExtendedGcd</a></div><div class="item-right docblock-short">Greatest common divisor and Bézout coefficients</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.IterBinomial.html" title="num_integer::IterBinomial struct">IterBinomial</a></div><div class="item-right docblock-short">An iterator over binomial coefficients.</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.Average.html" title="num_integer::Average trait">Average</a></div><div class="item-right docblock-short">Provides methods to compute the average of two integers, without overflows.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Integer.html" title="num_integer::Integer trait">Integer</a></div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Roots.html" title="num_integer::Roots trait">Roots</a></div><div class="item-right docblock-short">Provides methods to compute an integer’s square root, cube root, |
| and arbitrary <code>n</code>th root.</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.average_ceil.html" title="num_integer::average_ceil fn">average_ceil</a></div><div class="item-right docblock-short">Returns the ceiling value of the average of <code>x</code> and <code>y</code> – |
| see <a href="trait.Average.html#tymethod.average_ceil">Average::average_ceil</a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.average_floor.html" title="num_integer::average_floor fn">average_floor</a></div><div class="item-right docblock-short">Returns the floor value of the average of <code>x</code> and <code>y</code> – |
| see <a href="trait.Average.html#tymethod.average_floor">Average::average_floor</a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.binomial.html" title="num_integer::binomial fn">binomial</a></div><div class="item-right docblock-short">Calculate the binomial coefficient.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.cbrt.html" title="num_integer::cbrt fn">cbrt</a></div><div class="item-right docblock-short">Returns the truncated principal cube root of an integer – |
| see <a href="trait.Roots.html#method.cbrt">Roots::cbrt</a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.div_ceil.html" title="num_integer::div_ceil fn">div_ceil</a></div><div class="item-right docblock-short">Ceiled integer division</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.div_floor.html" title="num_integer::div_floor fn">div_floor</a></div><div class="item-right docblock-short">Floored integer division</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.div_mod_floor.html" title="num_integer::div_mod_floor fn">div_mod_floor</a></div><div class="item-right docblock-short">Simultaneous floored integer division and modulus</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.div_rem.html" title="num_integer::div_rem fn">div_rem</a></div><div class="item-right docblock-short">Simultaneous integer division and modulus</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.gcd.html" title="num_integer::gcd fn">gcd</a></div><div class="item-right docblock-short">Calculates the Greatest Common Divisor (GCD) of the number and <code>other</code>. The |
| result is always non-negative.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.gcd_lcm.html" title="num_integer::gcd_lcm fn">gcd_lcm</a></div><div class="item-right docblock-short">Calculates the Greatest Common Divisor (GCD) and |
| Lowest Common Multiple (LCM) of the number and <code>other</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.lcm.html" title="num_integer::lcm fn">lcm</a></div><div class="item-right docblock-short">Calculates the Lowest Common Multiple (LCM) of the number and <code>other</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.mod_floor.html" title="num_integer::mod_floor fn">mod_floor</a></div><div class="item-right docblock-short">Floored integer modulus</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.multinomial.html" title="num_integer::multinomial fn">multinomial</a></div><div class="item-right docblock-short">Calculate the multinomial coefficient.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.nth_root.html" title="num_integer::nth_root fn">nth_root</a></div><div class="item-right docblock-short">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>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.sqrt.html" title="num_integer::sqrt fn">sqrt</a></div><div class="item-right docblock-short">Returns the truncated principal square root of an integer – |
| see <a href="trait.Roots.html#method.sqrt">Roots::sqrt</a>.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="num_integer" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
