blob: cb03bdf4f76384bdd16bf20bced4139191b973e9 [file] [log] [blame]
<!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 `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/itertools-0.8.2/src/minmax.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>minmax.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" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.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"><a class="sidebar-logo" href="../../itertools/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../itertools/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-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"><code>
<span class="doccomment">/// `MinMaxResult` is an enum returned by `minmax`. See `Itertools::minmax()` for
/// more detail.
</span><span class="attribute">#[derive(Copy, Clone, PartialEq, Debug)]
</span><span class="kw">pub enum </span>MinMaxResult&lt;T&gt; {
<span class="doccomment">/// Empty iterator
</span>NoElements,
<span class="doccomment">/// Iterator with one element, so the minimum and maximum are the same
</span>OneElement(T),
<span class="doccomment">/// More than one element in the iterator, the first element is not larger
/// than the second
</span>MinMax(T, T)
}
<span class="kw">impl</span>&lt;T: Clone&gt; MinMaxResult&lt;T&gt; {
<span class="doccomment">/// `into_option` creates an `Option` of type `(T, T)`. The returned `Option`
/// has variant `None` if and only if the `MinMaxResult` has variant
/// `NoElements`. Otherwise `Some((x, y))` is returned where `x &lt;= y`.
/// If the `MinMaxResult` has variant `OneElement(x)`, performing this
/// operation will make one clone of `x`.
///
/// # Examples
///
/// ```
/// use itertools::MinMaxResult::{self, NoElements, OneElement, MinMax};
///
/// let r: MinMaxResult&lt;i32&gt; = NoElements;
/// assert_eq!(r.into_option(), None);
///
/// let r = OneElement(1);
/// assert_eq!(r.into_option(), Some((1, 1)));
///
/// let r = MinMax(1, 2);
/// assert_eq!(r.into_option(), Some((1, 2)));
/// ```
</span><span class="kw">pub fn </span>into_option(<span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;(T,T)&gt; {
<span class="kw">match </span><span class="self">self </span>{
MinMaxResult::NoElements =&gt; <span class="prelude-val">None</span>,
MinMaxResult::OneElement(x) =&gt; <span class="prelude-val">Some</span>((x.clone(), x)),
MinMaxResult::MinMax(x, y) =&gt; <span class="prelude-val">Some</span>((x, y))
}
}
}
<span class="doccomment">/// Implementation guts for `minmax` and `minmax_by_key`.
</span><span class="kw">pub fn </span>minmax_impl&lt;I, K, F, L&gt;(<span class="kw-2">mut </span>it: I, <span class="kw-2">mut </span>key_for: F,
<span class="kw-2">mut </span>lt: L) -&gt; MinMaxResult&lt;I::Item&gt;
<span class="kw">where </span>I: Iterator,
F: FnMut(<span class="kw-2">&amp;</span>I::Item) -&gt; K,
L: FnMut(<span class="kw-2">&amp;</span>I::Item, <span class="kw-2">&amp;</span>I::Item, <span class="kw-2">&amp;</span>K, <span class="kw-2">&amp;</span>K) -&gt; bool,
{
<span class="kw">let </span>(<span class="kw-2">mut </span>min, <span class="kw-2">mut </span>max, <span class="kw-2">mut </span>min_key, <span class="kw-2">mut </span>max_key) = <span class="kw">match </span>it.next() {
<span class="prelude-val">None </span>=&gt; <span class="kw">return </span>MinMaxResult::NoElements,
<span class="prelude-val">Some</span>(x) =&gt; {
<span class="kw">match </span>it.next() {
<span class="prelude-val">None </span>=&gt; <span class="kw">return </span>MinMaxResult::OneElement(x),
<span class="prelude-val">Some</span>(y) =&gt; {
<span class="kw">let </span>xk = key_for(<span class="kw-2">&amp;</span>x);
<span class="kw">let </span>yk = key_for(<span class="kw-2">&amp;</span>y);
<span class="kw">if </span>!lt(<span class="kw-2">&amp;</span>y, <span class="kw-2">&amp;</span>x, <span class="kw-2">&amp;</span>yk, <span class="kw-2">&amp;</span>xk) {(x, y, xk, yk)} <span class="kw">else </span>{(y, x, yk, xk)}
}
}
}
};
<span class="kw">loop </span>{
<span class="comment">// `first` and `second` are the two next elements we want to look
// at. We first compare `first` and `second` (#1). The smaller one
// is then compared to current minimum (#2). The larger one is
// compared to current maximum (#3). This way we do 3 comparisons
// for 2 elements.
</span><span class="kw">let </span>first = <span class="kw">match </span>it.next() {
<span class="prelude-val">None </span>=&gt; <span class="kw">break</span>,
<span class="prelude-val">Some</span>(x) =&gt; x
};
<span class="kw">let </span>second = <span class="kw">match </span>it.next() {
<span class="prelude-val">None </span>=&gt; {
<span class="kw">let </span>first_key = key_for(<span class="kw-2">&amp;</span>first);
<span class="kw">if </span>lt(<span class="kw-2">&amp;</span>first, <span class="kw-2">&amp;</span>min, <span class="kw-2">&amp;</span>first_key, <span class="kw-2">&amp;</span>min_key) {
min = first;
} <span class="kw">else if </span>!lt(<span class="kw-2">&amp;</span>first, <span class="kw-2">&amp;</span>max, <span class="kw-2">&amp;</span>first_key, <span class="kw-2">&amp;</span>max_key) {
max = first;
}
<span class="kw">break</span>;
}
<span class="prelude-val">Some</span>(x) =&gt; x
};
<span class="kw">let </span>first_key = key_for(<span class="kw-2">&amp;</span>first);
<span class="kw">let </span>second_key = key_for(<span class="kw-2">&amp;</span>second);
<span class="kw">if </span>!lt(<span class="kw-2">&amp;</span>second, <span class="kw-2">&amp;</span>first, <span class="kw-2">&amp;</span>second_key, <span class="kw-2">&amp;</span>first_key) {
<span class="kw">if </span>lt(<span class="kw-2">&amp;</span>first, <span class="kw-2">&amp;</span>min, <span class="kw-2">&amp;</span>first_key, <span class="kw-2">&amp;</span>min_key) {
min = first;
min_key = first_key;
}
<span class="kw">if </span>!lt(<span class="kw-2">&amp;</span>second, <span class="kw-2">&amp;</span>max, <span class="kw-2">&amp;</span>second_key, <span class="kw-2">&amp;</span>max_key) {
max = second;
max_key = second_key;
}
} <span class="kw">else </span>{
<span class="kw">if </span>lt(<span class="kw-2">&amp;</span>second, <span class="kw-2">&amp;</span>min, <span class="kw-2">&amp;</span>second_key, <span class="kw-2">&amp;</span>min_key) {
min = second;
min_key = second_key;
}
<span class="kw">if </span>!lt(<span class="kw-2">&amp;</span>first, <span class="kw-2">&amp;</span>max, <span class="kw-2">&amp;</span>first_key, <span class="kw-2">&amp;</span>max_key) {
max = first;
max_key = first_key;
}
}
}
MinMaxResult::MinMax(min, max)
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="itertools" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>