<!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="../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../main.css">
<link rel="shortcut icon" href="http://rust-num.github.io/num/favicon.ico">
</head>
<body class="rustdoc">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<a href='../num/index.html'><img src='http://rust-num.github.io/num/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a>
<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>
</nav>
<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">
</div>
</form>
</nav>
<section id='main' class="content trait">
<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'>−</span>]
</a>
</span><a id='src-97' class='srclink' href='../num_traits/sign/trait.Signed.html?gotosrc=97' title='goto source code'>[src]</a></span></h1>
<pre class='rust trait'>pub trait Signed: <a class='trait' href='../num/traits/trait.Num.html' title='num::traits::Num'>Num</a> + <a class='trait' href='https://doc.rust-lang.org/nightly/core/ops/trait.Neg.html' title='core::ops::Neg'>Neg</a><Output=Self> {
fn <a href='#tymethod.abs' class='fnname'>abs</a>(&self) -> Self;
fn <a href='#tymethod.abs_sub' class='fnname'>abs_sub</a>(&self, other: &Self) -> Self;
fn <a href='#tymethod.signum' class='fnname'>signum</a>(&self) -> Self;
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>;
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 class='docblock'><p>Useful functions for signed numbers (i.e. numbers that can be negative).</p>
</div>
<h2 id='required-methods'>Required Methods</h2>
<div class='methods'>
<h3 id='tymethod.abs' class='method stab '><span id='abs.v' class='invisible'><code>fn <a href='#tymethod.abs' class='fnname'>abs</a>(&self) -> Self</code></span></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 stab '><span id='abs_sub.v' class='invisible'><code>fn <a href='#tymethod.abs_sub' class='fnname'>abs_sub</a>(&self, other: &Self) -> Self</code></span></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 stab '><span id='signum.v' class='invisible'><code>fn <a href='#tymethod.signum' class='fnname'>signum</a>(&self) -> Self</code></span></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 stab '><span id='is_positive.v' class='invisible'><code>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></span></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 stab '><span id='is_negative.v' class='invisible'><code>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></span></h3><div class='docblock'><p>Returns true if the number is negative and false if the number is zero or positive.</p>
</div></div>
<h2 id='implementors'>Implementors</h2>
<ul class='item-list' id='implementors-list'>
<li><code>impl<T> Signed for <a class='struct' href='../num/rational/struct.Ratio.html' title='num::rational::Ratio'>Ratio</a><T> <span class='where'>where T: <a class='trait' href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html' title='core::clone::Clone'>Clone</a> + <a class='trait' href='../num/integer/trait.Integer.html' title='num::integer::Integer'>Integer</a> + <a class='trait' href='../num/traits/trait.Signed.html' title='num::traits::Signed'>Signed</a></span></code></li>
<li><code>impl Signed for <a class='struct' href='../num/bigint/struct.BigInt.html' title='num::bigint::BigInt'>BigInt</a></code></li>
<li><code>impl Signed for <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.isize.html'>isize</a></code></li>
<li><code>impl Signed for <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.i8.html'>i8</a></code></li>
<li><code>impl Signed for <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.i16.html'>i16</a></code></li>
<li><code>impl Signed for <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.i32.html'>i32</a></code></li>
<li><code>impl Signed for <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.i64.html'>i64</a></code></li>
<li><code>impl Signed for <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.f32.html'>f32</a></code></li>
<li><code>impl Signed for <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.f64.html'>f64</a></code></li>
</ul><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>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>⇤</dt>
<dd>Move up in search results</dd>
<dt>⇥</dt>
<dd>Move down in search results</dd>
<dt>⏎</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand 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>
</div>
</div>
</aside>
<script>
window.rootPath = "../";
window.currentCrate = "num";
window.playgroundUrl = "http://play.rust-lang.org/";
</script>
<script src="../jquery.js"></script>
<script src="../main.js"></script>
<script src="../playpen.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>