Google Git
Sign in
apache / incubator-teaclave-website / refs/heads/asf-site / . / api-docs / crates-enclave / src / tantivy / query / automaton_weight.rs.html
blob: cf41b501e06351913622ceefa04586cc331062e2 [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/query/automaton_weight.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>automaton_weight.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>
</pre><pre class="rust"><code><span class="kw">use </span>std::io;
<span class="kw">use </span>std::sync::Arc;
<span class="kw">use </span>common::BitSet;
<span class="kw">use </span>tantivy_fst::Automaton;
<span class="kw">use </span><span class="kw">crate</span>::core::SegmentReader;
<span class="kw">use </span><span class="kw">crate</span>::query::{BitSetDocSet, ConstScorer, Explanation, Scorer, Weight};
<span class="kw">use </span><span class="kw">crate</span>::schema::{Field, IndexRecordOption};
<span class="kw">use </span><span class="kw">crate</span>::termdict::{TermDictionary, TermStreamer};
<span class="kw">use crate</span>::{DocId, Score, TantivyError};
<span class="doccomment">/// A weight struct for Fuzzy Term and Regex Queries
</span><span class="kw">pub struct </span>AutomatonWeight&lt;A&gt; {
field: Field,
automaton: Arc&lt;A&gt;,
}
<span class="kw">impl</span>&lt;A&gt; AutomatonWeight&lt;A&gt;
<span class="kw">where
</span>A: Automaton + Send + Sync + <span class="lifetime">&#39;static</span>,
A::State: Clone,
{
<span class="doccomment">/// Create a new AutomationWeight
</span><span class="kw">pub fn </span>new&lt;IntoArcA: Into&lt;Arc&lt;A&gt;&gt;&gt;(field: Field, automaton: IntoArcA) -&gt; AutomatonWeight&lt;A&gt; {
AutomatonWeight {
field,
automaton: automaton.into(),
}
}
<span class="kw">fn </span>automaton_stream&lt;<span class="lifetime">&#39;a</span>&gt;(
<span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="self">self</span>,
term_dict: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>TermDictionary,
) -&gt; io::Result&lt;TermStreamer&lt;<span class="lifetime">&#39;a</span>, <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>A&gt;&gt; {
<span class="kw">let </span>automaton: <span class="kw-2">&amp;</span>A = <span class="kw-2">&amp;</span><span class="self">self</span>.automaton;
<span class="kw">let </span>term_stream_builder = term_dict.search(automaton);
term_stream_builder.into_stream()
}
}
<span class="kw">impl</span>&lt;A&gt; Weight <span class="kw">for </span>AutomatonWeight&lt;A&gt;
<span class="kw">where
</span>A: Automaton + Send + Sync + <span class="lifetime">&#39;static</span>,
A::State: Clone,
{
<span class="kw">fn </span>scorer(<span class="kw-2">&amp;</span><span class="self">self</span>, reader: <span class="kw-2">&amp;</span>SegmentReader, boost: Score) -&gt; <span class="kw">crate</span>::Result&lt;Box&lt;<span class="kw">dyn </span>Scorer&gt;&gt; {
<span class="kw">let </span>max_doc = reader.max_doc();
<span class="kw">let </span><span class="kw-2">mut </span>doc_bitset = BitSet::with_max_value(max_doc);
<span class="kw">let </span>inverted_index = reader.inverted_index(<span class="self">self</span>.field)<span class="question-mark">?</span>;
<span class="kw">let </span>term_dict = inverted_index.terms();
<span class="kw">let </span><span class="kw-2">mut </span>term_stream = <span class="self">self</span>.automaton_stream(term_dict)<span class="question-mark">?</span>;
<span class="kw">while </span>term_stream.advance() {
<span class="kw">let </span>term_info = term_stream.value();
<span class="kw">let </span><span class="kw-2">mut </span>block_segment_postings = inverted_index
.read_block_postings_from_terminfo(term_info, IndexRecordOption::Basic)<span class="question-mark">?</span>;
<span class="kw">loop </span>{
<span class="kw">let </span>docs = block_segment_postings.docs();
<span class="kw">if </span>docs.is_empty() {
<span class="kw">break</span>;
}
<span class="kw">for </span><span class="kw-2">&amp;</span>doc <span class="kw">in </span>docs {
doc_bitset.insert(doc);
}
block_segment_postings.advance();
}
}
<span class="kw">let </span>doc_bitset = BitSetDocSet::from(doc_bitset);
<span class="kw">let </span>const_scorer = ConstScorer::new(doc_bitset, boost);
<span class="prelude-val">Ok</span>(Box::new(const_scorer))
}
<span class="kw">fn </span>explain(<span class="kw-2">&amp;</span><span class="self">self</span>, reader: <span class="kw-2">&amp;</span>SegmentReader, doc: DocId) -&gt; <span class="kw">crate</span>::Result&lt;Explanation&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>scorer = <span class="self">self</span>.scorer(reader, <span class="number">1.0</span>)<span class="question-mark">?</span>;
<span class="kw">if </span>scorer.seek(doc) == doc {
<span class="prelude-val">Ok</span>(Explanation::new(<span class="string">&quot;AutomatonScorer&quot;</span>, <span class="number">1.0</span>))
} <span class="kw">else </span>{
<span class="prelude-val">Err</span>(TantivyError::InvalidArgument(
<span class="string">&quot;Document does not exist&quot;</span>.to_string(),
))
}
}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use </span>tantivy_fst::Automaton;
<span class="kw">use </span><span class="kw">super</span>::AutomatonWeight;
<span class="kw">use </span><span class="kw">crate</span>::docset::TERMINATED;
<span class="kw">use </span><span class="kw">crate</span>::query::Weight;
<span class="kw">use </span><span class="kw">crate</span>::schema::{Schema, STRING};
<span class="kw">use </span><span class="kw">crate</span>::Index;
<span class="kw">fn </span>create_index() -&gt; <span class="kw">crate</span>::Result&lt;Index&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>schema = Schema::builder();
<span class="kw">let </span>title = schema.add_text_field(<span class="string">&quot;title&quot;</span>, STRING);
<span class="kw">let </span>index = Index::create_in_ram(schema.build());
<span class="kw">let </span><span class="kw-2">mut </span>index_writer = index.writer_for_tests()<span class="question-mark">?</span>;
index_writer.add_document(<span class="macro">doc!</span>(title=&gt;<span class="string">&quot;abc&quot;</span>))<span class="question-mark">?</span>;
index_writer.add_document(<span class="macro">doc!</span>(title=&gt;<span class="string">&quot;bcd&quot;</span>))<span class="question-mark">?</span>;
index_writer.add_document(<span class="macro">doc!</span>(title=&gt;<span class="string">&quot;abcd&quot;</span>))<span class="question-mark">?</span>;
index_writer.commit()<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(index)
}
<span class="attribute">#[derive(Clone, Copy)]
</span><span class="kw">enum </span>State {
Start,
NotMatching,
AfterA,
}
<span class="kw">struct </span>PrefixedByA;
<span class="kw">impl </span>Automaton <span class="kw">for </span>PrefixedByA {
<span class="kw">type </span>State = State;
<span class="kw">fn </span>start(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="self">Self</span>::State {
State::Start
}
<span class="kw">fn </span>is_match(<span class="kw-2">&amp;</span><span class="self">self</span>, state: <span class="kw-2">&amp;</span><span class="self">Self</span>::State) -&gt; bool {
<span class="macro">matches!</span>(<span class="kw-2">*</span>state, State::AfterA)
}
<span class="kw">fn </span>accept(<span class="kw-2">&amp;</span><span class="self">self</span>, state: <span class="kw-2">&amp;</span><span class="self">Self</span>::State, byte: u8) -&gt; <span class="self">Self</span>::State {
<span class="kw">match </span><span class="kw-2">*</span>state {
State::Start =&gt; {
<span class="kw">if </span>byte == <span class="string">b&#39;a&#39; </span>{
State::AfterA
} <span class="kw">else </span>{
State::NotMatching
}
}
State::AfterA =&gt; State::AfterA,
State::NotMatching =&gt; State::NotMatching,
}
}
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_automaton_weight() -&gt; <span class="kw">crate</span>::Result&lt;()&gt; {
<span class="kw">let </span>index = create_index()<span class="question-mark">?</span>;
<span class="kw">let </span>field = index.schema().get_field(<span class="string">&quot;title&quot;</span>).unwrap();
<span class="kw">let </span>automaton_weight = AutomatonWeight::new(field, PrefixedByA);
<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><span class="kw-2">mut </span>scorer = automaton_weight.scorer(searcher.segment_reader(<span class="number">0u32</span>), <span class="number">1.0</span>)<span class="question-mark">?</span>;
<span class="macro">assert_eq!</span>(scorer.doc(), <span class="number">0u32</span>);
<span class="macro">assert_eq!</span>(scorer.score(), <span class="number">1.0</span>);
<span class="macro">assert_eq!</span>(scorer.advance(), <span class="number">2u32</span>);
<span class="macro">assert_eq!</span>(scorer.doc(), <span class="number">2u32</span>);
<span class="macro">assert_eq!</span>(scorer.score(), <span class="number">1.0</span>);
<span class="macro">assert_eq!</span>(scorer.advance(), TERMINATED);
<span class="prelude-val">Ok</span>(())
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_automaton_weight_boost() -&gt; <span class="kw">crate</span>::Result&lt;()&gt; {
<span class="kw">let </span>index = create_index()<span class="question-mark">?</span>;
<span class="kw">let </span>field = index.schema().get_field(<span class="string">&quot;title&quot;</span>).unwrap();
<span class="kw">let </span>automaton_weight = AutomatonWeight::new(field, PrefixedByA);
<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><span class="kw-2">mut </span>scorer = automaton_weight.scorer(searcher.segment_reader(<span class="number">0u32</span>), <span class="number">1.32</span>)<span class="question-mark">?</span>;
<span class="macro">assert_eq!</span>(scorer.doc(), <span class="number">0u32</span>);
<span class="macro">assert_eq!</span>(scorer.score(), <span class="number">1.32</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>