| <!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="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/num-integer-0.1.45/src/average.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>average.rs - source</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="../../source-script.js"></script><script defer src="../../source-files.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 source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><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></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../num_integer/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><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="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| </pre><pre class="rust"><code><span class="kw">use </span>core::ops::{BitAnd, BitOr, BitXor, Shr}; |
| <span class="kw">use </span>Integer; |
| |
| <span class="doccomment">/// Provides methods to compute the average of two integers, without overflows. |
| </span><span class="kw">pub trait </span>Average: Integer { |
| <span class="doccomment">/// Returns the ceiling value of the average of `self` and `other`. |
| /// -- `⌈(self + other)/2⌉` |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use num_integer::Average; |
| /// |
| /// assert_eq!(( 3).average_ceil(&10), 7); |
| /// assert_eq!((-2).average_ceil(&-5), -3); |
| /// assert_eq!(( 4).average_ceil(& 4), 4); |
| /// |
| /// assert_eq!(u8::max_value().average_ceil(&2), 129); |
| /// assert_eq!(i8::min_value().average_ceil(&-1), -64); |
| /// assert_eq!(i8::min_value().average_ceil(&i8::max_value()), 0); |
| /// ``` |
| /// |
| </span><span class="kw">fn </span>average_ceil(<span class="kw-2">&</span><span class="self">self</span>, other: <span class="kw-2">&</span><span class="self">Self</span>) -> <span class="self">Self</span>; |
| |
| <span class="doccomment">/// Returns the floor value of the average of `self` and `other`. |
| /// -- `⌊(self + other)/2⌋` |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use num_integer::Average; |
| /// |
| /// assert_eq!(( 3).average_floor(&10), 6); |
| /// assert_eq!((-2).average_floor(&-5), -4); |
| /// assert_eq!(( 4).average_floor(& 4), 4); |
| /// |
| /// assert_eq!(u8::max_value().average_floor(&2), 128); |
| /// assert_eq!(i8::min_value().average_floor(&-1), -65); |
| /// assert_eq!(i8::min_value().average_floor(&i8::max_value()), -1); |
| /// ``` |
| /// |
| </span><span class="kw">fn </span>average_floor(<span class="kw-2">&</span><span class="self">self</span>, other: <span class="kw-2">&</span><span class="self">Self</span>) -> <span class="self">Self</span>; |
| } |
| |
| <span class="kw">impl</span><I> Average <span class="kw">for </span>I |
| <span class="kw">where |
| </span>I: Integer + Shr<usize, Output = I>, |
| <span class="kw">for</span><<span class="lifetime">'a</span>, <span class="lifetime">'b</span>> <span class="kw-2">&</span><span class="lifetime">'a </span>I: |
| BitAnd<<span class="kw-2">&</span><span class="lifetime">'b </span>I, Output = I> + BitOr<<span class="kw-2">&</span><span class="lifetime">'b </span>I, Output = I> + BitXor<<span class="kw-2">&</span><span class="lifetime">'b </span>I, Output = I>, |
| { |
| <span class="comment">// The Henry Gordon Dietz implementation as shown in the Hacker's Delight, |
| // see http://aggregate.org/MAGIC/#Average%20of%20Integers |
| |
| </span><span class="doccomment">/// Returns the floor value of the average of `self` and `other`. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">fn </span>average_floor(<span class="kw-2">&</span><span class="self">self</span>, other: <span class="kw-2">&</span>I) -> I { |
| (<span class="self">self </span>& other) + ((<span class="self">self </span>^ other) >> <span class="number">1</span>) |
| } |
| |
| <span class="doccomment">/// Returns the ceil value of the average of `self` and `other`. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">fn </span>average_ceil(<span class="kw-2">&</span><span class="self">self</span>, other: <span class="kw-2">&</span>I) -> I { |
| (<span class="self">self </span>| other) - ((<span class="self">self </span>^ other) >> <span class="number">1</span>) |
| } |
| } |
| |
| <span class="doccomment">/// Returns the floor value of the average of `x` and `y` -- |
| /// see [Average::average_floor](trait.Average.html#tymethod.average_floor). |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>average_floor<T: Average>(x: T, y: T) -> T { |
| x.average_floor(<span class="kw-2">&</span>y) |
| } |
| <span class="doccomment">/// Returns the ceiling value of the average of `x` and `y` -- |
| /// see [Average::average_ceil](trait.Average.html#tymethod.average_ceil). |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>average_ceil<T: Average>(x: T, y: T) -> T { |
| x.average_ceil(<span class="kw-2">&</span>y) |
| } |
| </code></pre></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> |
