github-actions[bot]
22 lines
15 KiB
HTML
22 lines
15 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 `WrappingNeg` trait in crate `num_traits`."><meta name="keywords" content="rust, rustlang, rust-lang, WrappingNeg"><title>num_traits::ops::wrapping::WrappingNeg - 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 WrappingNeg</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.wrapping_neg">wrapping_neg</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-WrappingNeg-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">ops</a>::<wbr><a href="index.html">wrapping</a></p><script>window.sidebarCurrent = {name: "WrappingNeg", 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/ops/wrapping.rs.html#104-123" title="goto source code">[src]</a></span><span class="in-band">Trait <a href="../../index.html">num_traits</a>::<wbr><a href="../index.html">ops</a>::<wbr><a href="index.html">wrapping</a>::<wbr><a class="trait" href="">WrappingNeg</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait WrappingNeg: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
||
fn <a href="#tymethod.wrapping_neg" class="fnname">wrapping_neg</a>(&self) -> Self;
|
||
}</pre></div><div class="docblock"><p>Performs a negation that does not panic.</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.wrapping_neg" class="method"><code>fn <a href="#tymethod.wrapping_neg" class="fnname">wrapping_neg</a>(&self) -> Self</code><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#122" title="goto source code">[src]</a></h3><div class="docblock"><p>Wrapping (modular) negation. Computes <code>-self</code>,
|
||
wrapping around at the boundary of the type.</p>
|
||
<p>Since unsigned types do not have negative equivalents
|
||
all applications of this function will wrap (except for <code>-0</code>).
|
||
For values smaller than the corresponding signed type's maximum
|
||
the result is the same as casting the corresponding signed value.
|
||
Any larger values are equivalent to <code>MAX + 1 - (val - MAX - 1)</code> where
|
||
<code>MAX</code> is the corresponding signed type's maximum.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">WrappingNeg</span>;
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">100i8</span>.<span class="ident">wrapping_neg</span>(), <span class="op">-</span><span class="number">100</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>((<span class="op">-</span><span class="number">100i8</span>).<span class="ident">wrapping_neg</span>(), <span class="number">100</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>((<span class="op">-</span><span class="number">128i8</span>).<span class="ident">wrapping_neg</span>(), <span class="op">-</span><span class="number">128</span>); <span class="comment">// wrapped!</span></pre></div>
|
||
</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-WrappingNeg-for-Wrapping%3CT%3E" class="impl"><code class="in-band">impl<T: <a class="trait" href="../../../num_traits/ops/wrapping/trait.WrappingNeg.html" title="trait num_traits::ops::wrapping::WrappingNeg">WrappingNeg</a>> <a class="trait" href="../../../num_traits/ops/wrapping/trait.WrappingNeg.html" title="trait num_traits::ops::wrapping::WrappingNeg">WrappingNeg</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.Neg.html" title="trait core::ops::arith::Neg">Neg</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-WrappingNeg-for-Wrapping%3CT%3E" class="anchor"></a><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#246-253" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.wrapping_neg" class="method hidden"><code>fn <a href="#method.wrapping_neg" class="fnname">wrapping_neg</a>(&self) -> Self</code><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#250-252" 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-WrappingNeg" class="impl"><code class="in-band">impl WrappingNeg for i8</code><a href="#impl-WrappingNeg" class="anchor"></a><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#132" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.wrapping_neg-1" class="method hidden"><code>fn <a href="#method.wrapping_neg-1" class="fnname">wrapping_neg</a>(&self) -> i8</code><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#132" title="goto source code">[src]</a></h4></div><h3 id="impl-WrappingNeg-1" class="impl"><code class="in-band">impl WrappingNeg for i16</code><a href="#impl-WrappingNeg-1" class="anchor"></a><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#133" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.wrapping_neg-2" class="method hidden"><code>fn <a href="#method.wrapping_neg-2" class="fnname">wrapping_neg</a>(&self) -> i16</code><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#133" title="goto source code">[src]</a></h4></div><h3 id="impl-WrappingNeg-2" class="impl"><code class="in-band">impl WrappingNeg for i32</code><a href="#impl-WrappingNeg-2" class="anchor"></a><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#134" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.wrapping_neg-3" class="method hidden"><code>fn <a href="#method.wrapping_neg-3" class="fnname">wrapping_neg</a>(&self) -> i32</code><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#134" title="goto source code">[src]</a></h4></div><h3 id="impl-WrappingNeg-3" class="impl"><code class="in-band">impl WrappingNeg for i64</code><a href="#impl-WrappingNeg-3" class="anchor"></a><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#135" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.wrapping_neg-4" class="method hidden"><code>fn <a href="#method.wrapping_neg-4" class="fnname">wrapping_neg</a>(&self) -> i64</code><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#135" title="goto source code">[src]</a></h4></div><h3 id="impl-WrappingNeg-4" class="impl"><code class="in-band">impl WrappingNeg for i128</code><a href="#impl-WrappingNeg-4" class="anchor"></a><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#138" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.wrapping_neg-5" class="method hidden"><code>fn <a href="#method.wrapping_neg-5" class="fnname">wrapping_neg</a>(&self) -> i128</code><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#138" title="goto source code">[src]</a></h4></div><h3 id="impl-WrappingNeg-5" class="impl"><code class="in-band">impl WrappingNeg for isize</code><a href="#impl-WrappingNeg-5" class="anchor"></a><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#136" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.wrapping_neg-6" class="method hidden"><code>fn <a href="#method.wrapping_neg-6" class="fnname">wrapping_neg</a>(&self) -> isize</code><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#136" title="goto source code">[src]</a></h4></div><h3 id="impl-WrappingNeg-6" class="impl"><code class="in-band">impl WrappingNeg for u8</code><a href="#impl-WrappingNeg-6" class="anchor"></a><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#125" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.wrapping_neg-7" class="method hidden"><code>fn <a href="#method.wrapping_neg-7" class="fnname">wrapping_neg</a>(&self) -> u8</code><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#125" title="goto source code">[src]</a></h4></div><h3 id="impl-WrappingNeg-7" class="impl"><code class="in-band">impl WrappingNeg for u16</code><a href="#impl-WrappingNeg-7" class="anchor"></a><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#126" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.wrapping_neg-8" class="method hidden"><code>fn <a href="#method.wrapping_neg-8" class="fnname">wrapping_neg</a>(&self) -> u16</code><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#126" title="goto source code">[src]</a></h4></div><h3 id="impl-WrappingNeg-8" class="impl"><code class="in-band">impl WrappingNeg for u32</code><a href="#impl-WrappingNeg-8" class="anchor"></a><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#127" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.wrapping_neg-9" class="method hidden"><code>fn <a href="#method.wrapping_neg-9" class="fnname">wrapping_neg</a>(&self) -> u32</code><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#127" title="goto source code">[src]</a></h4></div><h3 id="impl-WrappingNeg-9" class="impl"><code class="in-band">impl WrappingNeg for u64</code><a href="#impl-WrappingNeg-9" class="anchor"></a><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#128" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.wrapping_neg-10" class="method hidden"><code>fn <a href="#method.wrapping_neg-10" class="fnname">wrapping_neg</a>(&self) -> u64</code><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#128" title="goto source code">[src]</a></h4></div><h3 id="impl-WrappingNeg-10" class="impl"><code class="in-band">impl WrappingNeg for u128</code><a href="#impl-WrappingNeg-10" class="anchor"></a><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#131" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.wrapping_neg-11" class="method hidden"><code>fn <a href="#method.wrapping_neg-11" class="fnname">wrapping_neg</a>(&self) -> u128</code><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#131" title="goto source code">[src]</a></h4></div><h3 id="impl-WrappingNeg-11" class="impl"><code class="in-band">impl WrappingNeg for usize</code><a href="#impl-WrappingNeg-11" class="anchor"></a><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#129" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.wrapping_neg-12" class="method hidden"><code>fn <a href="#method.wrapping_neg-12" class="fnname">wrapping_neg</a>(&self) -> usize</code><a class="srclink" href="../../../src/num_traits/ops/wrapping.rs.html#129" title="goto source code">[src]</a></h4></div></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../../../implementors/num_traits/ops/wrapping/trait.WrappingNeg.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> |