blob: 7b452508f1a4b6629ab1a400e171c1302ed0873a [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/root/.cargo/git/checkouts/rayon-3b3b152053499ede/a07ce2e/src/range.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>range.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="../../rayon/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="../../rayon/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
<span id="271">271</span>
<span id="272">272</span>
<span id="273">273</span>
<span id="274">274</span>
<span id="275">275</span>
<span id="276">276</span>
<span id="277">277</span>
<span id="278">278</span>
<span id="279">279</span>
<span id="280">280</span>
<span id="281">281</span>
<span id="282">282</span>
<span id="283">283</span>
<span id="284">284</span>
<span id="285">285</span>
<span id="286">286</span>
<span id="287">287</span>
<span id="288">288</span>
<span id="289">289</span>
<span id="290">290</span>
<span id="291">291</span>
<span id="292">292</span>
<span id="293">293</span>
<span id="294">294</span>
<span id="295">295</span>
<span id="296">296</span>
<span id="297">297</span>
<span id="298">298</span>
<span id="299">299</span>
<span id="300">300</span>
<span id="301">301</span>
<span id="302">302</span>
<span id="303">303</span>
<span id="304">304</span>
<span id="305">305</span>
<span id="306">306</span>
<span id="307">307</span>
<span id="308">308</span>
<span id="309">309</span>
<span id="310">310</span>
<span id="311">311</span>
<span id="312">312</span>
<span id="313">313</span>
<span id="314">314</span>
<span id="315">315</span>
<span id="316">316</span>
<span id="317">317</span>
<span id="318">318</span>
<span id="319">319</span>
<span id="320">320</span>
<span id="321">321</span>
<span id="322">322</span>
<span id="323">323</span>
<span id="324">324</span>
<span id="325">325</span>
<span id="326">326</span>
<span id="327">327</span>
<span id="328">328</span>
<span id="329">329</span>
<span id="330">330</span>
<span id="331">331</span>
<span id="332">332</span>
<span id="333">333</span>
<span id="334">334</span>
<span id="335">335</span>
<span id="336">336</span>
<span id="337">337</span>
<span id="338">338</span>
<span id="339">339</span>
<span id="340">340</span>
<span id="341">341</span>
<span id="342">342</span>
<span id="343">343</span>
<span id="344">344</span>
<span id="345">345</span>
<span id="346">346</span>
<span id="347">347</span>
<span id="348">348</span>
<span id="349">349</span>
<span id="350">350</span>
<span id="351">351</span>
<span id="352">352</span>
<span id="353">353</span>
<span id="354">354</span>
<span id="355">355</span>
<span id="356">356</span>
<span id="357">357</span>
<span id="358">358</span>
<span id="359">359</span>
<span id="360">360</span>
<span id="361">361</span>
<span id="362">362</span>
<span id="363">363</span>
<span id="364">364</span>
<span id="365">365</span>
<span id="366">366</span>
<span id="367">367</span>
<span id="368">368</span>
<span id="369">369</span>
<span id="370">370</span>
<span id="371">371</span>
<span id="372">372</span>
<span id="373">373</span>
<span id="374">374</span>
<span id="375">375</span>
<span id="376">376</span>
<span id="377">377</span>
<span id="378">378</span>
<span id="379">379</span>
<span id="380">380</span>
<span id="381">381</span>
<span id="382">382</span>
<span id="383">383</span>
<span id="384">384</span>
<span id="385">385</span>
<span id="386">386</span>
<span id="387">387</span>
<span id="388">388</span>
<span id="389">389</span>
<span id="390">390</span>
<span id="391">391</span>
<span id="392">392</span>
<span id="393">393</span>
<span id="394">394</span>
<span id="395">395</span>
<span id="396">396</span>
<span id="397">397</span>
<span id="398">398</span>
<span id="399">399</span>
<span id="400">400</span>
<span id="401">401</span>
<span id="402">402</span>
<span id="403">403</span>
<span id="404">404</span>
<span id="405">405</span>
<span id="406">406</span>
<span id="407">407</span>
<span id="408">408</span>
<span id="409">409</span>
<span id="410">410</span>
<span id="411">411</span>
<span id="412">412</span>
<span id="413">413</span>
<span id="414">414</span>
<span id="415">415</span>
<span id="416">416</span>
<span id="417">417</span>
<span id="418">418</span>
<span id="419">419</span>
<span id="420">420</span>
<span id="421">421</span>
<span id="422">422</span>
<span id="423">423</span>
<span id="424">424</span>
<span id="425">425</span>
<span id="426">426</span>
<span id="427">427</span>
<span id="428">428</span>
<span id="429">429</span>
<span id="430">430</span>
<span id="431">431</span>
<span id="432">432</span>
<span id="433">433</span>
<span id="434">434</span>
<span id="435">435</span>
<span id="436">436</span>
<span id="437">437</span>
<span id="438">438</span>
<span id="439">439</span>
<span id="440">440</span>
<span id="441">441</span>
<span id="442">442</span>
<span id="443">443</span>
<span id="444">444</span>
<span id="445">445</span>
<span id="446">446</span>
<span id="447">447</span>
<span id="448">448</span>
<span id="449">449</span>
<span id="450">450</span>
<span id="451">451</span>
<span id="452">452</span>
<span id="453">453</span>
<span id="454">454</span>
<span id="455">455</span>
<span id="456">456</span>
<span id="457">457</span>
<span id="458">458</span>
<span id="459">459</span>
<span id="460">460</span>
<span id="461">461</span>
<span id="462">462</span>
</pre><pre class="rust"><code><span class="doccomment">//! Parallel iterator types for [ranges][std::range],
//! the type for values created by `a..b` expressions
//!
//! You will rarely need to interact with this module directly unless you have
//! need to name one of the iterator types.
//!
//! ```
//! use rayon::prelude::*;
//!
//! let r = (0..100u64).into_par_iter()
//! .sum();
//!
//! // compare result with sequential calculation
//! assert_eq!((0..100).sum::&lt;u64&gt;(), r);
//! ```
//!
//! [std::range]: https://doc.rust-lang.org/core/ops/struct.Range.html
</span><span class="kw">use </span><span class="kw">crate</span>::iter::plumbing::<span class="kw-2">*</span>;
<span class="kw">use </span><span class="kw">crate</span>::iter::<span class="kw-2">*</span>;
<span class="kw">use </span>std::char;
<span class="kw">use </span>std::convert::TryFrom;
<span class="kw">use </span>std::ops::Range;
<span class="kw">use </span>std::usize;
<span class="doccomment">/// Parallel iterator over a range, implemented for all integer types and `char`.
///
/// **Note:** The `zip` operation requires `IndexedParallelIterator`
/// which is not implemented for `u64`, `i64`, `u128`, or `i128`.
///
/// ```
/// use rayon::prelude::*;
///
/// let p = (0..25usize).into_par_iter()
/// .zip(0..25usize)
/// .filter(|&amp;(x, y)| x % 5 == 0 || y % 5 == 0)
/// .map(|(x, y)| x * y)
/// .sum::&lt;usize&gt;();
///
/// let s = (0..25usize).zip(0..25)
/// .filter(|&amp;(x, y)| x % 5 == 0 || y % 5 == 0)
/// .map(|(x, y)| x * y)
/// .sum();
///
/// assert_eq!(p, s);
/// ```
</span><span class="attribute">#[derive(Debug, Clone)]
</span><span class="kw">pub struct </span>Iter&lt;T&gt; {
range: Range&lt;T&gt;,
}
<span class="doccomment">/// Implemented for ranges of all primitive integer types and `char`.
</span><span class="kw">impl</span>&lt;T&gt; IntoParallelIterator <span class="kw">for </span>Range&lt;T&gt;
<span class="kw">where
</span>Iter&lt;T&gt;: ParallelIterator,
{
<span class="kw">type </span>Item = &lt;Iter&lt;T&gt; <span class="kw">as </span>ParallelIterator&gt;::Item;
<span class="kw">type </span>Iter = Iter&lt;T&gt;;
<span class="kw">fn </span>into_par_iter(<span class="self">self</span>) -&gt; <span class="self">Self</span>::Iter {
Iter { range: <span class="self">self </span>}
}
}
<span class="kw">struct </span>IterProducer&lt;T&gt; {
range: Range&lt;T&gt;,
}
<span class="kw">impl</span>&lt;T&gt; IntoIterator <span class="kw">for </span>IterProducer&lt;T&gt;
<span class="kw">where
</span>Range&lt;T&gt;: Iterator,
{
<span class="kw">type </span>Item = &lt;Range&lt;T&gt; <span class="kw">as </span>Iterator&gt;::Item;
<span class="kw">type </span>IntoIter = Range&lt;T&gt;;
<span class="kw">fn </span>into_iter(<span class="self">self</span>) -&gt; <span class="self">Self</span>::IntoIter {
<span class="self">self</span>.range
}
}
<span class="doccomment">/// These traits help drive integer type inference. Without them, an unknown `{integer}` type only
/// has constraints on `Iter&lt;{integer}&gt;`, which will probably give up and use `i32`. By adding
/// these traits on the item type, the compiler can see a more direct constraint to infer like
/// `{integer}: RangeInteger`, which works better. See `test_issue_833` for an example.
///
/// They have to be `pub` since they&#39;re seen in the public `impl ParallelIterator` constraints, but
/// we put them in a private modules so they&#39;re not actually reachable in our public API.
</span><span class="kw">mod </span>private {
<span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="doccomment">/// Implementation details of `ParallelIterator for Iter&lt;Self&gt;`
</span><span class="kw">pub trait </span>RangeInteger: Sized + Send {
<span class="macro">private_decl! </span>{}
<span class="kw">fn </span>drive_unindexed&lt;C&gt;(iter: Iter&lt;<span class="self">Self</span>&gt;, consumer: C) -&gt; C::Result
<span class="kw">where
</span>C: UnindexedConsumer&lt;<span class="self">Self</span>&gt;;
<span class="kw">fn </span>opt_len(iter: <span class="kw-2">&amp;</span>Iter&lt;<span class="self">Self</span>&gt;) -&gt; <span class="prelude-ty">Option</span>&lt;usize&gt;;
}
<span class="doccomment">/// Implementation details of `IndexedParallelIterator for Iter&lt;Self&gt;`
</span><span class="kw">pub trait </span>IndexedRangeInteger: RangeInteger {
<span class="macro">private_decl! </span>{}
<span class="kw">fn </span>drive&lt;C&gt;(iter: Iter&lt;<span class="self">Self</span>&gt;, consumer: C) -&gt; C::Result
<span class="kw">where
</span>C: Consumer&lt;<span class="self">Self</span>&gt;;
<span class="kw">fn </span>len(iter: <span class="kw-2">&amp;</span>Iter&lt;<span class="self">Self</span>&gt;) -&gt; usize;
<span class="kw">fn </span>with_producer&lt;CB&gt;(iter: Iter&lt;<span class="self">Self</span>&gt;, callback: CB) -&gt; CB::Output
<span class="kw">where
</span>CB: ProducerCallback&lt;<span class="self">Self</span>&gt;;
}
}
<span class="kw">use </span>private::{IndexedRangeInteger, RangeInteger};
<span class="kw">impl</span>&lt;T: RangeInteger&gt; ParallelIterator <span class="kw">for </span>Iter&lt;T&gt; {
<span class="kw">type </span>Item = T;
<span class="kw">fn </span>drive_unindexed&lt;C&gt;(<span class="self">self</span>, consumer: C) -&gt; C::Result
<span class="kw">where
</span>C: UnindexedConsumer&lt;T&gt;,
{
T::drive_unindexed(<span class="self">self</span>, consumer)
}
<span class="attribute">#[inline]
</span><span class="kw">fn </span>opt_len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;usize&gt; {
T::opt_len(<span class="self">self</span>)
}
}
<span class="kw">impl</span>&lt;T: IndexedRangeInteger&gt; IndexedParallelIterator <span class="kw">for </span>Iter&lt;T&gt; {
<span class="kw">fn </span>drive&lt;C&gt;(<span class="self">self</span>, consumer: C) -&gt; C::Result
<span class="kw">where
</span>C: Consumer&lt;T&gt;,
{
T::drive(<span class="self">self</span>, consumer)
}
<span class="attribute">#[inline]
</span><span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
T::len(<span class="self">self</span>)
}
<span class="kw">fn </span>with_producer&lt;CB&gt;(<span class="self">self</span>, callback: CB) -&gt; CB::Output
<span class="kw">where
</span>CB: ProducerCallback&lt;T&gt;,
{
T::with_producer(<span class="self">self</span>, callback)
}
}
<span class="macro">macro_rules! </span>indexed_range_impl {
( <span class="macro-nonterminal">$t</span>:ty ) =&gt; {
<span class="kw">impl </span>RangeInteger <span class="kw">for </span><span class="macro-nonterminal">$t </span>{
<span class="macro">private_impl! </span>{}
<span class="kw">fn </span>drive_unindexed&lt;C&gt;(iter: Iter&lt;<span class="macro-nonterminal">$t</span>&gt;, consumer: C) -&gt; C::Result
<span class="kw">where
</span>C: UnindexedConsumer&lt;<span class="macro-nonterminal">$t</span>&gt;,
{
bridge(iter, consumer)
}
<span class="kw">fn </span>opt_len(iter: <span class="kw-2">&amp;</span>Iter&lt;<span class="macro-nonterminal">$t</span>&gt;) -&gt; <span class="prelude-ty">Option</span>&lt;usize&gt; {
<span class="prelude-val">Some</span>(iter.range.len())
}
}
<span class="kw">impl </span>IndexedRangeInteger <span class="kw">for </span><span class="macro-nonterminal">$t </span>{
<span class="macro">private_impl! </span>{}
<span class="kw">fn </span>drive&lt;C&gt;(iter: Iter&lt;<span class="macro-nonterminal">$t</span>&gt;, consumer: C) -&gt; C::Result
<span class="kw">where
</span>C: Consumer&lt;<span class="macro-nonterminal">$t</span>&gt;,
{
bridge(iter, consumer)
}
<span class="kw">fn </span>len(iter: <span class="kw-2">&amp;</span>Iter&lt;<span class="macro-nonterminal">$t</span>&gt;) -&gt; usize {
iter.range.len()
}
<span class="kw">fn </span>with_producer&lt;CB&gt;(iter: Iter&lt;<span class="macro-nonterminal">$t</span>&gt;, callback: CB) -&gt; CB::Output
<span class="kw">where
</span>CB: ProducerCallback&lt;<span class="macro-nonterminal">$t</span>&gt;,
{
callback.callback(IterProducer { range: iter.range })
}
}
<span class="kw">impl </span>Producer <span class="kw">for </span>IterProducer&lt;<span class="macro-nonterminal">$t</span>&gt; {
<span class="kw">type </span>Item = &lt;Range&lt;<span class="macro-nonterminal">$t</span>&gt; <span class="kw">as </span>Iterator&gt;::Item;
<span class="kw">type </span>IntoIter = Range&lt;<span class="macro-nonterminal">$t</span>&gt;;
<span class="kw">fn </span>into_iter(<span class="self">self</span>) -&gt; <span class="self">Self</span>::IntoIter {
<span class="self">self</span>.range
}
<span class="kw">fn </span>split_at(<span class="self">self</span>, index: usize) -&gt; (<span class="self">Self</span>, <span class="self">Self</span>) {
<span class="macro">assert!</span>(index &lt;= <span class="self">self</span>.range.len());
<span class="comment">// For signed $t, the length and requested index could be greater than $t::MAX, and
// then `index as $t` could wrap to negative, so wrapping_add is necessary.
</span><span class="kw">let </span>mid = <span class="self">self</span>.range.start.wrapping_add(index <span class="kw">as </span><span class="macro-nonterminal">$t</span>);
<span class="kw">let </span>left = <span class="self">self</span>.range.start..mid;
<span class="kw">let </span>right = mid..<span class="self">self</span>.range.end;
(IterProducer { range: left }, IterProducer { range: right })
}
}
};
}
<span class="kw">trait </span>UnindexedRangeLen&lt;L&gt; {
<span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; L;
}
<span class="macro">macro_rules! </span>unindexed_range_impl {
( <span class="macro-nonterminal">$t</span>:ty, <span class="macro-nonterminal">$len_t</span>:ty ) =&gt; {
<span class="kw">impl </span>UnindexedRangeLen&lt;<span class="macro-nonterminal">$len_t</span>&gt; <span class="kw">for </span>Range&lt;<span class="macro-nonterminal">$t</span>&gt; {
<span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="macro-nonterminal">$len_t </span>{
<span class="kw">let </span><span class="kw-2">&amp;</span>Range { start, end } = <span class="self">self</span>;
<span class="kw">if </span>end &gt; start {
end.wrapping_sub(start) <span class="kw">as </span><span class="macro-nonterminal">$len_t
</span>} <span class="kw">else </span>{
<span class="number">0
</span>}
}
}
<span class="kw">impl </span>RangeInteger <span class="kw">for </span><span class="macro-nonterminal">$t </span>{
<span class="macro">private_impl! </span>{}
<span class="kw">fn </span>drive_unindexed&lt;C&gt;(iter: Iter&lt;<span class="macro-nonterminal">$t</span>&gt;, consumer: C) -&gt; C::Result
<span class="kw">where
</span>C: UnindexedConsumer&lt;<span class="macro-nonterminal">$t</span>&gt;,
{
<span class="attribute">#[inline]
</span><span class="kw">fn </span>offset(start: <span class="macro-nonterminal">$t</span>) -&gt; <span class="kw">impl </span>Fn(usize) -&gt; <span class="macro-nonterminal">$t </span>{
<span class="kw">move </span>|i| start.wrapping_add(i <span class="kw">as </span><span class="macro-nonterminal">$t</span>)
}
<span class="kw">if let </span><span class="prelude-val">Some</span>(len) = iter.opt_len() {
<span class="comment">// Drive this in indexed mode for better `collect`.
</span>(<span class="number">0</span>..len)
.into_par_iter()
.map(offset(iter.range.start))
.drive(consumer)
} <span class="kw">else </span>{
bridge_unindexed(IterProducer { range: iter.range }, consumer)
}
}
<span class="kw">fn </span>opt_len(iter: <span class="kw-2">&amp;</span>Iter&lt;<span class="macro-nonterminal">$t</span>&gt;) -&gt; <span class="prelude-ty">Option</span>&lt;usize&gt; {
usize::try_from(iter.range.len()).ok()
}
}
<span class="kw">impl </span>UnindexedProducer <span class="kw">for </span>IterProducer&lt;<span class="macro-nonterminal">$t</span>&gt; {
<span class="kw">type </span>Item = <span class="macro-nonterminal">$t</span>;
<span class="kw">fn </span>split(<span class="kw-2">mut </span><span class="self">self</span>) -&gt; (<span class="self">Self</span>, <span class="prelude-ty">Option</span>&lt;<span class="self">Self</span>&gt;) {
<span class="kw">let </span>index = <span class="self">self</span>.range.len() / <span class="number">2</span>;
<span class="kw">if </span>index &gt; <span class="number">0 </span>{
<span class="kw">let </span>mid = <span class="self">self</span>.range.start.wrapping_add(index <span class="kw">as </span><span class="macro-nonterminal">$t</span>);
<span class="kw">let </span>right = mid..<span class="self">self</span>.range.end;
<span class="self">self</span>.range.end = mid;
(<span class="self">self</span>, <span class="prelude-val">Some</span>(IterProducer { range: right }))
} <span class="kw">else </span>{
(<span class="self">self</span>, <span class="prelude-val">None</span>)
}
}
<span class="kw">fn </span>fold_with&lt;F&gt;(<span class="self">self</span>, folder: F) -&gt; F
<span class="kw">where
</span>F: Folder&lt;<span class="self">Self</span>::Item&gt;,
{
folder.consume_iter(<span class="self">self</span>)
}
}
};
}
<span class="comment">// all Range&lt;T&gt; with ExactSizeIterator
</span><span class="macro">indexed_range_impl! </span>{u8}
<span class="macro">indexed_range_impl! </span>{u16}
<span class="macro">indexed_range_impl! </span>{u32}
<span class="macro">indexed_range_impl! </span>{usize}
<span class="macro">indexed_range_impl! </span>{i8}
<span class="macro">indexed_range_impl! </span>{i16}
<span class="macro">indexed_range_impl! </span>{i32}
<span class="macro">indexed_range_impl! </span>{isize}
<span class="comment">// other Range&lt;T&gt; with just Iterator
</span><span class="macro">unindexed_range_impl! </span>{u64, u64}
<span class="macro">unindexed_range_impl! </span>{i64, u64}
<span class="macro">unindexed_range_impl! </span>{u128, u128}
<span class="macro">unindexed_range_impl! </span>{i128, u128}
<span class="comment">// char is special because of the surrogate range hole
</span><span class="macro">macro_rules! </span>convert_char {
( <span class="macro-nonterminal">$self</span>:ident . <span class="macro-nonterminal">$method</span>:ident ( $( <span class="macro-nonterminal">$arg</span>:expr ),* ) ) =&gt; {{
<span class="kw">let </span>start = <span class="macro-nonterminal">$self</span>.range.start <span class="kw">as </span>u32;
<span class="kw">let </span>end = <span class="macro-nonterminal">$self</span>.range.end <span class="kw">as </span>u32;
<span class="kw">if </span>start &lt; <span class="number">0xD800 </span>&amp;&amp; <span class="number">0xE000 </span>&lt; end {
<span class="comment">// chain the before and after surrogate range fragments
</span>(start..<span class="number">0xD800</span>)
.into_par_iter()
.chain(<span class="number">0xE000</span>..end)
.map(|codepoint| <span class="kw">unsafe </span>{ char::from_u32_unchecked(codepoint) })
.<span class="macro-nonterminal">$method</span>($( <span class="macro-nonterminal">$arg </span>),<span class="kw-2">*</span>)
} <span class="kw">else </span>{
<span class="comment">// no surrogate range to worry about
</span>(start..end)
.into_par_iter()
.map(|codepoint| <span class="kw">unsafe </span>{ char::from_u32_unchecked(codepoint) })
.<span class="macro-nonterminal">$method</span>($( <span class="macro-nonterminal">$arg </span>),<span class="kw-2">*</span>)
}
}};
}
<span class="kw">impl </span>ParallelIterator <span class="kw">for </span>Iter&lt;char&gt; {
<span class="kw">type </span>Item = char;
<span class="kw">fn </span>drive_unindexed&lt;C&gt;(<span class="self">self</span>, consumer: C) -&gt; C::Result
<span class="kw">where
</span>C: UnindexedConsumer&lt;<span class="self">Self</span>::Item&gt;,
{
<span class="macro">convert_char!</span>(<span class="self">self</span>.drive(consumer))
}
<span class="kw">fn </span>opt_len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;usize&gt; {
<span class="prelude-val">Some</span>(<span class="self">self</span>.len())
}
}
<span class="kw">impl </span>IndexedParallelIterator <span class="kw">for </span>Iter&lt;char&gt; {
<span class="comment">// Split at the surrogate range first if we&#39;re allowed to
</span><span class="kw">fn </span>drive&lt;C&gt;(<span class="self">self</span>, consumer: C) -&gt; C::Result
<span class="kw">where
</span>C: Consumer&lt;<span class="self">Self</span>::Item&gt;,
{
<span class="macro">convert_char!</span>(<span class="self">self</span>.drive(consumer))
}
<span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="comment">// Taken from &lt;char as Step&gt;::steps_between
</span><span class="kw">let </span>start = <span class="self">self</span>.range.start <span class="kw">as </span>u32;
<span class="kw">let </span>end = <span class="self">self</span>.range.end <span class="kw">as </span>u32;
<span class="kw">if </span>start &lt; end {
<span class="kw">let </span><span class="kw-2">mut </span>count = end - start;
<span class="kw">if </span>start &lt; <span class="number">0xD800 </span>&amp;&amp; <span class="number">0xE000 </span>&lt;= end {
count -= <span class="number">0x800
</span>}
count <span class="kw">as </span>usize
} <span class="kw">else </span>{
<span class="number">0
</span>}
}
<span class="kw">fn </span>with_producer&lt;CB&gt;(<span class="self">self</span>, callback: CB) -&gt; CB::Output
<span class="kw">where
</span>CB: ProducerCallback&lt;<span class="self">Self</span>::Item&gt;,
{
<span class="macro">convert_char!</span>(<span class="self">self</span>.with_producer(callback))
}
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>check_range_split_at_overflow() {
<span class="comment">// Note, this split index overflows i8!
</span><span class="kw">let </span>producer = IterProducer { range: -<span class="number">100i8</span>..<span class="number">100 </span>};
<span class="kw">let </span>(left, right) = producer.split_at(<span class="number">150</span>);
<span class="kw">let </span>r1: i32 = left.range.map(i32::from).sum();
<span class="kw">let </span>r2: i32 = right.range.map(i32::from).sum();
<span class="macro">assert_eq!</span>(r1 + r2, -<span class="number">100</span>);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_i128_len_doesnt_overflow() {
<span class="kw">use </span>std::{i128, u128};
<span class="comment">// Using parse because some versions of rust don&#39;t allow long literals
</span><span class="kw">let </span>octillion: i128 = <span class="string">&quot;1000000000000000000000000000&quot;</span>.parse().unwrap();
<span class="kw">let </span>producer = IterProducer {
range: <span class="number">0</span>..octillion,
};
<span class="macro">assert_eq!</span>(octillion <span class="kw">as </span>u128, producer.range.len());
<span class="macro">assert_eq!</span>(octillion <span class="kw">as </span>u128, (<span class="number">0</span>..octillion).len());
<span class="macro">assert_eq!</span>(<span class="number">2 </span>* octillion <span class="kw">as </span>u128, (-octillion..octillion).len());
<span class="macro">assert_eq!</span>(u128::MAX, (i128::MIN..i128::MAX).len());
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_u64_opt_len() {
<span class="kw">use </span>std::{u64, usize};
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="number">100</span>), (<span class="number">0</span>..<span class="number">100u64</span>).into_par_iter().opt_len());
<span class="macro">assert_eq!</span>(
<span class="prelude-val">Some</span>(usize::MAX),
(<span class="number">0</span>..usize::MAX <span class="kw">as </span>u64).into_par_iter().opt_len()
);
<span class="kw">if </span>(usize::MAX <span class="kw">as </span>u64) &lt; u64::MAX {
<span class="macro">assert_eq!</span>(
<span class="prelude-val">None</span>,
(<span class="number">0</span>..(usize::MAX <span class="kw">as </span>u64).wrapping_add(<span class="number">1</span>))
.into_par_iter()
.opt_len()
);
<span class="macro">assert_eq!</span>(<span class="prelude-val">None</span>, (<span class="number">0</span>..u64::MAX).into_par_iter().opt_len());
}
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_u128_opt_len() {
<span class="kw">use </span>std::{u128, usize};
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="number">100</span>), (<span class="number">0</span>..<span class="number">100u128</span>).into_par_iter().opt_len());
<span class="macro">assert_eq!</span>(
<span class="prelude-val">Some</span>(usize::MAX),
(<span class="number">0</span>..usize::MAX <span class="kw">as </span>u128).into_par_iter().opt_len()
);
<span class="macro">assert_eq!</span>(<span class="prelude-val">None</span>, (<span class="number">0</span>..<span class="number">1 </span>+ usize::MAX <span class="kw">as </span>u128).into_par_iter().opt_len());
<span class="macro">assert_eq!</span>(<span class="prelude-val">None</span>, (<span class="number">0</span>..u128::MAX).into_par_iter().opt_len());
}
<span class="comment">// `usize as i64` can overflow, so make sure to wrap it appropriately
// when using the `opt_len` &quot;indexed&quot; mode.
</span><span class="attribute">#[test]
#[cfg(target_pointer_width = <span class="string">&quot;64&quot;</span>)]
</span><span class="kw">fn </span>test_usize_i64_overflow() {
<span class="kw">use </span><span class="kw">crate</span>::ThreadPoolBuilder;
<span class="kw">use </span>std::i64;
<span class="kw">let </span>iter = (-<span class="number">2</span>..i64::MAX).into_par_iter();
<span class="macro">assert_eq!</span>(iter.opt_len(), <span class="prelude-val">Some</span>(i64::MAX <span class="kw">as </span>usize + <span class="number">2</span>));
<span class="comment">// always run with multiple threads to split into, or this will take forever...
</span><span class="kw">let </span>pool = ThreadPoolBuilder::new().num_threads(<span class="number">8</span>).build().unwrap();
pool.install(|| <span class="macro">assert_eq!</span>(iter.find_last(|<span class="kw">_</span>| <span class="bool-val">true</span>), <span class="prelude-val">Some</span>(i64::MAX - <span class="number">1</span>)));
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_issue_833() {
<span class="kw">fn </span>is_even(n: i64) -&gt; bool {
n % <span class="number">2 </span>== <span class="number">0
</span>}
<span class="comment">// The integer type should be inferred from `is_even`
</span><span class="kw">let </span>v: Vec&lt;<span class="kw">_</span>&gt; = (<span class="number">1</span>..<span class="number">100</span>).into_par_iter().filter(|<span class="kw-2">&amp;</span>x| is_even(x)).collect();
<span class="macro">assert!</span>(v.into_iter().eq((<span class="number">2</span>..<span class="number">100</span>).step_by(<span class="number">2</span>)));
<span class="comment">// Try examples with indexed iterators too
</span><span class="kw">let </span>pos = (<span class="number">0</span>..<span class="number">100</span>).into_par_iter().position_any(|x| x == <span class="number">50i16</span>);
<span class="macro">assert_eq!</span>(pos, <span class="prelude-val">Some</span>(<span class="number">50usize</span>));
<span class="macro">assert!</span>((<span class="number">0</span>..<span class="number">100</span>)
.into_par_iter()
.zip(<span class="number">0</span>..<span class="number">100</span>)
.all(|(a, b)| i16::eq(<span class="kw-2">&amp;</span>a, <span class="kw-2">&amp;</span>b)));
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rayon" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>