|
|
|
|
|
<!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 `Signed` trait in crate `num_traits`."><meta name="keywords" content="rust, rustlang, rust-lang, Signed"><title>num_traits::sign::Signed - 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="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><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'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Trait Signed</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.abs">abs</a><a href="#tymethod.abs_sub">abs_sub</a><a href="#tymethod.is_negative">is_negative</a><a href="#tymethod.is_positive">is_positive</a><a href="#tymethod.signum">signum</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-Signed-for-Wrapping%3CT%3E">Wrapping<T></a><a href="#impl-Signed-for-f32">f32</a><a href="#impl-Signed-for-f64">f64</a><a href="#impl-Signed-for-i128">i128</a><a href="#impl-Signed-for-i16">i16</a><a href="#impl-Signed-for-i32">i32</a><a href="#impl-Signed-for-i64">i64</a><a href="#impl-Signed-for-i8">i8</a><a href="#impl-Signed-for-isize">isize</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'>sign</a></p><script>window.sidebarCurrent = {name: 'Signed', 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!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><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/sign.rs.html#8-42' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../index.html'>num_traits</a>::<wbr><a href='index.html'>sign</a>::<wbr><a class="trait" href=''>Signed</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait Signed: <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="../../num_traits/trait.Num.html" title="trait num_traits::Num">Num</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Neg.html" title="trait core::ops::arit
|
|
|
|
|
|
fn <a href='#tymethod.abs' class='fnname'>abs</a>(&self) -> Self;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.abs_sub' class='fnname'>abs_sub</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self) -> Self;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.signum' class='fnname'>signum</a>(&self) -> Self;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.is_positive' class='fnname'>is_positive</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.is_negative' class='fnname'>is_negative</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>;
|
|
|
|
|
|
}</pre></div><div class='docblock'><p>Useful functions for signed numbers (i.e. numbers that can be negative).</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.abs' class='method'><code id='abs.v'>fn <a href='#tymethod.abs' class='fnname'>abs</a>(&self) -> Self</code></h3><div class='docblock'><p>Computes the absolute value.</p>
|
|
|
|
|
|
<p>For <code>f32</code> and <code>f64</code>, <code>NaN</code> will be returned if the number is <code>NaN</code>.</p>
|
|
|
|
|
|
<p>For signed integers, <code>::MIN</code> will be returned if the number is <code>::MIN</code>.</p>
|
|
|
|
|
|
</div><h3 id='tymethod.abs_sub' class='method'><code id='abs_sub.v'>fn <a href='#tymethod.abs_sub' class='fnname'>abs_sub</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self) -> Self</code></h3><div class='docblock'><p>The positive difference of two numbers.</p>
|
|
|
|
|
|
<p>Returns <code>zero</code> if the number is less than or equal to <code>other</code>, otherwise the difference
|
|
|
|
|
|
between <code>self</code> and <code>other</code> is returned.</p>
|
|
|
|
|
|
</div><h3 id='tymethod.signum' class='method'><code id='signum.v'>fn <a href='#tymethod.signum' class='fnname'>signum</a>(&self) -> Self</code></h3><div class='docblock'><p>Returns the sign of the number.</p>
|
|
|
|
|
|
<p>For <code>f32</code> and <code>f64</code>:</p>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li><code>1.0</code> if the number is positive, <code>+0.0</code> or <code>INFINITY</code></li>
|
|
|
|
|
|
<li><code>-1.0</code> if the number is negative, <code>-0.0</code> or <code>NEG_INFINITY</code></li>
|
|
|
|
|
|
<li><code>NaN</code> if the number is <code>NaN</code></li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
<p>For signed integers:</p>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li><code>0</code> if the number is zero</li>
|
|
|
|
|
|
<li><code>1</code> if the number is positive</li>
|
|
|
|
|
|
<li><code>-1</code> if the number is negative</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</div><h3 id='tymethod.is_positive' class='method'><code id='is_positive.v'>fn <a href='#tymethod.is_positive' class='fnname'>is_positive</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3><div class='docblock'><p>Returns true if the number is positive and false if the number is zero or negative.</p>
|
|
|
|
|
|
</div><h3 id='tymethod.is_negative' class='method'><code id='is_negative.v'>fn <a href='#tymethod.is_negative' class='fnname'>is_negative</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3><div class='docblock'><p>Returns true if the number is negative and false if the number is zero or positive.</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-Signed-for-isize' class='impl'><code class='in-band'>impl <a class="trait" href="../../num_traits/sign/trait.Signed.html" title="trait num_traits::sign::Signed">Signed</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a></code><a href='#impl-Signed-for-isize' class='anchor'></a><a class='srclink' href='../../src/num_traits/sign.rs.html#46-71' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.abs' class="method hidden"><code id='abs.v-1'>fn <a href='#method.abs' class='fnname'>abs</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a></code><a class='srclink' href='../../src/num_traits/sign.rs.html#48-50' title='goto source code'>[src]</a></h4><h4 id='method.abs_sub' class="method hidden"><code id='abs_sub.v-1'>fn <a href='#method.abs_sub' class='fnname'>abs_sub</a>(&self, other: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a></code><a class='srclink' href='../../src/num_traits/sign.rs.html#53-55' title='goto source code'>[src]</a></h4><h4 id='method.signum' class="method hidden"><code id='signum.v-1'>fn <a href='#method.signum' class='fnname'>signum</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a></code><a class='srclink' href='../../src/num_traits/sign.rs.html#58-64' title='goto source code'>[src]</a></h4><h4 id='method.is_positive' class="method hidden"><code id='is_positive.v-1'>fn <a href='#method.is_positive' class='fnname'>is_positive</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../src/num_traits/sign.rs.html#67' title='goto source code'>[src]</a></h4><h4 id='method.is_negative' class="method hidden"><code id='is_negative.v-1'>fn <a href='#method.is_negative' class='fnname'>is_negative</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../src/num_traits/sign.rs.html#70' title='goto source code'>[src]</a></h4></div><h3 id='impl-Signed-for-i8' class='impl'><code class='in-band'>impl <a class="trait" href="../../num_traits/sign/trait.Signed.html" title="trait num_traits::sign::Signed">Signed</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a></code><a href='#impl-Signed-for-i8' class='anchor'></a><a class='srclink' href='../../src/num_traits/sign.rs.html#46-71' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.abs-1' class="method hidden"><code id='abs.v-2'>fn <a href='#method.abs' class='fnname'>abs</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a></code><a class='srclink' href='../../src/num_traits/sign.rs.html#48-50' title='goto source code'>[src]</a></h4><h4 id='method.abs_sub-1' class="method hidden"><code id='abs_sub.v-2'>fn <a href='#method.abs_sub' class='fnname'>abs_sub</a>(&self, other: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a></code><a class='srclink' href='../../src/num_traits/sign.rs.html#53-55' title='goto source code'>[src]</a></h4><h4 id='method.signum-1' class="method hidden"><code id='signum.v-2'>fn <a href='#method.signum' class='fnname'>signum</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a></code><a class='srclink' href='../../src/num_traits/sign.rs.html#58-64' title='goto source code'>[src]</a></h4><h4 id='method.is_positive
|
|
|
|
|
|
</div><h4 id='method.abs_sub-7' class="method"><code id='abs_sub.v-8'>fn <a href='#method.abs_sub' class='fnname'>abs_sub</a>(&self, other: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a></code><a class='srclink' href='../../src/num_traits/sign.rs.html#123-129' title='goto source code'>[src]</a></h4><div class='docblock'><p>The positive difference of two numbers. Returns <code>0.0</code> if the number is
|
|
|
|
|
|
less than or equal to <code>other</code>, otherwise the difference between<code>self</code>
|
|
|
|
|
|
and <code>other</code> is returned.</p>
|
|
|
|
|
|
</div><h4 id='method.signum-7' class="method"><code id='signum.v-8'>fn <a href='#method.signum' class='fnname'>signum</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a></code><a class='srclink' href='../../src/num_traits/sign.rs.html#137-139' title='goto source code'>[src]</a></h4><div class='docblock'><h1 id="returns" class="section-header"><a href="#returns">Returns</a></h1>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li><code>1.0</code> if the number is positive, <code>+0.0</code> or <code>INFINITY</code></li>
|
|
|
|
|
|
<li><code>-1.0</code> if the number is negative, <code>-0.0</code> or <code>NEG_INFINITY</code></li>
|
|
|
|
|
|
<li><code>NAN</code> if the number is NaN</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</div><h4 id='method.is_positive-7' class="method"><code id='is_positive.v-8'>fn <a href='#method.is_positive' class='fnname'>is_positive</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../src/num_traits/sign.rs.html#143-145' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns <code>true</code> if the number is positive, including <code>+0.0</code> and <code>INFINITY</code></p>
|
|
|
|
|
|
</div><h4 id='method.is_negative-7' class="method"><code id='is_negative.v-8'>fn <a href='#method.is_negative' class='fnname'>is_negative</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../src/num_traits/sign.rs.html#149-151' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns <code>true</code> if the number is negative, including <code>-0.0</code> and <code>NEG_INFINITY</code></p>
|
|
|
|
|
|
</div></div><h3 id='impl-Signed-for-f64' class='impl'><code class='in-band'>impl <a class="trait" href="../../num_traits/sign/trait.Signed.html" title="trait num_traits::sign::Signed">Signed</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a></code><a href='#impl-Signed-for-f64' class='anchor'></a><a class='srclink' href='../../src/num_traits/sign.rs.html#112-152' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.abs-8' class="method"><code id='abs.v-9'>fn <a href='#method.abs' class='fnname'>abs</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a></code><a class='srclink' href='../../src/num_traits/sign.rs.html#115-117' title='goto source code'>[src]</a></h4><div class='docblock'><p>Computes the absolute value. Returns <code>NAN</code> if the number is <code>NAN</code>.</p>
|
|
|
|
|
|
</div><h4 id='method.abs_sub-8' class="method"><code id='abs_sub.v-9'>fn <a href='#method.abs_sub' class='fnname'>abs_sub</a>(&self, other: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a></code><a class='srclink' href='../../src/num_traits/sign.rs.html#123-129' title='goto source code'>[src]</a></h4><div class='docblock'><p>The positive difference of two numbers. Returns <code>0.0</code> if the number is
|
|
|
|
|
|
less than or equal to <code>other</code>, otherwise the difference between<code>self</code>
|
|
|
|
|
|
and <code>other</code> is returned.</p>
|
|
|
|
|
|
</div><h4 id='method.signum-8' class="method"><code id='signum.v-9'>fn <a href='#method.signum' class='fnname'>signum</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a></code><a class='srclink' href='../../src/num_traits/sign.rs.html#137-139' title='goto source code'>[src]</a></h4><div class='docblock'><h1 id="returns-1" class="section-header"><a href="#returns-1">Returns</a></h1>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li><code>1.0</code> if the number is positive, <code>+0.0</code> or <code>INFINITY</code></li>
|
|
|
|
|
|
<li><code>-1.0</code> if the number is negative, <code>-0.0</code> or <code>NEG_INFINITY</code></li>
|
|
|
|
|
|
<li><code>NAN</code> if the number is NaN</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</div><h4 id='method.is_positive-8' class="method"><code id='is_positive.v-9'>fn <a href='#method.is_positive' class='fnname'>is_positive</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../src/num_traits/sign.rs.html#143-145' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns <code>true</code> if the number is positive, including <code>+0.0</code> and <code>INFINITY</code></p>
|
|
|
|
|
|
</div><h4 id='method.is_negative-8' class="method"><code id='is_negative.v-9'>fn <a href='#method.is_negative' class='fnname'>is_negative</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../src/num_traits/sign.rs.html#149-151' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns <code>true</code> if the number is negative, including <code>-0.0</code> and <code>NEG_INFINITY</code></p>
|
|
|
|
|
|
</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'></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
|
|
|
|
|
src="../../implementors/num_traits/sign/trait.Signed.js">
|
|
|
|
|
|
</script></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "num_traits";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
|
