clfft 0.3.2

Bindings for clFFT, a FFT library for OpenCL.
Documentation
<!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 `C:\Users\Chrilieb\.cargo\registry\src\github.com-1ecc6299db9ec823\num-traits-0.1.40\src\bounds.rs`.">
    <meta name="keywords" content="rust, rustlang, rust-lang">

    <title>bounds.rs.html -- source</title>

    <link rel="stylesheet" type="text/css" href="../../normalize.css">
    <link rel="stylesheet" type="text/css" href="../../rustdoc.css">
    <link rel="stylesheet" type="text/css" href="../../main.css">
    

    <link rel="shortcut icon" href="https://rust-num.github.io/num/favicon.ico">
    
</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">
        <a href='../../num_traits/index.html'><img src='https://rust-num.github.io/num/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a>
        
    </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"><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>
</pre><pre class="rust ">
<span class="kw">use</span> <span class="ident">std</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="kw">use</span> <span class="ident">std</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="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">std</span>::<span class="ident">num</span>::<span class="ident">Wrapping</span>;

<span class="doccomment">/// Numbers which have upper and lower bounds</span>
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">Bounded</span> {
    <span class="comment">// FIXME (#5527): These should be associated constants</span>
    <span class="doccomment">/// returns the smallest finite number this type can represent</span>
    <span class="kw">fn</span> <span class="ident">min_value</span>() <span class="op">-&gt;</span> <span class="self">Self</span>;
    <span class="doccomment">/// returns the largest finite number this type can represent</span>
    <span class="kw">fn</span> <span class="ident">max_value</span>() <span class="op">-&gt;</span> <span class="self">Self</span>;
}

<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">bounded_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">min</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">max</span>:<span class="ident">expr</span>) <span class="op">=&gt;</span> {
        <span class="kw">impl</span> <span class="ident">Bounded</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">min_value</span>() <span class="op">-&gt;</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">t</span> { <span class="macro-nonterminal">$</span><span class="macro-nonterminal">min</span> }

            <span class="attribute">#[<span class="ident">inline</span>]</span>
            <span class="kw">fn</span> <span class="ident">max_value</span>() <span class="op">-&gt;</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">t</span> { <span class="macro-nonterminal">$</span><span class="macro-nonterminal">max</span> }
        }
    }
}

<span class="macro">bounded_impl</span><span class="macro">!</span>(<span class="ident">usize</span>, <span class="ident">usize</span>::<span class="ident">MIN</span>, <span class="ident">usize</span>::<span class="ident">MAX</span>);
<span class="macro">bounded_impl</span><span class="macro">!</span>(<span class="ident">u8</span>,    <span class="ident">u8</span>::<span class="ident">MIN</span>,    <span class="ident">u8</span>::<span class="ident">MAX</span>);
<span class="macro">bounded_impl</span><span class="macro">!</span>(<span class="ident">u16</span>,   <span class="ident">u16</span>::<span class="ident">MIN</span>,   <span class="ident">u16</span>::<span class="ident">MAX</span>);
<span class="macro">bounded_impl</span><span class="macro">!</span>(<span class="ident">u32</span>,   <span class="ident">u32</span>::<span class="ident">MIN</span>,   <span class="ident">u32</span>::<span class="ident">MAX</span>);
<span class="macro">bounded_impl</span><span class="macro">!</span>(<span class="ident">u64</span>,   <span class="ident">u64</span>::<span class="ident">MIN</span>,   <span class="ident">u64</span>::<span class="ident">MAX</span>);

<span class="macro">bounded_impl</span><span class="macro">!</span>(<span class="ident">isize</span>, <span class="ident">isize</span>::<span class="ident">MIN</span>, <span class="ident">isize</span>::<span class="ident">MAX</span>);
<span class="macro">bounded_impl</span><span class="macro">!</span>(<span class="ident">i8</span>,    <span class="ident">i8</span>::<span class="ident">MIN</span>,    <span class="ident">i8</span>::<span class="ident">MAX</span>);
<span class="macro">bounded_impl</span><span class="macro">!</span>(<span class="ident">i16</span>,   <span class="ident">i16</span>::<span class="ident">MIN</span>,   <span class="ident">i16</span>::<span class="ident">MAX</span>);
<span class="macro">bounded_impl</span><span class="macro">!</span>(<span class="ident">i32</span>,   <span class="ident">i32</span>::<span class="ident">MIN</span>,   <span class="ident">i32</span>::<span class="ident">MAX</span>);
<span class="macro">bounded_impl</span><span class="macro">!</span>(<span class="ident">i64</span>,   <span class="ident">i64</span>::<span class="ident">MIN</span>,   <span class="ident">i64</span>::<span class="ident">MAX</span>);

<span class="kw">impl</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">Bounded</span><span class="op">&gt;</span> <span class="ident">Bounded</span> <span class="kw">for</span> <span class="ident">Wrapping</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span> {
    <span class="kw">fn</span> <span class="ident">min_value</span>() <span class="op">-&gt;</span> <span class="self">Self</span> { <span class="ident">Wrapping</span>(<span class="ident">T</span>::<span class="ident">min_value</span>()) }
    <span class="kw">fn</span> <span class="ident">max_value</span>() <span class="op">-&gt;</span> <span class="self">Self</span> { <span class="ident">Wrapping</span>(<span class="ident">T</span>::<span class="ident">max_value</span>()) }
}

<span class="macro">bounded_impl</span><span class="macro">!</span>(<span class="ident">f32</span>, <span class="ident">f32</span>::<span class="ident">MIN</span>, <span class="ident">f32</span>::<span class="ident">MAX</span>);

