Files
tantivy/src/num_traits/lib.rs.html
2018-02-12 02:52:50 +00:00

299 lines
14 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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/travis/.cargo/registry/src/github.com-1ecc6299db9ec823/num-traits-0.1.43/src/lib.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>lib.rs.html -- source</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="../../main.css" id="themeStyle">
<script src="../../storage.js"></script>
</head>
<body class="rustdoc source">
<!--[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>
</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">
</div>
</form>
</nav>
<section id='main' class="content"><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>
</pre><pre class="rust ">
<span class="comment">// Copyright 2013-2014 The Rust Project Developers. See the COPYRIGHT</span>
<span class="comment">// file at the top-level directory of this distribution and at</span>
<span class="comment">// http://rust-lang.org/COPYRIGHT.</span>
<span class="comment">//</span>
<span class="comment">// Licensed under the Apache License, Version 2.0 &lt;LICENSE-APACHE or</span>
<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0&gt; or the MIT license</span>
<span class="comment">// &lt;LICENSE-MIT or http://opensource.org/licenses/MIT&gt;, at your</span>
<span class="comment">// option. This file may not be copied, modified, or distributed</span>
<span class="comment">// except according to those terms.</span>
<span class="doccomment">//! Numeric traits for generic mathematics</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! This version of the crate only exists to re-export compatible</span>
<span class="doccomment">//! items from num-traits 0.2. Please consider updating!</span>
<span class="attribute">#![<span class="ident">doc</span>(<span class="ident">html_root_url</span> <span class="op">=</span> <span class="string">&quot;https://docs.rs/num-traits/0.1&quot;</span>)]</span>
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">num_traits</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">bounds</span>::<span class="ident">Bounded</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">float</span>::{<span class="ident">Float</span>, <span class="ident">FloatConst</span>};
<span class="comment">// pub use real::Real; // NOTE: Don&#39;t do this, it breaks `use num_traits::*;`.</span>
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">identities</span>::{<span class="ident">Zero</span>, <span class="ident">One</span>, <span class="ident">zero</span>, <span class="ident">one</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">ops</span>::<span class="ident">checked</span>::{<span class="ident">CheckedAdd</span>, <span class="ident">CheckedSub</span>, <span class="ident">CheckedMul</span>, <span class="ident">CheckedDiv</span>, <span class="ident">CheckedShl</span>, <span class="ident">CheckedShr</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">ops</span>::<span class="ident">wrapping</span>::{<span class="ident">WrappingAdd</span>, <span class="ident">WrappingMul</span>, <span class="ident">WrappingSub</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">ops</span>::<span class="ident">saturating</span>::<span class="ident">Saturating</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">sign</span>::{<span class="ident">Signed</span>, <span class="ident">Unsigned</span>, <span class="ident">abs</span>, <span class="ident">abs_sub</span>, <span class="ident">signum</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">cast</span>::{<span class="ident">AsPrimitive</span>, <span class="ident">FromPrimitive</span>, <span class="ident">ToPrimitive</span>, <span class="ident">NumCast</span>, <span class="ident">cast</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">int</span>::<span class="ident">PrimInt</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">pow</span>::{<span class="ident">pow</span>, <span class="ident">checked_pow</span>};
<span class="comment">// Re-exports from num-traits 0.2!</span>
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">num_traits</span>::{<span class="ident">Num</span>, <span class="ident">NumOps</span>, <span class="ident">NumRef</span>, <span class="ident">RefNum</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">num_traits</span>::{<span class="ident">NumAssignOps</span>, <span class="ident">NumAssign</span>, <span class="ident">NumAssignRef</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">num_traits</span>::{<span class="ident">FloatErrorKind</span>, <span class="ident">ParseFloatError</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">clamp</span>;
<span class="comment">// Note: the module structure is explicitly re-created, rather than re-exporting en masse,</span>
<span class="comment">// so we won&#39;t expose any items that may be added later in the new version.</span>
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">identities</span> {
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">identities</span>::{<span class="ident">Zero</span>, <span class="ident">One</span>, <span class="ident">zero</span>, <span class="ident">one</span>};
}
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">sign</span> {
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">sign</span>::{<span class="ident">Signed</span>, <span class="ident">Unsigned</span>, <span class="ident">abs</span>, <span class="ident">abs_sub</span>, <span class="ident">signum</span>};
}
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">ops</span> {
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">saturating</span> {
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">ops</span>::<span class="ident">saturating</span>::<span class="ident">Saturating</span>;
}
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">checked</span> {
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">ops</span>::<span class="ident">checked</span>::{<span class="ident">CheckedAdd</span>, <span class="ident">CheckedSub</span>, <span class="ident">CheckedMul</span>, <span class="ident">CheckedDiv</span>,
<span class="ident">CheckedShl</span>, <span class="ident">CheckedShr</span>};
}
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">wrapping</span> {
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">ops</span>::<span class="ident">wrapping</span>::{<span class="ident">WrappingAdd</span>, <span class="ident">WrappingMul</span>, <span class="ident">WrappingSub</span>};
}
}
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">bounds</span> {
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">bounds</span>::<span class="ident">Bounded</span>;
}
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">float</span> {
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">float</span>::{<span class="ident">Float</span>, <span class="ident">FloatConst</span>};
}
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">real</span> {
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">real</span>::<span class="ident">Real</span>;
}
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">cast</span> {
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">cast</span>::{<span class="ident">AsPrimitive</span>, <span class="ident">FromPrimitive</span>, <span class="ident">ToPrimitive</span>, <span class="ident">NumCast</span>, <span class="ident">cast</span>};
}
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">int</span> {
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">int</span>::<span class="ident">PrimInt</span>;
}
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">pow</span> {
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">pow</span>::{<span class="ident">pow</span>, <span class="ident">checked_pow</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><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>
</div>
</div>
</aside>
<script>
window.rootPath = "../../";
window.currentCrate = "num_traits";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>