api-docs/crates-enclave/src/tantivy/query/term_query/term_scorer.rs.html - incubator-teaclave-website - Git at Google

 <!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/query/term_query/term_scorer.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>term_scorer.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>
 </pre><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::docset::DocSet;
 <span class="kw">use </span><span class="kw">crate</span>::fieldnorm::FieldNormReader;
 <span class="kw">use </span><span class="kw">crate</span>::postings::{FreqReadingOption, Postings, SegmentPostings};
 <span class="kw">use </span><span class="kw">crate</span>::query::bm25::Bm25Weight;
 <span class="kw">use </span><span class="kw">crate</span>::query::{Explanation, Scorer};
 <span class="kw">use crate</span>::{DocId, Score};

 <span class="attribute">#[derive(Clone)]
 </span><span class="kw">pub struct </span>TermScorer {
     postings: SegmentPostings,
     fieldnorm_reader: FieldNormReader,
     similarity_weight: Bm25Weight,
 }

 <span class="kw">impl </span>TermScorer {
     <span class="kw">pub fn </span>new(
         postings: SegmentPostings,
         fieldnorm_reader: FieldNormReader,
         similarity_weight: Bm25Weight,
     ) -&gt; TermScorer {
         TermScorer {
             postings,
             fieldnorm_reader,
             similarity_weight,
         }
     }

     <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="self">self</span>.postings.block_cursor.shallow_seek(target_doc);
     }

     <span class="attribute">#[cfg(test)]
     </span><span class="kw">pub fn </span>create_for_test(
         doc_and_tfs: <span class="kw-2">&amp;</span>[(DocId, u32)],
         fieldnorms: <span class="kw-2">&amp;</span>[u32],
         similarity_weight: Bm25Weight,
     ) -&gt; TermScorer {
         <span class="macro">assert!</span>(!doc_and_tfs.is_empty());
         <span class="macro">assert!</span>(
             doc_and_tfs
                 .iter()
                 .map(|(doc, _tf)| <span class="kw-2">*</span>doc)
                 .max()
                 .unwrap_or(<span class="number">0u32</span>)
                 &lt; fieldnorms.len() <span class="kw">as </span>u32
         );
         <span class="kw">let </span>segment_postings =
             SegmentPostings::create_from_docs_and_tfs(doc_and_tfs, <span class="prelude-val">Some</span>(fieldnorms));
         <span class="kw">let </span>fieldnorm_reader = FieldNormReader::for_test(fieldnorms);
         TermScorer::new(segment_postings, fieldnorm_reader, similarity_weight)
     }

     <span class="doccomment">/// See `FreqReadingOption`.
     </span><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>.postings.block_cursor.freq_reading_option()
     }

     <span class="doccomment">/// Returns the maximum score for the current block.
     ///
     /// In some rare case, the result may not be exact. In this case a lower value is returned,
     /// (and may lead us to return a lesser document).
     ///
     /// At index time, we store the (fieldnorm_id, term frequency) pair that maximizes the
     /// score assuming the average fieldnorm computed on this segment.
     ///
     /// Though extremely rare, it is theoretically possible that the actual average fieldnorm
     /// is different enough from the current segment average fieldnorm that the maximum over a
     /// specific is achieved on a different document.
     ///
     /// (The result is on the other hand guaranteed to be correct if there is only one segment).
     </span><span class="kw">pub fn </span>block_max_score(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; Score {
         <span class="self">self</span>.postings
             .block_cursor
             .block_max_score(<span class="kw-2">&amp;</span><span class="self">self</span>.fieldnorm_reader, <span class="kw-2">&amp;</span><span class="self">self</span>.similarity_weight)
     }

     <span class="kw">pub fn </span>term_freq(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; u32 {
         <span class="self">self</span>.postings.term_freq()
     }

     <span class="kw">pub fn </span>fieldnorm_id(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; u8 {
         <span class="self">self</span>.fieldnorm_reader.fieldnorm_id(<span class="self">self</span>.doc())
     }

     <span class="kw">pub fn </span>explain(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Explanation {
         <span class="kw">let </span>fieldnorm_id = <span class="self">self</span>.fieldnorm_id();
         <span class="kw">let </span>term_freq = <span class="self">self</span>.term_freq();
         <span class="self">self</span>.similarity_weight.explain(fieldnorm_id, term_freq)
     }

     <span class="kw">pub fn </span>max_score(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Score {
         <span class="self">self</span>.similarity_weight.max_score()
     }

     <span class="kw">pub fn </span>last_doc_in_block(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; DocId {
         <span class="self">self</span>.postings.block_cursor.skip_reader.last_doc_in_block()
     }
 }

 <span class="kw">impl </span>DocSet <span class="kw">for </span>TermScorer {
     <span class="kw">fn </span>advance(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; DocId {
         <span class="self">self</span>.postings.advance()
     }

     <span class="kw">fn </span>seek(<span class="kw-2">&amp;mut </span><span class="self">self</span>, target: DocId) -&gt; DocId {
         <span class="self">self</span>.postings.seek(target)
     }

     <span class="kw">fn </span>doc(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; DocId {
         <span class="self">self</span>.postings.doc()
     }

     <span class="kw">fn </span>size_hint(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; u32 {
         <span class="self">self</span>.postings.size_hint()
     }
 }

 <span class="kw">impl </span>Scorer <span class="kw">for </span>TermScorer {
     <span class="kw">fn </span>score(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; Score {
         <span class="kw">let </span>fieldnorm_id = <span class="self">self</span>.fieldnorm_id();
         <span class="kw">let </span>term_freq = <span class="self">self</span>.term_freq();
         <span class="self">self</span>.similarity_weight.score(fieldnorm_id, term_freq)
     }
 }

 <span class="attribute">#[cfg(test)]
 </span><span class="kw">mod </span>tests {
     <span class="kw">use </span>proptest::prelude::<span class="kw-2">*</span>;

     <span class="kw">use </span><span class="kw">crate</span>::merge_policy::NoMergePolicy;
     <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>::query::term_query::TermScorer;
     <span class="kw">use </span><span class="kw">crate</span>::query::{Bm25Weight, EnableScoring, Scorer, TermQuery};
     <span class="kw">use </span><span class="kw">crate</span>::schema::{IndexRecordOption, Schema, TEXT};
     <span class="kw">use crate</span>::{
         assert_nearly_equals, DocId, DocSet, Index, Score, Searcher, SegmentId, Term, TERMINATED,
     };

     <span class="attribute">#[test]
     </span><span class="kw">fn </span>test_term_scorer_max_score() -&gt; <span class="kw">crate</span>::Result&lt;()&gt; {
         <span class="kw">let </span>bm25_weight = Bm25Weight::for_one_term(<span class="number">3</span>, <span class="number">6</span>, <span class="number">10.0</span>);
         <span class="kw">let </span><span class="kw-2">mut </span>term_scorer = TermScorer::create_for_test(
             <span class="kw-2">&amp;</span>[(<span class="number">2</span>, <span class="number">3</span>), (<span class="number">3</span>, <span class="number">12</span>), (<span class="number">7</span>, <span class="number">8</span>)],
             <span class="kw-2">&amp;</span>[<span class="number">0</span>, <span class="number">0</span>, <span class="number">10</span>, <span class="number">12</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">100</span>],
             bm25_weight,
         );
         <span class="kw">let </span>max_scorer = term_scorer.max_score();
         <span class="macro">crate::assert_nearly_equals!</span>(max_scorer, <span class="number">1.3990127</span>);
         <span class="macro">assert_eq!</span>(term_scorer.doc(), <span class="number">2</span>);
         <span class="macro">assert_eq!</span>(term_scorer.term_freq(), <span class="number">3</span>);
         <span class="macro">assert_nearly_equals!</span>(term_scorer.block_max_score(), <span class="number">1.3676447</span>);
         <span class="macro">assert_nearly_equals!</span>(term_scorer.score(), <span class="number">1.0892314</span>);
         <span class="macro">assert_eq!</span>(term_scorer.advance(), <span class="number">3</span>);
         <span class="macro">assert_eq!</span>(term_scorer.doc(), <span class="number">3</span>);
         <span class="macro">assert_eq!</span>(term_scorer.term_freq(), <span class="number">12</span>);
         <span class="macro">assert_nearly_equals!</span>(term_scorer.score(), <span class="number">1.3676447</span>);
         <span class="macro">assert_eq!</span>(term_scorer.advance(), <span class="number">7</span>);
         <span class="macro">assert_eq!</span>(term_scorer.doc(), <span class="number">7</span>);
         <span class="macro">assert_eq!</span>(term_scorer.term_freq(), <span class="number">8</span>);
         <span class="macro">assert_nearly_equals!</span>(term_scorer.score(), <span class="number">0.72015285</span>);
         <span class="macro">assert_eq!</span>(term_scorer.advance(), TERMINATED);
         <span class="prelude-val">Ok</span>(())
     }

     <span class="attribute">#[test]
     </span><span class="kw">fn </span>test_term_scorer_shallow_advance() -&gt; <span class="kw">crate</span>::Result&lt;()&gt; {
         <span class="kw">let </span>bm25_weight = Bm25Weight::for_one_term(<span class="number">300</span>, <span class="number">1024</span>, <span class="number">10.0</span>);
         <span class="kw">let </span><span class="kw-2">mut </span>doc_and_tfs = <span class="macro">vec!</span>[];
         <span class="kw">for </span>i <span class="kw">in </span><span class="number">0u32</span>..<span class="number">300u32 </span>{
             <span class="kw">let </span>doc = i * <span class="number">10</span>;
             doc_and_tfs.push((doc, <span class="number">1u32 </span>+ doc % <span class="number">3u32</span>));
         }
         <span class="kw">let </span>fieldnorms: Vec&lt;u32&gt; = std::iter::repeat(<span class="number">10u32</span>).take(<span class="number">3_000</span>).collect();
         <span class="kw">let </span><span class="kw-2">mut </span>term_scorer = TermScorer::create_for_test(<span class="kw-2">&amp;</span>doc_and_tfs, <span class="kw-2">&amp;</span>fieldnorms, bm25_weight);
         <span class="macro">assert_eq!</span>(term_scorer.doc(), <span class="number">0u32</span>);
         term_scorer.shallow_seek(<span class="number">1289</span>);
         <span class="macro">assert_eq!</span>(term_scorer.doc(), <span class="number">0u32</span>);
         term_scorer.seek(<span class="number">1289</span>);
         <span class="macro">assert_eq!</span>(term_scorer.doc(), <span class="number">1290</span>);
         <span class="prelude-val">Ok</span>(())
     }

     <span class="macro">proptest! </span>{
         <span class="attribute">#[test]
         </span><span class="kw">fn </span>test_term_scorer_block_max_score(term_freqs_fieldnorms <span class="kw">in </span>proptest::collection::vec((<span class="number">1u32</span>..<span class="number">10u32</span>, <span class="number">0u32</span>..<span class="number">100u32</span>), <span class="number">80</span>..<span class="number">300</span>)) {
         <span class="kw">let </span>term_doc_freq = term_freqs_fieldnorms.len();
          <span class="kw">let </span>doc_tfs: Vec&lt;(u32, u32)&gt; = term_freqs_fieldnorms.iter()
                    .cloned()
                   .enumerate()
                   .map(|(doc, (tf, <span class="kw">_</span>))| (doc <span class="kw">as </span>u32, tf))
                   .collect();

          <span class="kw">let </span><span class="kw-2">mut </span>fieldnorms: Vec&lt;u32&gt; = <span class="macro">vec!</span>[];
          <span class="kw">for </span>item <span class="kw">in </span>term_freqs_fieldnorms.iter().take(term_doc_freq) {
              <span class="kw">let </span>(tf, num_extra_terms) = item;
              fieldnorms.push(tf + num_extra_terms);
          }
          <span class="kw">let </span>average_fieldnorm = fieldnorms
              .iter()
              .cloned()
              .sum::&lt;u32&gt;() <span class="kw">as </span>Score / term_doc_freq <span class="kw">as </span>Score;
              <span class="comment">// Average fieldnorm is over the entire index,
              // not necessarily the docs that are in the posting list.
              // For this reason we multiply by 1.1 to make a realistic value.
          </span><span class="kw">let </span>bm25_weight = Bm25Weight::for_one_term(term_doc_freq <span class="kw">as </span>u64,
             term_doc_freq <span class="kw">as </span>u64 * <span class="number">10u64</span>,
             average_fieldnorm);

          <span class="kw">let </span><span class="kw-2">mut </span>term_scorer =
               TermScorer::create_for_test(<span class="kw-2">&amp;</span>doc_tfs[..], <span class="kw-2">&amp;</span>fieldnorms[..], bm25_weight);

          <span class="kw">let </span>docs: Vec&lt;DocId&gt; = (<span class="number">0</span>..term_doc_freq).map(|doc| doc <span class="kw">as </span>DocId).collect();
          <span class="kw">for </span>block <span class="kw">in </span>docs.chunks(COMPRESSION_BLOCK_SIZE) {
              <span class="kw">let </span>block_max_score: Score = term_scorer.block_max_score();
              <span class="kw">let </span><span class="kw-2">mut </span>block_max_score_computed: Score = <span class="number">0.0</span>;
              <span class="kw">for </span><span class="kw-2">&amp;</span>doc <span class="kw">in </span>block {
                 <span class="macro">assert_eq!</span>(term_scorer.doc(), doc);
                 block_max_score_computed = block_max_score_computed.max(term_scorer.score());
                 term_scorer.advance();
              }
              <span class="macro">assert_nearly_equals!</span>(block_max_score_computed, block_max_score);
          }
         }
     }

     <span class="attribute">#[test]
     </span><span class="kw">fn </span>test_block_wand() {
         <span class="kw">let </span><span class="kw-2">mut </span>doc_tfs: Vec&lt;(u32, u32)&gt; = <span class="macro">vec!</span>[];
         <span class="kw">for </span>doc <span class="kw">in </span><span class="number">0u32</span>..<span class="number">128u32 </span>{
             doc_tfs.push((doc, <span class="number">1u32</span>));
         }
         <span class="kw">for </span>doc <span class="kw">in </span><span class="number">128u32</span>..<span class="number">256u32 </span>{
             doc_tfs.push((doc, <span class="kw">if </span>doc == <span class="number">200 </span>{ <span class="number">2u32 </span>} <span class="kw">else </span>{ <span class="number">1u32 </span>}));
         }
         doc_tfs.push((<span class="number">256</span>, <span class="number">1u32</span>));
         doc_tfs.push((<span class="number">257</span>, <span class="number">3u32</span>));
         doc_tfs.push((<span class="number">258</span>, <span class="number">1u32</span>));

         <span class="kw">let </span>fieldnorms: Vec&lt;u32&gt; = std::iter::repeat(<span class="number">20u32</span>).take(<span class="number">300</span>).collect();
         <span class="kw">let </span>bm25_weight = Bm25Weight::for_one_term(<span class="number">10</span>, <span class="number">129</span>, <span class="number">20.0</span>);
         <span class="kw">let </span><span class="kw-2">mut </span>docs = TermScorer::create_for_test(<span class="kw-2">&amp;</span>doc_tfs[..], <span class="kw-2">&amp;</span>fieldnorms[..], bm25_weight);
         <span class="macro">assert_nearly_equals!</span>(docs.block_max_score(), <span class="number">2.5161593</span>);
         docs.shallow_seek(<span class="number">135</span>);
         <span class="macro">assert_nearly_equals!</span>(docs.block_max_score(), <span class="number">3.4597192</span>);
         docs.shallow_seek(<span class="number">256</span>);
         <span class="comment">// the block is not loaded yet.
         </span><span class="macro">assert_nearly_equals!</span>(docs.block_max_score(), <span class="number">5.2971773</span>);
         <span class="macro">assert_eq!</span>(<span class="number">256</span>, docs.seek(<span class="number">256</span>));
         <span class="macro">assert_nearly_equals!</span>(docs.block_max_score(), <span class="number">3.9539647</span>);
     }

     <span class="kw">fn </span>test_block_wand_aux(term_query: <span class="kw-2">&amp;</span>TermQuery, searcher: <span class="kw-2">&amp;</span>Searcher) -&gt; <span class="kw">crate</span>::Result&lt;()&gt; {
         <span class="kw">let </span>term_weight = term_query.specialized_weight(EnableScoring::Enabled(searcher))<span class="question-mark">?</span>;
         <span class="kw">for </span>reader <span class="kw">in </span>searcher.segment_readers() {
             <span class="kw">let </span><span class="kw-2">mut </span>block_max_scores = <span class="macro">vec!</span>[];
             <span class="kw">let </span><span class="kw-2">mut </span>block_max_scores_b = <span class="macro">vec!</span>[];
             <span class="kw">let </span><span class="kw-2">mut </span>docs = <span class="macro">vec!</span>[];
             {
                 <span class="kw">let </span><span class="kw-2">mut </span>term_scorer = term_weight.specialized_scorer(reader, <span class="number">1.0</span>)<span class="question-mark">?</span>;
                 <span class="kw">while </span>term_scorer.doc() != TERMINATED {
                     <span class="kw">let </span><span class="kw-2">mut </span>score = term_scorer.score();
                     docs.push(term_scorer.doc());
                     <span class="kw">for _ in </span><span class="number">0</span>..<span class="number">128 </span>{
                         score = score.max(term_scorer.score());
                         <span class="kw">if </span>term_scorer.advance() == TERMINATED {
                             <span class="kw">break</span>;
                         }
                     }
                     block_max_scores.push(score);
                 }
             }
             {
                 <span class="kw">let </span><span class="kw-2">mut </span>term_scorer = term_weight.specialized_scorer(reader, <span class="number">1.0</span>)<span class="question-mark">?</span>;
                 <span class="kw">for </span>d <span class="kw">in </span>docs {
                     term_scorer.shallow_seek(d);
                     block_max_scores_b.push(term_scorer.block_max_score());
                 }
             }
             <span class="kw">for </span>(l, r) <span class="kw">in </span>block_max_scores
                 .iter()
                 .cloned()
                 .zip(block_max_scores_b.iter().cloned())
             {
                 <span class="macro">assert_nearly_equals!</span>(l, r);
             }
         }
         <span class="prelude-val">Ok</span>(())
     }

     <span class="attribute">#[ignore]
     #[test]
     </span><span class="kw">fn </span>test_block_wand_long_test() -&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>text_field = schema_builder.add_text_field(<span class="string">&quot;text&quot;</span>, TEXT);
         <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>writer = index.writer_with_num_threads(<span class="number">3</span>, <span class="number">30_000_000</span>)<span class="question-mark">?</span>;
         <span class="kw">use </span>rand::Rng;
         <span class="kw">let </span><span class="kw-2">mut </span>rng = rand::thread_rng();
         writer.set_merge_policy(Box::new(NoMergePolicy));
         <span class="kw">for _ in </span><span class="number">0</span>..<span class="number">3_000 </span>{
             <span class="kw">let </span>term_freq = rng.gen_range(<span class="number">1</span>..<span class="number">10000</span>);
             <span class="kw">let </span>words: Vec&lt;<span class="kw-2">&amp;</span>str&gt; = std::iter::repeat(<span class="string">&quot;bbbb&quot;</span>).take(term_freq).collect();
             <span class="kw">let </span>text = words.join(<span class="string">&quot; &quot;</span>);
             writer.add_document(<span class="macro">doc!</span>(text_field=&gt;text))<span class="question-mark">?</span>;
         }
         writer.commit()<span class="question-mark">?</span>;
         <span class="kw">let </span>term_query = TermQuery::new(
             Term::from_field_text(text_field, <span class="string">&quot;bbbb&quot;</span>),
             IndexRecordOption::WithFreqs,
         );
         <span class="kw">let </span>segment_ids: Vec&lt;SegmentId&gt;;
         <span class="kw">let </span>reader = index.reader()<span class="question-mark">?</span>;
         {
             <span class="kw">let </span>searcher = reader.searcher();
             segment_ids = searcher
                 .segment_readers()
                 .iter()
                 .map(|segment| segment.segment_id())
                 .collect();
             test_block_wand_aux(<span class="kw-2">&amp;</span>term_query, <span class="kw-2">&amp;</span>searcher)<span class="question-mark">?</span>;
         }
         writer.merge(<span class="kw-2">&amp;</span>segment_ids[..]).wait().unwrap();
         {
             reader.reload()<span class="question-mark">?</span>;
             <span class="kw">let </span>searcher = reader.searcher();
             <span class="macro">assert_eq!</span>(searcher.segment_readers().len(), <span class="number">1</span>);
             test_block_wand_aux(<span class="kw-2">&amp;</span>term_query, <span class="kw-2">&amp;</span>searcher)<span class="question-mark">?</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>