trait.Signed.html 43 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. <!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`."><meta name="keywords" content="rust, rustlang, rust-lang, Signed"><title>num::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></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">&#9776;</div><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.signum">signum</a><a href="#tymethod.is_positive">is_positive</a><a href="#tymethod.is_negative">is_negative</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-Signed">i8</a><a href="#impl-Signed">f64</a><a href="#impl-Signed">i64</a><a href="#impl-Signed">Wrapping&lt;T&gt;</a><a href="#impl-Signed">f32</a><a href="#impl-Signed">isize</a><a href="#impl-Signed">i16</a><a href="#impl-Signed">i128</a><a href="#impl-Signed">i32</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>num</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"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Trait <a href='index.html'>num</a>::<wbr><a class="trait" href=''>Signed</a></span><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>&#x2212;</span>]</a></span><a class='srclink' href='../src/num_traits/sign.rs.html#8-42' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust trait'>pub trait Signed: <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::arith::Neg">Neg</a>&lt;Output = Self&gt; {
  2. fn <a href='#tymethod.abs' class='fnname'>abs</a>(&amp;self) -&gt; Self;
  3. <div class='item-spacer'></div> 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;
  4. <div class='item-spacer'></div> fn <a href='#tymethod.signum' class='fnname'>signum</a>(&amp;self) -&gt; Self;
  5. <div class='item-spacer'></div> 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>;
  6. <div class='item-spacer'></div> 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>;
  7. }</pre></div><div class='docblock'><p>Useful functions for signed numbers (i.e. numbers that can be negative).</p>
  8. </div>
  9. <h2 id='required-methods' class='small-section-header'>
  10. Required Methods<a href='#required-methods' class='anchor'></a>
  11. </h2>
  12. <div class='methods'>
  13. <h3 id='tymethod.abs' class='method'><span id='abs.v' class='invisible'><code>fn <a href='#tymethod.abs' class='fnname'>abs</a>(&amp;self) -&gt; Self</code></span></h3><div class='docblock'><p>Computes the absolute value.</p>
  14. <p>For <code>f32</code> and <code>f64</code>, <code>NaN</code> will be returned if the number is <code>NaN</code>.</p>
  15. <p>For signed integers, <code>::MIN</code> will be returned if the number is <code>::MIN</code>.</p>
  16. </div><h3 id='tymethod.abs_sub' class='method'><span id='abs_sub.v' class='invisible'><code>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</code></span></h3><div class='docblock'><p>The positive difference of two numbers.</p>
  17. <p>Returns <code>zero</code> if the number is less than or equal to <code>other</code>, otherwise the difference
  18. between <code>self</code> and <code>other</code> is returned.</p>
  19. </div><h3 id='tymethod.signum' class='method'><span id='signum.v' class='invisible'><code>fn <a href='#tymethod.signum' class='fnname'>signum</a>(&amp;self) -&gt; Self</code></span></h3><div class='docblock'><p>Returns the sign of the number.</p>
  20. <p>For <code>f32</code> and <code>f64</code>:</p>
  21. <ul>
  22. <li><code>1.0</code> if the number is positive, <code>+0.0</code> or <code>INFINITY</code></li>
  23. <li><code>-1.0</code> if the number is negative, <code>-0.0</code> or <code>NEG_INFINITY</code></li>
  24. <li><code>NaN</code> if the number is <code>NaN</code></li>
  25. </ul>
  26. <p>For signed integers:</p>
  27. <ul>
  28. <li><code>0</code> if the number is zero</li>
  29. <li><code>1</code> if the number is positive</li>
  30. <li><code>-1</code> if the number is negative</li>
  31. </ul>
  32. </div><h3 id='tymethod.is_positive' class='method'><span id='is_positive.v' class='invisible'><code>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></code></span></h3><div class='docblock'><p>Returns true if the number is positive and false if the number is zero or negative.</p>
  33. </div><h3 id='tymethod.is_negative' class='method'><span id='is_negative.v' class='invisible'><code>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></span></h3><div class='docblock'><p>Returns true if the number is negative and false if the number is zero or positive.</p>
  34. </div></div>
  35. <h2 id='foreign-impls' class='small-section-header'>
  36. Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a>
  37. </h2>
  38. <h3 id='impl-Signed' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>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' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#46-71' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='method.abs' class="method"><span id='abs.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.abs' class='fnname'>abs</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#48-50' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.abs_sub' class="method"><span id='abs_sub.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.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></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#53-55' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.signum' class="method"><span id='signum.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.signum' class='fnname'>signum</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#58-64' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.is_positive' class="method"><span id='is_positive.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.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></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#67' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.is_negative' class="method"><span id='is_negative.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#70' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4></div></span><h3 id='impl-Signed-1' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>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-1' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#106-138' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='method.abs-1' class="method"><span id='abs.v-2' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.abs' class='fnname'>abs</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#109-111' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Computes the absolute value. Returns <code>NAN</code> if the number is <code>NAN</code>.</p>
  39. </div><h4 id='method.abs_sub-1' class="method"><span id='abs_sub.v-2' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.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></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#117-119' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>The positive difference of two numbers. Returns <code>0.0</code> if the number is
  40. less than or equal to <code>other</code>, otherwise the difference between<code>self</code>
  41. and <code>other</code> is returned.</p>
  42. </div><h4 id='method.signum-1' class="method"><span id='signum.v-2' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.signum' class='fnname'>signum</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#127-129' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><h1 id="returns" class="section-header"><a href="#returns">Returns</a></h1>
  43. <ul>
  44. <li><code>1.0</code> if the number is positive, <code>+0.0</code> or <code>INFINITY</code></li>
  45. <li><code>-1.0</code> if the number is negative, <code>-0.0</code> or <code>NEG_INFINITY</code></li>
  46. <li><code>NAN</code> if the number is NaN</li>
  47. </ul>
  48. </div><h4 id='method.is_positive-1' class="method"><span id='is_positive.v-2' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.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></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#133' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns <code>true</code> if the number is positive, including <code>+0.0</code> and <code>INFINITY</code></p>
  49. </div><h4 id='method.is_negative-1' class="method"><span id='is_negative.v-2' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#137' title='goto source code'>[src]</a></td></tr></tbody></table></span></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>
  50. </div></div></span><h3 id='impl-Signed-2' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>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.i64.html">i64</a></code><a href='#impl-Signed-2' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#46-71' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='method.abs-2' class="method"><span id='abs.v-3' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.abs' class='fnname'>abs</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#48-50' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.abs_sub-2' class="method"><span id='abs_sub.v-3' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.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></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#53-55' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.signum-2' class="method"><span id='signum.v-3' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.signum' class='fnname'>signum</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#58-64' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.is_positive-2' class="method"><span id='is_positive.v-3' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.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></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#67' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.is_negative-2' class="method"><span id='is_negative.v-3' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#70' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4></div></span><h3 id='impl-Signed-3' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl&lt;T&gt; <a class="trait" href="../num/traits/sign/trait.Signed.html" title="trait num::traits::sign::Signed">Signed</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.Wrapping.html" title="struct core::num::Wrapping">Wrapping</a>&lt;T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="../num/traits/sign/trait.Signed.html" title="trait num::traits::sign::Signed">Signed</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.Wrapping.html" title="struct core::num::Wrapping">Wrapping</a>&lt;T&gt;: <a class="trait" href="../num/traits/trait.Num.html" title="trait num::traits::Num">Num</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.Wrapping.html" title="struct core::num::Wrapping">Wrapping</a>&lt;T&gt;: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Neg.html" title="trait core::ops::arith::Neg">Neg</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.Wrapping.html" title="struct core::num::Wrapping">Wrapping</a>&lt;T&gt; as <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Neg.html" title="trait core::ops::arith::Neg">Neg</a>&gt;::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Neg.html#associatedtype.Output" title="type core::ops::arith::Neg::Output">Output</a> == <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.Wrapping.html" title="struct core::num::Wrapping">Wrapping</a>&lt;T&gt;,&nbsp;</span></code><a href='#impl-Signed-3' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#80-102' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='method.abs-3' class="method"><span id='abs.v-4' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.abs' class='fnname'>abs</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.Wrapping.html" title="struct core::num::Wrapping">Wrapping</a>&lt;T&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#83-85' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.abs_sub-3' class="method"><span id='abs_sub.v-4' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.abs_sub' class='fnname'>abs_sub</a>(&amp;self, other: &amp;<a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.Wrapping.html" title="struct core::num::Wrapping">Wrapping</a>&lt;T&gt;) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.Wrapping.html" title="struct core::num::Wrapping">Wrapping</a>&lt;T&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#88-90' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.signum-3' class="method"><span id='signum.v-4' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.signum' class='fnname'>signum</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.Wrapping.html" title="struct core::num::Wrapping">Wrapping</a>&lt;T&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#93-95' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.is_positive-3' class="method"><span id='is_positive.v-4' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.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></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#98' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.is_negative-3' class="method"><span id='is_negative.v-4' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#101' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4></div></span><h3 id='impl-Signed-4' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>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.f32.html">f32</a></code><a href='#impl-Signed-4' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#106-138' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='method.abs-4' class="method"><span id='abs.v-5' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.abs' class='fnname'>abs</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#109-111' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Computes the absolute value. Returns <code>NAN</code> if the number is <code>NAN</code>.</p>
  51. </div><h4 id='method.abs_sub-4' class="method"><span id='abs_sub.v-5' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.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></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#117-119' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>The positive difference of two numbers. Returns <code>0.0</code> if the number is
  52. less than or equal to <code>other</code>, otherwise the difference between<code>self</code>
  53. and <code>other</code> is returned.</p>
  54. </div><h4 id='method.signum-4' class="method"><span id='signum.v-5' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.signum' class='fnname'>signum</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#127-129' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><h1 id="returns-1" class="section-header"><a href="#returns-1">Returns</a></h1>
  55. <ul>
  56. <li><code>1.0</code> if the number is positive, <code>+0.0</code> or <code>INFINITY</code></li>
  57. <li><code>-1.0</code> if the number is negative, <code>-0.0</code> or <code>NEG_INFINITY</code></li>
  58. <li><code>NAN</code> if the number is NaN</li>
  59. </ul>
  60. </div><h4 id='method.is_positive-4' class="method"><span id='is_positive.v-5' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.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></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#133' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns <code>true</code> if the number is positive, including <code>+0.0</code> and <code>INFINITY</code></p>
  61. </div><h4 id='method.is_negative-4' class="method"><span id='is_negative.v-5' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#137' title='goto source code'>[src]</a></td></tr></tbody></table></span></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>
  62. </div></div></span><h3 id='impl-Signed-5' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>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-5' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#46-71' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='method.abs-5' class="method"><span id='abs.v-6' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.abs' class='fnname'>abs</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#48-50' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.abs_sub-5' class="method"><span id='abs_sub.v-6' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.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></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#53-55' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.signum-5' class="method"><span id='signum.v-6' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.signum' class='fnname'>signum</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#58-64' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.is_positive-5' class="method"><span id='is_positive.v-6' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.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></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#67' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.is_negative-5' class="method"><span id='is_negative.v-6' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#70' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4></div></span><h3 id='impl-Signed-6' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>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.i16.html">i16</a></code><a href='#impl-Signed-6' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#46-71' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='method.abs-6' class="method"><span id='abs.v-7' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.abs' class='fnname'>abs</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#48-50' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.abs_sub-6' class="method"><span id='abs_sub.v-7' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.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></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#53-55' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.signum-6' class="method"><span id='signum.v-7' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.signum' class='fnname'>signum</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#58-64' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.is_positive-6' class="method"><span id='is_positive.v-7' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.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></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#67' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.is_negative-6' class="method"><span id='is_negative.v-7' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#70' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4></div></span><h3 id='impl-Signed-7' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>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.i128.html">i128</a></code><a href='#impl-Signed-7' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#46-71' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='method.abs-7' class="method"><span id='abs.v-8' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.abs' class='fnname'>abs</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i128.html">i128</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#48-50' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.abs_sub-7' class="method"><span id='abs_sub.v-8' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.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></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#53-55' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.signum-7' class="method"><span id='signum.v-8' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.signum' class='fnname'>signum</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i128.html">i128</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#58-64' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.is_positive-7' class="method"><span id='is_positive.v-8' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.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></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#67' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.is_negative-7' class="method"><span id='is_negative.v-8' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#70' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4></div></span><h3 id='impl-Signed-8' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>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.i32.html">i32</a></code><a href='#impl-Signed-8' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#46-71' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='method.abs-8' class="method"><span id='abs.v-9' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.abs' class='fnname'>abs</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#48-50' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.abs_sub-8' class="method"><span id='abs_sub.v-9' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.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></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#53-55' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.signum-8' class="method"><span id='signum.v-9' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.signum' class='fnname'>signum</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#58-64' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.is_positive-8' class="method"><span id='is_positive.v-9' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.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></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#67' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.is_negative-8' class="method"><span id='is_negative.v-9' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/num_traits/sign.rs.html#70' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4></div></span>
  63. <h2 id='implementors' class='small-section-header'>
  64. Implementors<a href='#implementors' class='anchor'></a>
  65. </h2>
  66. <ul class='item-list' id='implementors-list'>
  67. <li><table class='table-display'><tbody><tr><td><code>impl Signed for <a class="struct" href="../num/bigint/struct.BigInt.html" title="struct num::bigint::BigInt">BigInt</a></code><td><div class='out-of-band'><a class='srclink' href='../src/num_bigint/bigint.rs.html#268-304' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
  68. <li><table class='table-display'><tbody><tr><td><code>impl&lt;T&gt; Signed for <a class="struct" href="../num/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="../num/integer/trait.Integer.html" title="trait num::integer::Integer">Integer</a> + <a class="trait" href="../num/traits/sign/trait.Signed.html" title="trait num::traits::sign::Signed">Signed</a>,&nbsp;</span></code><td><div class='out-of-band'><a class='srclink' href='../src/num_rational/lib.rs.html#766-807' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
  69. </ul><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
  70. src="../implementors/num_traits/sign/trait.Signed.js">
  71. </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>&#9166;</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";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>