| <!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 of the Rust file `/home/runner/.cargo/registry/src/github.com-1ecc6299db9ec823/num-traits-0.2.14/src/sign.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>sign.rs - source</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" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script src="../../crates.js"></script><script defer src="../../main.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.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 source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a class="sidebar-logo" href="../../num_traits/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.png" alt="logo"></div> |
| </a></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../num_traits/index.html"><img class="rust-logo" src="../../rust-logo.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><div> |
| <input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><div class="example-wrap"><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> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| <span id="182">182</span> |
| <span id="183">183</span> |
| <span id="184">184</span> |
| <span id="185">185</span> |
| <span id="186">186</span> |
| <span id="187">187</span> |
| <span id="188">188</span> |
| <span id="189">189</span> |
| <span id="190">190</span> |
| <span id="191">191</span> |
| <span id="192">192</span> |
| <span id="193">193</span> |
| <span id="194">194</span> |
| <span id="195">195</span> |
| <span id="196">196</span> |
| <span id="197">197</span> |
| <span id="198">198</span> |
| <span id="199">199</span> |
| <span id="200">200</span> |
| <span id="201">201</span> |
| <span id="202">202</span> |
| <span id="203">203</span> |
| <span id="204">204</span> |
| <span id="205">205</span> |
| <span id="206">206</span> |
| <span id="207">207</span> |
| <span id="208">208</span> |
| <span id="209">209</span> |
| <span id="210">210</span> |
| <span id="211">211</span> |
| <span id="212">212</span> |
| <span id="213">213</span> |
| <span id="214">214</span> |
| <span id="215">215</span> |
| <span id="216">216</span> |
| <span id="217">217</span> |
| <span id="218">218</span> |
| <span id="219">219</span> |
| <span id="220">220</span> |
| <span id="221">221</span> |
| <span id="222">222</span> |
| <span id="223">223</span> |
| <span id="224">224</span> |
| </pre><pre class="rust"><code><span class="kw">use</span> <span class="ident">core::num::Wrapping</span>; |
| <span class="kw">use</span> <span class="ident">core::ops::Neg</span>; |
| |
| <span class="kw">use</span> <span class="ident">float::FloatCore</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="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="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="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="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="ident">bool</span>; |
| } |
| |
| <span class="macro">macro_rules!</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="kw-2">*</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="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="kw-2">*</span><span class="self">self</span> } <span class="kw">else</span> { <span class="kw-2">*</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="macro-nonterminal">$</span><span class="macro-nonterminal">t</span> { |
| <span class="kw">if</span> <span class="kw-2">*</span><span class="self">self</span> <span class="op"><</span><span class="op">=</span> <span class="kw-2">*</span><span class="ident">other</span> { <span class="number">0</span> } <span class="kw">else</span> { <span class="kw-2">*</span><span class="self">self</span> <span class="op">-</span> <span class="kw-2">*</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="macro-nonterminal">$</span><span class="macro-nonterminal">t</span> { |
| <span class="kw">match</span> <span class="kw-2">*</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="number">1</span>, |
| <span class="number">0</span> => <span class="number">0</span>, |
| <span class="kw">_</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="ident">bool</span> { <span class="kw-2">*</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="ident">bool</span> { <span class="kw-2">*</span><span class="self">self</span> <span class="op"><</span> <span class="number">0</span> } |
| } |
| )<span class="kw-2">*</span>) |
| } |
| |
| <span class="macro">signed_impl!</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="attribute">#[<span class="ident">cfg</span>(<span class="ident">has_i128</span>)]</span> |
| <span class="macro">signed_impl!</span>(<span class="ident">i128</span>); |
| |
| <span class="kw">impl</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">Signed</span><span class="op">></span> <span class="ident">Signed</span> <span class="kw">for</span> <span class="ident">Wrapping</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> |
| <span class="kw">where</span> |
| <span class="ident">Wrapping</span><span class="op"><</span><span class="ident">T</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="ident">Wrapping</span><span class="op"><</span><span class="ident">T</span><span class="op">></span><span class="op">></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="self">Self</span> { |
| <span class="ident">Wrapping</span>(<span class="self">self</span>.<span class="number">0</span>.<span class="ident">abs</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="self">Self</span>) -> <span class="self">Self</span> { |
| <span class="ident">Wrapping</span>(<span class="self">self</span>.<span class="number">0</span>.<span class="ident">abs_sub</span>(<span class="kw-2">&</span><span class="ident">other</span>.<span class="number">0</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="self">Self</span> { |
| <span class="ident">Wrapping</span>(<span class="self">self</span>.<span class="number">0</span>.<span class="ident">signum</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="ident">bool</span> { |
| <span class="self">self</span>.<span class="number">0</span>.<span class="ident">is_positive</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="ident">bool</span> { |
| <span class="self">self</span>.<span class="number">0</span>.<span class="ident">is_negative</span>() |
| } |
| } |
| |
| <span class="macro">macro_rules!</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="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="macro-nonterminal">$</span><span class="macro-nonterminal">t</span> { |
| <span class="ident">FloatCore::abs</span>(<span class="kw-2">*</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="macro-nonterminal">$</span><span class="macro-nonterminal">t</span> { |
| <span class="kw">if</span> <span class="kw-2">*</span><span class="self">self</span> <span class="op"><</span><span class="op">=</span> <span class="kw-2">*</span><span class="ident">other</span> { |
| <span class="number">0.</span> |
| } <span class="kw">else</span> { |
| <span class="kw-2">*</span><span class="self">self</span> <span class="op">-</span> <span class="kw-2">*</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="macro-nonterminal">$</span><span class="macro-nonterminal">t</span> { |
| <span class="ident">FloatCore::signum</span>(<span class="kw-2">*</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="ident">bool</span> { |
| <span class="ident">FloatCore::is_sign_positive</span>(<span class="kw-2">*</span><span class="self">self</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="ident">bool</span> { |
| <span class="ident">FloatCore::is_sign_negative</span>(<span class="kw-2">*</span><span class="self">self</span>) |
| } |
| } |
| }; |
| } |
| |
| <span class="macro">signed_float_impl!</span>(<span class="ident">f32</span>); |
| <span class="macro">signed_float_impl!</span>(<span class="ident">f64</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="attribute">#[<span class="ident">inline</span>(<span class="ident">always</span>)]</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">abs</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">Signed</span><span class="op">></span>(<span class="ident">value</span>: <span class="ident">T</span>) -> <span class="ident">T</span> { |
| <span class="ident">value</span>.<span class="ident">abs</span>() |
| } |
| |
| <span class="doccomment">/// The positive difference of two numbers.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Returns zero if `x` is less than or equal to `y`, otherwise the difference</span> |
| <span class="doccomment">/// between `x` and `y` is returned.</span> |
| <span class="attribute">#[<span class="ident">inline</span>(<span class="ident">always</span>)]</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">abs_sub</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">Signed</span><span class="op">></span>(<span class="ident">x</span>: <span class="ident">T</span>, <span class="ident">y</span>: <span class="ident">T</span>) -> <span class="ident">T</span> { |
| <span class="ident">x</span>.<span class="ident">abs_sub</span>(<span class="kw-2">&</span><span class="ident">y</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="attribute">#[<span class="ident">inline</span>(<span class="ident">always</span>)]</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">signum</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">Signed</span><span class="op">></span>(<span class="ident">value</span>: <span class="ident">T</span>) -> <span class="ident">T</span> { |
| <span class="ident">value</span>.<span class="ident">signum</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="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="kw-2">*</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="kw-2">*</span>) |
| } |
| |
| <span class="macro">empty_trait_impl!</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>); |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">has_i128</span>)]</span> |
| <span class="macro">empty_trait_impl!</span>(<span class="ident">Unsigned</span> <span class="kw">for</span> <span class="ident">u128</span>); |
| |
| <span class="kw">impl</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">Unsigned</span><span class="op">></span> <span class="ident">Unsigned</span> <span class="kw">for</span> <span class="ident">Wrapping</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="kw">where</span> <span class="ident">Wrapping</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>: <span class="ident">Num</span> {} |
| |
| <span class="attribute">#[<span class="ident">test</span>]</span> |
| <span class="kw">fn</span> <span class="ident">unsigned_wrapping_is_unsigned</span>() { |
| <span class="kw">fn</span> <span class="ident">require_unsigned</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">Unsigned</span><span class="op">></span>(<span class="kw">_</span>: <span class="kw-2">&</span><span class="ident">T</span>) {} |
| <span class="ident">require_unsigned</span>(<span class="kw-2">&</span><span class="ident">Wrapping</span>(<span class="number">42_u32</span>)); |
| } |
| |
| <span class="comment">// Commenting this out since it doesn't compile on Rust 1.8,</span> |
| <span class="comment">// because on this version Wrapping doesn't implement Neg and therefore can't</span> |
| <span class="comment">// implement Signed.</span> |
| <span class="comment">// #[test]</span> |
| <span class="comment">// fn signed_wrapping_is_signed() {</span> |
| <span class="comment">// fn require_signed<T: Signed>(_: &T) {}</span> |
| <span class="comment">// require_signed(&Wrapping(-42));</span> |
| <span class="comment">// }</span> |
| </code></pre></div> |
| </section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="num_traits" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.60.0-nightly (1bd4fdc94 2022-01-12)" ></div> |
| </body></html> |