<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">for_each_tuple_</span> {
    ( <span class="macro-nonterminal">$</span><span class="macro-nonterminal">m</span>:<span class="ident">ident</span> <span class="op">!</span><span class="op">!</span> ) <span class="op">=&gt;</span> (
        <span class="macro-nonterminal">$</span><span class="macro-nonterminal">m</span><span class="op">!</span> { }
    );
    ( <span class="macro-nonterminal">$</span><span class="macro-nonterminal">m</span>:<span class="ident">ident</span> <span class="op">!</span><span class="op">!</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">h</span>:<span class="ident">ident</span>, $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">t</span>:<span class="ident">ident</span>,)<span class="op">*</span> ) <span class="op">=&gt;</span> (
        <span class="macro-nonterminal">$</span><span class="macro-nonterminal">m</span><span class="op">!</span> { <span class="macro-nonterminal">$</span><span class="macro-nonterminal">h</span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">t</span>)<span class="op">*</span> }
        <span class="macro">for_each_tuple_</span><span class="macro">!</span> { <span class="macro-nonterminal">$</span><span class="macro-nonterminal">m</span> <span class="op">!</span><span class="op">!</span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">t</span>,)<span class="op">*</span> }
    );
}
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">for_each_tuple</span> {
    ( <span class="macro-nonterminal">$</span><span class="macro-nonterminal">m</span>:<span class="ident">ident</span> ) <span class="op">=&gt;</span> (
        <span class="macro">for_each_tuple_</span><span class="macro">!</span> { <span class="macro-nonterminal">$</span><span class="macro-nonterminal">m</span> <span class="op">!</span><span class="op">!</span> <span class="ident">A</span>, <span class="ident">B</span>, <span class="ident">C</span>, <span class="ident">D</span>, <span class="ident">E</span>, <span class="ident">F</span>, <span class="ident">G</span>, <span class="ident">H</span>, <span class="ident">I</span>, <span class="ident">J</span>, <span class="ident">K</span>, <span class="ident">L</span>, <span class="ident">M</span>, <span class="ident">N</span>, <span class="ident">O</span>, <span class="ident">P</span>, <span class="ident">Q</span>, <span class="ident">R</span>, <span class="ident">S</span>, <span class="ident">T</span>, }
    );
}

<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">bounded_tuple</span> {
    ( $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span>)<span class="op">*</span> ) <span class="op">=&gt;</span> (
        <span class="kw">impl</span><span class="op">&lt;</span>$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>: <span class="ident">Bounded</span>,)<span class="kw-2">*</span><span class="op">&gt;</span> <span class="ident">Bounded</span> <span class="kw">for</span> ($(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>,)<span class="kw-2">*</span>) {
            <span class="attribute">#[<span class="ident">inline</span>]</span>
            <span class="kw">fn</span> <span class="ident">min_value</span>() <span class="op">-&gt;</span> <span class="self">Self</span> {
                ($(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>::<span class="ident">min_value</span>(),)<span class="kw-2">*</span>)
            }
            <span class="attribute">#[<span class="ident">inline</span>]</span>
            <span class="kw">fn</span> <span class="ident">max_value</span>() <span class="op">-&gt;</span> <span class="self">Self</span> {
                ($(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>::<span class="ident">max_value</span>(),)<span class="kw-2">*</span>)
            }
        }
    );
}

<span class="macro">for_each_tuple</span><span class="macro">!</span>(<span class="ident">bounded_tuple</span>);
<span class="macro">bounded_impl</span><span class="macro">!</span>(<span class="ident">f64</span>, <span class="ident">f64</span>::<span class="ident">MIN</span>, <span class="ident">f64</span>::<span class="ident">MAX</span>);


<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">test_wrapping_bounded</span> {
    ($(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">t</span>:<span class="ident">ty</span>)<span class="op">+</span>) <span class="op">=&gt;</span> {
        $(
            <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">Wrapping</span>::<span class="op">&lt;</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">t</span><span class="op">&gt;</span>::<span class="ident">min_value</span>().<span class="number">0</span>, <span class="op">&lt;</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">t</span><span class="op">&gt;</span>::<span class="ident">min_value</span>());
            <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">Wrapping</span>::<span class="op">&lt;</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">t</span><span class="op">&gt;</span>::<span class="ident">max_value</span>().<span class="number">0</span>, <span class="op">&lt;</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">t</span><span class="op">&gt;</span>::<span class="ident">max_value</span>());
        )<span class="op">+</span>   
    };
}

<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">wrapping_bounded</span>() {
    <span class="macro">test_wrapping_bounded</span><span class="macro">!</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="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">test</span>]</span>
<span class="kw">fn</span> <span class="ident">wrapping_is_bounded</span>() {
    <span class="kw">fn</span> <span class="ident">require_bounded</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">Bounded</span><span class="op">&gt;</span>(_: <span class="kw-2">&amp;</span><span class="ident">T</span>) {}
    <span class="ident">require_bounded</span>(<span class="kw-2">&amp;</span><span class="ident">Wrapping</span>(<span class="number">42_u32</span>));
    <span class="ident">require_bounded</span>(<span class="kw-2">&amp;</span><span class="ident">Wrapping</span>(<span class="op">-</span><span class="number">42</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>&larrb;</dt>
                    <dd>Move up in search results</dd>
                    <dt>&rarrb;</dt>
                    <dd>Move down in search results</dd>
                    <dt>&#9166;</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";
    </script>
    <script src="../../jquery.js"></script>
    <script src="../../main.js"></script>
    <script defer src="../../search-index.js"></script>
</body>
</html>