rust/tantivy
1
0
Fork 0
mirror of https://github.com/quickwit-oss/tantivy.git synced 2026-05-24 12:10:41 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
459c11ce1fb46d8f57bb07dc7d6b6db131949e77
tantivy/src/itertools/minmax.rs.html
Travis CI User d4ca9ce21b Documentation for tantivy-search/tantivy@9f5498d
2018-02-12 02:52:50 +00:00

351 lines
20 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/itertools-0.5.10/src/minmax.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>minmax.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>
<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>
</pre><pre class="rust ">
<span class="doccomment">/// `MinMaxResult` is an enum returned by `minmax`. See `Itertools::minmax()` for</span>
<span class="doccomment">/// more detail.</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Copy</span>, <span class="ident">Clone</span>, <span class="ident">PartialEq</span>, <span class="ident">Debug</span>)]</span>
<span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">MinMaxResult</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span> {
<span class="doccomment">/// Empty iterator</span>
<span class="ident">NoElements</span>,
<span class="doccomment">/// Iterator with one element, so the minimum and maximum are the same</span>
<span class="ident">OneElement</span>(<span class="ident">T</span>),
<span class="doccomment">/// More than one element in the iterator, the first element is not larger</span>
<span class="doccomment">/// than the second</span>
<span class="ident">MinMax</span>(<span class="ident">T</span>, <span class="ident">T</span>)
}
<span class="kw">impl</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">Clone</span><span class="op">&gt;</span> <span class="ident">MinMaxResult</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span> {
<span class="doccomment">/// `into_option` creates an `Option` of type `(T, T)`. The returned `Option`</span>
<span class="doccomment">/// has variant `None` if and only if the `MinMaxResult` has variant</span>
<span class="doccomment">/// `NoElements`. Otherwise `Some((x, y))` is returned where `x &lt;= y`.</span>
<span class="doccomment">/// If the `MinMaxResult` has variant `OneElement(x)`, performing this</span>
<span class="doccomment">/// operation will make one clone of `x`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use itertools::MinMaxResult::{self, NoElements, OneElement, MinMax};</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let r: MinMaxResult&lt;i32&gt; = NoElements;</span>
<span class="doccomment">/// assert_eq!(r.into_option(), None);</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let r = OneElement(1);</span>
<span class="doccomment">/// assert_eq!(r.into_option(), Some((1, 1)));</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let r = MinMax(1, 2);</span>
<span class="doccomment">/// assert_eq!(r.into_option(), Some((1, 2)));</span>
<span class="doccomment">/// ```</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">into_option</span>(<span class="self">self</span>) <span class="op">-&gt;</span> <span class="prelude-ty">Option</span><span class="op">&lt;</span>(<span class="ident">T</span>,<span class="ident">T</span>)<span class="op">&gt;</span> {
<span class="kw">match</span> <span class="self">self</span> {
<span class="ident">MinMaxResult</span>::<span class="ident">NoElements</span> <span class="op">=&gt;</span> <span class="prelude-val">None</span>,
<span class="ident">MinMaxResult</span>::<span class="ident">OneElement</span>(<span class="ident">x</span>) <span class="op">=&gt;</span> <span class="prelude-val">Some</span>((<span class="ident">x</span>.<span class="ident">clone</span>(), <span class="ident">x</span>)),
<span class="ident">MinMaxResult</span>::<span class="ident">MinMax</span>(<span class="ident">x</span>, <span class="ident">y</span>) <span class="op">=&gt;</span> <span class="prelude-val">Some</span>((<span class="ident">x</span>, <span class="ident">y</span>))
}
}
}
<span class="doccomment">/// Implementation guts for `minmax` and `minmax_by_key`.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">minmax_impl</span><span class="op">&lt;</span><span class="ident">I</span>, <span class="ident">K</span>, <span class="ident">F</span>, <span class="ident">L</span><span class="op">&gt;</span>(<span class="kw-2">mut</span> <span class="ident">it</span>: <span class="ident">I</span>, <span class="kw-2">mut</span> <span class="ident">key_for</span>: <span class="ident">F</span>,
<span class="kw-2">mut</span> <span class="ident">lt</span>: <span class="ident">L</span>) <span class="op">-&gt;</span> <span class="ident">MinMaxResult</span><span class="op">&lt;</span><span class="ident">I</span>::<span class="ident">Item</span><span class="op">&gt;</span>
<span class="kw">where</span> <span class="ident">I</span>: <span class="ident">Iterator</span>,
<span class="ident">F</span>: <span class="ident">FnMut</span>(<span class="kw-2">&amp;</span><span class="ident">I</span>::<span class="ident">Item</span>) <span class="op">-&gt;</span> <span class="ident">K</span>,
<span class="ident">L</span>: <span class="ident">FnMut</span>(<span class="kw-2">&amp;</span><span class="ident">I</span>::<span class="ident">Item</span>, <span class="kw-2">&amp;</span><span class="ident">I</span>::<span class="ident">Item</span>, <span class="kw-2">&amp;</span><span class="ident">K</span>, <span class="kw-2">&amp;</span><span class="ident">K</span>) <span class="op">-&gt;</span> <span class="ident">bool</span>,
{
<span class="kw">let</span> (<span class="kw-2">mut</span> <span class="ident">min</span>, <span class="kw-2">mut</span> <span class="ident">max</span>, <span class="kw-2">mut</span> <span class="ident">min_key</span>, <span class="kw-2">mut</span> <span class="ident">max_key</span>) <span class="op">=</span> <span class="kw">match</span> <span class="ident">it</span>.<span class="ident">next</span>() {
<span class="prelude-val">None</span> <span class="op">=&gt;</span> <span class="kw">return</span> <span class="ident">MinMaxResult</span>::<span class="ident">NoElements</span>,
<span class="prelude-val">Some</span>(<span class="ident">x</span>) <span class="op">=&gt;</span> {
<span class="kw">match</span> <span class="ident">it</span>.<span class="ident">next</span>() {
<span class="prelude-val">None</span> <span class="op">=&gt;</span> <span class="kw">return</span> <span class="ident">MinMaxResult</span>::<span class="ident">OneElement</span>(<span class="ident">x</span>),
<span class="prelude-val">Some</span>(<span class="ident">y</span>) <span class="op">=&gt;</span> {
<span class="kw">let</span> <span class="ident">xk</span> <span class="op">=</span> <span class="ident">key_for</span>(<span class="kw-2">&amp;</span><span class="ident">x</span>);
<span class="kw">let</span> <span class="ident">yk</span> <span class="op">=</span> <span class="ident">key_for</span>(<span class="kw-2">&amp;</span><span class="ident">y</span>);
<span class="kw">if</span> <span class="op">!</span><span class="ident">lt</span>(<span class="kw-2">&amp;</span><span class="ident">y</span>, <span class="kw-2">&amp;</span><span class="ident">x</span>, <span class="kw-2">&amp;</span><span class="ident">yk</span>, <span class="kw-2">&amp;</span><span class="ident">xk</span>) {(<span class="ident">x</span>, <span class="ident">y</span>, <span class="ident">xk</span>, <span class="ident">yk</span>)} <span class="kw">else</span> {(<span class="ident">y</span>, <span class="ident">x</span>, <span class="ident">yk</span>, <span class="ident">xk</span>)}
}
}
}
};
<span class="kw">loop</span> {
<span class="comment">// `first` and `second` are the two next elements we want to look</span>
<span class="comment">// at. We first compare `first` and `second` (#1). The smaller one</span>
<span class="comment">// is then compared to current minimum (#2). The larger one is</span>
<span class="comment">// compared to current maximum (#3). This way we do 3 comparisons</span>
<span class="comment">// for 2 elements.</span>
<span class="kw">let</span> <span class="ident">first</span> <span class="op">=</span> <span class="kw">match</span> <span class="ident">it</span>.<span class="ident">next</span>() {
<span class="prelude-val">None</span> <span class="op">=&gt;</span> <span class="kw">break</span>,
<span class="prelude-val">Some</span>(<span class="ident">x</span>) <span class="op">=&gt;</span> <span class="ident">x</span>
};
<span class="kw">let</span> <span class="ident">second</span> <span class="op">=</span> <span class="kw">match</span> <span class="ident">it</span>.<span class="ident">next</span>() {
<span class="prelude-val">None</span> <span class="op">=&gt;</span> {
<span class="kw">let</span> <span class="ident">first_key</span> <span class="op">=</span> <span class="ident">key_for</span>(<span class="kw-2">&amp;</span><span class="ident">first</span>);
<span class="kw">if</span> <span class="ident">lt</span>(<span class="kw-2">&amp;</span><span class="ident">first</span>, <span class="kw-2">&amp;</span><span class="ident">min</span>, <span class="kw-2">&amp;</span><span class="ident">first_key</span>, <span class="kw-2">&amp;</span><span class="ident">min_key</span>) {
<span class="ident">min</span> <span class="op">=</span> <span class="ident">first</span>;
} <span class="kw">else</span> <span class="kw">if</span> <span class="op">!</span><span class="ident">lt</span>(<span class="kw-2">&amp;</span><span class="ident">first</span>, <span class="kw-2">&amp;</span><span class="ident">max</span>, <span class="kw-2">&amp;</span><span class="ident">first_key</span>, <span class="kw-2">&amp;</span><span class="ident">max_key</span>) {
<span class="ident">max</span> <span class="op">=</span> <span class="ident">first</span>;
}
<span class="kw">break</span>;
}
<span class="prelude-val">Some</span>(<span class="ident">x</span>) <span class="op">=&gt;</span> <span class="ident">x</span>
};
<span class="kw">let</span> <span class="ident">first_key</span> <span class="op">=</span> <span class="ident">key_for</span>(<span class="kw-2">&amp;</span><span class="ident">first</span>);
<span class="kw">let</span> <span class="ident">second_key</span> <span class="op">=</span> <span class="ident">key_for</span>(<span class="kw-2">&amp;</span><span class="ident">second</span>);
<span class="kw">if</span> <span class="op">!</span><span class="ident">lt</span>(<span class="kw-2">&amp;</span><span class="ident">second</span>, <span class="kw-2">&amp;</span><span class="ident">first</span>, <span class="kw-2">&amp;</span><span class="ident">second_key</span>, <span class="kw-2">&amp;</span><span class="ident">first_key</span>) {
<span class="kw">if</span> <span class="ident">lt</span>(<span class="kw-2">&amp;</span><span class="ident">first</span>, <span class="kw-2">&amp;</span><span class="ident">min</span>, <span class="kw-2">&amp;</span><span class="ident">first_key</span>, <span class="kw-2">&amp;</span><span class="ident">min_key</span>) {
<span class="ident">min</span> <span class="op">=</span> <span class="ident">first</span>;
<span class="ident">min_key</span> <span class="op">=</span> <span class="ident">first_key</span>;
}
<span class="kw">if</span> <span class="op">!</span><span class="ident">lt</span>(<span class="kw-2">&amp;</span><span class="ident">second</span>, <span class="kw-2">&amp;</span><span class="ident">max</span>, <span class="kw-2">&amp;</span><span class="ident">second_key</span>, <span class="kw-2">&amp;</span><span class="ident">max_key</span>) {
<span class="ident">max</span> <span class="op">=</span> <span class="ident">second</span>;
<span class="ident">max_key</span> <span class="op">=</span> <span class="ident">second_key</span>;
}
} <span class="kw">else</span> {
<span class="kw">if</span> <span class="ident">lt</span>(<span class="kw-2">&amp;</span><span class="ident">second</span>, <span class="kw-2">&amp;</span><span class="ident">min</span>, <span class="kw-2">&amp;</span><span class="ident">second_key</span>, <span class="kw-2">&amp;</span><span class="ident">min_key</span>) {
<span class="ident">min</span> <span class="op">=</span> <span class="ident">second</span>;
<span class="ident">min_key</span> <span class="op">=</span> <span class="ident">second_key</span>;
}
<span class="kw">if</span> <span class="op">!</span><span class="ident">lt</span>(<span class="kw-2">&amp;</span><span class="ident">first</span>, <span class="kw-2">&amp;</span><span class="ident">max</span>, <span class="kw-2">&amp;</span><span class="ident">first_key</span>, <span class="kw-2">&amp;</span><span class="ident">max_key</span>) {
<span class="ident">max</span> <span class="op">=</span> <span class="ident">first</span>;
<span class="ident">max_key</span> <span class="op">=</span> <span class="ident">first_key</span>;
}
}
}
<span class="ident">MinMaxResult</span>::<span class="ident">MinMax</span>(<span class="ident">min</span>, <span class="ident">max</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 = "itertools";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink