| <!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/combinations.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>combinations.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> |
| </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">super</span>::lazy_buffer::LazyBuffer; |
| <span class="kw">use </span>alloc::vec::Vec; |
| |
| <span class="doccomment">/// An iterator to iterate through all the `k`-length combinations in an iterator. |
| /// |
| /// See [`.combinations()`](crate::Itertools::combinations) for more information. |
| </span><span class="attribute">#[must_use = <span class="string">"iterator adaptors are lazy and do nothing unless consumed"</span>] |
| </span><span class="kw">pub struct </span>Combinations<I: Iterator> { |
| indices: Vec<usize>, |
| pool: LazyBuffer<I>, |
| first: bool, |
| } |
| |
| <span class="kw">impl</span><I> Clone <span class="kw">for </span>Combinations<I> |
| <span class="kw">where </span>I: Clone + Iterator, |
| I::Item: Clone, |
| { |
| <span class="macro">clone_fields!</span>(indices, pool, first); |
| } |
| |
| <span class="kw">impl</span><I> fmt::Debug <span class="kw">for </span>Combinations<I> |
| <span class="kw">where </span>I: Iterator + fmt::Debug, |
| I::Item: fmt::Debug, |
| { |
| <span class="macro">debug_fmt_fields!</span>(Combinations, indices, pool, first); |
| } |
| |
| <span class="doccomment">/// Create a new `Combinations` from a clonable iterator. |
| </span><span class="kw">pub fn </span>combinations<I>(iter: I, k: usize) -> Combinations<I> |
| <span class="kw">where </span>I: Iterator |
| { |
| <span class="kw">let </span><span class="kw-2">mut </span>pool = LazyBuffer::new(iter); |
| pool.prefill(k); |
| |
| Combinations { |
| indices: (<span class="number">0</span>..k).collect(), |
| pool, |
| first: <span class="bool-val">true</span>, |
| } |
| } |
| |
| <span class="kw">impl</span><I: Iterator> Combinations<I> { |
| <span class="doccomment">/// Returns the length of a combination produced by this iterator. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>k(<span class="kw-2">&</span><span class="self">self</span>) -> usize { <span class="self">self</span>.indices.len() } |
| |
| <span class="doccomment">/// Returns the (current) length of the pool from which combination elements are |
| /// selected. This value can change between invocations of [`next`](Combinations::next). |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>n(<span class="kw-2">&</span><span class="self">self</span>) -> usize { <span class="self">self</span>.pool.len() } |
| |
| <span class="doccomment">/// Returns a reference to the source iterator. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>src(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>I { <span class="kw-2">&</span><span class="self">self</span>.pool.it } |
| |
| <span class="doccomment">/// Resets this `Combinations` back to an initial state for combinations of length |
| /// `k` over the same pool data source. If `k` is larger than the current length |
| /// of the data pool an attempt is made to prefill the pool so that it holds `k` |
| /// elements. |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>reset(<span class="kw-2">&mut </span><span class="self">self</span>, k: usize) { |
| <span class="self">self</span>.first = <span class="bool-val">true</span>; |
| |
| <span class="kw">if </span>k < <span class="self">self</span>.indices.len() { |
| <span class="self">self</span>.indices.truncate(k); |
| <span class="kw">for </span>i <span class="kw">in </span><span class="number">0</span>..k { |
| <span class="self">self</span>.indices[i] = i; |
| } |
| |
| } <span class="kw">else </span>{ |
| <span class="kw">for </span>i <span class="kw">in </span><span class="number">0</span>..<span class="self">self</span>.indices.len() { |
| <span class="self">self</span>.indices[i] = i; |
| } |
| <span class="self">self</span>.indices.extend(<span class="self">self</span>.indices.len()..k); |
| <span class="self">self</span>.pool.prefill(k); |
| } |
| } |
| } |
| |
| <span class="kw">impl</span><I> Iterator <span class="kw">for </span>Combinations<I> |
| <span class="kw">where </span>I: Iterator, |
| I::Item: Clone |
| { |
| <span class="kw">type </span>Item = Vec<I::Item>; |
| <span class="kw">fn </span>next(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="self">Self</span>::Item> { |
| <span class="kw">if </span><span class="self">self</span>.first { |
| <span class="kw">if </span><span class="self">self</span>.k() > <span class="self">self</span>.n() { |
| <span class="kw">return </span><span class="prelude-val">None</span>; |
| } |
| <span class="self">self</span>.first = <span class="bool-val">false</span>; |
| } <span class="kw">else if </span><span class="self">self</span>.indices.is_empty() { |
| <span class="kw">return </span><span class="prelude-val">None</span>; |
| } <span class="kw">else </span>{ |
| <span class="comment">// Scan from the end, looking for an index to increment |
| </span><span class="kw">let </span><span class="kw-2">mut </span>i: usize = <span class="self">self</span>.indices.len() - <span class="number">1</span>; |
| |
| <span class="comment">// Check if we need to consume more from the iterator |
| </span><span class="kw">if </span><span class="self">self</span>.indices[i] == <span class="self">self</span>.pool.len() - <span class="number">1 </span>{ |
| <span class="self">self</span>.pool.get_next(); <span class="comment">// may change pool size |
| </span>} |
| |
| <span class="kw">while </span><span class="self">self</span>.indices[i] == i + <span class="self">self</span>.pool.len() - <span class="self">self</span>.indices.len() { |
| <span class="kw">if </span>i > <span class="number">0 </span>{ |
| i -= <span class="number">1</span>; |
| } <span class="kw">else </span>{ |
| <span class="comment">// Reached the last combination |
| </span><span class="kw">return </span><span class="prelude-val">None</span>; |
| } |
| } |
| |
| <span class="comment">// Increment index, and reset the ones to its right |
| </span><span class="self">self</span>.indices[i] += <span class="number">1</span>; |
| <span class="kw">for </span>j <span class="kw">in </span>i+<span class="number">1</span>..<span class="self">self</span>.indices.len() { |
| <span class="self">self</span>.indices[j] = <span class="self">self</span>.indices[j - <span class="number">1</span>] + <span class="number">1</span>; |
| } |
| } |
| |
| <span class="comment">// Create result vector based on the indices |
| </span><span class="prelude-val">Some</span>(<span class="self">self</span>.indices.iter().map(|i| <span class="self">self</span>.pool[<span class="kw-2">*</span>i].clone()).collect()) |
| } |
| } |
| |
| <span class="kw">impl</span><I> FusedIterator <span class="kw">for </span>Combinations<I> |
| <span class="kw">where </span>I: Iterator, |
| I::Item: Clone |
| {} |
| </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> |