mirror of
https://github.com/Rust-GPU/rust-gpu.git
synced 2026-06-08 10:39:50 +09:00
343 lines
85 KiB
HTML
343 lines
85 KiB
HTML
<!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="`GroupingMap` is an intermediate struct for efficient group-and-fold operations. It groups elements by their key and at the same time fold each group using some aggregating operation."><title>GroupingMap in itertools::structs - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="itertools" data-themes="" data-resource-suffix="" data-rustdoc-version="1.96.0-nightly (02c7f9bec 2026-04-10)" data-channel="nightly" data-search-js="search-b5634cc7.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../../static.files/storage-41dd4d93.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5013f961.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-f7c3ffd8.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc struct"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">GroupingMap</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../itertools/index.html">itertools</a><span class="version">0.14.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Grouping<wbr>Map</a></h2><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.aggregate" title="aggregate">aggregate</a></li><li><a href="#method.collect" title="collect">collect</a></li><li><a href="#method.fold" title="fold">fold</a></li><li><a href="#method.fold_first" title="fold_first">fold_first</a></li><li><a href="#method.fold_with" title="fold_with">fold_with</a></li><li><a href="#method.max" title="max">max</a></li><li><a href="#method.max_by" title="max_by">max_by</a></li><li><a href="#method.max_by_key" title="max_by_key">max_by_key</a></li><li><a href="#method.min" title="min">min</a></li><li><a href="#method.min_by" title="min_by">min_by</a></li><li><a href="#method.min_by_key" title="min_by_key">min_by_key</a></li><li><a href="#method.minmax" title="minmax">minmax</a></li><li><a href="#method.minmax_by" title="minmax_by">minmax_by</a></li><li><a href="#method.minmax_by_key" title="minmax_by_key">minmax_by_key</a></li><li><a href="#method.product" title="product">product</a></li><li><a href="#method.reduce" title="reduce">reduce</a></li><li><a href="#method.sum" title="sum">sum</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Clone-for-GroupingMap%3CI%3E" title="Clone">Clone</a></li><li><a href="#impl-Debug-for-GroupingMap%3CI%3E" title="Debug">Debug</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-GroupingMap%3CI%3E" title="Freeze">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-GroupingMap%3CI%3E" title="RefUnwindSafe">RefUnwindSafe</a></li><li><a href="#impl-Send-for-GroupingMap%3CI%3E" title="Send">Send</a></li><li><a href="#impl-Sync-for-GroupingMap%3CI%3E" title="Sync">Sync</a></li><li><a href="#impl-Unpin-for-GroupingMap%3CI%3E" title="Unpin">Unpin</a></li><li><a href="#impl-UnsafeUnpin-for-GroupingMap%3CI%3E" title="UnsafeUnpin">UnsafeUnpin</a></li><li><a href="#impl-UnwindSafe-for-GroupingMap%3CI%3E" title="UnwindSafe">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T" title="Any">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T" title="Borrow<T>">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T" title="BorrowMut<T>">BorrowMut<T></a></li><li><a href="#impl-CloneToUninit-for-T" title="CloneToUninit">CloneToUninit</a></li><li><a href="#impl-From%3CT%3E-for-T" title="From<T>">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-T" title="Into<U>">Into<U></a></li><li><a href="#impl-IntoEither-for-T" title="IntoEither">IntoEither</a></li><li><a href="#impl-ToOwned-for-T" title="ToOwned">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-T" title="TryFrom<U>">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-T" title="TryInto<U>">TryInto<U></a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In itertools::<wbr>structs</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content" tabindex="-1"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">itertools</a>::<wbr><a href="index.html">structs</a></div><h1>Struct <span class="struct">Grouping<wbr>Map</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/itertools/grouping_map.rs.html#59-61">Source</a> </span></div><pre class="rust item-decl"><code>pub struct GroupingMap<I> { <span class="comment">/* private fields */</span> }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>GroupingMap</code> is an intermediate struct for efficient group-and-fold operations.
|
||
It groups elements by their key and at the same time fold each group
|
||
using some aggregating operation.</p>
|
||
<p>No method on this struct performs temporary allocations.</p>
|
||
</div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-GroupingMap%3CI%3E" class="impl"><a class="src rightside" href="../../src/itertools/grouping_map.rs.html#63-612">Source</a><a href="#impl-GroupingMap%3CI%3E" class="anchor">§</a><h3 class="code-header">impl<I, K, V> <a class="struct" href="struct.GroupingMap.html" title="struct itertools::structs::GroupingMap">GroupingMap</a><I><div class="where">where
|
||
I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a><Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(K, V)</a>>,
|
||
K: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.aggregate" class="method"><a class="src rightside" href="../../src/itertools/grouping_map.rs.html#108-122">Source</a><h4 class="code-header">pub fn <a href="#method.aggregate" class="fn">aggregate</a><FO, R>(self, operation: FO) -> <a class="struct" href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html" title="struct std::collections::hash::map::HashMap">HashMap</a><K, R><div class="where">where
|
||
FO: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><R>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&K</a>, V) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><R>,</div></h4></section></summary><div class="docblock"><p>This is the generic way to perform any operation on a <code>GroupingMap</code>.
|
||
It’s suggested to use this method only to implement custom operations
|
||
when the already provided ones are not enough.</p>
|
||
<p>Groups elements from the <code>GroupingMap</code> source by key and applies <code>operation</code> to the elements
|
||
of each group sequentially, passing the previously accumulated value, a reference to the key
|
||
and the current element as arguments, and stores the results in an <code>HashMap</code>.</p>
|
||
<p>The <code>operation</code> function is invoked on each element with the following parameters:</p>
|
||
<ul>
|
||
<li>the current value of the accumulator of the group if there is currently one;</li>
|
||
<li>a reference to the key of the group this element belongs to;</li>
|
||
<li>the element from the source being aggregated;</li>
|
||
</ul>
|
||
<p>If <code>operation</code> returns <code>Some(element)</code> then the accumulator is updated with <code>element</code>,
|
||
otherwise the previous accumulation is discarded.</p>
|
||
<p>Return a <code>HashMap</code> associating the key of each group with the result of aggregation of
|
||
that group’s elements. If the aggregation of the last element of a group discards the
|
||
accumulator then there won’t be an entry associated to that group’s key.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>itertools::Itertools;
|
||
|
||
<span class="kw">let </span>data = <span class="macro">vec!</span>[<span class="number">2</span>, <span class="number">8</span>, <span class="number">5</span>, <span class="number">7</span>, <span class="number">9</span>, <span class="number">0</span>, <span class="number">4</span>, <span class="number">10</span>];
|
||
<span class="kw">let </span>lookup = data.into_iter()
|
||
.into_grouping_map_by(|<span class="kw-2">&</span>n| n % <span class="number">4</span>)
|
||
.aggregate(|acc, _key, val| {
|
||
<span class="kw">if </span>val == <span class="number">0 </span>|| val == <span class="number">10 </span>{
|
||
<span class="prelude-val">None
|
||
</span>} <span class="kw">else </span>{
|
||
<span class="prelude-val">Some</span>(acc.unwrap_or(<span class="number">0</span>) + val)
|
||
}
|
||
});
|
||
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">0</span>], <span class="number">4</span>); <span class="comment">// 0 resets the accumulator so only 4 is summed
|
||
</span><span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">1</span>], <span class="number">5 </span>+ <span class="number">9</span>);
|
||
<span class="macro">assert_eq!</span>(lookup.get(<span class="kw-2">&</span><span class="number">2</span>), <span class="prelude-val">None</span>); <span class="comment">// 10 resets the accumulator and nothing is summed afterward
|
||
</span><span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">3</span>], <span class="number">7</span>);
|
||
<span class="macro">assert_eq!</span>(lookup.len(), <span class="number">3</span>); <span class="comment">// The final keys are only 0, 1 and 2</span></code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.fold_with" class="method"><a class="src rightside" href="../../src/itertools/grouping_map.rs.html#157-166">Source</a><h4 class="code-header">pub fn <a href="#method.fold_with" class="fn">fold_with</a><FI, FO, R>(self, init: FI, operation: FO) -> <a class="struct" href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html" title="struct std::collections::hash::map::HashMap">HashMap</a><K, R><div class="where">where
|
||
FI: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&K</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&V</a>) -> R,
|
||
FO: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(R, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&K</a>, V) -> R,</div></h4></section></summary><div class="docblock"><p>Groups elements from the <code>GroupingMap</code> source by key and applies <code>operation</code> to the elements
|
||
of each group sequentially, passing the previously accumulated value, a reference to the key
|
||
and the current element as arguments, and stores the results in a new map.</p>
|
||
<p><code>init</code> is called to obtain the initial value of each accumulator.</p>
|
||
<p><code>operation</code> is a function that is invoked on each element with the following parameters:</p>
|
||
<ul>
|
||
<li>the current value of the accumulator of the group;</li>
|
||
<li>a reference to the key of the group this element belongs to;</li>
|
||
<li>the element from the source being accumulated.</li>
|
||
</ul>
|
||
<p>Return a <code>HashMap</code> associating the key of each group with the result of folding that group’s elements.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>itertools::Itertools;
|
||
|
||
<span class="attr">#[derive(Debug, Default)]
|
||
</span><span class="kw">struct </span>Accumulator {
|
||
acc: usize,
|
||
}
|
||
|
||
<span class="kw">let </span>lookup = (<span class="number">1</span>..=<span class="number">7</span>)
|
||
.into_grouping_map_by(|<span class="kw-2">&</span>n| n % <span class="number">3</span>)
|
||
.fold_with(|_key, _val| Default::default(), |Accumulator { acc }, _key, val| {
|
||
<span class="kw">let </span>acc = acc + val;
|
||
Accumulator { acc }
|
||
});
|
||
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">0</span>].acc, <span class="number">3 </span>+ <span class="number">6</span>);
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">1</span>].acc, <span class="number">1 </span>+ <span class="number">4 </span>+ <span class="number">7</span>);
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">2</span>].acc, <span class="number">2 </span>+ <span class="number">5</span>);
|
||
<span class="macro">assert_eq!</span>(lookup.len(), <span class="number">3</span>);</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.fold" class="method"><a class="src rightside" href="../../src/itertools/grouping_map.rs.html#193-199">Source</a><h4 class="code-header">pub fn <a href="#method.fold" class="fn">fold</a><FO, R>(self, init: R, operation: FO) -> <a class="struct" href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html" title="struct std::collections::hash::map::HashMap">HashMap</a><K, R><div class="where">where
|
||
R: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,
|
||
FO: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(R, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&K</a>, V) -> R,</div></h4></section></summary><div class="docblock"><p>Groups elements from the <code>GroupingMap</code> source by key and applies <code>operation</code> to the elements
|
||
of each group sequentially, passing the previously accumulated value, a reference to the key
|
||
and the current element as arguments, and stores the results in a new map.</p>
|
||
<p><code>init</code> is the value from which will be cloned the initial value of each accumulator.</p>
|
||
<p><code>operation</code> is a function that is invoked on each element with the following parameters:</p>
|
||
<ul>
|
||
<li>the current value of the accumulator of the group;</li>
|
||
<li>a reference to the key of the group this element belongs to;</li>
|
||
<li>the element from the source being accumulated.</li>
|
||
</ul>
|
||
<p>Return a <code>HashMap</code> associating the key of each group with the result of folding that group’s elements.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>itertools::Itertools;
|
||
|
||
<span class="kw">let </span>lookup = (<span class="number">1</span>..=<span class="number">7</span>)
|
||
.into_grouping_map_by(|<span class="kw-2">&</span>n| n % <span class="number">3</span>)
|
||
.fold(<span class="number">0</span>, |acc, _key, val| acc + val);
|
||
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">0</span>], <span class="number">3 </span>+ <span class="number">6</span>);
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">1</span>], <span class="number">1 </span>+ <span class="number">4 </span>+ <span class="number">7</span>);
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">2</span>], <span class="number">2 </span>+ <span class="number">5</span>);
|
||
<span class="macro">assert_eq!</span>(lookup.len(), <span class="number">3</span>);</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.reduce" class="method"><a class="src rightside" href="../../src/itertools/grouping_map.rs.html#228-238">Source</a><h4 class="code-header">pub fn <a href="#method.reduce" class="fn">reduce</a><FO>(self, operation: FO) -> <a class="struct" href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html" title="struct std::collections::hash::map::HashMap">HashMap</a><K, V><div class="where">where
|
||
FO: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(V, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&K</a>, V) -> V,</div></h4></section></summary><div class="docblock"><p>Groups elements from the <code>GroupingMap</code> source by key and applies <code>operation</code> to the elements
|
||
of each group sequentially, passing the previously accumulated value, a reference to the key
|
||
and the current element as arguments, and stores the results in a new map.</p>
|
||
<p>This is similar to <a href="struct.GroupingMap.html#method.fold" title="method itertools::structs::GroupingMap::fold"><code>fold</code></a> but the initial value of the accumulator is the first element of the group.</p>
|
||
<p><code>operation</code> is a function that is invoked on each element with the following parameters:</p>
|
||
<ul>
|
||
<li>the current value of the accumulator of the group;</li>
|
||
<li>a reference to the key of the group this element belongs to;</li>
|
||
<li>the element from the source being accumulated.</li>
|
||
</ul>
|
||
<p>Return a <code>HashMap</code> associating the key of each group with the result of folding that group’s elements.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>itertools::Itertools;
|
||
|
||
<span class="kw">let </span>lookup = (<span class="number">1</span>..=<span class="number">7</span>)
|
||
.into_grouping_map_by(|<span class="kw-2">&</span>n| n % <span class="number">3</span>)
|
||
.reduce(|acc, _key, val| acc + val);
|
||
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">0</span>], <span class="number">3 </span>+ <span class="number">6</span>);
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">1</span>], <span class="number">1 </span>+ <span class="number">4 </span>+ <span class="number">7</span>);
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">2</span>], <span class="number">2 </span>+ <span class="number">5</span>);
|
||
<span class="macro">assert_eq!</span>(lookup.len(), <span class="number">3</span>);</code></pre></div></div></details><details class="toggle method-toggle deprecated" open><summary><section id="method.fold_first" class="method"><a class="src rightside" href="../../src/itertools/grouping_map.rs.html#242-247">Source</a><h4 class="code-header">pub fn <a href="#method.fold_first" class="fn">fold_first</a><FO>(self, operation: FO) -> <a class="struct" href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html" title="struct std::collections::hash::map::HashMap">HashMap</a><K, V><div class="where">where
|
||
FO: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(V, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&K</a>, V) -> V,</div></h4></section><span class="item-info"><div class="stab deprecated"><span class="emoji">👎</span><span>Deprecated since 0.13.0: <p>Use .reduce() instead</p>
|
||
</span></div></span></summary><div class="docblock"><p>See <a href="struct.GroupingMap.html#method.reduce" title="method itertools::structs::GroupingMap::reduce"><code>.reduce()</code></a>.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.collect" class="method"><a class="src rightside" href="../../src/itertools/grouping_map.rs.html#267-281">Source</a><h4 class="code-header">pub fn <a href="#method.collect" class="fn">collect</a><C>(self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html" title="struct std::collections::hash::map::HashMap">HashMap</a><K, C><div class="where">where
|
||
C: <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.Extend.html" title="trait core::iter::traits::collect::Extend">Extend</a><V>,</div></h4></section></summary><div class="docblock"><p>Groups elements from the <code>GroupingMap</code> source by key and collects the elements of each group in
|
||
an instance of <code>C</code>. The iteration order is preserved when inserting elements.</p>
|
||
<p>Return a <code>HashMap</code> associating the key of each group with the collection containing that group’s elements.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>itertools::Itertools;
|
||
<span class="kw">use </span>std::collections::HashSet;
|
||
|
||
<span class="kw">let </span>lookup = <span class="macro">vec!</span>[<span class="number">0</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">6</span>].into_iter()
|
||
.into_grouping_map_by(|<span class="kw-2">&</span>n| n % <span class="number">3</span>)
|
||
.collect::<HashSet<<span class="kw">_</span>>>();
|
||
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">0</span>], <span class="macro">vec!</span>[<span class="number">0</span>, <span class="number">3</span>, <span class="number">6</span>].into_iter().collect::<HashSet<<span class="kw">_</span>>>());
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">1</span>], <span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">4</span>].into_iter().collect::<HashSet<<span class="kw">_</span>>>());
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">2</span>], <span class="macro">vec!</span>[<span class="number">2</span>, <span class="number">5</span>].into_iter().collect::<HashSet<<span class="kw">_</span>>>());
|
||
<span class="macro">assert_eq!</span>(lookup.len(), <span class="number">3</span>);</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.max" class="method"><a class="src rightside" href="../../src/itertools/grouping_map.rs.html#301-306">Source</a><h4 class="code-header">pub fn <a href="#method.max" class="fn">max</a>(self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html" title="struct std::collections::hash::map::HashMap">HashMap</a><K, V><div class="where">where
|
||
V: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a>,</div></h4></section></summary><div class="docblock"><p>Groups elements from the <code>GroupingMap</code> source by key and finds the maximum of each group.</p>
|
||
<p>If several elements are equally maximum, the last element is picked.</p>
|
||
<p>Returns a <code>HashMap</code> associating the key of each group with the maximum of that group’s elements.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>itertools::Itertools;
|
||
|
||
<span class="kw">let </span>lookup = <span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">7</span>, <span class="number">8</span>, <span class="number">9</span>, <span class="number">12</span>].into_iter()
|
||
.into_grouping_map_by(|<span class="kw-2">&</span>n| n % <span class="number">3</span>)
|
||
.max();
|
||
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">0</span>], <span class="number">12</span>);
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">1</span>], <span class="number">7</span>);
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">2</span>], <span class="number">8</span>);
|
||
<span class="macro">assert_eq!</span>(lookup.len(), <span class="number">3</span>);</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.max_by" class="method"><a class="src rightside" href="../../src/itertools/grouping_map.rs.html#327-335">Source</a><h4 class="code-header">pub fn <a href="#method.max_by" class="fn">max_by</a><F>(self, compare: F) -> <a class="struct" href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html" title="struct std::collections::hash::map::HashMap">HashMap</a><K, V><div class="where">where
|
||
F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&K</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&V</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&V</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a>,</div></h4></section></summary><div class="docblock"><p>Groups elements from the <code>GroupingMap</code> source by key and finds the maximum of each group
|
||
with respect to the specified comparison function.</p>
|
||
<p>If several elements are equally maximum, the last element is picked.</p>
|
||
<p>Returns a <code>HashMap</code> associating the key of each group with the maximum of that group’s elements.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>itertools::Itertools;
|
||
|
||
<span class="kw">let </span>lookup = <span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">7</span>, <span class="number">8</span>, <span class="number">9</span>, <span class="number">12</span>].into_iter()
|
||
.into_grouping_map_by(|<span class="kw-2">&</span>n| n % <span class="number">3</span>)
|
||
.max_by(|_key, x, y| y.cmp(x));
|
||
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">0</span>], <span class="number">3</span>);
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">1</span>], <span class="number">1</span>);
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">2</span>], <span class="number">5</span>);
|
||
<span class="macro">assert_eq!</span>(lookup.len(), <span class="number">3</span>);</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.max_by_key" class="method"><a class="src rightside" href="../../src/itertools/grouping_map.rs.html#356-362">Source</a><h4 class="code-header">pub fn <a href="#method.max_by_key" class="fn">max_by_key</a><F, CK>(self, f: F) -> <a class="struct" href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html" title="struct std::collections::hash::map::HashMap">HashMap</a><K, V><div class="where">where
|
||
F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&K</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&V</a>) -> CK,
|
||
CK: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a>,</div></h4></section></summary><div class="docblock"><p>Groups elements from the <code>GroupingMap</code> source by key and finds the element of each group
|
||
that gives the maximum from the specified function.</p>
|
||
<p>If several elements are equally maximum, the last element is picked.</p>
|
||
<p>Returns a <code>HashMap</code> associating the key of each group with the maximum of that group’s elements.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>itertools::Itertools;
|
||
|
||
<span class="kw">let </span>lookup = <span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">7</span>, <span class="number">8</span>, <span class="number">9</span>, <span class="number">12</span>].into_iter()
|
||
.into_grouping_map_by(|<span class="kw-2">&</span>n| n % <span class="number">3</span>)
|
||
.max_by_key(|_key, <span class="kw-2">&</span>val| val % <span class="number">4</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">0</span>], <span class="number">3</span>);
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">1</span>], <span class="number">7</span>);
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">2</span>], <span class="number">5</span>);
|
||
<span class="macro">assert_eq!</span>(lookup.len(), <span class="number">3</span>);</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.min" class="method"><a class="src rightside" href="../../src/itertools/grouping_map.rs.html#382-387">Source</a><h4 class="code-header">pub fn <a href="#method.min" class="fn">min</a>(self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html" title="struct std::collections::hash::map::HashMap">HashMap</a><K, V><div class="where">where
|
||
V: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a>,</div></h4></section></summary><div class="docblock"><p>Groups elements from the <code>GroupingMap</code> source by key and finds the minimum of each group.</p>
|
||
<p>If several elements are equally minimum, the first element is picked.</p>
|
||
<p>Returns a <code>HashMap</code> associating the key of each group with the minimum of that group’s elements.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>itertools::Itertools;
|
||
|
||
<span class="kw">let </span>lookup = <span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">7</span>, <span class="number">8</span>, <span class="number">9</span>, <span class="number">12</span>].into_iter()
|
||
.into_grouping_map_by(|<span class="kw-2">&</span>n| n % <span class="number">3</span>)
|
||
.min();
|
||
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">0</span>], <span class="number">3</span>);
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">1</span>], <span class="number">1</span>);
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">2</span>], <span class="number">5</span>);
|
||
<span class="macro">assert_eq!</span>(lookup.len(), <span class="number">3</span>);</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.min_by" class="method"><a class="src rightside" href="../../src/itertools/grouping_map.rs.html#408-416">Source</a><h4 class="code-header">pub fn <a href="#method.min_by" class="fn">min_by</a><F>(self, compare: F) -> <a class="struct" href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html" title="struct std::collections::hash::map::HashMap">HashMap</a><K, V><div class="where">where
|
||
F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&K</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&V</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&V</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a>,</div></h4></section></summary><div class="docblock"><p>Groups elements from the <code>GroupingMap</code> source by key and finds the minimum of each group
|
||
with respect to the specified comparison function.</p>
|
||
<p>If several elements are equally minimum, the first element is picked.</p>
|
||
<p>Returns a <code>HashMap</code> associating the key of each group with the minimum of that group’s elements.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>itertools::Itertools;
|
||
|
||
<span class="kw">let </span>lookup = <span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">7</span>, <span class="number">8</span>, <span class="number">9</span>, <span class="number">12</span>].into_iter()
|
||
.into_grouping_map_by(|<span class="kw-2">&</span>n| n % <span class="number">3</span>)
|
||
.min_by(|_key, x, y| y.cmp(x));
|
||
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">0</span>], <span class="number">12</span>);
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">1</span>], <span class="number">7</span>);
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">2</span>], <span class="number">8</span>);
|
||
<span class="macro">assert_eq!</span>(lookup.len(), <span class="number">3</span>);</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.min_by_key" class="method"><a class="src rightside" href="../../src/itertools/grouping_map.rs.html#437-443">Source</a><h4 class="code-header">pub fn <a href="#method.min_by_key" class="fn">min_by_key</a><F, CK>(self, f: F) -> <a class="struct" href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html" title="struct std::collections::hash::map::HashMap">HashMap</a><K, V><div class="where">where
|
||
F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&K</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&V</a>) -> CK,
|
||
CK: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a>,</div></h4></section></summary><div class="docblock"><p>Groups elements from the <code>GroupingMap</code> source by key and finds the element of each group
|
||
that gives the minimum from the specified function.</p>
|
||
<p>If several elements are equally minimum, the first element is picked.</p>
|
||
<p>Returns a <code>HashMap</code> associating the key of each group with the minimum of that group’s elements.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>itertools::Itertools;
|
||
|
||
<span class="kw">let </span>lookup = <span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">7</span>, <span class="number">8</span>, <span class="number">9</span>, <span class="number">12</span>].into_iter()
|
||
.into_grouping_map_by(|<span class="kw-2">&</span>n| n % <span class="number">3</span>)
|
||
.min_by_key(|_key, <span class="kw-2">&</span>val| val % <span class="number">4</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">0</span>], <span class="number">12</span>);
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">1</span>], <span class="number">4</span>);
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">2</span>], <span class="number">8</span>);
|
||
<span class="macro">assert_eq!</span>(lookup.len(), <span class="number">3</span>);</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.minmax" class="method"><a class="src rightside" href="../../src/itertools/grouping_map.rs.html#472-477">Source</a><h4 class="code-header">pub fn <a href="#method.minmax" class="fn">minmax</a>(self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html" title="struct std::collections::hash::map::HashMap">HashMap</a><K, <a class="enum" href="../enum.MinMaxResult.html" title="enum itertools::MinMaxResult">MinMaxResult</a><V>><div class="where">where
|
||
V: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a>,</div></h4></section></summary><div class="docblock"><p>Groups elements from the <code>GroupingMap</code> source by key and find the maximum and minimum of
|
||
each group.</p>
|
||
<p>If several elements are equally maximum, the last element is picked.
|
||
If several elements are equally minimum, the first element is picked.</p>
|
||
<p>See <a href="../trait.Itertools.html#method.minmax" title="method itertools::Itertools::minmax"><code>Itertools::minmax</code></a> for the non-grouping version.</p>
|
||
<p>Differences from the non grouping version:</p>
|
||
<ul>
|
||
<li>It never produces a <code>MinMaxResult::NoElements</code></li>
|
||
<li>It doesn’t have any speedup</li>
|
||
</ul>
|
||
<p>Returns a <code>HashMap</code> associating the key of each group with the minimum and maximum of that group’s elements.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>itertools::Itertools;
|
||
<span class="kw">use </span>itertools::MinMaxResult::{OneElement, MinMax};
|
||
|
||
<span class="kw">let </span>lookup = <span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">7</span>, <span class="number">9</span>, <span class="number">12</span>].into_iter()
|
||
.into_grouping_map_by(|<span class="kw-2">&</span>n| n % <span class="number">3</span>)
|
||
.minmax();
|
||
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">0</span>], MinMax(<span class="number">3</span>, <span class="number">12</span>));
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">1</span>], MinMax(<span class="number">1</span>, <span class="number">7</span>));
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">2</span>], OneElement(<span class="number">5</span>));
|
||
<span class="macro">assert_eq!</span>(lookup.len(), <span class="number">3</span>);</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.minmax_by" class="method"><a class="src rightside" href="../../src/itertools/grouping_map.rs.html#502-528">Source</a><h4 class="code-header">pub fn <a href="#method.minmax_by" class="fn">minmax_by</a><F>(self, compare: F) -> <a class="struct" href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html" title="struct std::collections::hash::map::HashMap">HashMap</a><K, <a class="enum" href="../enum.MinMaxResult.html" title="enum itertools::MinMaxResult">MinMaxResult</a><V>><div class="where">where
|
||
F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&K</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&V</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&V</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a>,</div></h4></section></summary><div class="docblock"><p>Groups elements from the <code>GroupingMap</code> source by key and find the maximum and minimum of
|
||
each group with respect to the specified comparison function.</p>
|
||
<p>If several elements are equally maximum, the last element is picked.
|
||
If several elements are equally minimum, the first element is picked.</p>
|
||
<p>It has the same differences from the non-grouping version as <code>minmax</code>.</p>
|
||
<p>Returns a <code>HashMap</code> associating the key of each group with the minimum and maximum of that group’s elements.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>itertools::Itertools;
|
||
<span class="kw">use </span>itertools::MinMaxResult::{OneElement, MinMax};
|
||
|
||
<span class="kw">let </span>lookup = <span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">7</span>, <span class="number">9</span>, <span class="number">12</span>].into_iter()
|
||
.into_grouping_map_by(|<span class="kw-2">&</span>n| n % <span class="number">3</span>)
|
||
.minmax_by(|_key, x, y| y.cmp(x));
|
||
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">0</span>], MinMax(<span class="number">12</span>, <span class="number">3</span>));
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">1</span>], MinMax(<span class="number">7</span>, <span class="number">1</span>));
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">2</span>], OneElement(<span class="number">5</span>));
|
||
<span class="macro">assert_eq!</span>(lookup.len(), <span class="number">3</span>);</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.minmax_by_key" class="method"><a class="src rightside" href="../../src/itertools/grouping_map.rs.html#553-559">Source</a><h4 class="code-header">pub fn <a href="#method.minmax_by_key" class="fn">minmax_by_key</a><F, CK>(self, f: F) -> <a class="struct" href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html" title="struct std::collections::hash::map::HashMap">HashMap</a><K, <a class="enum" href="../enum.MinMaxResult.html" title="enum itertools::MinMaxResult">MinMaxResult</a><V>><div class="where">where
|
||
F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&K</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&V</a>) -> CK,
|
||
CK: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a>,</div></h4></section></summary><div class="docblock"><p>Groups elements from the <code>GroupingMap</code> source by key and find the elements of each group
|
||
that gives the minimum and maximum from the specified function.</p>
|
||
<p>If several elements are equally maximum, the last element is picked.
|
||
If several elements are equally minimum, the first element is picked.</p>
|
||
<p>It has the same differences from the non-grouping version as <code>minmax</code>.</p>
|
||
<p>Returns a <code>HashMap</code> associating the key of each group with the minimum and maximum of that group’s elements.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>itertools::Itertools;
|
||
<span class="kw">use </span>itertools::MinMaxResult::{OneElement, MinMax};
|
||
|
||
<span class="kw">let </span>lookup = <span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">7</span>, <span class="number">9</span>, <span class="number">12</span>].into_iter()
|
||
.into_grouping_map_by(|<span class="kw-2">&</span>n| n % <span class="number">3</span>)
|
||
.minmax_by_key(|_key, <span class="kw-2">&</span>val| val % <span class="number">4</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">0</span>], MinMax(<span class="number">12</span>, <span class="number">3</span>));
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">1</span>], MinMax(<span class="number">4</span>, <span class="number">7</span>));
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">2</span>], OneElement(<span class="number">5</span>));
|
||
<span class="macro">assert_eq!</span>(lookup.len(), <span class="number">3</span>);</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.sum" class="method"><a class="src rightside" href="../../src/itertools/grouping_map.rs.html#580-585">Source</a><h4 class="code-header">pub fn <a href="#method.sum" class="fn">sum</a>(self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html" title="struct std::collections::hash::map::HashMap">HashMap</a><K, V><div class="where">where
|
||
V: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Add.html" title="trait core::ops::arith::Add">Add</a><V, Output = V>,</div></h4></section></summary><div class="docblock"><p>Groups elements from the <code>GroupingMap</code> source by key and sums them.</p>
|
||
<p>This is just a shorthand for <code>self.reduce(|acc, _, val| acc + val)</code>.
|
||
It is more limited than <code>Iterator::sum</code> since it doesn’t use the <code>Sum</code> trait.</p>
|
||
<p>Returns a <code>HashMap</code> associating the key of each group with the sum of that group’s elements.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>itertools::Itertools;
|
||
|
||
<span class="kw">let </span>lookup = <span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">7</span>, <span class="number">8</span>, <span class="number">9</span>, <span class="number">12</span>].into_iter()
|
||
.into_grouping_map_by(|<span class="kw-2">&</span>n| n % <span class="number">3</span>)
|
||
.sum();
|
||
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">0</span>], <span class="number">3 </span>+ <span class="number">9 </span>+ <span class="number">12</span>);
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">1</span>], <span class="number">1 </span>+ <span class="number">4 </span>+ <span class="number">7</span>);
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">2</span>], <span class="number">5 </span>+ <span class="number">8</span>);
|
||
<span class="macro">assert_eq!</span>(lookup.len(), <span class="number">3</span>);</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.product" class="method"><a class="src rightside" href="../../src/itertools/grouping_map.rs.html#606-611">Source</a><h4 class="code-header">pub fn <a href="#method.product" class="fn">product</a>(self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html" title="struct std::collections::hash::map::HashMap">HashMap</a><K, V><div class="where">where
|
||
V: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Mul.html" title="trait core::ops::arith::Mul">Mul</a><V, Output = V>,</div></h4></section></summary><div class="docblock"><p>Groups elements from the <code>GroupingMap</code> source by key and multiply them.</p>
|
||
<p>This is just a shorthand for <code>self.reduce(|acc, _, val| acc * val)</code>.
|
||
It is more limited than <code>Iterator::product</code> since it doesn’t use the <code>Product</code> trait.</p>
|
||
<p>Returns a <code>HashMap</code> associating the key of each group with the product of that group’s elements.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>itertools::Itertools;
|
||
|
||
<span class="kw">let </span>lookup = <span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">7</span>, <span class="number">8</span>, <span class="number">9</span>, <span class="number">12</span>].into_iter()
|
||
.into_grouping_map_by(|<span class="kw-2">&</span>n| n % <span class="number">3</span>)
|
||
.product();
|
||
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">0</span>], <span class="number">3 </span>* <span class="number">9 </span>* <span class="number">12</span>);
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">1</span>], <span class="number">1 </span>* <span class="number">4 </span>* <span class="number">7</span>);
|
||
<span class="macro">assert_eq!</span>(lookup[<span class="kw-2">&</span><span class="number">2</span>], <span class="number">5 </span>* <span class="number">8</span>);
|
||
<span class="macro">assert_eq!</span>(lookup.len(), <span class="number">3</span>);</code></pre></div></div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Clone-for-GroupingMap%3CI%3E" class="impl"><a class="src rightside" href="../../src/itertools/grouping_map.rs.html#57">Source</a><a href="#impl-Clone-for-GroupingMap%3CI%3E" class="anchor">§</a><h3 class="code-header">impl<I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="struct.GroupingMap.html" title="struct itertools::structs::GroupingMap">GroupingMap</a><I></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl"><a class="src rightside" href="../../src/itertools/grouping_map.rs.html#57">Source</a><a href="#method.clone" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone" class="fn">clone</a>(&self) -> <a class="struct" href="struct.GroupingMap.html" title="struct itertools::structs::GroupingMap">GroupingMap</a><I></h4></section></summary><div class='docblock'>Returns a duplicate of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/nightly/src/core/clone.rs.html#245-247">Source</a></span><a href="#method.clone_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from" class="fn">clone_from</a>(&mut self, source: &Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-GroupingMap%3CI%3E" class="impl"><a class="src rightside" href="../../src/itertools/grouping_map.rs.html#57">Source</a><a href="#impl-Debug-for-GroupingMap%3CI%3E" class="anchor">§</a><h3 class="code-header">impl<I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.GroupingMap.html" title="struct itertools::structs::GroupingMap">GroupingMap</a><I></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../../src/itertools/grouping_map.rs.html#57">Source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-GroupingMap%3CI%3E" class="impl"><a href="#impl-Freeze-for-GroupingMap%3CI%3E" class="anchor">§</a><h3 class="code-header">impl<I> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.GroupingMap.html" title="struct itertools::structs::GroupingMap">GroupingMap</a><I><div class="where">where
|
||
I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a>,</div></h3></section><section id="impl-RefUnwindSafe-for-GroupingMap%3CI%3E" class="impl"><a href="#impl-RefUnwindSafe-for-GroupingMap%3CI%3E" class="anchor">§</a><h3 class="code-header">impl<I> <a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.GroupingMap.html" title="struct itertools::structs::GroupingMap">GroupingMap</a><I><div class="where">where
|
||
I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a>,</div></h3></section><section id="impl-Send-for-GroupingMap%3CI%3E" class="impl"><a href="#impl-Send-for-GroupingMap%3CI%3E" class="anchor">§</a><h3 class="code-header">impl<I> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.GroupingMap.html" title="struct itertools::structs::GroupingMap">GroupingMap</a><I><div class="where">where
|
||
I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</div></h3></section><section id="impl-Sync-for-GroupingMap%3CI%3E" class="impl"><a href="#impl-Sync-for-GroupingMap%3CI%3E" class="anchor">§</a><h3 class="code-header">impl<I> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.GroupingMap.html" title="struct itertools::structs::GroupingMap">GroupingMap</a><I><div class="where">where
|
||
I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,</div></h3></section><section id="impl-Unpin-for-GroupingMap%3CI%3E" class="impl"><a href="#impl-Unpin-for-GroupingMap%3CI%3E" class="anchor">§</a><h3 class="code-header">impl<I> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.GroupingMap.html" title="struct itertools::structs::GroupingMap">GroupingMap</a><I><div class="where">where
|
||
I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h3></section><section id="impl-UnsafeUnpin-for-GroupingMap%3CI%3E" class="impl"><a href="#impl-UnsafeUnpin-for-GroupingMap%3CI%3E" class="anchor">§</a><h3 class="code-header">impl<I> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.UnsafeUnpin.html" title="trait core::marker::UnsafeUnpin">UnsafeUnpin</a> for <a class="struct" href="struct.GroupingMap.html" title="struct itertools::structs::GroupingMap">GroupingMap</a><I><div class="where">where
|
||
I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.UnsafeUnpin.html" title="trait core::marker::UnsafeUnpin">UnsafeUnpin</a>,</div></h3></section><section id="impl-UnwindSafe-for-GroupingMap%3CI%3E" class="impl"><a href="#impl-UnwindSafe-for-GroupingMap%3CI%3E" class="anchor">§</a><h3 class="code-header">impl<I> <a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.GroupingMap.html" title="struct itertools::structs::GroupingMap">GroupingMap</a><I><div class="where">where
|
||
I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a>,</div></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#141">Source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
|
||
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#142">Source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#212">Source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214">Source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#221">Source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#222">Source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CloneToUninit-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/clone.rs.html#547">Source</a><a href="#impl-CloneToUninit-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.CloneToUninit.html" title="trait core::clone::CloneToUninit">CloneToUninit</a> for T<div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone_to_uninit" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/clone.rs.html#549">Source</a><a href="#method.clone_to_uninit" class="anchor">§</a><h4 class="code-header">unsafe fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.CloneToUninit.html#tymethod.clone_to_uninit" class="fn">clone_to_uninit</a>(&self, dest: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>)</h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>clone_to_uninit</code>)</span></div></span><div class='docblock'>Performs copy-assignment from <code>self</code> to <code>dest</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.CloneToUninit.html#tymethod.clone_to_uninit">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#785">Source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#788">Source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#767-769">Source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#777">Source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
|
||
<p>That is, this conversion is whatever the implementation of
|
||
<code><a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-IntoEither-for-T" class="impl"><a class="src rightside" href="../../src/either/into_either.rs.html#64">Source</a><a href="#impl-IntoEither-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="../../either/into_either/trait.IntoEither.html" title="trait either::into_either::IntoEither">IntoEither</a> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into_either" class="method trait-impl"><a class="src rightside" href="../../src/either/into_either.rs.html#29">Source</a><a href="#method.into_either" class="anchor">§</a><h4 class="code-header">fn <a href="../../either/into_either/trait.IntoEither.html#method.into_either" class="fn">into_either</a>(self, into_left: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> <a class="enum" href="../enum.Either.html" title="enum itertools::Either">Either</a><Self, Self> <a href="#" class="tooltip" data-notable-ty="Either<Self, Self>">ⓘ</a></h4></section></summary><div class='docblock'>Converts <code>self</code> into a <a href="../enum.Either.html#variant.Left" title="variant itertools::Either::Left"><code>Left</code></a> variant of <a href="../enum.Either.html" title="enum itertools::Either"><code>Either<Self, Self></code></a>
|
||
if <code>into_left</code> is <code>true</code>.
|
||
Converts <code>self</code> into a <a href="../enum.Either.html#variant.Right" title="variant itertools::Either::Right"><code>Right</code></a> variant of <a href="../enum.Either.html" title="enum itertools::Either"><code>Either<Self, Self></code></a>
|
||
otherwise. <a href="../../either/into_either/trait.IntoEither.html#method.into_either">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.into_either_with" class="method trait-impl"><a class="src rightside" href="../../src/either/into_either.rs.html#55-57">Source</a><a href="#method.into_either_with" class="anchor">§</a><h4 class="code-header">fn <a href="../../either/into_either/trait.IntoEither.html#method.into_either_with" class="fn">into_either_with</a><F>(self, into_left: F) -> <a class="enum" href="../enum.Either.html" title="enum itertools::Either">Either</a><Self, Self> <a href="#" class="tooltip" data-notable-ty="Either<Self, Self>">ⓘ</a><div class="where">where
|
||
F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(&Self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>,</div></h4></section></summary><div class='docblock'>Converts <code>self</code> into a <a href="../enum.Either.html#variant.Left" title="variant itertools::Either::Left"><code>Left</code></a> variant of <a href="../enum.Either.html" title="enum itertools::Either"><code>Either<Self, Self></code></a>
|
||
if <code>into_left(&self)</code> returns <code>true</code>.
|
||
Converts <code>self</code> into a <a href="../enum.Either.html#variant.Right" title="variant itertools::Either::Right"><code>Right</code></a> variant of <a href="../enum.Either.html" title="enum itertools::Either"><code>Either<Self, Self></code></a>
|
||
otherwise. <a href="../../either/into_either/trait.IntoEither.html#method.into_either_with">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ToOwned-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#72-74">Source</a><a href="#impl-ToOwned-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T<div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#76">Source</a><a href="#associatedtype.Owned" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'>The resulting type after obtaining ownership.</div></details><details class="toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#77">Source</a><a href="#method.to_owned" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fn">to_owned</a>(&self) -> T</h4></section></summary><div class='docblock'>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#81">Source</a><a href="#method.clone_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into" class="fn">clone_into</a>(&self, target: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut T</a>)</h4></section></summary><div class='docblock'>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#827-829">Source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#831">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#834">Source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#811-813">Source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#815">Source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#818">Source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div><script type="text/json" id="notable-traits-data">{"Either<Self, Self>":"<h3>Notable traits for <code><a class=\"enum\" href=\"../enum.Either.html\" title=\"enum itertools::Either\">Either</a><L, R></code></h3><pre><code><div class=\"where\">impl<L, R> <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a> for <a class=\"enum\" href=\"../enum.Either.html\" title=\"enum itertools::Either\">Either</a><L, R><div class=\"where\">where\n L: <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a>,\n R: <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a><Item = <L as <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a>>::<a class=\"associatedtype\" href=\"https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item\" title=\"type core::iter::traits::iterator::Iterator::Item\">Item</a>>,</div></div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item\" class=\"associatedtype\">Item</a> = <L as <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a>>::<a class=\"associatedtype\" href=\"https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item\" title=\"type core::iter::traits::iterator::Iterator::Item\">Item</a>;</div><div class=\"where\">impl<L, R> <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html\" title=\"trait core::future::future::Future\">Future</a> for <a class=\"enum\" href=\"../enum.Either.html\" title=\"enum itertools::Either\">Either</a><L, R><div class=\"where\">where\n L: <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html\" title=\"trait core::future::future::Future\">Future</a>,\n R: <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html\" title=\"trait core::future::future::Future\">Future</a><Output = <L as <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html\" title=\"trait core::future::future::Future\">Future</a>>::<a class=\"associatedtype\" href=\"https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output\" title=\"type core::future::future::Future::Output\">Output</a>>,</div></div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output\" class=\"associatedtype\">Output</a> = <L as <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html\" title=\"trait core::future::future::Future\">Future</a>>::<a class=\"associatedtype\" href=\"https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output\" title=\"type core::future::future::Future::Output\">Output</a>;</div><div class=\"where\">impl<L, R> <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/std/io/trait.Read.html\" title=\"trait std::io::Read\">Read</a> for <a class=\"enum\" href=\"../enum.Either.html\" title=\"enum itertools::Either\">Either</a><L, R><div class=\"where\">where\n L: <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/std/io/trait.Read.html\" title=\"trait std::io::Read\">Read</a>,\n R: <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/std/io/trait.Read.html\" title=\"trait std::io::Read\">Read</a>,</div></div><div class=\"where\">impl<L, R> <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/std/io/trait.Write.html\" title=\"trait std::io::Write\">Write</a> for <a class=\"enum\" href=\"../enum.Either.html\" title=\"enum itertools::Either\">Either</a><L, R><div class=\"where\">where\n L: <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/std/io/trait.Write.html\" title=\"trait std::io::Write\">Write</a>,\n R: <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/std/io/trait.Write.html\" title=\"trait std::io::Write\">Write</a>,</div></div>"}</script></section></div></main></body></html> |