| <!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/aggregation/metric/average.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>average.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> |
| </pre><pre class="rust"><code><span class="kw">use </span>std::fmt::Debug; |
| |
| <span class="kw">use </span>fastfield_codecs::Column; |
| <span class="kw">use </span>serde::{Deserialize, Serialize}; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::aggregation::f64_from_fastfield_u64; |
| <span class="kw">use </span><span class="kw">crate</span>::schema::Type; |
| <span class="kw">use </span><span class="kw">crate</span>::DocId; |
| |
| <span class="attribute">#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)] |
| </span><span class="doccomment">/// A single-value metric aggregation that computes the average of numeric values that are |
| /// extracted from the aggregated documents. |
| /// Supported field types are u64, i64, and f64. |
| /// See [super::SingleMetricResult] for return value. |
| /// |
| /// # JSON Format |
| /// ```json |
| /// { |
| /// "avg": { |
| /// "field": "score", |
| /// } |
| /// } |
| /// ``` |
| </span><span class="kw">pub struct </span>AverageAggregation { |
| <span class="doccomment">/// The field name to compute the stats on. |
| </span><span class="kw">pub </span>field: String, |
| } |
| <span class="kw">impl </span>AverageAggregation { |
| <span class="doccomment">/// Create new AverageAggregation from a field. |
| </span><span class="kw">pub fn </span>from_field_name(field_name: String) -> <span class="self">Self </span>{ |
| AverageAggregation { field: field_name } |
| } |
| <span class="doccomment">/// Return the field name. |
| </span><span class="kw">pub fn </span>field_name(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>str { |
| <span class="kw-2">&</span><span class="self">self</span>.field |
| } |
| } |
| |
| <span class="attribute">#[derive(Clone, PartialEq)] |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>SegmentAverageCollector { |
| <span class="kw">pub </span>data: IntermediateAverage, |
| field_type: Type, |
| } |
| |
| <span class="kw">impl </span>Debug <span class="kw">for </span>SegmentAverageCollector { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>std::fmt::Formatter<<span class="lifetime">'_</span>>) -> std::fmt::Result { |
| f.debug_struct(<span class="string">"AverageCollector"</span>) |
| .field(<span class="string">"data"</span>, <span class="kw-2">&</span><span class="self">self</span>.data) |
| .finish() |
| } |
| } |
| |
| <span class="kw">impl </span>SegmentAverageCollector { |
| <span class="kw">pub fn </span>from_req(field_type: Type) -> <span class="self">Self </span>{ |
| <span class="self">Self </span>{ |
| field_type, |
| data: Default::default(), |
| } |
| } |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>collect_block(<span class="kw-2">&mut </span><span class="self">self</span>, doc: <span class="kw-2">&</span>[DocId], field: <span class="kw-2">&</span><span class="kw">dyn </span>Column<u64>) { |
| <span class="kw">let </span><span class="kw-2">mut </span>iter = doc.chunks_exact(<span class="number">4</span>); |
| <span class="kw">for </span>docs <span class="kw">in </span>iter.by_ref() { |
| <span class="kw">let </span>val1 = field.get_val(docs[<span class="number">0</span>]); |
| <span class="kw">let </span>val2 = field.get_val(docs[<span class="number">1</span>]); |
| <span class="kw">let </span>val3 = field.get_val(docs[<span class="number">2</span>]); |
| <span class="kw">let </span>val4 = field.get_val(docs[<span class="number">3</span>]); |
| <span class="kw">let </span>val1 = f64_from_fastfield_u64(val1, <span class="kw-2">&</span><span class="self">self</span>.field_type); |
| <span class="kw">let </span>val2 = f64_from_fastfield_u64(val2, <span class="kw-2">&</span><span class="self">self</span>.field_type); |
| <span class="kw">let </span>val3 = f64_from_fastfield_u64(val3, <span class="kw-2">&</span><span class="self">self</span>.field_type); |
| <span class="kw">let </span>val4 = f64_from_fastfield_u64(val4, <span class="kw-2">&</span><span class="self">self</span>.field_type); |
| <span class="self">self</span>.data.collect(val1); |
| <span class="self">self</span>.data.collect(val2); |
| <span class="self">self</span>.data.collect(val3); |
| <span class="self">self</span>.data.collect(val4); |
| } |
| <span class="kw">for </span><span class="kw-2">&</span>doc <span class="kw">in </span>iter.remainder() { |
| <span class="kw">let </span>val = field.get_val(doc); |
| <span class="kw">let </span>val = f64_from_fastfield_u64(val, <span class="kw-2">&</span><span class="self">self</span>.field_type); |
| <span class="self">self</span>.data.collect(val); |
| } |
| } |
| } |
| |
| <span class="doccomment">/// Contains mergeable version of average data. |
| </span><span class="attribute">#[derive(Default, Clone, Debug, PartialEq, Serialize, Deserialize)] |
| </span><span class="kw">pub struct </span>IntermediateAverage { |
| <span class="kw">pub</span>(<span class="kw">crate</span>) sum: f64, |
| <span class="kw">pub</span>(<span class="kw">crate</span>) doc_count: u64, |
| } |
| |
| <span class="kw">impl </span>IntermediateAverage { |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>from_collector(collector: SegmentAverageCollector) -> <span class="self">Self </span>{ |
| collector.data |
| } |
| |
| <span class="doccomment">/// Merge average data into this instance. |
| </span><span class="kw">pub fn </span>merge_fruits(<span class="kw-2">&mut </span><span class="self">self</span>, other: IntermediateAverage) { |
| <span class="self">self</span>.sum += other.sum; |
| <span class="self">self</span>.doc_count += other.doc_count; |
| } |
| <span class="doccomment">/// compute final result |
| </span><span class="kw">pub fn </span>finalize(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><f64> { |
| <span class="kw">if </span><span class="self">self</span>.doc_count == <span class="number">0 </span>{ |
| <span class="prelude-val">None |
| </span>} <span class="kw">else </span>{ |
| <span class="prelude-val">Some</span>(<span class="self">self</span>.sum / <span class="self">self</span>.doc_count <span class="kw">as </span>f64) |
| } |
| } |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>collect(<span class="kw-2">&mut </span><span class="self">self</span>, val: f64) { |
| <span class="self">self</span>.doc_count += <span class="number">1</span>; |
| <span class="self">self</span>.sum += val; |
| } |
| } |
| </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> |
