| <!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/disjunction_max_query.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>disjunction_max_query.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> |
| </pre><pre class="rust"><code><span class="kw">use </span>tantivy_query_grammar::Occur; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::query::{BooleanWeight, DisjunctionMaxCombiner, EnableScoring, Query, Weight}; |
| <span class="kw">use crate</span>::{Score, Term}; |
| |
| <span class="doccomment">/// The disjunction max query кeturns documents matching one or more wrapped queries, |
| /// called query clauses or clauses. |
| /// |
| /// If a returned document matches multiple query clauses, |
| /// the `DisjunctionMaxQuery` assigns the document the highest relevance score from any matching |
| /// clause, plus a tie breaking increment for any additional matching subqueries. |
| /// |
| /// ```rust |
| /// use tantivy::collector::TopDocs; |
| /// use tantivy::doc; |
| /// use tantivy::query::{DisjunctionMaxQuery, Query, QueryClone, TermQuery}; |
| /// use tantivy::schema::{IndexRecordOption, Schema, TEXT}; |
| /// use tantivy::Term; |
| /// use tantivy::Index; |
| /// |
| /// fn main() -> tantivy::Result<()> { |
| /// let mut schema_builder = Schema::builder(); |
| /// let title = schema_builder.add_text_field("title", TEXT); |
| /// let body = schema_builder.add_text_field("body", TEXT); |
| /// let schema = schema_builder.build(); |
| /// let index = Index::create_in_ram(schema); |
| /// { |
| /// let mut index_writer = index.writer(3_000_000)?; |
| /// index_writer.add_document(doc!( |
| /// title => "The Name of Girl", |
| /// ))?; |
| /// index_writer.add_document(doc!( |
| /// title => "The Diary of Muadib", |
| /// ))?; |
| /// index_writer.add_document(doc!( |
| /// title => "The Diary of Girl", |
| /// ))?; |
| /// index_writer.commit()?; |
| /// } |
| /// |
| /// let reader = index.reader()?; |
| /// let searcher = reader.searcher(); |
| /// |
| /// // Make TermQuery's for "girl" and "diary" in the title |
| /// let girl_term_query: Box<dyn Query> = Box::new(TermQuery::new( |
| /// Term::from_field_text(title, "girl"), |
| /// IndexRecordOption::Basic, |
| /// )); |
| /// let diary_term_query: Box<dyn Query> = Box::new(TermQuery::new( |
| /// Term::from_field_text(title, "diary"), |
| /// IndexRecordOption::Basic, |
| /// )); |
| /// |
| /// // TermQuery "diary" and "girl" should be present and only one should be accounted in score |
| /// let queries1 = vec![diary_term_query.box_clone(), girl_term_query.box_clone()]; |
| /// let diary_and_girl = DisjunctionMaxQuery::new(queries1); |
| /// let documents = searcher.search(&diary_and_girl, &TopDocs::with_limit(3))?; |
| /// assert_eq!(documents[0].0, documents[1].0); |
| /// assert_eq!(documents[1].0, documents[2].0); |
| /// |
| /// // TermQuery "diary" and "girl" should be present |
| /// // and one should be accounted with multiplier 0.7 |
| /// let queries2 = vec![diary_term_query.box_clone(), girl_term_query.box_clone()]; |
| /// let tie_breaker = 0.7; |
| /// let diary_and_girl_with_tie_breaker = DisjunctionMaxQuery::with_tie_breaker(queries2, tie_breaker); |
| /// let documents = searcher.search(&diary_and_girl_with_tie_breaker, &TopDocs::with_limit(3))?; |
| /// assert_eq!(documents[1].0, documents[2].0); |
| /// // For this test all terms brings the same score. So we can do easy math and assume that |
| /// // `DisjunctionMaxQuery` with tie breakers score should be equal |
| /// // to term1 score + `tie_breaker` * term2 score or (1.0 + tie_breaker) * term score |
| /// assert!(f32::abs(documents[0].0 - documents[1].0 * (1.0 + tie_breaker)) < 0.001); |
| /// Ok(()) |
| /// } |
| /// ``` |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub struct </span>DisjunctionMaxQuery { |
| disjuncts: Vec<Box<<span class="kw">dyn </span>Query>>, |
| tie_breaker: Score, |
| } |
| |
| <span class="kw">impl </span>Clone <span class="kw">for </span>DisjunctionMaxQuery { |
| <span class="kw">fn </span>clone(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="self">Self </span>{ |
| DisjunctionMaxQuery::with_tie_breaker( |
| <span class="self">self</span>.disjuncts |
| .iter() |
| .map(|disjunct| disjunct.box_clone()) |
| .collect::<Vec<<span class="kw">_</span>>>(), |
| <span class="self">self</span>.tie_breaker, |
| ) |
| } |
| } |
| |
| <span class="kw">impl </span>Query <span class="kw">for </span>DisjunctionMaxQuery { |
| <span class="kw">fn </span>weight(<span class="kw-2">&</span><span class="self">self</span>, enable_scoring: EnableScoring<<span class="lifetime">'_</span>>) -> <span class="kw">crate</span>::Result<Box<<span class="kw">dyn </span>Weight>> { |
| <span class="kw">let </span>disjuncts = <span class="self">self |
| </span>.disjuncts |
| .iter() |
| .map(|disjunct| <span class="prelude-val">Ok</span>((Occur::Should, disjunct.weight(enable_scoring)<span class="question-mark">?</span>))) |
| .collect::<<span class="kw">crate</span>::Result<<span class="kw">_</span>>>()<span class="question-mark">?</span>; |
| <span class="kw">let </span>tie_breaker = <span class="self">self</span>.tie_breaker; |
| <span class="prelude-val">Ok</span>(Box::new(BooleanWeight::new( |
| disjuncts, |
| enable_scoring.is_scoring_enabled(), |
| Box::new(<span class="kw">move </span>|| DisjunctionMaxCombiner::with_tie_breaker(tie_breaker)), |
| ))) |
| } |
| |
| <span class="kw">fn </span>query_terms<<span class="lifetime">'a</span>>(<span class="kw-2">&</span><span class="lifetime">'a </span><span class="self">self</span>, visitor: <span class="kw-2">&mut </span><span class="kw">dyn </span>FnMut(<span class="kw-2">&</span><span class="lifetime">'a </span>Term, bool)) { |
| <span class="kw">for </span>disjunct <span class="kw">in </span><span class="kw-2">&</span><span class="self">self</span>.disjuncts { |
| disjunct.query_terms(visitor); |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>DisjunctionMaxQuery { |
| <span class="doccomment">/// Creates a new `DisjunctionMaxQuery` with tie breaker. |
| </span><span class="kw">pub fn </span>with_tie_breaker( |
| disjuncts: Vec<Box<<span class="kw">dyn </span>Query>>, |
| tie_breaker: Score, |
| ) -> DisjunctionMaxQuery { |
| DisjunctionMaxQuery { |
| disjuncts, |
| tie_breaker, |
| } |
| } |
| |
| <span class="doccomment">/// Creates a new `DisjunctionMaxQuery` with no tie breaker. |
| </span><span class="kw">pub fn </span>new(disjuncts: Vec<Box<<span class="kw">dyn </span>Query>>) -> DisjunctionMaxQuery { |
| DisjunctionMaxQuery::with_tie_breaker(disjuncts, <span class="number">0.0</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> |
