blob: 96368df5191861d498c9d98f83cc9baa80a73673 [file] [log] [blame]
<!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="Useful functions for signed numbers (i.e. numbers that can be negative)."><meta name="keywords" content="rust, rustlang, rust-lang, Signed"><title>Signed in num::traits::sign - Rust</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="sidebar-items.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 trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../../num/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../../num/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Signed</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.abs">abs</a></li><li><a href="#tymethod.abs_sub">abs_sub</a></li><li><a href="#tymethod.is_negative">is_negative</a></li><li><a href="#tymethod.is_positive">is_positive</a></li><li><a href="#tymethod.signum">signum</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-Signed-for-Wrapping%3CT%3E">Wrapping&lt;T&gt;</a></li><li><a href="#impl-Signed-for-f32">f32</a></li><li><a href="#impl-Signed-for-f64">f64</a></li><li><a href="#impl-Signed-for-i128">i128</a></li><li><a href="#impl-Signed-for-i16">i16</a></li><li><a href="#impl-Signed-for-i32">i32</a></li><li><a href="#impl-Signed-for-i64">i64</a></li><li><a href="#impl-Signed-for-i8">i8</a></li><li><a href="#impl-Signed-for-isize">isize</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In num::traits::sign</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><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="main-heading"><h1 class="fqn">Trait <a href="../../index.html">num</a>::<wbr><a href="../index.html">traits</a>::<wbr><a href="index.html">sign</a>::<wbr><a class="trait" href="#">Signed</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../../src/num_traits/sign.rs.html#8">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="item-decl"><pre class="rust trait"><code>pub trait Signed: <a class="trait" href="../../trait.Num.html" title="trait num::Num">Num</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Neg.html" title="trait core::ops::arith::Neg">Neg</a>&lt;Output = Self&gt; {
fn <a href="#tymethod.abs" class="fnname">abs</a>(&amp;self) -&gt; Self;
<span class="item-spacer"></span> fn <a href="#tymethod.abs_sub" class="fnname">abs_sub</a>(&amp;self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self) -&gt; Self;
<span class="item-spacer"></span> fn <a href="#tymethod.signum" class="fnname">signum</a>(&amp;self) -&gt; Self;
<span class="item-spacer"></span> fn <a href="#tymethod.is_positive" class="fnname">is_positive</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>;
<span class="item-spacer"></span> fn <a href="#tymethod.is_negative" class="fnname">is_negative</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>;
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Useful functions for signed numbers (i.e. numbers that can be negative).</p>
</div></details><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.abs" class="method has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#14">source</a><h4 class="code-header">fn <a href="#tymethod.abs" class="fnname">abs</a>(&amp;self) -&gt; Self</h4></section></summary><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></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.abs_sub" class="method has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#20">source</a><h4 class="code-header">fn <a href="#tymethod.abs_sub" class="fnname">abs_sub</a>(&amp;self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self) -&gt; Self</h4></section></summary><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></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.signum" class="method has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#35">source</a><h4 class="code-header">fn <a href="#tymethod.signum" class="fnname">signum</a>(&amp;self) -&gt; Self</h4></section></summary><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></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.is_positive" class="method has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#38">source</a><h4 class="code-header">fn <a href="#tymethod.is_positive" class="fnname">is_positive</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns true if the number is positive and false if the number is zero or negative.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.is_negative" class="method has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#41">source</a><h4 class="code-header">fn <a href="#tymethod.is_negative" class="fnname">is_negative</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns true if the number is negative and false if the number is zero or positive.</p>
</div></details></div><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Signed-for-i64" class="impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#75">source</a><a href="#impl-Signed-for-i64" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="../../trait.Signed.html" title="trait num::Signed">Signed</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a></h3></section></summary><div class="impl-items"><section id="method.abs" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#75">source</a><a href="#method.abs" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.abs" class="fnname">abs</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a></h4></section><section id="method.abs_sub" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#75">source</a><a href="#method.abs_sub" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.abs_sub" class="fnname">abs_sub</a>(&amp;self, other: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a></h4></section><section id="method.signum" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#75">source</a><a href="#method.signum" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.signum" class="fnname">signum</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a></h4></section><section id="method.is_positive" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#75">source</a><a href="#method.is_positive" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.is_positive" class="fnname">is_positive</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section><section id="method.is_negative" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#75">source</a><a href="#method.is_negative" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.is_negative" class="fnname">is_negative</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Signed-for-i128" class="impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#78">source</a><a href="#impl-Signed-for-i128" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="../../trait.Signed.html" title="trait num::Signed">Signed</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i128.html">i128</a></h3></section></summary><div class="impl-items"><section id="method.abs-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#78">source</a><a href="#method.abs-1" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.abs" class="fnname">abs</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i128.html">i128</a></h4></section><section id="method.abs_sub-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#78">source</a><a href="#method.abs_sub-1" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.abs_sub" class="fnname">abs_sub</a>(&amp;self, other: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i128.html">i128</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i128.html">i128</a></h4></section><section id="method.signum-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#78">source</a><a href="#method.signum-1" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.signum" class="fnname">signum</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i128.html">i128</a></h4></section><section id="method.is_positive-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#78">source</a><a href="#method.is_positive-1" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.is_positive" class="fnname">is_positive</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section><section id="method.is_negative-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#78">source</a><a href="#method.is_negative-1" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.is_negative" class="fnname">is_negative</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Signed-for-i8" class="impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#75">source</a><a href="#impl-Signed-for-i8" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="../../trait.Signed.html" title="trait num::Signed">Signed</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a></h3></section></summary><div class="impl-items"><section id="method.abs-2" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#75">source</a><a href="#method.abs-2" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.abs" class="fnname">abs</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a></h4></section><section id="method.abs_sub-2" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#75">source</a><a href="#method.abs_sub-2" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.abs_sub" class="fnname">abs_sub</a>(&amp;self, other: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a></h4></section><section id="method.signum-2" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#75">source</a><a href="#method.signum-2" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.signum" class="fnname">signum</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a></h4></section><section id="method.is_positive-2" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#75">source</a><a href="#method.is_positive-2" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.is_positive" class="fnname">is_positive</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section><section id="method.is_negative-2" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#75">source</a><a href="#method.is_negative-2" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.is_negative" class="fnname">is_negative</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Signed-for-i16" class="impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#75">source</a><a href="#impl-Signed-for-i16" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="../../trait.Signed.html" title="trait num::Signed">Signed</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a></h3></section></summary><div class="impl-items"><section id="method.abs-3" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#75">source</a><a href="#method.abs-3" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.abs" class="fnname">abs</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a></h4></section><section id="method.abs_sub-3" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#75">source</a><a href="#method.abs_sub-3" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.abs_sub" class="fnname">abs_sub</a>(&amp;self, other: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a></h4></section><section id="method.signum-3" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#75">source</a><a href="#method.signum-3" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.signum" class="fnname">signum</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a></h4></section><section id="method.is_positive-3" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#75">source</a><a href="#method.is_positive-3" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.is_positive" class="fnname">is_positive</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section><section id="method.is_negative-3" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#75">source</a><a href="#method.is_negative-3" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.is_negative" class="fnname">is_negative</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Signed-for-Wrapping%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#80">source</a><a href="#impl-Signed-for-Wrapping%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="../../trait.Signed.html" title="trait num::Signed">Signed</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>&lt;T&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="../../trait.Signed.html" title="trait num::Signed">Signed</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="struct" href="https://doc.rust-lang.org/nightly/core/num/wrapping/struct.Wrapping.html" title="struct core::num::wrapping::Wrapping">Wrapping</a>&lt;T&gt;: <a class="trait" href="../../trait.Num.html" title="trait num::Num">Num</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Neg.html" title="trait core::ops::arith::Neg">Neg</a>&lt;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>&lt;T&gt;&gt;,</span></h3></section></summary><div class="impl-items"><section id="method.abs-4" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#85">source</a><a href="#method.abs-4" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.abs" class="fnname">abs</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/wrapping/struct.Wrapping.html" title="struct core::num::wrapping::Wrapping">Wrapping</a>&lt;T&gt;</h4></section><section id="method.abs_sub-4" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#90">source</a><a href="#method.abs_sub-4" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.abs_sub" class="fnname">abs_sub</a>(&amp;self, other: &amp;<a class="struct" href="https://doc.rust-lang.org/nightly/core/num/wrapping/struct.Wrapping.html" title="struct core::num::wrapping::Wrapping">Wrapping</a>&lt;T&gt;) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/wrapping/struct.Wrapping.html" title="struct core::num::wrapping::Wrapping">Wrapping</a>&lt;T&gt;</h4></section><section id="method.signum-4" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#95">source</a><a href="#method.signum-4" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.signum" class="fnname">signum</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/wrapping/struct.Wrapping.html" title="struct core::num::wrapping::Wrapping">Wrapping</a>&lt;T&gt;</h4></section><section id="method.is_positive-4" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#100">source</a><a href="#method.is_positive-4" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.is_positive" class="fnname">is_positive</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section><section id="method.is_negative-4" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#105">source</a><a href="#method.is_negative-4" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.is_negative" class="fnname">is_negative</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Signed-for-i32" class="impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#75">source</a><a href="#impl-Signed-for-i32" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="../../trait.Signed.html" title="trait num::Signed">Signed</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a></h3></section></summary><div class="impl-items"><section id="method.abs-5" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#75">source</a><a href="#method.abs-5" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.abs" class="fnname">abs</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a></h4></section><section id="method.abs_sub-5" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#75">source</a><a href="#method.abs_sub-5" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.abs_sub" class="fnname">abs_sub</a>(&amp;self, other: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a></h4></section><section id="method.signum-5" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#75">source</a><a href="#method.signum-5" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.signum" class="fnname">signum</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a></h4></section><section id="method.is_positive-5" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#75">source</a><a href="#method.is_positive-5" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.is_positive" class="fnname">is_positive</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section><section id="method.is_negative-5" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#75">source</a><a href="#method.is_negative-5" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.is_negative" class="fnname">is_negative</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Signed-for-f64" class="impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#157">source</a><a href="#impl-Signed-for-f64" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="../../trait.Signed.html" title="trait num::Signed">Signed</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.abs-6" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#157">source</a><a href="#method.abs-6" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.abs" class="fnname">abs</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a></h4></section></summary><div class="docblock"><p>Computes the absolute value. Returns <code>NAN</code> if the number is <code>NAN</code>.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.abs_sub-6" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#157">source</a><a href="#method.abs_sub-6" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.abs_sub" class="fnname">abs_sub</a>(&amp;self, other: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a></h4></section></summary><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></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.signum-6" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#157">source</a><a href="#method.signum-6" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.signum" class="fnname">signum</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a></h4></section></summary><div class="docblock"><h5 id="returns"><a href="#returns">Returns</a></h5>
<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></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_positive-6" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#157">source</a><a href="#method.is_positive-6" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.is_positive" class="fnname">is_positive</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns <code>true</code> if the number is positive, including <code>+0.0</code> and <code>INFINITY</code></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_negative-6" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#157">source</a><a href="#method.is_negative-6" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.is_negative" class="fnname">is_negative</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><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></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Signed-for-isize" class="impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#75">source</a><a href="#impl-Signed-for-isize" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="../../trait.Signed.html" title="trait num::Signed">Signed</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a></h3></section></summary><div class="impl-items"><section id="method.abs-7" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#75">source</a><a href="#method.abs-7" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.abs" class="fnname">abs</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a></h4></section><section id="method.abs_sub-7" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#75">source</a><a href="#method.abs_sub-7" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.abs_sub" class="fnname">abs_sub</a>(&amp;self, other: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a></h4></section><section id="method.signum-7" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#75">source</a><a href="#method.signum-7" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.signum" class="fnname">signum</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a></h4></section><section id="method.is_positive-7" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#75">source</a><a href="#method.is_positive-7" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.is_positive" class="fnname">is_positive</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section><section id="method.is_negative-7" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#75">source</a><a href="#method.is_negative-7" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.is_negative" class="fnname">is_negative</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Signed-for-f32" class="impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#156">source</a><a href="#impl-Signed-for-f32" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="../../trait.Signed.html" title="trait num::Signed">Signed</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.abs-8" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#156">source</a><a href="#method.abs-8" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.abs" class="fnname">abs</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a></h4></section></summary><div class="docblock"><p>Computes the absolute value. Returns <code>NAN</code> if the number is <code>NAN</code>.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.abs_sub-8" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#156">source</a><a href="#method.abs_sub-8" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.abs_sub" class="fnname">abs_sub</a>(&amp;self, other: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a></h4></section></summary><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></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.signum-8" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#156">source</a><a href="#method.signum-8" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.signum" class="fnname">signum</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a></h4></section></summary><div class="docblock"><h5 id="returns-1"><a href="#returns-1">Returns</a></h5>
<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></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_positive-8" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#156">source</a><a href="#method.is_positive-8" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.is_positive" class="fnname">is_positive</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns <code>true</code> if the number is positive, including <code>+0.0</code> and <code>INFINITY</code></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_negative-8" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/num_traits/sign.rs.html#156">source</a><a href="#method.is_negative-8" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.is_negative" class="fnname">is_negative</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><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></details></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"><section id="impl-Signed-for-BigInt" class="impl has-srclink"><a class="srclink rightside" href="../../../src/num_bigint/bigint.rs.html#248">source</a><a href="#impl-Signed-for-BigInt" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="../../trait.Signed.html" title="trait num::Signed">Signed</a> for <a class="struct" href="../../struct.BigInt.html" title="struct num::BigInt">BigInt</a></h3></section><section id="impl-Signed-for-Ratio%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../../src/num_rational/lib.rs.html#970">source</a><a href="#impl-Signed-for-Ratio%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="../../trait.Signed.html" title="trait num::Signed">Signed</a> for <a class="struct" href="../../rational/struct.Ratio.html" title="struct num::rational::Ratio">Ratio</a>&lt;T&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> + <a class="trait" href="../../trait.Integer.html" title="trait num::Integer">Integer</a> + <a class="trait" href="../../trait.Signed.html" title="trait num::Signed">Signed</a>,</span></h3></section></div><script src="../../../implementors/num_traits/sign/trait.Signed.js" data-ignore-extern-crates="std,num_bigint,core,num_rational" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="num" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>