github-actions[bot]
21 lines
19 KiB
HTML
21 lines
19 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 `Zero` trait in crate `num_traits`."><meta name="keywords" content="rust, rustlang, rust-lang, Zero"><title>num_traits::identities::Zero - 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_traits/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Trait Zero</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.is_zero">is_zero</a><a href="#tymethod.zero">zero</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.set_zero">set_zero</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-Zero-for-Wrapping%3CT%3E">Wrapping<T></a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="../index.html">num_traits</a>::<wbr><a href="index.html">identities</a></p><script>window.sidebarCurrent = {name: "Zero", ty: "trait", relpath: ""};</script><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="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_traits/identities.rs.html#12-29" title="goto source code">[src]</a></span><span class="in-band">Trait <a href="../index.html">num_traits</a>::<wbr><a href="index.html">identities</a>::<wbr><a class="trait" href="">Zero</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait Zero: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Add.html" title="trait core::ops::arith::Add">Add</a><Self, Output = Self> {
|
||
fn <a href="#tymethod.zero" class="fnname">zero</a>() -> Self;
|
||
<div class="item-spacer"></div> fn <a href="#tymethod.is_zero" class="fnname">is_zero</a>(&self) -> bool;
|
||
|
||
fn <a href="#method.set_zero" class="fnname">set_zero</a>(&mut self) { ... }
|
||
}</pre></div><div class="docblock"><p>Defines an additive identity element for <code>Self</code>.</p>
|
||
<h1 id="laws" class="section-header"><a href="#laws">Laws</a></h1>
|
||
<pre><code class="language-{.text}">a + 0 = a ∀ a ∈ Self
|
||
0 + a = a ∀ a ∈ Self
|
||
</code></pre>
|
||
</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.zero" class="method"><code>fn <a href="#tymethod.zero" class="fnname">zero</a>() -> Self</code><a class="srclink" href="../../src/num_traits/identities.rs.html#20" title="goto source code">[src]</a></h3><div class="docblock"><p>Returns the additive identity element of <code>Self</code>, <code>0</code>.</p>
|
||
<h1 id="purity" class="section-header"><a href="#purity">Purity</a></h1>
|
||
<p>This function should return the same result at all times regardless of
|
||
external mutable state, for example values stored in TLS or in
|
||
<code>static mut</code>s.</p>
|
||
</div><h3 id="tymethod.is_zero" class="method"><code>fn <a href="#tymethod.is_zero" class="fnname">is_zero</a>(&self) -> bool</code><a class="srclink" href="../../src/num_traits/identities.rs.html#28" title="goto source code">[src]</a></h3><div class="docblock"><p>Returns <code>true</code> if <code>self</code> is equal to the additive identity.</p>
|
||
</div></div><span class="loading-content">Loading content...</span><h2 id="provided-methods" class="small-section-header">Provided methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><h3 id="method.set_zero" class="method"><code>fn <a href="#method.set_zero" class="fnname">set_zero</a>(&mut self)</code><a class="srclink" href="../../src/num_traits/identities.rs.html#23-25" title="goto source code">[src]</a></h3><div class="docblock"><p>Sets <code>self</code> to the additive identity element of <code>Self</code>, <code>0</code>.</p>
|
||
</div></div><span class="loading-content">Loading content...</span><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><h3 id="impl-Zero-for-Wrapping%3CT%3E" class="impl"><code class="in-band">impl<T: <a class="trait" href="../../num_traits/identities/trait.Zero.html" title="trait num_traits::identities::Zero">Zero</a>> <a class="trait" href="../../num_traits/identities/trait.Zero.html" title="trait num_traits::identities::Zero">Zero</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/wrapping/struct.Wrapping.html" title="struct core::num::wrapping::Wrapping">Wrapping</a><T> <span class="where fmt-newline">where<br> <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/wrapping/struct.Wrapping.html" title="struct core::num::wrapping::Wrapping">Wrapping</a><T>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Add.html" title="trait core::ops::arith::Add">Add</a><Output = <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/wrapping/struct.Wrapping.html" title="struct core::num::wrapping::Wrapping">Wrapping</a><T>>, </span></code><a href="#impl-Zero-for-Wrapping%3CT%3E" class="anchor"></a><a class="srclink" href="../../src/num_traits/identities.rs.html#65-80" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.is_zero" class="method hidden"><code>fn <a href="#method.is_zero" class="fnname">is_zero</a>(&self) -> bool</code><a class="srclink" href="../../src/num_traits/identities.rs.html#69-71" title="goto source code">[src]</a></h4><h4 id="method.set_zero-1" class="method hidden"><code>fn <a href="#method.set_zero" class="fnname">set_zero</a>(&mut self)</code><a class="srclink" href="../../src/num_traits/identities.rs.html#73-75" title="goto source code">[src]</a></h4><h4 id="method.zero" class="method hidden"><code>fn <a href="#method.zero" class="fnname">zero</a>() -> Self</code><a class="srclink" href="../../src/num_traits/identities.rs.html#77-79" title="goto source code">[src]</a></h4></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-Zero" class="impl"><code class="in-band">impl Zero for f32</code><a href="#impl-Zero" class="anchor"></a><a class="srclink" href="../../src/num_traits/identities.rs.html#62" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.zero-1" class="method hidden"><code>fn <a href="#method.zero-1" class="fnname">zero</a>() -> f32</code><a class="srclink" href="../../src/num_traits/identities.rs.html#62" title="goto source code">[src]</a></h4><h4 id="method.is_zero-1" class="method hidden"><code>fn <a href="#method.is_zero-1" class="fnname">is_zero</a>(&self) -> bool</code><a class="srclink" href="../../src/num_traits/identities.rs.html#62" title="goto source code">[src]</a></h4></div><h3 id="impl-Zero-1" class="impl"><code class="in-band">impl Zero for f64</code><a href="#impl-Zero-1" class="anchor"></a><a class="srclink" href="../../src/num_traits/identities.rs.html#63" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.zero-2" class="method hidden"><code>fn <a href="#method.zero-2" class="fnname">zero</a>() -> f64</code><a class="srclink" href="../../src/num_traits/identities.rs.html#63" title="goto source code">[src]</a></h4><h4 id="method.is_zero-2" class="method hidden"><code>fn <a href="#method.is_zero-2" class="fnname">is_zero</a>(&self) -> bool</code><a class="srclink" href="../../src/num_traits/identities.rs.html#63" title="goto source code">[src]</a></h4></div><h3 id="impl-Zero-2" class="impl"><code class="in-band">impl Zero for i8</code><a href="#impl-Zero-2" class="anchor"></a><a class="srclink" href="../../src/num_traits/identities.rs.html#55" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.zero-3" class="method hidden"><code>fn <a href="#method.zero-3" class="fnname">zero</a>() -> i8</code><a class="srclink" href="../../src/num_traits/identities.rs.html#55" title="goto source code">[src]</a></h4><h4 id="method.is_zero-3" class="method hidden"><code>fn <a href="#method.is_zero-3" class="fnname">is_zero</a>(&self) -> bool</code><a class="srclink" href="../../src/num_traits/identities.rs.html#55" title="goto source code">[src]</a></h4></div><h3 id="impl-Zero-3" class="impl"><code class="in-band">impl Zero for i16</code><a href="#impl-Zero-3" class="anchor"></a><a class="srclink" href="../../src/num_traits/identities.rs.html#56" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.zero-4" class="method hidden"><code>fn <a href="#method.zero-4" class="fnname">zero</a>() -> i16</code><a class="srclink" href="../../src/num_traits/identities.rs.html#56" title="goto source code">[src]</a></h4><h4 id="method.is_zero-4" class="method hidden"><code>fn <a href="#method.is_zero-4" class="fnname">is_zero</a>(&self) -> bool</code><a class="srclink" href="../../src/num_traits/identities.rs.html#56" title="goto source code">[src]</a></h4></div><h3 id="impl-Zero-4" class="impl"><code class="in-band">impl Zero for i32</code><a href="#impl-Zero-4" class="anchor"></a><a class="srclink" href="../../src/num_traits/identities.rs.html#57" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.zero-5" class="method hidden"><code>fn <a href="#method.zero-5" class="fnname">zero</a>() -> i32</code><a class="srclink" href="../../src/num_traits/identities.rs.html#57" title="goto source code">[src]</a></h4><h4 id="method.is_zero-5" class="method hidden"><code>fn <a href="#method.is_zero-5" class="fnname">is_zero</a>(&self) -> bool</code><a class="srclink" href="../../src/num_traits/identities.rs.html#57" title="goto source code">[src]</a></h4></div><h3 id="impl-Zero-5" class="impl"><code class="in-band">impl Zero for i64</code><a href="#impl-Zero-5" class="anchor"></a><a class="srclink" href="../../src/num_traits/identities.rs.html#58" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.zero-6" class="method hidden"><code>fn <a href="#method.zero-6" class="fnname">zero</a>() -> i64</code><a class="srclink" href="../../src/num_traits/identities.rs.html#58" title="goto source code">[src]</a></h4><h4 id="method.is_zero-6" class="method hidden"><code>fn <a href="#method.is_zero-6" class="fnname">is_zero</a>(&self) -> bool</code><a class="srclink" href="../../src/num_traits/identities.rs.html#58" title="goto source code">[src]</a></h4></div><h3 id="impl-Zero-6" class="impl"><code class="in-band">impl Zero for i128</code><a href="#impl-Zero-6" class="anchor"></a><a class="srclink" href="../../src/num_traits/identities.rs.html#60" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.zero-7" class="method hidden"><code>fn <a href="#method.zero-7" class="fnname">zero</a>() -> i128</code><a class="srclink" href="../../src/num_traits/identities.rs.html#60" title="goto source code">[src]</a></h4><h4 id="method.is_zero-7" class="method hidden"><code>fn <a href="#method.is_zero-7" class="fnname">is_zero</a>(&self) -> bool</code><a class="srclink" href="../../src/num_traits/identities.rs.html#60" title="goto source code">[src]</a></h4></div><h3 id="impl-Zero-7" class="impl"><code class="in-band">impl Zero for isize</code><a href="#impl-Zero-7" class="anchor"></a><a class="srclink" href="../../src/num_traits/identities.rs.html#54" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.zero-8" class="method hidden"><code>fn <a href="#method.zero-8" class="fnname">zero</a>() -> isize</code><a class="srclink" href="../../src/num_traits/identities.rs.html#54" title="goto source code">[src]</a></h4><h4 id="method.is_zero-8" class="method hidden"><code>fn <a href="#method.is_zero-8" class="fnname">is_zero</a>(&self) -> bool</code><a class="srclink" href="../../src/num_traits/identities.rs.html#54" title="goto source code">[src]</a></h4></div><h3 id="impl-Zero-8" class="impl"><code class="in-band">impl Zero for u8</code><a href="#impl-Zero-8" class="anchor"></a><a class="srclink" href="../../src/num_traits/identities.rs.html#47" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.zero-9" class="method hidden"><code>fn <a href="#method.zero-9" class="fnname">zero</a>() -> u8</code><a class="srclink" href="../../src/num_traits/identities.rs.html#47" title="goto source code">[src]</a></h4><h4 id="method.is_zero-9" class="method hidden"><code>fn <a href="#method.is_zero-9" class="fnname">is_zero</a>(&self) -> bool</code><a class="srclink" href="../../src/num_traits/identities.rs.html#47" title="goto source code">[src]</a></h4></div><h3 id="impl-Zero-9" class="impl"><code class="in-band">impl Zero for u16</code><a href="#impl-Zero-9" class="anchor"></a><a class="srclink" href="../../src/num_traits/identities.rs.html#48" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.zero-10" class="method hidden"><code>fn <a href="#method.zero-10" class="fnname">zero</a>() -> u16</code><a class="srclink" href="../../src/num_traits/identities.rs.html#48" title="goto source code">[src]</a></h4><h4 id="method.is_zero-10" class="method hidden"><code>fn <a href="#method.is_zero-10" class="fnname">is_zero</a>(&self) -> bool</code><a class="srclink" href="../../src/num_traits/identities.rs.html#48" title="goto source code">[src]</a></h4></div><h3 id="impl-Zero-10" class="impl"><code class="in-band">impl Zero for u32</code><a href="#impl-Zero-10" class="anchor"></a><a class="srclink" href="../../src/num_traits/identities.rs.html#49" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.zero-11" class="method hidden"><code>fn <a href="#method.zero-11" class="fnname">zero</a>() -> u32</code><a class="srclink" href="../../src/num_traits/identities.rs.html#49" title="goto source code">[src]</a></h4><h4 id="method.is_zero-11" class="method hidden"><code>fn <a href="#method.is_zero-11" class="fnname">is_zero</a>(&self) -> bool</code><a class="srclink" href="../../src/num_traits/identities.rs.html#49" title="goto source code">[src]</a></h4></div><h3 id="impl-Zero-11" class="impl"><code class="in-band">impl Zero for u64</code><a href="#impl-Zero-11" class="anchor"></a><a class="srclink" href="../../src/num_traits/identities.rs.html#50" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.zero-12" class="method hidden"><code>fn <a href="#method.zero-12" class="fnname">zero</a>() -> u64</code><a class="srclink" href="../../src/num_traits/identities.rs.html#50" title="goto source code">[src]</a></h4><h4 id="method.is_zero-12" class="method hidden"><code>fn <a href="#method.is_zero-12" class="fnname">is_zero</a>(&self) -> bool</code><a class="srclink" href="../../src/num_traits/identities.rs.html#50" title="goto source code">[src]</a></h4></div><h3 id="impl-Zero-12" class="impl"><code class="in-band">impl Zero for u128</code><a href="#impl-Zero-12" class="anchor"></a><a class="srclink" href="../../src/num_traits/identities.rs.html#52" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.zero-13" class="method hidden"><code>fn <a href="#method.zero-13" class="fnname">zero</a>() -> u128</code><a class="srclink" href="../../src/num_traits/identities.rs.html#52" title="goto source code">[src]</a></h4><h4 id="method.is_zero-13" class="method hidden"><code>fn <a href="#method.is_zero-13" class="fnname">is_zero</a>(&self) -> bool</code><a class="srclink" href="../../src/num_traits/identities.rs.html#52" title="goto source code">[src]</a></h4></div><h3 id="impl-Zero-13" class="impl"><code class="in-band">impl Zero for usize</code><a href="#impl-Zero-13" class="anchor"></a><a class="srclink" href="../../src/num_traits/identities.rs.html#46" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.zero-14" class="method hidden"><code>fn <a href="#method.zero-14" class="fnname">zero</a>() -> usize</code><a class="srclink" href="../../src/num_traits/identities.rs.html#46" title="goto source code">[src]</a></h4><h4 id="method.is_zero-14" class="method hidden"><code>fn <a href="#method.is_zero-14" class="fnname">is_zero</a>(&self) -> bool</code><a class="srclink" href="../../src/num_traits/identities.rs.html#46" title="goto source code">[src]</a></h4></div></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../../implementors/num_traits/identities/trait.Zero.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../";window.currentCrate = "num_traits";</script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |