blob: 7e442f37c2627d4b768001a17abf2575f049ca5b [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/tantivy-65d0bbbddbbd5d02/433372d/src/postings/block_segment_postings.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>block_segment_postings.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="../../../tantivy/index.html"><div class="logo-container">
<img src="http://fulmicoton.com/tantivy-logo/tantivy-logo.png" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../tantivy/index.html">
<img src="http://fulmicoton.com/tantivy-logo/tantivy-logo.png" 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>
<span id="463">463</span>
<span id="464">464</span>
<span id="465">465</span>
<span id="466">466</span>
<span id="467">467</span>
<span id="468">468</span>
<span id="469">469</span>
<span id="470">470</span>
<span id="471">471</span>
<span id="472">472</span>
<span id="473">473</span>
<span id="474">474</span>
<span id="475">475</span>
<span id="476">476</span>
<span id="477">477</span>
<span id="478">478</span>
<span id="479">479</span>
<span id="480">480</span>
<span id="481">481</span>
<span id="482">482</span>
<span id="483">483</span>
<span id="484">484</span>
<span id="485">485</span>
<span id="486">486</span>
<span id="487">487</span>
<span id="488">488</span>
<span id="489">489</span>
<span id="490">490</span>
<span id="491">491</span>
<span id="492">492</span>
<span id="493">493</span>
<span id="494">494</span>
<span id="495">495</span>
<span id="496">496</span>
<span id="497">497</span>
<span id="498">498</span>
<span id="499">499</span>
<span id="500">500</span>
<span id="501">501</span>
<span id="502">502</span>
<span id="503">503</span>
<span id="504">504</span>
<span id="505">505</span>
<span id="506">506</span>
<span id="507">507</span>
<span id="508">508</span>
<span id="509">509</span>
<span id="510">510</span>
<span id="511">511</span>
<span id="512">512</span>
<span id="513">513</span>
<span id="514">514</span>
<span id="515">515</span>
<span id="516">516</span>
<span id="517">517</span>
<span id="518">518</span>
<span id="519">519</span>
<span id="520">520</span>
<span id="521">521</span>
<span id="522">522</span>
<span id="523">523</span>
<span id="524">524</span>
<span id="525">525</span>
</pre><pre class="rust"><code><span class="kw">use </span>std::io;
<span class="kw">use </span>common::VInt;
<span class="kw">use </span><span class="kw">crate</span>::directory::{FileSlice, OwnedBytes};
<span class="kw">use </span><span class="kw">crate</span>::fieldnorm::FieldNormReader;
<span class="kw">use </span><span class="kw">crate</span>::postings::compression::{BlockDecoder, VIntDecoder, COMPRESSION_BLOCK_SIZE};
<span class="kw">use </span><span class="kw">crate</span>::postings::{BlockInfo, FreqReadingOption, SkipReader};
<span class="kw">use </span><span class="kw">crate</span>::query::Bm25Weight;
<span class="kw">use </span><span class="kw">crate</span>::schema::IndexRecordOption;
<span class="kw">use crate</span>::{DocId, Score, TERMINATED};
<span class="kw">fn </span>max_score&lt;I: Iterator&lt;Item = Score&gt;&gt;(<span class="kw-2">mut </span>it: I) -&gt; <span class="prelude-ty">Option</span>&lt;Score&gt; {
it.next().map(|first| it.fold(first, Score::max))
}
<span class="doccomment">/// `BlockSegmentPostings` is a cursor iterating over blocks
/// of documents.
///
/// # Warning
///
/// While it is useful for some very specific high-performance
/// use cases, you should prefer using `SegmentPostings` for most usage.
</span><span class="attribute">#[derive(Clone)]
</span><span class="kw">pub struct </span>BlockSegmentPostings {
<span class="kw">pub</span>(<span class="kw">crate</span>) doc_decoder: BlockDecoder,
loaded_offset: usize,
freq_decoder: BlockDecoder,
freq_reading_option: FreqReadingOption,
block_max_score_cache: <span class="prelude-ty">Option</span>&lt;Score&gt;,
doc_freq: u32,
data: OwnedBytes,
<span class="kw">pub</span>(<span class="kw">crate</span>) skip_reader: SkipReader,
}
<span class="kw">fn </span>decode_bitpacked_block(
doc_decoder: <span class="kw-2">&amp;mut </span>BlockDecoder,
freq_decoder_opt: <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;mut </span>BlockDecoder&gt;,
data: <span class="kw-2">&amp;</span>[u8],
doc_offset: DocId,
doc_num_bits: u8,
tf_num_bits: u8,
) {
<span class="kw">let </span>num_consumed_bytes = doc_decoder.uncompress_block_sorted(data, doc_offset, doc_num_bits);
<span class="kw">if let </span><span class="prelude-val">Some</span>(freq_decoder) = freq_decoder_opt {
freq_decoder.uncompress_block_unsorted(<span class="kw-2">&amp;</span>data[num_consumed_bytes..], tf_num_bits);
}
}
<span class="kw">fn </span>decode_vint_block(
doc_decoder: <span class="kw-2">&amp;mut </span>BlockDecoder,
freq_decoder_opt: <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;mut </span>BlockDecoder&gt;,
data: <span class="kw-2">&amp;</span>[u8],
doc_offset: DocId,
num_vint_docs: usize,
) {
<span class="kw">let </span>num_consumed_bytes =
doc_decoder.uncompress_vint_sorted(data, doc_offset, num_vint_docs, TERMINATED);
<span class="kw">if let </span><span class="prelude-val">Some</span>(freq_decoder) = freq_decoder_opt {
freq_decoder.uncompress_vint_unsorted(
<span class="kw-2">&amp;</span>data[num_consumed_bytes..],
num_vint_docs,
TERMINATED,
);
}
}
<span class="kw">fn </span>split_into_skips_and_postings(
doc_freq: u32,
<span class="kw-2">mut </span>bytes: OwnedBytes,
) -&gt; io::Result&lt;(<span class="prelude-ty">Option</span>&lt;OwnedBytes&gt;, OwnedBytes)&gt; {
<span class="kw">if </span>doc_freq &lt; COMPRESSION_BLOCK_SIZE <span class="kw">as </span>u32 {
<span class="kw">return </span><span class="prelude-val">Ok</span>((<span class="prelude-val">None</span>, bytes));
}
<span class="kw">let </span>skip_len = VInt::deserialize_u64(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">? </span><span class="kw">as </span>usize;
<span class="kw">let </span>(skip_data, postings_data) = bytes.split(skip_len);
<span class="prelude-val">Ok</span>((<span class="prelude-val">Some</span>(skip_data), postings_data))
}
<span class="kw">impl </span>BlockSegmentPostings {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>open(
doc_freq: u32,
data: FileSlice,
record_option: IndexRecordOption,
requested_option: IndexRecordOption,
) -&gt; io::Result&lt;BlockSegmentPostings&gt; {
<span class="kw">let </span>freq_reading_option = <span class="kw">match </span>(record_option, requested_option) {
(IndexRecordOption::Basic, <span class="kw">_</span>) =&gt; FreqReadingOption::NoFreq,
(<span class="kw">_</span>, IndexRecordOption::Basic) =&gt; FreqReadingOption::SkipFreq,
(<span class="kw">_</span>, <span class="kw">_</span>) =&gt; FreqReadingOption::ReadFreq,
};
<span class="kw">let </span>bytes = data.read_bytes()<span class="question-mark">?</span>;
<span class="kw">let </span>(skip_data_opt, postings_data) = split_into_skips_and_postings(doc_freq, bytes)<span class="question-mark">?</span>;
<span class="kw">let </span>skip_reader = <span class="kw">match </span>skip_data_opt {
<span class="prelude-val">Some</span>(skip_data) =&gt; SkipReader::new(skip_data, doc_freq, record_option),
<span class="prelude-val">None </span>=&gt; SkipReader::new(OwnedBytes::empty(), doc_freq, record_option),
};
<span class="kw">let </span><span class="kw-2">mut </span>block_segment_postings = BlockSegmentPostings {
doc_decoder: BlockDecoder::with_val(TERMINATED),
loaded_offset: usize::MAX,
freq_decoder: BlockDecoder::with_val(<span class="number">1</span>),
freq_reading_option,
block_max_score_cache: <span class="prelude-val">None</span>,
doc_freq,
data: postings_data,
skip_reader,
};
block_segment_postings.load_block();
<span class="prelude-val">Ok</span>(block_segment_postings)
}
<span class="doccomment">/// Returns the block_max_score for the current block.
/// It does not require the block to be loaded. For instance, it is ok to call this method
/// after having called `.shallow_advance(..)`.
///
/// See `TermScorer::block_max_score(..)` for more information.
</span><span class="kw">pub fn </span>block_max_score(
<span class="kw-2">&amp;mut </span><span class="self">self</span>,
fieldnorm_reader: <span class="kw-2">&amp;</span>FieldNormReader,
bm25_weight: <span class="kw-2">&amp;</span>Bm25Weight,
) -&gt; Score {
<span class="kw">if let </span><span class="prelude-val">Some</span>(score) = <span class="self">self</span>.block_max_score_cache {
<span class="kw">return </span>score;
}
<span class="kw">if let </span><span class="prelude-val">Some</span>(skip_reader_max_score) = <span class="self">self</span>.skip_reader.block_max_score(bm25_weight) {
<span class="comment">// if we are on a full block, the skip reader should have the block max information
// for us
</span><span class="self">self</span>.block_max_score_cache = <span class="prelude-val">Some</span>(skip_reader_max_score);
<span class="kw">return </span>skip_reader_max_score;
}
<span class="comment">// this is the last block of the segment posting list.
// If it is actually loaded, we can compute block max manually.
</span><span class="kw">if </span><span class="self">self</span>.block_is_loaded() {
<span class="kw">let </span>docs = <span class="self">self</span>.doc_decoder.output_array().iter().cloned();
<span class="kw">let </span>freqs = <span class="self">self</span>.freq_decoder.output_array().iter().cloned();
<span class="kw">let </span>bm25_scores = docs.zip(freqs).map(|(doc, term_freq)| {
<span class="kw">let </span>fieldnorm_id = fieldnorm_reader.fieldnorm_id(doc);
bm25_weight.score(fieldnorm_id, term_freq)
});
<span class="kw">let </span>block_max_score = max_score(bm25_scores).unwrap_or(<span class="number">0.0</span>);
<span class="self">self</span>.block_max_score_cache = <span class="prelude-val">Some</span>(block_max_score);
<span class="kw">return </span>block_max_score;
}
<span class="comment">// We do not have access to any good block max value. We return bm25_weight.max_score()
// as it is a valid upperbound.
//
// We do not cache it however, so that it gets computed when once block is loaded.
</span>bm25_weight.max_score()
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>freq_reading_option(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; FreqReadingOption {
<span class="self">self</span>.freq_reading_option
}
<span class="comment">// Resets the block segment postings on another position
// in the postings file.
//
// This is useful for enumerating through a list of terms,
// and consuming the associated posting lists while avoiding
// reallocating a `BlockSegmentPostings`.
//
// # Warning
//
// This does not reset the positions list.
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>reset(<span class="kw-2">&amp;mut </span><span class="self">self</span>, doc_freq: u32, postings_data: OwnedBytes) -&gt; io::Result&lt;()&gt; {
<span class="kw">let </span>(skip_data_opt, postings_data) =
split_into_skips_and_postings(doc_freq, postings_data)<span class="question-mark">?</span>;
<span class="self">self</span>.data = postings_data;
<span class="self">self</span>.block_max_score_cache = <span class="prelude-val">None</span>;
<span class="self">self</span>.loaded_offset = usize::MAX;
<span class="kw">if let </span><span class="prelude-val">Some</span>(skip_data) = skip_data_opt {
<span class="self">self</span>.skip_reader.reset(skip_data, doc_freq);
} <span class="kw">else </span>{
<span class="self">self</span>.skip_reader.reset(OwnedBytes::empty(), doc_freq);
}
<span class="self">self</span>.doc_freq = doc_freq;
<span class="self">self</span>.load_block();
<span class="prelude-val">Ok</span>(())
}
<span class="doccomment">/// Returns the overall number of documents in the block postings.
/// It does not take in account whether documents are deleted or not.
///
/// This `doc_freq` is simply the sum of the length of all of the blocks
/// length, and it does not take in account deleted documents.
</span><span class="kw">pub fn </span>doc_freq(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; u32 {
<span class="self">self</span>.doc_freq
}
<span class="doccomment">/// Returns the array of docs in the current block.
///
/// Before the first call to `.advance()`, the block
/// returned by `.docs()` is empty.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>docs(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>[DocId] {
<span class="macro">debug_assert!</span>(<span class="self">self</span>.block_is_loaded());
<span class="self">self</span>.doc_decoder.output_array()
}
<span class="doccomment">/// Returns a full block, regardless of whether the block is complete or incomplete (
/// as it happens for the last block of the posting list).
///
/// In the latter case, the block is guaranteed to be padded with the sentinel value:
/// `TERMINATED`. The array is also guaranteed to be aligned on 16 bytes = 128 bits.
///
/// This method is useful to run SSE2 linear search.
</span><span class="attribute">#[inline]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>full_block(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>[DocId; COMPRESSION_BLOCK_SIZE] {
<span class="macro">debug_assert!</span>(<span class="self">self</span>.block_is_loaded());
<span class="self">self</span>.doc_decoder.full_output()
}
<span class="doccomment">/// Return the document at index `idx` of the block.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>doc(<span class="kw-2">&amp;</span><span class="self">self</span>, idx: usize) -&gt; u32 {
<span class="self">self</span>.doc_decoder.output(idx)
}
<span class="doccomment">/// Return the array of `term freq` in the block.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>freqs(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>[u32] {
<span class="macro">debug_assert!</span>(<span class="self">self</span>.block_is_loaded());
<span class="self">self</span>.freq_decoder.output_array()
}
<span class="doccomment">/// Return the frequency at index `idx` of the block.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>freq(<span class="kw-2">&amp;</span><span class="self">self</span>, idx: usize) -&gt; u32 {
<span class="macro">debug_assert!</span>(<span class="self">self</span>.block_is_loaded());
<span class="self">self</span>.freq_decoder.output(idx)
}
<span class="doccomment">/// Returns the length of the current block.
///
/// All blocks have a length of `NUM_DOCS_PER_BLOCK`,
/// except the last block that may have a length
/// of any number between 1 and `NUM_DOCS_PER_BLOCK - 1`
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>block_len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="macro">debug_assert!</span>(<span class="self">self</span>.block_is_loaded());
<span class="self">self</span>.doc_decoder.output_len
}
<span class="doccomment">/// Position on a block that may contains `target_doc`.
///
/// If all docs are smaller than target, the block loaded may be empty,
/// or be the last an incomplete VInt block.
</span><span class="kw">pub fn </span>seek(<span class="kw-2">&amp;mut </span><span class="self">self</span>, target_doc: DocId) {
<span class="self">self</span>.shallow_seek(target_doc);
<span class="self">self</span>.load_block();
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>position_offset(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; u64 {
<span class="self">self</span>.skip_reader.position_offset()
}
<span class="doccomment">/// Dangerous API! This calls seek on the skip list,
/// but does not `.load_block()` afterwards.
///
/// `.load_block()` needs to be called manually afterwards.
/// If all docs are smaller than target, the block loaded may be empty,
/// or be the last an incomplete VInt block.
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>shallow_seek(<span class="kw-2">&amp;mut </span><span class="self">self</span>, target_doc: DocId) {
<span class="kw">if </span><span class="self">self</span>.skip_reader.seek(target_doc) {
<span class="self">self</span>.block_max_score_cache = <span class="prelude-val">None</span>;
}
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>block_is_loaded(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="self">self</span>.loaded_offset == <span class="self">self</span>.skip_reader.byte_offset()
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>load_block(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<span class="kw">let </span>offset = <span class="self">self</span>.skip_reader.byte_offset();
<span class="kw">if </span><span class="self">self</span>.loaded_offset == offset {
<span class="kw">return</span>;
}
<span class="self">self</span>.loaded_offset = offset;
<span class="kw">match </span><span class="self">self</span>.skip_reader.block_info() {
BlockInfo::BitPacked {
doc_num_bits,
tf_num_bits,
..
} =&gt; {
decode_bitpacked_block(
<span class="kw-2">&amp;mut </span><span class="self">self</span>.doc_decoder,
<span class="kw">if let </span>FreqReadingOption::ReadFreq = <span class="self">self</span>.freq_reading_option {
<span class="prelude-val">Some</span>(<span class="kw-2">&amp;mut </span><span class="self">self</span>.freq_decoder)
} <span class="kw">else </span>{
<span class="prelude-val">None
</span>},
<span class="kw-2">&amp;</span><span class="self">self</span>.data.as_slice()[offset..],
<span class="self">self</span>.skip_reader.last_doc_in_previous_block,
doc_num_bits,
tf_num_bits,
);
}
BlockInfo::VInt { num_docs } =&gt; {
<span class="kw">let </span>data = {
<span class="kw">if </span>num_docs == <span class="number">0 </span>{
<span class="kw-2">&amp;</span>[]
} <span class="kw">else </span>{
<span class="kw-2">&amp;</span><span class="self">self</span>.data.as_slice()[offset..]
}
};
decode_vint_block(
<span class="kw-2">&amp;mut </span><span class="self">self</span>.doc_decoder,
<span class="kw">if let </span>FreqReadingOption::ReadFreq = <span class="self">self</span>.freq_reading_option {
<span class="prelude-val">Some</span>(<span class="kw-2">&amp;mut </span><span class="self">self</span>.freq_decoder)
} <span class="kw">else </span>{
<span class="prelude-val">None
</span>},
data,
<span class="self">self</span>.skip_reader.last_doc_in_previous_block,
num_docs <span class="kw">as </span>usize,
);
}
}
}
<span class="doccomment">/// Advance to the next block.
///
/// Returns false if and only if there is no remaining block.
</span><span class="kw">pub fn </span>advance(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<span class="self">self</span>.skip_reader.advance();
<span class="self">self</span>.block_max_score_cache = <span class="prelude-val">None</span>;
<span class="self">self</span>.load_block();
}
<span class="doccomment">/// Returns an empty segment postings object
</span><span class="kw">pub fn </span>empty() -&gt; BlockSegmentPostings {
BlockSegmentPostings {
doc_decoder: BlockDecoder::with_val(TERMINATED),
loaded_offset: <span class="number">0</span>,
freq_decoder: BlockDecoder::with_val(<span class="number">1</span>),
freq_reading_option: FreqReadingOption::NoFreq,
block_max_score_cache: <span class="prelude-val">None</span>,
doc_freq: <span class="number">0</span>,
data: OwnedBytes::empty(),
skip_reader: SkipReader::new(OwnedBytes::empty(), <span class="number">0</span>, IndexRecordOption::Basic),
}
}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use </span>common::HasLen;
<span class="kw">use </span><span class="kw">super</span>::BlockSegmentPostings;
<span class="kw">use </span><span class="kw">crate</span>::core::Index;
<span class="kw">use </span><span class="kw">crate</span>::docset::{DocSet, TERMINATED};
<span class="kw">use </span><span class="kw">crate</span>::postings::compression::COMPRESSION_BLOCK_SIZE;
<span class="kw">use </span><span class="kw">crate</span>::postings::postings::Postings;
<span class="kw">use </span><span class="kw">crate</span>::postings::SegmentPostings;
<span class="kw">use </span><span class="kw">crate</span>::schema::{IndexRecordOption, Schema, Term, INDEXED};
<span class="kw">use </span><span class="kw">crate</span>::DocId;
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_empty_segment_postings() {
<span class="kw">let </span><span class="kw-2">mut </span>postings = SegmentPostings::empty();
<span class="macro">assert_eq!</span>(postings.doc(), TERMINATED);
<span class="macro">assert_eq!</span>(postings.advance(), TERMINATED);
<span class="macro">assert_eq!</span>(postings.advance(), TERMINATED);
<span class="macro">assert_eq!</span>(postings.doc_freq(), <span class="number">0</span>);
<span class="macro">assert_eq!</span>(postings.len(), <span class="number">0</span>);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_empty_postings_doc_returns_terminated() {
<span class="kw">let </span><span class="kw-2">mut </span>postings = SegmentPostings::empty();
<span class="macro">assert_eq!</span>(postings.doc(), TERMINATED);
<span class="macro">assert_eq!</span>(postings.advance(), TERMINATED);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_empty_postings_doc_term_freq_returns_0() {
<span class="kw">let </span>postings = SegmentPostings::empty();
<span class="macro">assert_eq!</span>(postings.term_freq(), <span class="number">1</span>);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_empty_block_segment_postings() {
<span class="kw">let </span><span class="kw-2">mut </span>postings = BlockSegmentPostings::empty();
<span class="macro">assert!</span>(postings.docs().is_empty());
<span class="macro">assert_eq!</span>(postings.doc_freq(), <span class="number">0</span>);
postings.advance();
<span class="macro">assert!</span>(postings.docs().is_empty());
<span class="macro">assert_eq!</span>(postings.doc_freq(), <span class="number">0</span>);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_block_segment_postings() -&gt; <span class="kw">crate</span>::Result&lt;()&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>block_segments = build_block_postings(<span class="kw-2">&amp;</span>(<span class="number">0</span>..<span class="number">100_000</span>).collect::&lt;Vec&lt;u32&gt;&gt;())<span class="question-mark">?</span>;
<span class="kw">let </span><span class="kw-2">mut </span>offset: u32 = <span class="number">0u32</span>;
<span class="comment">// checking that the `doc_freq` is correct
</span><span class="macro">assert_eq!</span>(block_segments.doc_freq(), <span class="number">100_000</span>);
<span class="kw">loop </span>{
<span class="kw">let </span>block = block_segments.docs();
<span class="kw">if </span>block.is_empty() {
<span class="kw">break</span>;
}
<span class="kw">for </span>(i, doc) <span class="kw">in </span>block.iter().cloned().enumerate() {
<span class="macro">assert_eq!</span>(offset + (i <span class="kw">as </span>u32), doc);
}
offset += block.len() <span class="kw">as </span>u32;
block_segments.advance();
}
<span class="prelude-val">Ok</span>(())
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_skip_right_at_new_block() -&gt; <span class="kw">crate</span>::Result&lt;()&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>doc_ids = (<span class="number">0</span>..<span class="number">128</span>).collect::&lt;Vec&lt;u32&gt;&gt;();
<span class="comment">// 128 is missing
</span>doc_ids.push(<span class="number">129</span>);
doc_ids.push(<span class="number">130</span>);
{
<span class="kw">let </span>block_segments = build_block_postings(<span class="kw-2">&amp;</span>doc_ids)<span class="question-mark">?</span>;
<span class="kw">let </span><span class="kw-2">mut </span>docset = SegmentPostings::from_block_postings(block_segments, <span class="prelude-val">None</span>);
<span class="macro">assert_eq!</span>(docset.seek(<span class="number">128</span>), <span class="number">129</span>);
<span class="macro">assert_eq!</span>(docset.doc(), <span class="number">129</span>);
<span class="macro">assert_eq!</span>(docset.advance(), <span class="number">130</span>);
<span class="macro">assert_eq!</span>(docset.doc(), <span class="number">130</span>);
<span class="macro">assert_eq!</span>(docset.advance(), TERMINATED);
}
{
<span class="kw">let </span>block_segments = build_block_postings(<span class="kw-2">&amp;</span>doc_ids).unwrap();
<span class="kw">let </span><span class="kw-2">mut </span>docset = SegmentPostings::from_block_postings(block_segments, <span class="prelude-val">None</span>);
<span class="macro">assert_eq!</span>(docset.seek(<span class="number">129</span>), <span class="number">129</span>);
<span class="macro">assert_eq!</span>(docset.doc(), <span class="number">129</span>);
<span class="macro">assert_eq!</span>(docset.advance(), <span class="number">130</span>);
<span class="macro">assert_eq!</span>(docset.doc(), <span class="number">130</span>);
<span class="macro">assert_eq!</span>(docset.advance(), TERMINATED);
}
{
<span class="kw">let </span>block_segments = build_block_postings(<span class="kw-2">&amp;</span>doc_ids)<span class="question-mark">?</span>;
<span class="kw">let </span><span class="kw-2">mut </span>docset = SegmentPostings::from_block_postings(block_segments, <span class="prelude-val">None</span>);
<span class="macro">assert_eq!</span>(docset.doc(), <span class="number">0</span>);
<span class="macro">assert_eq!</span>(docset.seek(<span class="number">131</span>), TERMINATED);
<span class="macro">assert_eq!</span>(docset.doc(), TERMINATED);
}
<span class="prelude-val">Ok</span>(())
}
<span class="kw">fn </span>build_block_postings(docs: <span class="kw-2">&amp;</span>[DocId]) -&gt; <span class="kw">crate</span>::Result&lt;BlockSegmentPostings&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>schema_builder = Schema::builder();
<span class="kw">let </span>int_field = schema_builder.add_u64_field(<span class="string">&quot;id&quot;</span>, INDEXED);
<span class="kw">let </span>schema = schema_builder.build();
<span class="kw">let </span>index = Index::create_in_ram(schema);
<span class="kw">let </span><span class="kw-2">mut </span>index_writer = index.writer_for_tests()<span class="question-mark">?</span>;
<span class="kw">let </span><span class="kw-2">mut </span>last_doc = <span class="number">0u32</span>;
<span class="kw">for </span><span class="kw-2">&amp;</span>doc <span class="kw">in </span>docs {
<span class="kw">for _ in </span>last_doc..doc {
index_writer.add_document(<span class="macro">doc!</span>(int_field=&gt;<span class="number">1u64</span>))<span class="question-mark">?</span>;
}
index_writer.add_document(<span class="macro">doc!</span>(int_field=&gt;<span class="number">0u64</span>))<span class="question-mark">?</span>;
last_doc = doc + <span class="number">1</span>;
}
index_writer.commit()<span class="question-mark">?</span>;
<span class="kw">let </span>searcher = index.reader()<span class="question-mark">?</span>.searcher();
<span class="kw">let </span>segment_reader = searcher.segment_reader(<span class="number">0</span>);
<span class="kw">let </span>inverted_index = segment_reader.inverted_index(int_field).unwrap();
<span class="kw">let </span>term = Term::from_field_u64(int_field, <span class="number">0u64</span>);
<span class="kw">let </span>term_info = inverted_index.get_term_info(<span class="kw-2">&amp;</span>term)<span class="question-mark">?</span>.unwrap();
<span class="kw">let </span>block_postings = inverted_index
.read_block_postings_from_terminfo(<span class="kw-2">&amp;</span>term_info, IndexRecordOption::Basic)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(block_postings)
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_block_segment_postings_seek() -&gt; <span class="kw">crate</span>::Result&lt;()&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>docs = <span class="macro">vec!</span>[<span class="number">0</span>];
<span class="kw">for </span>i <span class="kw">in </span><span class="number">0</span>..<span class="number">1300 </span>{
docs.push((i * i / <span class="number">100</span>) + i);
}
<span class="kw">let </span><span class="kw-2">mut </span>block_postings = build_block_postings(<span class="kw-2">&amp;</span>docs[..])<span class="question-mark">?</span>;
<span class="kw">for </span>i <span class="kw">in </span><span class="kw-2">&amp;</span>[<span class="number">0</span>, <span class="number">424</span>, <span class="number">10000</span>] {
block_postings.seek(<span class="kw-2">*</span>i);
<span class="kw">let </span>docs = block_postings.docs();
<span class="macro">assert!</span>(docs[<span class="number">0</span>] &lt;= <span class="kw-2">*</span>i);
<span class="macro">assert!</span>(docs.last().cloned().unwrap_or(<span class="number">0u32</span>) &gt;= <span class="kw-2">*</span>i);
}
block_postings.seek(<span class="number">100_000</span>);
<span class="macro">assert_eq!</span>(block_postings.doc(COMPRESSION_BLOCK_SIZE - <span class="number">1</span>), TERMINATED);
<span class="prelude-val">Ok</span>(())
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_reset_block_segment_postings() -&gt; <span class="kw">crate</span>::Result&lt;()&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>schema_builder = Schema::builder();
<span class="kw">let </span>int_field = schema_builder.add_u64_field(<span class="string">&quot;id&quot;</span>, INDEXED);
<span class="kw">let </span>schema = schema_builder.build();
<span class="kw">let </span>index = Index::create_in_ram(schema);
<span class="kw">let </span><span class="kw-2">mut </span>index_writer = index.writer_for_tests()<span class="question-mark">?</span>;
<span class="comment">// create two postings list, one containing even number,
// the other containing odd numbers.
</span><span class="kw">for </span>i <span class="kw">in </span><span class="number">0</span>..<span class="number">6 </span>{
<span class="kw">let </span>doc = <span class="macro">doc!</span>(int_field=&gt; (i % <span class="number">2</span>) <span class="kw">as </span>u64);
index_writer.add_document(doc)<span class="question-mark">?</span>;
}
index_writer.commit()<span class="question-mark">?</span>;
<span class="kw">let </span>searcher = index.reader()<span class="question-mark">?</span>.searcher();
<span class="kw">let </span>segment_reader = searcher.segment_reader(<span class="number">0</span>);
<span class="kw">let </span><span class="kw-2">mut </span>block_segments;
{
<span class="kw">let </span>term = Term::from_field_u64(int_field, <span class="number">0u64</span>);
<span class="kw">let </span>inverted_index = segment_reader.inverted_index(int_field)<span class="question-mark">?</span>;
<span class="kw">let </span>term_info = inverted_index.get_term_info(<span class="kw-2">&amp;</span>term)<span class="question-mark">?</span>.unwrap();
block_segments = inverted_index
.read_block_postings_from_terminfo(<span class="kw-2">&amp;</span>term_info, IndexRecordOption::Basic)<span class="question-mark">?</span>;
}
<span class="macro">assert_eq!</span>(block_segments.docs(), <span class="kw-2">&amp;</span>[<span class="number">0</span>, <span class="number">2</span>, <span class="number">4</span>]);
{
<span class="kw">let </span>term = Term::from_field_u64(int_field, <span class="number">1u64</span>);
<span class="kw">let </span>inverted_index = segment_reader.inverted_index(int_field)<span class="question-mark">?</span>;
<span class="kw">let </span>term_info = inverted_index.get_term_info(<span class="kw-2">&amp;</span>term)<span class="question-mark">?</span>.unwrap();
inverted_index.reset_block_postings_from_terminfo(<span class="kw-2">&amp;</span>term_info, <span class="kw-2">&amp;mut </span>block_segments)<span class="question-mark">?</span>;
}
<span class="macro">assert_eq!</span>(block_segments.docs(), <span class="kw-2">&amp;</span>[<span class="number">1</span>, <span class="number">3</span>, <span class="number">5</span>]);
<span class="prelude-val">Ok</span>(())
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="tantivy" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>