12 lines
8.3 KiB
HTML
12 lines
8.3 KiB
HTML
<!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."><title>num_integer - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="num_integer" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../num_integer/index.html">num_<wbr>integer</a><span class="version">0.1.46</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#compatibility" title="Compatibility">Compatibility</a></li></ul><h3><a href="#structs">Crate Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <span>num_integer</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/num_integer/lib.rs.html#11-1386">Source</a> </span></div><details class="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 class="doc-anchor" href="#compatibility">§</a>Compatibility</h3>
|
||
<p>The <code>num-integer</code> crate is tested for rustc 1.31 and greater.</p>
|
||
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.ExtendedGcd.html" title="struct num_integer::ExtendedGcd">Extended<wbr>Gcd</a></div><div class="desc docblock-short">Greatest common divisor and Bézout coefficients</div></li><li><div class="item-name"><a class="struct" href="struct.IterBinomial.html" title="struct num_integer::IterBinomial">Iter<wbr>Binomial</a></div><div class="desc docblock-short">An iterator over binomial coefficients.</div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.Average.html" title="trait num_integer::Average">Average</a></div><div class="desc docblock-short">Provides methods to compute the average of two integers, without overflows.</div></li><li><div class="item-name"><a class="trait" href="trait.Integer.html" title="trait num_integer::Integer">Integer</a></div></li><li><div class="item-name"><a class="trait" href="trait.Roots.html" title="trait num_integer::Roots">Roots</a></div><div class="desc docblock-short">Provides methods to compute an integer’s square root, cube root,
|
||
and arbitrary <code>n</code>th root.</div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.average_ceil.html" title="fn num_integer::average_ceil">average_<wbr>ceil</a></div><div class="desc 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></li><li><div class="item-name"><a class="fn" href="fn.average_floor.html" title="fn num_integer::average_floor">average_<wbr>floor</a></div><div class="desc 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></li><li><div class="item-name"><a class="fn" href="fn.binomial.html" title="fn num_integer::binomial">binomial</a></div><div class="desc docblock-short">Calculate the binomial coefficient.</div></li><li><div class="item-name"><a class="fn" href="fn.cbrt.html" title="fn num_integer::cbrt">cbrt</a></div><div class="desc docblock-short">Returns the truncated principal cube root of an integer –
|
||
see <a href="trait.Roots.html#method.cbrt">Roots::cbrt</a>.</div></li><li><div class="item-name"><a class="fn" href="fn.div_ceil.html" title="fn num_integer::div_ceil">div_<wbr>ceil</a></div><div class="desc docblock-short">Ceiled integer division</div></li><li><div class="item-name"><a class="fn" href="fn.div_floor.html" title="fn num_integer::div_floor">div_<wbr>floor</a></div><div class="desc docblock-short">Floored integer division</div></li><li><div class="item-name"><a class="fn" href="fn.div_mod_floor.html" title="fn num_integer::div_mod_floor">div_<wbr>mod_<wbr>floor</a></div><div class="desc docblock-short">Simultaneous floored integer division and modulus</div></li><li><div class="item-name"><a class="fn" href="fn.div_rem.html" title="fn num_integer::div_rem">div_rem</a></div><div class="desc docblock-short">Simultaneous integer division and modulus</div></li><li><div class="item-name"><a class="fn" href="fn.gcd.html" title="fn num_integer::gcd">gcd</a></div><div class="desc docblock-short">Calculates the Greatest Common Divisor (GCD) of the number and <code>other</code>. The
|
||
result is always non-negative.</div></li><li><div class="item-name"><a class="fn" href="fn.gcd_lcm.html" title="fn num_integer::gcd_lcm">gcd_lcm</a></div><div class="desc docblock-short">Calculates the Greatest Common Divisor (GCD) and
|
||
Lowest Common Multiple (LCM) of the number and <code>other</code>.</div></li><li><div class="item-name"><a class="fn" href="fn.lcm.html" title="fn num_integer::lcm">lcm</a></div><div class="desc docblock-short">Calculates the Lowest Common Multiple (LCM) of the number and <code>other</code>.</div></li><li><div class="item-name"><a class="fn" href="fn.mod_floor.html" title="fn num_integer::mod_floor">mod_<wbr>floor</a></div><div class="desc docblock-short">Floored integer modulus</div></li><li><div class="item-name"><a class="fn" href="fn.multinomial.html" title="fn num_integer::multinomial">multinomial</a></div><div class="desc docblock-short">Calculate the multinomial coefficient.</div></li><li><div class="item-name"><a class="fn" href="fn.nth_root.html" title="fn num_integer::nth_root">nth_<wbr>root</a></div><div class="desc 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></li><li><div class="item-name"><a class="fn" href="fn.sqrt.html" title="fn num_integer::sqrt">sqrt</a></div><div class="desc docblock-short">Returns the truncated principal square root of an integer –
|
||
see <a href="trait.Roots.html#method.sqrt">Roots::sqrt</a>.</div></li></ul></section></div></main></body></html> |