rlucene 0.1.0-alpha.3

A Rust port of Apache Lucene, a full-text search engine library
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

use crate::core::search::approximation_disi::ApproximationBitSetAccess;
use crate::core::search::approximation_disi::ApproximationDISI;
use crate::core::search::doc_id_set_iterator::DocIdSetIterator;
use crate::core::search::scorable::{ChildScorable, Scorable};
#[cfg(test)]
use crate::core::search::scorer::ScorerKind;
use crate::core::search::scorer::TwoPhaseState::Yes;
use crate::core::search::scorer::{Scorer, TwoPhaseState};
use crate::core::search::two_phase_iterator::{
  TwoPhaseIterator, TwoPhaseIteratorAsDocIdSetIterator, TwoPhaseIteratorEnum2,
};
use crate::core::util::error::lucene_error::Result;

/// A scorer whose required/excluded matching order is selected at construction.
pub struct ReqExclScorer<T> {
  disi: TwoPhaseIteratorAsDocIdSetIterator<T>,
}
impl<T> ReqExclScorer<T> {
  pub(crate) fn new(two_phase_iterator: T) -> Self {
    Self {
      disi: TwoPhaseIteratorAsDocIdSetIterator::new(two_phase_iterator),
    }
  }
}
impl<S1: Scorer, S2: Scorer> ReqExclScorer<TwoPhaseIteratorImpl1<S1, S2>> {
  pub(crate) fn prepare(mut req_scorer: S1, mut excl_scorer: S2) -> Result<Tpi<S1, S2>> {
    let match_cost = match_cost(&mut req_scorer, &mut excl_scorer)?;

    let check_req = match req_scorer.has_two_phase_iterator() {
      TwoPhaseState::Yes => match excl_scorer.has_two_phase_iterator() {
        TwoPhaseState::Yes => req_scorer.match_cost() <= excl_scorer.match_cost(),
        TwoPhaseState::No => false,
      },
      TwoPhaseState::No => true,
    };

    let two_phase_iterator = if check_req {
      TwoPhaseIteratorEnum2::A(TwoPhaseIteratorImpl1::new(
        req_scorer,
        excl_scorer,
        match_cost,
      ))
    } else {
      TwoPhaseIteratorEnum2::B(TwoPhaseIteratorImpl2::new(
        req_scorer,
        excl_scorer,
        match_cost,
      ))
    };
    Ok(two_phase_iterator)
  }
}

/// Access to the required scorer owned by either concrete matching order.
#[doc(hidden)]
pub trait ReqExclState: TwoPhaseIterator + 'static {
  type Required: Scorer + 'static;
  fn req_scorer_mut(&mut self) -> &mut Self::Required;
}
impl<S1: Scorer + 'static, S2: Scorer + 'static> ReqExclState for TwoPhaseIteratorImpl1<S1, S2> {
  type Required = S1;
  fn req_scorer_mut(&mut self) -> &mut S1 {
    &mut self.req_scorer
  }
}
impl<S1: Scorer + 'static, S2: Scorer + 'static> ReqExclState for TwoPhaseIteratorImpl2<S1, S2> {
  type Required = S1;
  fn req_scorer_mut(&mut self) -> &mut S1 {
    &mut self.req_scorer
  }
}
impl<T: ReqExclState> Scorable for ReqExclScorer<T> {
  type Child<'a>
    = &'a mut T::Required
  where
    Self: 'a;
  fn score(&mut self) -> Result<f32> {
    self.disi.two_phase_iterator.req_scorer_mut().score()
  }
  fn set_min_competitive_score(&mut self, min_score: f32) -> Result<()> {
    self
      .disi
      .two_phase_iterator
      .req_scorer_mut()
      .set_min_competitive_score(min_score)
  }
  fn get_children(&mut self) -> Result<Vec<ChildScorable<Self::Child<'_>>>> {
    Ok(vec![ChildScorable::new(
      self.disi.two_phase_iterator.req_scorer_mut(),
      "MUST",
    )])
  }
  fn cost(&self) -> Result<i64> {
    self.disi.cost()
  }
}
impl<T> crate::core::search::scorable::FixedScore for ReqExclScorer<T> {}
impl<T: TwoPhaseIterator> crate::core::search::doc_id_set_iterator::DocIdSetIteratorExtensions
  for ReqExclScorer<T>
{
}
impl<T: TwoPhaseIterator> crate::core::search::doc_id_set_iterator::BitSetIteratorAccess
  for ReqExclScorer<T>
{
}
impl<T: TwoPhaseIterator> DocIdSetIterator for ReqExclScorer<T> {
  fn doc_id(&self) -> i32 {
    self.disi.doc_id()
  }
  fn next_doc(&mut self) -> Result<i32> {
    self.disi.next_doc()
  }
  fn advance(&mut self, target: i32) -> Result<i32> {
    self.disi.advance(target)
  }
  fn slow_advance(&mut self, target: i32) -> Result<i32> {
    self.disi.slow_advance(target)
  }
  fn cost(&self) -> Result<i64> {
    self.disi.cost()
  }
}
impl<T: ReqExclState> ApproximationDISI for ReqExclScorer<T> {
  fn approx_doc_id(&self) -> i32 {
    self.disi.two_phase_iterator.approx_doc_id()
  }
  fn approx_next_doc(&mut self) -> Result<i32> {
    self.disi.two_phase_iterator.approx_next_doc()
  }
  fn approx_advance(&mut self, target: i32) -> Result<i32> {
    self.disi.two_phase_iterator.approx_advance(target)
  }
  fn approx_slow_advance(&mut self, target: i32) -> Result<i32> {
    self.disi.two_phase_iterator.approx_slow_advance(target)
  }
  fn approx_cost(&self) -> Result<i64> {
    self.disi.two_phase_iterator.approx_cost()
  }
}
impl<T: ReqExclState> ApproximationBitSetAccess for ReqExclScorer<T> {
  fn approx_is_bit_iter(&self) -> bool {
    self.disi.two_phase_iterator.approx_is_bit_iter()
  }
  fn approx_get(&self, index: usize) -> Result<bool> {
    self.disi.two_phase_iterator.approx_get(index)
  }
  fn approx_set_doc_id(&mut self, doc: i32) -> Result<()> {
    self.disi.two_phase_iterator.approx_set_doc_id(doc)
  }
  fn approx_bit_set_length(&self) -> Result<usize> {
    self.disi.two_phase_iterator.approx_bit_set_length()
  }
}

