<!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="Source to the Rust file `/home/frans/.cargo/registry/src/github.com-1ecc6299db9ec823/num-traits-0.1.32/src/sign.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>sign.rs.html -- source</title>
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../main.css">
</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">
</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 source"><pre class="line-numbers"><span id="1"> 1</span>
<span id="2"> 2</span>
<span id="3"> 3</span>
<span id="4"> 4</span>
<span id="5"> 5</span>
<span id="6"> 6</span>
<span id="7"> 7</span>
<span id="8"> 8</span>
<span id="9"> 9</span>
<span id="10"> 10</span>
<span id="11"> 11</span>
<span id="12"> 12</span>
<span id="13"> 13</span>
<span id="14"> 14</span>
<span id="15"> 15</span>
<span id="16"> 16</span>
<span id="17"> 17</span>
<span id="18"> 18</span>
<span id="19"> 19</span>
<span id="20"> 20</span>
<span id="21"> 21</span>
<span id="22"> 22</span>
<span id="23"> 23</span>
<span id="24"> 24</span>
<span id="25"> 25</span>
<span id="26"> 26</span>
<span id="27"> 27</span>
<span id="28"> 28</span>
<span id="29"> 29</span>
<span id="30"> 30</span>
<span id="31"> 31</span>
<span id="32"> 32</span>
<span id="33"> 33</span>
<span id="34"> 34</span>
<span id="35"> 35</span>
<span id="36"> 36</span>
<span id="37"> 37</span>
<span id="38"> 38</span>
<span id="39"> 39</span>
<span id="40"> 40</span>
<span id="41"> 41</span>
<span id="42"> 42</span>
<span id="43"> 43</span>
<span id="44"> 44</span>
<span id="45"> 45</span>
<span id="46"> 46</span>
<span id="47"> 47</span>
<span id="48"> 48</span>
<span id="49"> 49</span>
<span id="50"> 50</span>
<span id="51"> 51</span>
<span id="52"> 52</span>
<span id="53"> 53</span>
<span id="54"> 54</span>
<span id="55"> 55</span>
<span id="56"> 56</span>
<span id="57"> 57</span>
<span id="58"> 58</span>
<span id="59"> 59</span>
<span id="60"> 60</span>
<span id="61"> 61</span>
<span id="62"> 62</span>
<span id="63"> 63</span>
<span id="64"> 64</span>
<span id="65"> 65</span>
<span id="66"> 66</span>
<span id="67"> 67</span>
<span id="68"> 68</span>
<span id="69"> 69</span>
<span id="70"> 70</span>
<span id="71"> 71</span>
<span id="72"> 72</span>
<span id="73"> 73</span>
<span id="74"> 74</span>
<span id="75"> 75</span>
<span id="76"> 76</span>
<span id="77"> 77</span>
<span id="78"> 78</span>
<span id="79"> 79</span>
<span id="80"> 80</span>
<span id="81"> 81</span>
<span id="82"> 82</span>
<span id="83"> 83</span>
<span id="84"> 84</span>
<span id="85"> 85</span>
<span id="86"> 86</span>
<span id="87"> 87</span>
<span id="88"> 88</span>
<span id="89"> 89</span>
<span id="90"> 90</span>
<span id="91"> 91</span>
<span id="92"> 92</span>
<span id="93"> 93</span>
<span id="94"> 94</span>
<span id="95"> 95</span>
<span id="96"> 96</span>
<span id="97"> 97</span>
<span id="98"> 98</span>
<span id="99"> 99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
</pre><pre class='rust '>
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>ops</span>::<span class='ident'>Neg</span>;
<span class='kw'>use</span> <span class='ident'>std</span>::{<span class='ident'>f32</span>, <span class='ident'>f64</span>};
<span class='kw'>use</span> <span class='ident'>Num</span>;
<span class='doccomment'>/// Useful functions for signed numbers (i.e. numbers that can be negative).</span>
<span class='kw'>pub</span> <span class='kw'>trait</span> <span class='ident'>Signed</span>: <span class='ident'>Sized</span> <span class='op'>+</span> <span class='ident'>Num</span> <span class='op'>+</span> <span class='ident'>Neg</span><span class='op'><</span><span class='ident'>Output</span> <span class='op'>=</span> <span class='self'>Self</span><span class='op'>></span> {
<span class='doccomment'>/// Computes the absolute value.</span>
<span class='doccomment'>///</span>
<span class='doccomment'>/// For `f32` and `f64`, `NaN` will be returned if the number is `NaN`.</span>
<span class='doccomment'>///</span>
<span class='doccomment'>/// For signed integers, `::MIN` will be returned if the number is `::MIN`.</span>
<span class='kw'>fn</span> <span class='ident'>abs</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='self'>Self</span>;
<span class='doccomment'>/// The positive difference of two numbers.</span>
<span class='doccomment'>///</span>
<span class='doccomment'>/// Returns `zero` if the number is less than or equal to `other`, otherwise the difference</span>
<span class='doccomment'>/// between `self` and `other` is returned.</span>
<span class='kw'>fn</span> <span class='ident'>abs_sub</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>other</span>: <span class='kw-2'>&</span><span class='self'>Self</span>) <span class='op'>-></span> <span class='self'>Self</span>;
<span class='doccomment'>/// Returns the sign of the number.</span>
<span class='doccomment'>///</span>
<span class='doccomment'>/// For `f32` and `f64`:</span>
<span class='doccomment'>///</span>
<span class='doccomment'>/// * `1.0` if the number is positive, `+0.0` or `INFINITY`</span>
<span class='doccomment'>/// * `-1.0` if the number is negative, `-0.0` or `NEG_INFINITY`</span>
<span class='doccomment'>/// * `NaN` if the number is `NaN`</span>
<span class='doccomment'>///</span>
<span class='doccomment'>/// For signed integers:</span>
<span class='doccomment'>///</span>
<span class='doccomment'>/// * `0` if the number is zero</span>
<span class='doccomment'>/// * `1` if the number is positive</span>
<span class='doccomment'>/// * `-1` if the number is negative</span>
<span class='kw'>fn</span> <span class='ident'>signum</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='self'>Self</span>;
<span class='doccomment'>/// Returns true if the number is positive and false if the number is zero or negative.</span>
<span class='kw'>fn</span> <span class='ident'>is_positive</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>bool</span>;
<span class='doccomment'>/// Returns true if the number is negative and false if the number is zero or positive.</span>
<span class='kw'>fn</span> <span class='ident'>is_negative</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>bool</span>;
}
<span class='macro'>macro_rules</span><span class='macro'>!</span> <span class='ident'>signed_impl</span> {
($(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>t</span>:<span class='ident'>ty</span>)<span class='op'>*</span>) <span class='op'>=></span> ($(
<span class='kw'>impl</span> <span class='ident'>Signed</span> <span class='kw'>for</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>t</span> {
<span class='attribute'>#[<span class='ident'>inline</span>]</span>
<span class='kw'>fn</span> <span class='ident'>abs</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>t</span> {
<span class='kw'>if</span> <span class='self'>self</span>.<span class='ident'>is_negative</span>() { <span class='op'>-</span><span class='op'>*</span><span class='self'>self</span> } <span class='kw'>else</span> { <span class='op'>*</span><span class='self'>self</span> }
}
<span class='attribute'>#[<span class='ident'>inline</span>]</span>
<span class='kw'>fn</span> <span class='ident'>abs_sub</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>other</span>: <span class='kw-2'>&</span><span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>t</span>) <span class='op'>-></span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>t</span> {
<span class='kw'>if</span> <span class='op'>*</span><span class='self'>self</span> <span class='op'><=</span> <span class='op'>*</span><span class='ident'>other</span> { <span class='number'>0</span> } <span class='kw'>else</span> { <span class='op'>*</span><span class='self'>self</span> <span class='op'>-</span> <span class='op'>*</span><span class='ident'>other</span> }
}
<span class='attribute'>#[<span class='ident'>inline</span>]</span>
<span class='kw'>fn</span> <span class='ident'>signum</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>t</span> {
<span class='kw'>match</span> <span class='op'>*</span><span class='self'>self</span> {
<span class='ident'>n</span> <span class='kw'>if</span> <span class='ident'>n</span> <span class='op'>></span> <span class='number'>0</span> <span class='op'>=></span> <span class='number'>1</span>,
<span class='number'>0</span> <span class='op'>=></span> <span class='number'>0</span>,
_ <span class='op'>=></span> <span class='op'>-</span><span class='number'>1</span>,
}
}
<span class='attribute'>#[<span class='ident'>inline</span>]</span>
<span class='kw'>fn</span> <span class='ident'>is_positive</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>bool</span> { <span class='op'>*</span><span class='self'>self</span> <span class='op'>></span> <span class='number'>0</span> }
<span class='attribute'>#[<span class='ident'>inline</span>]</span>
<span class='kw'>fn</span> <span class='ident'>is_negative</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>bool</span> { <span class='op'>*</span><span class='self'>self</span> <span class='op'><</span> <span class='number'>0</span> }
}
)<span class='op'>*</span>)
}
<span class='macro'>signed_impl</span><span class='macro'>!</span>(<span class='ident'>isize</span> <span class='ident'>i8</span> <span class='ident'>i16</span> <span class='ident'>i32</span> <span class='ident'>i64</span>);
<span class='macro'>macro_rules</span><span class='macro'>!</span> <span class='ident'>signed_float_impl</span> {
(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>t</span>:<span class='ident'>ty</span>, <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>nan</span>:<span class='ident'>expr</span>, <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>inf</span>:<span class='ident'>expr</span>, <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>neg_inf</span>:<span class='ident'>expr</span>) <span class='op'>=></span> {
<span class='kw'>impl</span> <span class='ident'>Signed</span> <span class='kw'>for</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>t</span> {
<span class='doccomment'>/// Computes the absolute value. Returns `NAN` if the number is `NAN`.</span>
<span class='attribute'>#[<span class='ident'>inline</span>]</span>
<span class='kw'>fn</span> <span class='ident'>abs</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>t</span> {
<span class='op'><</span><span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>t</span><span class='op'>></span>::<span class='ident'>abs</span>(<span class='op'>*</span><span class='self'>self</span>)
}
<span class='doccomment'>/// The positive difference of two numbers. Returns `0.0` if the number is</span>
<span class='doccomment'>/// less than or equal to `other`, otherwise the difference between`self`</span>
<span class='doccomment'>/// and `other` is returned.</span>
<span class='attribute'>#[<span class='ident'>inline</span>]</span>
<span class='kw'>fn</span> <span class='ident'>abs_sub</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>other</span>: <span class='kw-2'>&</span><span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>t</span>) <span class='op'>-></span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>t</span> {
<span class='op'><</span><span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>t</span><span class='op'>></span>::<span class='ident'>abs_sub</span>(<span class='op'>*</span><span class='self'>self</span>, <span class='op'>*</span><span class='ident'>other</span>)
}
<span class='doccomment'>/// # Returns</span>
<span class='doccomment'>///</span>
<span class='doccomment'>/// - `1.0` if the number is positive, `+0.0` or `INFINITY`</span>
<span class='doccomment'>/// - `-1.0` if the number is negative, `-0.0` or `NEG_INFINITY`</span>
<span class='doccomment'>/// - `NAN` if the number is NaN</span>
<span class='attribute'>#[<span class='ident'>inline</span>]</span>
<span class='kw'>fn</span> <span class='ident'>signum</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>t</span> {
<span class='op'><</span><span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>t</span><span class='op'>></span>::<span class='ident'>signum</span>(<span class='op'>*</span><span class='self'>self</span>)
}
<span class='doccomment'>/// Returns `true` if the number is positive, including `+0.0` and `INFINITY`</span>
<span class='attribute'>#[<span class='ident'>inline</span>]</span>
<span class='kw'>fn</span> <span class='ident'>is_positive</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>bool</span> { <span class='op'>*</span><span class='self'>self</span> <span class='op'>></span> <span class='number'>0.0</span> <span class='op'>||</span> (<span class='number'>1.0</span> <span class='op'>/</span> <span class='op'>*</span><span class='self'>self</span>) <span class='op'>==</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>inf</span> }
<span class='doccomment'>/// Returns `true` if the number is negative, including `-0.0` and `NEG_INFINITY`</span>
<span class='attribute'>#[<span class='ident'>inline</span>]</span>
<span class='kw'>fn</span> <span class='ident'>is_negative</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>bool</span> { <span class='op'>*</span><span class='self'>self</span> <span class='op'><</span> <span class='number'>0.0</span> <span class='op'>||</span> (<span class='number'>1.0</span> <span class='op'>/</span> <span class='op'>*</span><span class='self'>self</span>) <span class='op'>==</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>neg_inf</span> }
}
}
}
<span class='macro'>signed_float_impl</span><span class='macro'>!</span>(<span class='ident'>f32</span>, <span class='ident'>f32</span>::<span class='ident'>NAN</span>, <span class='ident'>f32</span>::<span class='ident'>INFINITY</span>, <span class='ident'>f32</span>::<span class='ident'>NEG_INFINITY</span>);
<span class='macro'>signed_float_impl</span><span class='macro'>!</span>(<span class='ident'>f64</span>, <span class='ident'>f64</span>::<span class='ident'>NAN</span>, <span class='ident'>f64</span>::<span class='ident'>INFINITY</span>, <span class='ident'>f64</span>::<span class='ident'>NEG_INFINITY</span>);
<span class='doccomment'>/// A trait for values which cannot be negative</span>
<span class='kw'>pub</span> <span class='kw'>trait</span> <span class='ident'>Unsigned</span>: <span class='ident'>Num</span> {}
<span class='macro'>macro_rules</span><span class='macro'>!</span> <span class='ident'>empty_trait_impl</span> {
(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>name</span>:<span class='ident'>ident</span> <span class='kw'>for</span> $(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>t</span>:<span class='ident'>ty</span>)<span class='op'>*</span>) <span class='op'>=></span> ($(
<span class='kw'>impl</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>name</span> <span class='kw'>for</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>t</span> {}
)<span class='op'>*</span>)
}
<span class='macro'>empty_trait_impl</span><span class='macro'>!</span>(<span class='ident'>Unsigned</span> <span class='kw'>for</span> <span class='ident'>usize</span> <span class='ident'>u8</span> <span class='ident'>u16</span> <span class='ident'>u32</span> <span class='ident'>u64</span>);
</pre>
</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_traits";
window.playgroundUrl = "";
</script>
<script src="../../jquery.js"></script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>