blob: badbbf475a70f53172dc4afd7ceaeba4c162e3d5 [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.10.5/src/adaptors/coalesce.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>coalesce.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>
<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>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
</pre><pre class="rust"><code><span class="kw">use </span>std::fmt;
<span class="kw">use </span>std::iter::FusedIterator;
<span class="kw">use </span><span class="kw">crate</span>::size_hint;
<span class="attribute">#[must_use = <span class="string">&quot;iterator adaptors are lazy and do nothing unless consumed&quot;</span>]
</span><span class="kw">pub struct </span>CoalesceBy&lt;I, F, T&gt;
<span class="kw">where
</span>I: Iterator,
{
iter: I,
last: <span class="prelude-ty">Option</span>&lt;T&gt;,
f: F,
}
<span class="kw">impl</span>&lt;I: Clone, F: Clone, T: Clone&gt; Clone <span class="kw">for </span>CoalesceBy&lt;I, F, T&gt;
<span class="kw">where
</span>I: Iterator,
{
<span class="macro">clone_fields!</span>(last, iter, f);
}
<span class="kw">impl</span>&lt;I, F, T&gt; fmt::Debug <span class="kw">for </span>CoalesceBy&lt;I, F, T&gt;
<span class="kw">where
</span>I: Iterator + fmt::Debug,
T: fmt::Debug,
{
<span class="macro">debug_fmt_fields!</span>(CoalesceBy, iter);
}
<span class="kw">pub trait </span>CoalescePredicate&lt;Item, T&gt; {
<span class="kw">fn </span>coalesce_pair(<span class="kw-2">&amp;mut </span><span class="self">self</span>, t: T, item: Item) -&gt; <span class="prelude-ty">Result</span>&lt;T, (T, T)&gt;;
}
<span class="kw">impl</span>&lt;I, F, T&gt; Iterator <span class="kw">for </span>CoalesceBy&lt;I, F, T&gt;
<span class="kw">where
</span>I: Iterator,
F: CoalescePredicate&lt;I::Item, T&gt;,
{
<span class="kw">type </span>Item = T;
<span class="kw">fn </span>next(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="self">Self</span>::Item&gt; {
<span class="comment">// this fuses the iterator
</span><span class="kw">let </span>last = <span class="self">self</span>.last.take()<span class="question-mark">?</span>;
<span class="kw">let </span>self_last = <span class="kw-2">&amp;mut </span><span class="self">self</span>.last;
<span class="kw">let </span>self_f = <span class="kw-2">&amp;mut </span><span class="self">self</span>.f;
<span class="prelude-val">Some</span>(
<span class="self">self</span>.iter
.try_fold(last, |last, next| <span class="kw">match </span>self_f.coalesce_pair(last, next) {
<span class="prelude-val">Ok</span>(joined) =&gt; <span class="prelude-val">Ok</span>(joined),
<span class="prelude-val">Err</span>((last_, next_)) =&gt; {
<span class="kw-2">*</span>self_last = <span class="prelude-val">Some</span>(next_);
<span class="prelude-val">Err</span>(last_)
}
})
.unwrap_or_else(|x| x),
)
}
<span class="kw">fn </span>size_hint(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; (usize, <span class="prelude-ty">Option</span>&lt;usize&gt;) {
<span class="kw">let </span>(low, hi) = size_hint::add_scalar(<span class="self">self</span>.iter.size_hint(), <span class="self">self</span>.last.is_some() <span class="kw">as </span>usize);
((low &gt; <span class="number">0</span>) <span class="kw">as </span>usize, hi)
}
<span class="kw">fn </span>fold&lt;Acc, FnAcc&gt;(<span class="self">self</span>, acc: Acc, <span class="kw-2">mut </span>fn_acc: FnAcc) -&gt; Acc
<span class="kw">where
</span>FnAcc: FnMut(Acc, <span class="self">Self</span>::Item) -&gt; Acc,
{
<span class="kw">if let </span><span class="prelude-val">Some</span>(last) = <span class="self">self</span>.last {
<span class="kw">let </span><span class="kw-2">mut </span>f = <span class="self">self</span>.f;
<span class="kw">let </span>(last, acc) = <span class="self">self</span>.iter.fold((last, acc), |(last, acc), elt| {
<span class="kw">match </span>f.coalesce_pair(last, elt) {
<span class="prelude-val">Ok</span>(joined) =&gt; (joined, acc),
<span class="prelude-val">Err</span>((last_, next_)) =&gt; (next_, fn_acc(acc, last_)),
}
});
fn_acc(acc, last)
} <span class="kw">else </span>{
acc
}
}
}
<span class="kw">impl</span>&lt;I: Iterator, F: CoalescePredicate&lt;I::Item, T&gt;, T&gt; FusedIterator <span class="kw">for </span>CoalesceBy&lt;I, F, T&gt; {}
<span class="doccomment">/// An iterator adaptor that may join together adjacent elements.
///
/// See [`.coalesce()`](crate::Itertools::coalesce) for more information.
</span><span class="kw">pub type </span>Coalesce&lt;I, F&gt; = CoalesceBy&lt;I, F, &lt;I <span class="kw">as </span>Iterator&gt;::Item&gt;;
<span class="kw">impl</span>&lt;F, Item, T&gt; CoalescePredicate&lt;Item, T&gt; <span class="kw">for </span>F
<span class="kw">where
</span>F: FnMut(T, Item) -&gt; <span class="prelude-ty">Result</span>&lt;T, (T, T)&gt;,
{
<span class="kw">fn </span>coalesce_pair(<span class="kw-2">&amp;mut </span><span class="self">self</span>, t: T, item: Item) -&gt; <span class="prelude-ty">Result</span>&lt;T, (T, T)&gt; {
<span class="self">self</span>(t, item)
}
}
<span class="doccomment">/// Create a new `Coalesce`.
</span><span class="kw">pub fn </span>coalesce&lt;I, F&gt;(<span class="kw-2">mut </span>iter: I, f: F) -&gt; Coalesce&lt;I, F&gt;
<span class="kw">where
</span>I: Iterator,
{
Coalesce {
last: iter.next(),
iter,
f,
}
}
<span class="doccomment">/// An iterator adaptor that removes repeated duplicates, determining equality using a comparison function.
///
/// See [`.dedup_by()`](crate::Itertools::dedup_by) or [`.dedup()`](crate::Itertools::dedup) for more information.
</span><span class="kw">pub type </span>DedupBy&lt;I, Pred&gt; = CoalesceBy&lt;I, DedupPred2CoalescePred&lt;Pred&gt;, &lt;I <span class="kw">as </span>Iterator&gt;::Item&gt;;
<span class="attribute">#[derive(Clone)]
</span><span class="kw">pub struct </span>DedupPred2CoalescePred&lt;DP&gt;(DP);
<span class="kw">impl</span>&lt;DP&gt; fmt::Debug <span class="kw">for </span>DedupPred2CoalescePred&lt;DP&gt; {
<span class="macro">debug_fmt_fields!</span>(DedupPred2CoalescePred,);
}
<span class="kw">pub trait </span>DedupPredicate&lt;T&gt; {
<span class="comment">// TODO replace by Fn(&amp;T, &amp;T)-&gt;bool once Rust supports it
</span><span class="kw">fn </span>dedup_pair(<span class="kw-2">&amp;mut </span><span class="self">self</span>, a: <span class="kw-2">&amp;</span>T, b: <span class="kw-2">&amp;</span>T) -&gt; bool;
}
<span class="kw">impl</span>&lt;DP, T&gt; CoalescePredicate&lt;T, T&gt; <span class="kw">for </span>DedupPred2CoalescePred&lt;DP&gt;
<span class="kw">where
</span>DP: DedupPredicate&lt;T&gt;,
{
<span class="kw">fn </span>coalesce_pair(<span class="kw-2">&amp;mut </span><span class="self">self</span>, t: T, item: T) -&gt; <span class="prelude-ty">Result</span>&lt;T, (T, T)&gt; {
<span class="kw">if </span><span class="self">self</span>.<span class="number">0</span>.dedup_pair(<span class="kw-2">&amp;</span>t, <span class="kw-2">&amp;</span>item) {
<span class="prelude-val">Ok</span>(t)
} <span class="kw">else </span>{
<span class="prelude-val">Err</span>((t, item))
}
}
}
<span class="attribute">#[derive(Clone, Debug)]
</span><span class="kw">pub struct </span>DedupEq;
<span class="kw">impl</span>&lt;T: PartialEq&gt; DedupPredicate&lt;T&gt; <span class="kw">for </span>DedupEq {
<span class="kw">fn </span>dedup_pair(<span class="kw-2">&amp;mut </span><span class="self">self</span>, a: <span class="kw-2">&amp;</span>T, b: <span class="kw-2">&amp;</span>T) -&gt; bool {
a == b
}
}
<span class="kw">impl</span>&lt;T, F: FnMut(<span class="kw-2">&amp;</span>T, <span class="kw-2">&amp;</span>T) -&gt; bool&gt; DedupPredicate&lt;T&gt; <span class="kw">for </span>F {
<span class="kw">fn </span>dedup_pair(<span class="kw-2">&amp;mut </span><span class="self">self</span>, a: <span class="kw-2">&amp;</span>T, b: <span class="kw-2">&amp;</span>T) -&gt; bool {
<span class="self">self</span>(a, b)
}
}
<span class="doccomment">/// Create a new `DedupBy`.
</span><span class="kw">pub fn </span>dedup_by&lt;I, Pred&gt;(<span class="kw-2">mut </span>iter: I, dedup_pred: Pred) -&gt; DedupBy&lt;I, Pred&gt;
<span class="kw">where
</span>I: Iterator,
{
DedupBy {
last: iter.next(),
iter,
f: DedupPred2CoalescePred(dedup_pred),
}
}
<span class="doccomment">/// An iterator adaptor that removes repeated duplicates.
///
/// See [`.dedup()`](crate::Itertools::dedup) for more information.
</span><span class="kw">pub type </span>Dedup&lt;I&gt; = DedupBy&lt;I, DedupEq&gt;;
<span class="doccomment">/// Create a new `Dedup`.
</span><span class="kw">pub fn </span>dedup&lt;I&gt;(iter: I) -&gt; Dedup&lt;I&gt;
<span class="kw">where
</span>I: Iterator,
{
dedup_by(iter, DedupEq)
}
<span class="doccomment">/// An iterator adaptor that removes repeated duplicates, while keeping a count of how many
/// repeated elements were present. This will determine equality using a comparison function.
///
/// See [`.dedup_by_with_count()`](crate::Itertools::dedup_by_with_count) or
/// [`.dedup_with_count()`](crate::Itertools::dedup_with_count) for more information.
</span><span class="kw">pub type </span>DedupByWithCount&lt;I, Pred&gt; =
CoalesceBy&lt;I, DedupPredWithCount2CoalescePred&lt;Pred&gt;, (usize, &lt;I <span class="kw">as </span>Iterator&gt;::Item)&gt;;
<span class="attribute">#[derive(Clone, Debug)]
</span><span class="kw">pub struct </span>DedupPredWithCount2CoalescePred&lt;DP&gt;(DP);
<span class="kw">impl</span>&lt;DP, T&gt; CoalescePredicate&lt;T, (usize, T)&gt; <span class="kw">for </span>DedupPredWithCount2CoalescePred&lt;DP&gt;
<span class="kw">where
</span>DP: DedupPredicate&lt;T&gt;,
{
<span class="kw">fn </span>coalesce_pair(
<span class="kw-2">&amp;mut </span><span class="self">self</span>,
(c, t): (usize, T),
item: T,
) -&gt; <span class="prelude-ty">Result</span>&lt;(usize, T), ((usize, T), (usize, T))&gt; {
<span class="kw">if </span><span class="self">self</span>.<span class="number">0</span>.dedup_pair(<span class="kw-2">&amp;</span>t, <span class="kw-2">&amp;</span>item) {
<span class="prelude-val">Ok</span>((c + <span class="number">1</span>, t))
} <span class="kw">else </span>{
<span class="prelude-val">Err</span>(((c, t), (<span class="number">1</span>, item)))
}
}
}
<span class="doccomment">/// An iterator adaptor that removes repeated duplicates, while keeping a count of how many
/// repeated elements were present.
///
/// See [`.dedup_with_count()`](crate::Itertools::dedup_with_count) for more information.
</span><span class="kw">pub type </span>DedupWithCount&lt;I&gt; = DedupByWithCount&lt;I, DedupEq&gt;;
<span class="doccomment">/// Create a new `DedupByWithCount`.
</span><span class="kw">pub fn </span>dedup_by_with_count&lt;I, Pred&gt;(<span class="kw-2">mut </span>iter: I, dedup_pred: Pred) -&gt; DedupByWithCount&lt;I, Pred&gt;
<span class="kw">where
</span>I: Iterator,
{
DedupByWithCount {
last: iter.next().map(|v| (<span class="number">1</span>, v)),
iter,
f: DedupPredWithCount2CoalescePred(dedup_pred),
}
}
<span class="doccomment">/// Create a new `DedupWithCount`.
</span><span class="kw">pub fn </span>dedup_with_count&lt;I&gt;(iter: I) -&gt; DedupWithCount&lt;I&gt;
<span class="kw">where
</span>I: Iterator,
{
dedup_by_with_count(iter, DedupEq)
}
</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>