mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-28 04:41:02 +01:00
37 lines
11 KiB
HTML
37 lines
11 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="API documentation for the Rust `Average` trait in crate `num_integer`."><meta name="keywords" content="rust, rustlang, rust-lang, Average"><title>num_integer::Average - 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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[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 rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Trait Average</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.average_ceil">average_ceil</a><a href="#tymethod.average_floor">average_floor</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="index.html">num_integer</a></p><div id="sidebar-vars" data-name="Average" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<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="in-band">Trait <a href="index.html">num_integer</a>::<wbr><a class="trait" href="">Average</a></span><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/average.rs.html#5-43" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait Average: <a class="trait" href="../num_integer/trait.Integer.html" title="trait num_integer::Integer">Integer</a> {
|
||
fn <a href="#tymethod.average_ceil" class="fnname">average_ceil</a>(&self, other: &Self) -> Self;
|
||
<div class="item-spacer"></div> fn <a href="#tymethod.average_floor" class="fnname">average_floor</a>(&self, other: &Self) -> Self;
|
||
}</pre></div><div class="docblock"><p>Provides methods to compute the average of two integers, without overflows.</p>
|
||
</div><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><h3 id="tymethod.average_ceil" class="method"><code>fn <a href="#tymethod.average_ceil" class="fnname">average_ceil</a>(&self, other: &Self) -> Self</code><a class="srclink" href="../src/num_integer/average.rs.html#23" title="goto source code">[src]</a></h3><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>
|
||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">num_integer</span>::<span class="ident">Average</span>;
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(( <span class="number">3</span>).<span class="ident">average_ceil</span>(<span class="kw-2">&</span><span class="number">10</span>), <span class="number">7</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>((<span class="op">-</span><span class="number">2</span>).<span class="ident">average_ceil</span>(<span class="kw-2">&</span><span class="op">-</span><span class="number">5</span>), <span class="op">-</span><span class="number">3</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(( <span class="number">4</span>).<span class="ident">average_ceil</span>(<span class="op">&</span> <span class="number">4</span>), <span class="number">4</span>);
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">u8</span>::<span class="ident">max_value</span>().<span class="ident">average_ceil</span>(<span class="kw-2">&</span><span class="number">2</span>), <span class="number">129</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">i8</span>::<span class="ident">min_value</span>().<span class="ident">average_ceil</span>(<span class="kw-2">&</span><span class="op">-</span><span class="number">1</span>), <span class="op">-</span><span class="number">64</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">i8</span>::<span class="ident">min_value</span>().<span class="ident">average_ceil</span>(<span class="kw-2">&</span><span class="ident">i8</span>::<span class="ident">max_value</span>()), <span class="number">0</span>);</pre></div>
|
||
</div><h3 id="tymethod.average_floor" class="method"><code>fn <a href="#tymethod.average_floor" class="fnname">average_floor</a>(&self, other: &Self) -> Self</code><a class="srclink" href="../src/num_integer/average.rs.html#42" title="goto source code">[src]</a></h3><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>
|
||
<h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">num_integer</span>::<span class="ident">Average</span>;
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(( <span class="number">3</span>).<span class="ident">average_floor</span>(<span class="kw-2">&</span><span class="number">10</span>), <span class="number">6</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>((<span class="op">-</span><span class="number">2</span>).<span class="ident">average_floor</span>(<span class="kw-2">&</span><span class="op">-</span><span class="number">5</span>), <span class="op">-</span><span class="number">4</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(( <span class="number">4</span>).<span class="ident">average_floor</span>(<span class="op">&</span> <span class="number">4</span>), <span class="number">4</span>);
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">u8</span>::<span class="ident">max_value</span>().<span class="ident">average_floor</span>(<span class="kw-2">&</span><span class="number">2</span>), <span class="number">128</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">i8</span>::<span class="ident">min_value</span>().<span class="ident">average_floor</span>(<span class="kw-2">&</span><span class="op">-</span><span class="number">1</span>), <span class="op">-</span><span class="number">65</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">i8</span>::<span class="ident">min_value</span>().<span class="ident">average_floor</span>(<span class="kw-2">&</span><span class="ident">i8</span>::<span class="ident">max_value</span>()), <span class="op">-</span><span class="number">1</span>);</pre></div>
|
||
</div></div><span class="loading-content">Loading content...</span><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><h3 id="impl-Average" class="impl"><code class="in-band">impl<I> Average for I <span class="where fmt-newline">where<br> I: <a class="trait" href="../num_integer/trait.Integer.html" title="trait num_integer::Integer">Integer</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/bit/trait.Shr.html" title="trait core::ops::bit::Shr">Shr</a><usize, Output = I>,<br> &'a I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/bit/trait.BitAnd.html" title="trait core::ops::bit::BitAnd">BitAnd</a><&'b I, Output = I> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/bit/trait.BitOr.html" title="trait core::ops::bit::BitOr">BitOr</a><&'b I, Output = I> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/bit/trait.BitXor.html" title="trait core::ops::bit::BitXor">BitXor</a><&'b I, Output = I>, </span></code><a href="#impl-Average" class="anchor"></a><a class="srclink" href="../src/num_integer/average.rs.html#45-65" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.average_floor" class="method"><code>fn <a href="#method.average_floor" class="fnname">average_floor</a>(&self, other: &I) -> I</code><a class="srclink" href="../src/num_integer/average.rs.html#56-58" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns the floor value of the average of <code>self</code> and <code>other</code>.</p>
|
||
</div><h4 id="method.average_ceil" class="method"><code>fn <a href="#method.average_ceil" class="fnname">average_ceil</a>(&self, other: &I) -> I</code><a class="srclink" href="../src/num_integer/average.rs.html#62-64" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns the ceil value of the average of <code>self</code> and <code>other</code>.</p>
|
||
</div></div></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../implementors/num_integer/trait.Average.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="num_integer"></div>
|
||
<script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |