32 lines
9.5 KiB
HTML
32 lines
9.5 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="Provides methods to compute the average of two integers, without overflows."><title>Average in 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="sidebar-items.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 trait"><!--[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"><section id="rustdoc-toc"><h2 class="location"><a href="#">Average</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.average_ceil" title="average_ceil">average_ceil</a></li><li><a href="#tymethod.average_floor" title="average_floor">average_floor</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate num_<wbr>integer</a></h2></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"><span class="rustdoc-breadcrumbs"><a href="index.html">num_integer</a></span><h1>Trait <span class="trait">Average</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/average.rs.html#5-43">Source</a> </span></div><pre class="rust item-decl"><code>pub trait Average: <a class="trait" href="trait.Integer.html" title="trait num_integer::Integer">Integer</a> {
|
||
// Required methods
|
||
fn <a href="#tymethod.average_ceil" class="fn">average_ceil</a>(&self, other: &Self) -> Self;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.average_floor" class="fn">average_floor</a>(&self, other: &Self) -> Self;
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Provides methods to compute the average of two integers, without overflows.</p>
|
||
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.average_ceil" class="method"><a class="src rightside" href="../src/num_integer/average.rs.html#23">Source</a><h4 class="code-header">fn <a href="#tymethod.average_ceil" class="fn">average_ceil</a>(&self, other: &Self) -> Self</h4></section></summary><div class="docblock"><p>Returns the ceiling value of the average of <code>self</code> and <code>other</code>.
|
||
– <code>⌈(self + other)/2⌉</code></p>
|
||
<h5 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>num_integer::Average;
|
||
|
||
<span class="macro">assert_eq!</span>(( <span class="number">3</span>).average_ceil(<span class="kw-2">&</span><span class="number">10</span>), <span class="number">7</span>);
|
||
<span class="macro">assert_eq!</span>((-<span class="number">2</span>).average_ceil(<span class="kw-2">&</span>-<span class="number">5</span>), -<span class="number">3</span>);
|
||
<span class="macro">assert_eq!</span>(( <span class="number">4</span>).average_ceil(& <span class="number">4</span>), <span class="number">4</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(u8::max_value().average_ceil(<span class="kw-2">&</span><span class="number">2</span>), <span class="number">129</span>);
|
||
<span class="macro">assert_eq!</span>(i8::min_value().average_ceil(<span class="kw-2">&</span>-<span class="number">1</span>), -<span class="number">64</span>);
|
||
<span class="macro">assert_eq!</span>(i8::min_value().average_ceil(<span class="kw-2">&</span>i8::max_value()), <span class="number">0</span>);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.average_floor" class="method"><a class="src rightside" href="../src/num_integer/average.rs.html#42">Source</a><h4 class="code-header">fn <a href="#tymethod.average_floor" class="fn">average_floor</a>(&self, other: &Self) -> Self</h4></section></summary><div class="docblock"><p>Returns the floor value of the average of <code>self</code> and <code>other</code>.
|
||
– <code>⌊(self + other)/2⌋</code></p>
|
||
<h5 id="examples-1"><a class="doc-anchor" href="#examples-1">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>num_integer::Average;
|
||
|
||
<span class="macro">assert_eq!</span>(( <span class="number">3</span>).average_floor(<span class="kw-2">&</span><span class="number">10</span>), <span class="number">6</span>);
|
||
<span class="macro">assert_eq!</span>((-<span class="number">2</span>).average_floor(<span class="kw-2">&</span>-<span class="number">5</span>), -<span class="number">4</span>);
|
||
<span class="macro">assert_eq!</span>(( <span class="number">4</span>).average_floor(& <span class="number">4</span>), <span class="number">4</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(u8::max_value().average_floor(<span class="kw-2">&</span><span class="number">2</span>), <span class="number">128</span>);
|
||
<span class="macro">assert_eq!</span>(i8::min_value().average_floor(<span class="kw-2">&</span>-<span class="number">1</span>), -<span class="number">65</span>);
|
||
<span class="macro">assert_eq!</span>(i8::min_value().average_floor(<span class="kw-2">&</span>i8::max_value()), -<span class="number">1</span>);</code></pre></div>
|
||
</div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.84.0/reference/items/traits.html#object-safety">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-Average-for-I" class="impl"><a class="src rightside" href="../src/num_integer/average.rs.html#45-65">Source</a><a href="#impl-Average-for-I" class="anchor">§</a><h3 class="code-header">impl<I> <a class="trait" href="trait.Average.html" title="trait num_integer::Average">Average</a> for I<div class="where">where
|
||
I: <a class="trait" href="trait.Integer.html" title="trait num_integer::Integer">Integer</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/ops/bit/trait.Shr.html" title="trait core::ops::bit::Shr">Shr</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>, Output = I>,
|
||
for<'a, 'b> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&'a I</a>: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/ops/bit/trait.BitAnd.html" title="trait core::ops::bit::BitAnd">BitAnd</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&'b I</a>, Output = I> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/ops/bit/trait.BitOr.html" title="trait core::ops::bit::BitOr">BitOr</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&'b I</a>, Output = I> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/ops/bit/trait.BitXor.html" title="trait core::ops::bit::BitXor">BitXor</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&'b I</a>, Output = I>,</div></h3></section></div><script src="../trait.impl/num_integer/average/trait.Average.js" async></script></section></div></main></body></html> |