Google Git
Sign in
apache / incubator-teaclave-website / refs/heads/asf-site / . / api-docs / crates-enclave / src / tantivy / collector / histogram_collector.rs.html
blob: 1599f2576ee6f5a48bd67dd3a554b266cf545071 [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/collector/histogram_collector.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>histogram_collector.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>
</pre><pre class="rust"><code><span class="kw">use </span>std::sync::Arc;
<span class="kw">use </span>fastdivide::DividerU64;
<span class="kw">use </span>fastfield_codecs::Column;
<span class="kw">use </span><span class="kw">crate</span>::collector::{Collector, SegmentCollector};
<span class="kw">use </span><span class="kw">crate</span>::fastfield::FastValue;
<span class="kw">use </span><span class="kw">crate</span>::schema::{Field, Type};
<span class="kw">use crate</span>::{DocId, Score};
<span class="doccomment">/// Histogram builds an histogram of the values of a fastfield for the
/// collected DocSet.
///
/// At construction, it is given parameters that define a partition of an interval
/// [min_val, max_val) into N buckets with the same width.
/// The ith bucket is then defined by `[min_val + i * bucket_width, min_val + (i+1) * bucket_width)`
///
/// An histogram is then defined as a `Vec&lt;u64&gt;` of length `num_buckets`, that contains a count of
/// documents for each value bucket.
///
/// See also [`HistogramCollector::new()`].
///
/// # Warning
///
/// f64 fields are not supported.
</span><span class="attribute">#[derive(Clone)]
</span><span class="kw">pub struct </span>HistogramCollector {
min_value: u64,
num_buckets: usize,
divider: DividerU64,
field: Field,
}
<span class="kw">impl </span>HistogramCollector {
<span class="doccomment">/// Builds a new HistogramCollector.
///
/// The scale/range of the histogram is not dynamic. It is required to
/// define it by supplying following parameter:
/// - `min_value`: the minimum value that can be recorded in the histogram.
/// - `bucket_width`: the length of the interval that is associated with each buckets.
/// - `num_buckets`: The overall number of buckets.
///
/// Together, this parameters define a partition of `[min_value, min_value + num_buckets *
/// bucket_width)` into `num_buckets` intervals of width bucket that we call `bucket`.
///
/// # Disclaimer
/// This function panics if the field given is of type f64.
</span><span class="kw">pub fn </span>new&lt;TFastValue: FastValue&gt;(
field: Field,
min_value: TFastValue,
bucket_width: u64,
num_buckets: usize,
) -&gt; HistogramCollector {
<span class="kw">let </span>fast_type = TFastValue::to_type();
<span class="macro">assert!</span>(fast_type == Type::U64 || fast_type == Type::I64 || fast_type == Type::Date);
HistogramCollector {
min_value: min_value.to_u64(),
num_buckets,
field,
divider: DividerU64::divide_by(bucket_width),
}
}
}
<span class="kw">struct </span>HistogramComputer {
counts: Vec&lt;u64&gt;,
min_value: u64,
divider: DividerU64,
}
<span class="kw">impl </span>HistogramComputer {
<span class="attribute">#[inline]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>add_value(<span class="kw-2">&amp;mut </span><span class="self">self</span>, value: u64) {
<span class="kw">if </span>value &lt; <span class="self">self</span>.min_value {
<span class="kw">return</span>;
}
<span class="kw">let </span>delta = value - <span class="self">self</span>.min_value;
<span class="kw">let </span>bucket_id: usize = <span class="self">self</span>.divider.divide(delta) <span class="kw">as </span>usize;
<span class="kw">if </span>bucket_id &lt; <span class="self">self</span>.counts.len() {
<span class="self">self</span>.counts[bucket_id] += <span class="number">1</span>;
}
}
<span class="kw">fn </span>harvest(<span class="self">self</span>) -&gt; Vec&lt;u64&gt; {
<span class="self">self</span>.counts
}
}
<span class="kw">pub struct </span>SegmentHistogramCollector {
histogram_computer: HistogramComputer,
ff_reader: Arc&lt;<span class="kw">dyn </span>Column&lt;u64&gt;&gt;,
}
<span class="kw">impl </span>SegmentCollector <span class="kw">for </span>SegmentHistogramCollector {
<span class="kw">type </span>Fruit = Vec&lt;u64&gt;;
<span class="kw">fn </span>collect(<span class="kw-2">&amp;mut </span><span class="self">self</span>, doc: DocId, _score: Score) {
<span class="kw">let </span>value = <span class="self">self</span>.ff_reader.get_val(doc);
<span class="self">self</span>.histogram_computer.add_value(value);
}
<span class="kw">fn </span>harvest(<span class="self">self</span>) -&gt; <span class="self">Self</span>::Fruit {
<span class="self">self</span>.histogram_computer.harvest()
}
}
<span class="kw">impl </span>Collector <span class="kw">for </span>HistogramCollector {
<span class="kw">type </span>Fruit = Vec&lt;u64&gt;;
<span class="kw">type </span>Child = SegmentHistogramCollector;
<span class="kw">fn </span>for_segment(
<span class="kw-2">&amp;</span><span class="self">self</span>,
_segment_local_id: <span class="kw">crate</span>::SegmentOrdinal,
segment: <span class="kw-2">&amp;</span><span class="kw">crate</span>::SegmentReader,
) -&gt; <span class="kw">crate</span>::Result&lt;<span class="self">Self</span>::Child&gt; {
<span class="kw">let </span>ff_reader = segment.fast_fields().u64_lenient(<span class="self">self</span>.field)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(SegmentHistogramCollector {
histogram_computer: HistogramComputer {
counts: <span class="macro">vec!</span>[<span class="number">0</span>; <span class="self">self</span>.num_buckets],
min_value: <span class="self">self</span>.min_value,
divider: <span class="self">self</span>.divider,
},
ff_reader,
})
}
<span class="kw">fn </span>requires_scoring(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="bool-val">false
</span>}
<span class="kw">fn </span>merge_fruits(<span class="kw-2">&amp;</span><span class="self">self</span>, child_histograms: Vec&lt;Vec&lt;u64&gt;&gt;) -&gt; <span class="kw">crate</span>::Result&lt;Vec&lt;u64&gt;&gt; {
<span class="prelude-val">Ok</span>(add_vecs(child_histograms, <span class="self">self</span>.num_buckets))
}
}
<span class="kw">pub fn </span>add_arrays_into(acc: <span class="kw-2">&amp;mut </span>[u64], add: <span class="kw-2">&amp;</span>[u64]) {
<span class="macro">assert_eq!</span>(acc.len(), add.len());
<span class="kw">for </span>(dest_bucket, bucket_count) <span class="kw">in </span>acc.iter_mut().zip(add) {
<span class="kw-2">*</span>dest_bucket += bucket_count;
}
}
<span class="kw">fn </span>add_vecs(<span class="kw-2">mut </span>vals_list: Vec&lt;Vec&lt;u64&gt;&gt;, len: usize) -&gt; Vec&lt;u64&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>acc = vals_list.pop().unwrap_or_else(|| <span class="macro">vec!</span>[<span class="number">0u64</span>; len]);
<span class="macro">assert_eq!</span>(acc.len(), len);
<span class="kw">for </span>vals <span class="kw">in </span>vals_list {
add_arrays_into(<span class="kw-2">&amp;mut </span>acc, <span class="kw-2">&amp;</span>vals);
}
acc
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use </span>fastdivide::DividerU64;
<span class="kw">use </span>query::AllQuery;
<span class="kw">use super</span>::{add_vecs, HistogramCollector, HistogramComputer};
<span class="kw">use </span><span class="kw">crate</span>::schema::{Schema, FAST};
<span class="kw">use </span><span class="kw">crate</span>::time::{Date, Month};
<span class="kw">use crate</span>::{doc, query, DateTime, Index};
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_add_histograms_simple() {
<span class="macro">assert_eq!</span>(
add_vecs(<span class="macro">vec!</span>[<span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">0</span>, <span class="number">3</span>], <span class="macro">vec!</span>[<span class="number">11</span>, <span class="number">2</span>, <span class="number">3</span>], <span class="macro">vec!</span>[<span class="number">0</span>, <span class="number">0</span>, <span class="number">1</span>]], <span class="number">3</span>),
<span class="macro">vec!</span>[<span class="number">12</span>, <span class="number">2</span>, <span class="number">7</span>]
)
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_add_histograms_empty() {
<span class="macro">assert_eq!</span>(add_vecs(<span class="macro">vec!</span>[], <span class="number">3</span>), <span class="macro">vec!</span>[<span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>])
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_histogram_builder_simple() {
<span class="comment">// [1..3)
// [3..5)
// ..
// [9..11)
</span><span class="kw">let </span><span class="kw-2">mut </span>histogram_computer = HistogramComputer {
counts: <span class="macro">vec!</span>[<span class="number">0</span>; <span class="number">5</span>],
min_value: <span class="number">1</span>,
divider: DividerU64::divide_by(<span class="number">2</span>),
};
histogram_computer.add_value(<span class="number">1</span>);
histogram_computer.add_value(<span class="number">7</span>);
<span class="macro">assert_eq!</span>(histogram_computer.harvest(), <span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">1</span>, <span class="number">0</span>]);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_histogram_too_low_is_ignored() {
<span class="kw">let </span><span class="kw-2">mut </span>histogram_computer = HistogramComputer {
counts: <span class="macro">vec!</span>[<span class="number">0</span>; <span class="number">5</span>],
min_value: <span class="number">2</span>,
divider: DividerU64::divide_by(<span class="number">2</span>),
};
histogram_computer.add_value(<span class="number">0</span>);
<span class="macro">assert_eq!</span>(histogram_computer.harvest(), <span class="macro">vec!</span>[<span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>]);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_histogram_too_high_is_ignored() {
<span class="kw">let </span><span class="kw-2">mut </span>histogram_computer = HistogramComputer {
counts: <span class="macro">vec!</span>[<span class="number">0u64</span>; <span class="number">5</span>],
min_value: <span class="number">0</span>,
divider: DividerU64::divide_by(<span class="number">2</span>),
};
histogram_computer.add_value(<span class="number">10</span>);
<span class="macro">assert_eq!</span>(histogram_computer.harvest(), <span class="macro">vec!</span>[<span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>]);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_no_segments() -&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>val_field = schema_builder.add_u64_field(<span class="string">&quot;val_field&quot;</span>, FAST);
<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>reader = index.reader()<span class="question-mark">?</span>;
<span class="kw">let </span>searcher = reader.searcher();
<span class="kw">let </span>all_query = AllQuery;
<span class="kw">let </span>histogram_collector = HistogramCollector::new(val_field, <span class="number">0u64</span>, <span class="number">2</span>, <span class="number">5</span>);
<span class="kw">let </span>histogram = searcher.search(<span class="kw-2">&amp;</span>all_query, <span class="kw-2">&amp;</span>histogram_collector)<span class="question-mark">?</span>;
<span class="macro">assert_eq!</span>(histogram, <span class="macro">vec!</span>[<span class="number">0</span>; <span class="number">5</span>]);
<span class="prelude-val">Ok</span>(())
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_histogram_i64() -&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>val_field = schema_builder.add_i64_field(<span class="string">&quot;val_field&quot;</span>, FAST);
<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">1</span>, <span class="number">4_000_000</span>)<span class="question-mark">?</span>;
writer.add_document(<span class="macro">doc!</span>(val_field=&gt;<span class="number">12i64</span>))<span class="question-mark">?</span>;
writer.add_document(<span class="macro">doc!</span>(val_field=&gt;-<span class="number">30i64</span>))<span class="question-mark">?</span>;
writer.add_document(<span class="macro">doc!</span>(val_field=&gt;-<span class="number">12i64</span>))<span class="question-mark">?</span>;
writer.add_document(<span class="macro">doc!</span>(val_field=&gt;-<span class="number">10i64</span>))<span class="question-mark">?</span>;
writer.commit()<span class="question-mark">?</span>;
<span class="kw">let </span>reader = index.reader()<span class="question-mark">?</span>;
<span class="kw">let </span>searcher = reader.searcher();
<span class="kw">let </span>all_query = AllQuery;
<span class="kw">let </span>histogram_collector = HistogramCollector::new(val_field, -<span class="number">20i64</span>, <span class="number">10u64</span>, <span class="number">4</span>);
<span class="kw">let </span>histogram = searcher.search(<span class="kw-2">&amp;</span>all_query, <span class="kw-2">&amp;</span>histogram_collector)<span class="question-mark">?</span>;
<span class="macro">assert_eq!</span>(histogram, <span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">1</span>, <span class="number">0</span>, <span class="number">1</span>]);
<span class="prelude-val">Ok</span>(())
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_histogram_merge() -&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>val_field = schema_builder.add_i64_field(<span class="string">&quot;val_field&quot;</span>, FAST);
<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">1</span>, <span class="number">4_000_000</span>)<span class="question-mark">?</span>;
writer.add_document(<span class="macro">doc!</span>(val_field=&gt;<span class="number">12i64</span>))<span class="question-mark">?</span>;
writer.commit()<span class="question-mark">?</span>;
writer.add_document(<span class="macro">doc!</span>(val_field=&gt;-<span class="number">30i64</span>))<span class="question-mark">?</span>;
writer.commit()<span class="question-mark">?</span>;
writer.add_document(<span class="macro">doc!</span>(val_field=&gt;-<span class="number">12i64</span>))<span class="question-mark">?</span>;
writer.commit()<span class="question-mark">?</span>;
writer.add_document(<span class="macro">doc!</span>(val_field=&gt;-<span class="number">10i64</span>))<span class="question-mark">?</span>;
writer.commit()<span class="question-mark">?</span>;
<span class="kw">let </span>reader = index.reader()<span class="question-mark">?</span>;
<span class="kw">let </span>searcher = reader.searcher();
<span class="kw">let </span>all_query = AllQuery;
<span class="kw">let </span>histogram_collector = HistogramCollector::new(val_field, -<span class="number">20i64</span>, <span class="number">10u64</span>, <span class="number">4</span>);
<span class="kw">let </span>histogram = searcher.search(<span class="kw-2">&amp;</span>all_query, <span class="kw-2">&amp;</span>histogram_collector)<span class="question-mark">?</span>;
<span class="macro">assert_eq!</span>(histogram, <span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">1</span>, <span class="number">0</span>, <span class="number">1</span>]);
<span class="prelude-val">Ok</span>(())
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_histogram_dates() -&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>date_field = schema_builder.add_date_field(<span class="string">&quot;date_field&quot;</span>, FAST);
<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">1</span>, <span class="number">4_000_000</span>)<span class="question-mark">?</span>;
writer.add_document(<span class="macro">doc!</span>(date_field=&gt;DateTime::from_primitive(Date::from_calendar_date(<span class="number">1982</span>, Month::September, <span class="number">17</span>)<span class="question-mark">?</span>.with_hms(<span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>)<span class="question-mark">?</span>)))<span class="question-mark">?</span>;
writer.add_document(
<span class="macro">doc!</span>(date_field=&gt;DateTime::from_primitive(Date::from_calendar_date(<span class="number">1986</span>, Month::March, <span class="number">9</span>)<span class="question-mark">?</span>.with_hms(<span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>)<span class="question-mark">?</span>)),
)<span class="question-mark">?</span>;
writer.add_document(<span class="macro">doc!</span>(date_field=&gt;DateTime::from_primitive(Date::from_calendar_date(<span class="number">1983</span>, Month::September, <span class="number">27</span>)<span class="question-mark">?</span>.with_hms(<span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>)<span class="question-mark">?</span>)))<span class="question-mark">?</span>;
writer.commit()<span class="question-mark">?</span>;
<span class="kw">let </span>reader = index.reader()<span class="question-mark">?</span>;
<span class="kw">let </span>searcher = reader.searcher();
<span class="kw">let </span>all_query = AllQuery;
<span class="kw">let </span>week_histogram_collector = HistogramCollector::new(
date_field,
DateTime::from_primitive(
Date::from_calendar_date(<span class="number">1980</span>, Month::January, <span class="number">1</span>)<span class="question-mark">?</span>.with_hms(<span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>)<span class="question-mark">?</span>,
),
<span class="number">3_600_000_000 </span>* <span class="number">24 </span>* <span class="number">365</span>, <span class="comment">// it is just for a unit test... sorry leap years.
</span><span class="number">10</span>,
);
<span class="kw">let </span>week_histogram = searcher.search(<span class="kw-2">&amp;</span>all_query, <span class="kw-2">&amp;</span>week_histogram_collector)<span class="question-mark">?</span>;
<span class="macro">assert_eq!</span>(week_histogram, <span class="macro">vec!</span>[<span class="number">0</span>, <span class="number">0</span>, <span class="number">1</span>, <span class="number">1</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">1</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</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>