| <!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/custom_score_top_collector.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>custom_score_top_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> |
| </pre><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::collector::top_collector::{TopCollector, TopSegmentCollector}; |
| <span class="kw">use </span><span class="kw">crate</span>::collector::{Collector, SegmentCollector}; |
| <span class="kw">use crate</span>::{DocAddress, DocId, Score, SegmentReader}; |
| |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>CustomScoreTopCollector<TCustomScorer, TScore = Score> { |
| custom_scorer: TCustomScorer, |
| collector: TopCollector<TScore>, |
| } |
| |
| <span class="kw">impl</span><TCustomScorer, TScore> CustomScoreTopCollector<TCustomScorer, TScore> |
| <span class="kw">where </span>TScore: Clone + PartialOrd |
| { |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new( |
| custom_scorer: TCustomScorer, |
| collector: TopCollector<TScore>, |
| ) -> CustomScoreTopCollector<TCustomScorer, TScore> { |
| CustomScoreTopCollector { |
| custom_scorer, |
| collector, |
| } |
| } |
| } |
| |
| <span class="doccomment">/// A custom segment scorer makes it possible to define any kind of score |
| /// for a given document belonging to a specific segment. |
| /// |
| /// It is the segment local version of the [`CustomScorer`]. |
| </span><span class="kw">pub trait </span>CustomSegmentScorer<TScore>: <span class="lifetime">'static </span>{ |
| <span class="doccomment">/// Computes the score of a specific `doc`. |
| </span><span class="kw">fn </span>score(<span class="kw-2">&mut </span><span class="self">self</span>, doc: DocId) -> TScore; |
| } |
| |
| <span class="doccomment">/// `CustomScorer` makes it possible to define any kind of score. |
| /// |
| /// The `CustomerScorer` itself does not make much of the computation itself. |
| /// Instead, it helps constructing `Self::Child` instances that will compute |
| /// the score at a segment scale. |
| </span><span class="kw">pub trait </span>CustomScorer<TScore>: Sync { |
| <span class="doccomment">/// Type of the associated [`CustomSegmentScorer`]. |
| </span><span class="kw">type </span>Child: CustomSegmentScorer<TScore>; |
| <span class="doccomment">/// Builds a child scorer for a specific segment. The child scorer is associated with |
| /// a specific segment. |
| </span><span class="kw">fn </span>segment_scorer(<span class="kw-2">&</span><span class="self">self</span>, segment_reader: <span class="kw-2">&</span>SegmentReader) -> <span class="kw">crate</span>::Result<<span class="self">Self</span>::Child>; |
| } |
| |
| <span class="kw">impl</span><TCustomScorer, TScore> Collector <span class="kw">for </span>CustomScoreTopCollector<TCustomScorer, TScore> |
| <span class="kw">where |
| </span>TCustomScorer: CustomScorer<TScore> + Send + Sync, |
| TScore: <span class="lifetime">'static </span>+ PartialOrd + Clone + Send + Sync, |
| { |
| <span class="kw">type </span>Fruit = Vec<(TScore, DocAddress)>; |
| |
| <span class="kw">type </span>Child = CustomScoreTopSegmentCollector<TCustomScorer::Child, TScore>; |
| |
| <span class="kw">fn </span>for_segment( |
| <span class="kw-2">&</span><span class="self">self</span>, |
| segment_local_id: u32, |
| segment_reader: <span class="kw-2">&</span>SegmentReader, |
| ) -> <span class="kw">crate</span>::Result<<span class="self">Self</span>::Child> { |
| <span class="kw">let </span>segment_collector = <span class="self">self</span>.collector.for_segment(segment_local_id, segment_reader); |
| <span class="kw">let </span>segment_scorer = <span class="self">self</span>.custom_scorer.segment_scorer(segment_reader)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(CustomScoreTopSegmentCollector { |
| segment_collector, |
| segment_scorer, |
| }) |
| } |
| |
| <span class="kw">fn </span>requires_scoring(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="bool-val">false |
| </span>} |
| |
| <span class="kw">fn </span>merge_fruits(<span class="kw-2">&</span><span class="self">self</span>, segment_fruits: Vec<<span class="self">Self</span>::Fruit>) -> <span class="kw">crate</span>::Result<<span class="self">Self</span>::Fruit> { |
| <span class="self">self</span>.collector.merge_fruits(segment_fruits) |
| } |
| } |
| |
| <span class="kw">pub struct </span>CustomScoreTopSegmentCollector<T, TScore> |
| <span class="kw">where |
| </span>TScore: <span class="lifetime">'static </span>+ PartialOrd + Clone + Send + Sync + Sized, |
| T: CustomSegmentScorer<TScore>, |
| { |
| segment_collector: TopSegmentCollector<TScore>, |
| segment_scorer: T, |
| } |
| |
| <span class="kw">impl</span><T, TScore> SegmentCollector <span class="kw">for </span>CustomScoreTopSegmentCollector<T, TScore> |
| <span class="kw">where |
| </span>TScore: <span class="lifetime">'static </span>+ PartialOrd + Clone + Send + Sync, |
| T: <span class="lifetime">'static </span>+ CustomSegmentScorer<TScore>, |
| { |
| <span class="kw">type </span>Fruit = Vec<(TScore, DocAddress)>; |
| |
| <span class="kw">fn </span>collect(<span class="kw-2">&mut </span><span class="self">self</span>, doc: DocId, _score: Score) { |
| <span class="kw">let </span>score = <span class="self">self</span>.segment_scorer.score(doc); |
| <span class="self">self</span>.segment_collector.collect(doc, score); |
| } |
| |
| <span class="kw">fn </span>harvest(<span class="self">self</span>) -> Vec<(TScore, DocAddress)> { |
| <span class="self">self</span>.segment_collector.harvest() |
| } |
| } |
| |
| <span class="kw">impl</span><F, TScore, T> CustomScorer<TScore> <span class="kw">for </span>F |
| <span class="kw">where |
| </span>F: <span class="lifetime">'static </span>+ Send + Sync + Fn(<span class="kw-2">&</span>SegmentReader) -> T, |
| T: CustomSegmentScorer<TScore>, |
| { |
| <span class="kw">type </span>Child = T; |
| |
| <span class="kw">fn </span>segment_scorer(<span class="kw-2">&</span><span class="self">self</span>, segment_reader: <span class="kw-2">&</span>SegmentReader) -> <span class="kw">crate</span>::Result<<span class="self">Self</span>::Child> { |
| <span class="prelude-val">Ok</span>((<span class="self">self</span>)(segment_reader)) |
| } |
| } |
| |
| <span class="kw">impl</span><F, TScore> CustomSegmentScorer<TScore> <span class="kw">for </span>F |
| <span class="kw">where </span>F: <span class="lifetime">'static </span>+ FnMut(DocId) -> TScore |
| { |
| <span class="kw">fn </span>score(<span class="kw-2">&mut </span><span class="self">self</span>, doc: DocId) -> TScore { |
| (<span class="self">self</span>)(doc) |
| } |
| } |
| </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> |