impl<T: ReqExclState> TwoPhaseIterator for ReqExclScorer<T> {
  fn matches(&mut self) -> Result<bool> {
    self.disi.two_phase_iterator.matches()
  }
  fn match_cost(&self) -> f32 {
    self.disi.two_phase_iterator.match_cost()
  }
}

impl<T: ReqExclState> Scorer for ReqExclScorer<T> {
  fn scoring_doc_id(&mut self) -> Result<i32> {
    self
      .disi
      .two_phase_iterator
      .req_scorer_mut()
      .scoring_doc_id()
  }

  fn advance_shallow(&mut self, target: i32) -> Result<i32> {
    self
      .disi
      .two_phase_iterator
      .req_scorer_mut()
      .advance_shallow(target)
  }
  fn get_max_score(&mut self, upto: i32) -> Result<f32> {
    self
      .disi
      .two_phase_iterator
      .req_scorer_mut()
      .get_max_score(upto)
  }
  fn has_two_phase_iterator(&self) -> TwoPhaseState {
    Yes
  }

  #[cfg(test)]
  fn kind(&self) -> ScorerKind {
    ScorerKind::ReqExcl
  }
}

pub struct TwoPhaseIteratorImpl1<S1, S2> {
  req_scorer: S1,
  excl_scorer: S2,
  match_cost: f32,
}
impl<S1, S2> TwoPhaseIteratorImpl1<S1, S2> {
  fn new(req_scorer: S1, excl_scorer: S2, match_cost: f32) -> Self {
    Self {
      req_scorer,
      excl_scorer,
      match_cost,
    }
  }
}
impl<S1, S2> ApproximationDISI for TwoPhaseIteratorImpl1<S1, S2>
where
  S1: Scorer,
  S2: Scorer,
{
  fn approx_doc_id(&self) -> i32 {
    self.req_scorer.approx_doc_id()
  }

  fn approx_next_doc(&mut self) -> Result<i32> {
    self.req_scorer.approx_next_doc()
  }

  fn approx_advance(&mut self, target: i32) -> Result<i32> {
    self.req_scorer.approx_advance(target)
  }

  fn approx_slow_advance(&mut self, target: i32) -> Result<i32> {
    self.req_scorer.approx_slow_advance(target)
  }

  fn approx_cost(&self) -> Result<i64> {
    self.req_scorer.approx_cost()
  }
}
impl<S1, S2> ApproximationBitSetAccess for TwoPhaseIteratorImpl1<S1, S2>
where
  S1: Scorer,
  S2: Scorer,
{
  fn approx_is_bit_iter(&self) -> bool {
    self.req_scorer.approx_is_bit_iter()
  }

  fn approx_get(&self, index: usize) -> Result<bool> {
    self.req_scorer.approx_get(index)
  }

  fn approx_set_doc_id(&mut self, doc: i32) -> Result<()> {
    self.req_scorer.approx_set_doc_id(doc)
  }

  fn approx_bit_set_length(&self) -> Result<usize> {
    self.req_scorer.approx_bit_set_length()
  }
}

impl<S1, S2> TwoPhaseIterator for TwoPhaseIteratorImpl1<S1, S2>
where
  S1: Scorer,
  S2: Scorer,
{
  fn matches(&mut self) -> Result<bool> {
    let doc = self.req_scorer.approx_doc_id();
    // check if the doc is not excluded
    {
      let mut excl_doc = self.excl_scorer.approx_doc_id();
      if excl_doc < doc {
        excl_doc = self.excl_scorer.approx_advance(doc)?;
      }
      if excl_doc != doc {
        return self.req_scorer.matches();
      }
    }
    let req_match = self.req_scorer.matches()?;
    match req_match {
      true => {
        let v = self.excl_scorer.matches()?;
        Ok(!v)
      },
      false => Ok(false),
    }
  }

  fn match_cost(&self) -> f32 {
    self.match_cost
  }
}

pub struct TwoPhaseIteratorImpl2<S1, S2> {
  req_scorer: S1,
  excl_scorer: S2,
  match_cost: f32,
}
impl<S1, S2> TwoPhaseIteratorImpl2<S1, S2> {
  fn new(req_scorer: S1, excl_scorer: S2, match_cost: f32) -> Self {
    Self {
      req_scorer,
      excl_scorer,
      match_cost,
    }
  }
}
impl<S1, S2> ApproximationDISI for TwoPhaseIteratorImpl2<S1, S2>
where
  S1: Scorer,
  S2: Scorer,
{
  fn approx_doc_id(&self) -> i32 {
    self.req_scorer.approx_doc_id()
  }

  fn approx_next_doc(&mut self) -> Result<i32> {
    self.req_scorer.approx_next_doc()
  }

  fn approx_advance(&mut self, target: i32) -> Result<i32> {
    self.req_scorer.approx_advance(target)
  }

  fn approx_slow_advance(&mut self, target: i32) -> Result<i32> {
    self.req_scorer.approx_slow_advance(target)
  }

  fn approx_cost(&self) -> Result<i64> {
    self.req_scorer.approx_cost()
  }
}
impl<S1, S2> ApproximationBitSetAccess for TwoPhaseIteratorImpl2<S1, S2>
where
  S1: Scorer,
  S2: Scorer,
{
  fn approx_is_bit_iter(&self) -> bool {
    self.req_scorer.approx_is_bit_iter()
  }

  fn approx_get(&self, index: usize) -> Result<bool> {
    self.req_scorer.approx_get(index)
  }

  fn approx_set_doc_id(&mut self, doc: i32) -> Result<()> {
    self.req_scorer.approx_set_doc_id(doc)
  }

  fn approx_bit_set_length(&self) -> Result<usize> {
    self.req_scorer.approx_bit_set_length()
  }
}

impl<S1, S2> TwoPhaseIterator for TwoPhaseIteratorImpl2<S1, S2>
where
  S1: Scorer,
  S2: Scorer,
{
  fn matches(&mut self) -> Result<bool> {
    let doc = self.req_scorer.approx_doc_id();

    // check if doc is excluded
    {
      let excl_approximation = &mut self.excl_scorer;
      let mut excl_doc = excl_approximation.approx_doc_id();
      if excl_doc < doc {
        excl_doc = excl_approximation.approx_advance(doc)?;
      }

      if excl_doc != doc {
        return self.req_scorer.matches();
      }
    }

    let excl_not_match = !self.excl_scorer.matches()?;

    if !excl_not_match {
      return Ok(false);
    }

    let req_match = self.req_scorer.matches()?;

    Ok(req_match)
  }

  fn match_cost(&self) -> f32 {
    self.match_cost
  }
}

pub type Tpi<S1, S2> =
  TwoPhaseIteratorEnum2<TwoPhaseIteratorImpl1<S1, S2>, TwoPhaseIteratorImpl2<S1, S2>>;
/// Estimation of the number of operations required to call DISI.advance.
/// This is likely completely wrong,
/// especially given that the cost of this method usually depends on how far you want to advance,
/// but it's probably better than nothing.
const ADVANCE_COST: i32 = 10;
fn match_cost<S1, S2>(req_scorer: &mut S1, excl_scorer: &mut S2) -> Result<f32>
where
  S1: Scorer,
  S2: Scorer,
{
  let mut match_cost: f32 = 2.0;

  if req_scorer.has_two_phase_iterator() == TwoPhaseState::Yes {
    // this two-phase iterator must always be matched
    match_cost += req_scorer.match_cost();
  }
  // match cost of the prohibited clause: we need to advance the approximation
  // and match the two-phased iterator
  let excl_match_cost = {
    let extra = excl_scorer.match_cost();
    (ADVANCE_COST as f32) + extra
  };
  // upper value for the ratio of documents that reqApproximation matches that
  // exclApproximation also matches
  let req_cost = req_scorer.approx_cost()?;
  let excl_cost = excl_scorer.approx_cost()?;

  let ratio = if req_cost <= 0 {
    1.0
  } else if excl_cost <= 0 {
    0.0
  } else {
    (req_cost.min(excl_cost) as f32) / (req_cost as f32)
  };

  match_cost += ratio * excl_match_cost;

  Ok(match_cost)
}