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
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
/*
 * 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::document::lat_lon_point_distance_comparator::LatLonPointDistanceLeafComparator;
use crate::core::document::xy_point_distance_comparator::XYPointDistanceLeafComparator;
use crate::core::index::doc_values::{Binary, SortedNumeric};
use crate::core::index::leaf_reader::LeafReader;
use crate::core::search::comparators::doc_comparator::{DocComparatorIterator, DocLeafComparator};
use crate::core::search::comparators::double_comparator::DoubleLeafComparator;
use crate::core::search::comparators::float_comparator::FloatLeafComparator;
use crate::core::search::comparators::int_comparator::IntLeafComparator;
use crate::core::search::comparators::long_comparator::LongLeafComparator;
use crate::core::search::comparators::numeric_comparator::NumericCompetitiveIterator;
use crate::core::search::comparators::term_ord_val_comparator::{
  TermOrdValCompetitiveIterator, TermOrdValLeafComparator,
};
use crate::core::search::doc_id_set_iterator::{DocIdSetIterator, DocIdSetIteratorEnum3};
use crate::core::search::field_comparator::{
  FieldComparator, FieldComparatorEnum, RelevanceLeafComparator, TermValLeafComparator,
};
use crate::core::search::scorable::Scorable;
use crate::core::util::error::lucene_error::{LuceneError, Result};

/// Expert: comparator that gets instantiated on each leaf from a top-level
/// [`FieldComparator`]
/// instance.
///
/// A leaf comparator must define these functions:
///
/// - [`set_bottom`](LeafFieldComparator::set_bottom) This method is called by
///   [`FieldValueHitQueue`](crate::core::search::field_value_hit_queue::FieldValueHitQueue)
///   to notify the [`FieldComparator`] of the current weakest ("bottom") slot.
///   Note that this slot may not hold the weakest value according to your
///   comparator, in cases where your comparator is not the primary one (i.e.,
///   is only used to break ties from the comparators before it).
/// - [`compare_bottom`](LeafFieldComparator::compare_bottom) Compare a new hit
///   (docID) against the "weakest" (bottom) entry in the queue.
/// - [`compare_top`](LeafFieldComparator::compare_top) Compares a new hit
///   (docID) against the top value previously set by a call to
///   [`FieldComparator::set_top_value`].
/// - [`copy`](LeafFieldComparator::copy) Installs a new hit into the priority
///   queue. The
///   [`FieldValueHitQueue`](crate::core::search::field_value_hit_queue::FieldValueHitQueue)
///   calls this method when a new hit is competitive.
///
/// # See Also
/// - [`FieldComparator`]
///
/// # Lucene Experimental
/// This API is experimental and may change in future versions.
pub trait LeafFieldComparator {
  type FieldComparator: FieldComparator;
  /// Set the bottom slot, i.e., the "weakest" (sorted last) entry in the
  /// queue. When `compare_bottom` is called, you should compare against
  /// this slot.
  ///
  /// This will always be called before `compare_bottom`.
  ///
  /// # Arguments
  /// - `slot`: The currently weakest (sorted last) slot in the queue.
  ///
  /// # Errors
  /// Returns an error if an I/O error occurs.
  fn set_bottom(&mut self, slot: usize, comparator: &mut Self::FieldComparator) -> Result<()>;

  /// Compare the bottom of the queue with this document.
  ///
  /// This will only be invoked after `set_bottom` has been called. This
  /// should return the same result as if `bottom` were slot1 and the new
  /// document were slot2.
  ///
  /// For a search that hits many results, this method will be the hotspot
  /// (invoked the most frequently).
  ///
  /// # Arguments
  /// - `doc`: The docID that was hit.
  /// - `scorer`: The scorer instance currently used to evaluate the hit.
  /// - `comparator`: The parent field comparator associated with this leaf comparator.
  ///
  /// # Returns
  /// - `N < 0` if the doc's value is sorted after the bottom entry (not
  ///   competitive).
  /// - `N > 0` if the doc's value is sorted before the bottom entry.
  /// - `0` if they are equal.
  ///
  /// # Errors
  /// Returns an error if an I/O error occurs.
  fn compare_bottom<S>(
    &mut self,
    doc: i32,
    scorer: &mut S,
    comparator: &mut Self::FieldComparator,
  ) -> Result<i32>
  where
    S: Scorable + ?Sized;

  /// Compare the top value with this document.
  ///
  /// This will only be invoked after `set_top_value` has been called. This
  /// should return the same result as if `top_value` were slot1 and the
  /// new document were slot2.
  ///
  /// This is only called for searches that use searchAfter (deep paging).
  /// # Arguments
  /// - `doc`: The docID that was hit.
  /// - `scorer`: The scorer instance currently used to evaluate the hit.
  /// - `comparator`: The parent field comparator associated with this leaf comparator.
  ///
  /// # Returns
  /// - `N < 0` if the doc's value is sorted after the top entry (not
  ///   competitive).
  /// - `N > 0` if the doc's value is sorted before the top entry.
  /// - `0` if they are equal.
  ///
  /// # Errors
  /// Returns an error if an I/O error occurs.
  fn compare_top<S>(
    &mut self,
    doc: i32,
    scorer: &mut S,
    comparator: &mut Self::FieldComparator,
  ) -> Result<i32>
  where
    S: Scorable + ?Sized;

  /// Called when a new hit is competitive.
  ///
  /// You should copy any state associated with this document that will be
  /// required for future comparisons into the specified slot.
  ///
  /// # Arguments
  /// - `slot`: The slot to copy the hit to.
  /// - `doc`: The docID relative to the current reader.
  /// - `scorer`: The scorer instance currently used to evaluate the hit.
  /// - `comparator`: The parent field comparator associated with this leaf comparator.
  ///
  /// # Errors
  /// Returns an error if an I/O error occurs.
  fn copy<S>(
    &mut self,
    slot: usize,
    doc: i32,
    scorer: &mut S,
    comparator: &mut Self::FieldComparator,
  ) -> Result<()>
  where
    S: Scorable + ?Sized;

  /// Sets the scorer to use in case a document's score is needed.
  ///
  /// # Arguments
  /// - `scorer`: Scorer instance to get the current hit's score, if
  ///   necessary.
  /// - `comparator`: The parent field comparator associated with this leaf comparator.
  ///
  /// # Errors
  /// Returns an error if an I/O error occurs.
  fn set_scorer<S>(&mut self, scorer: &mut S, comparator: &mut Self::FieldComparator) -> Result<()>
  where
    S: Scorable + ?Sized;

  type DocIdSetIteratorRef<'a>: DocIdSetIterator
  where
    Self: 'a;
  /// Returns a competitive iterator over documents stronger than already
  /// collected docs, or `None` if such an iterator is not available for
  /// the current comparator or segment.
  ///
  /// # Returns
  /// An iterator over competitive docs.
  ///
  /// # Arguments
  /// - `comparator`: The parent field comparator associated with this leaf comparator.
  fn competitive_iterator(
    &mut self,
    _comparator: &mut Self::FieldComparator,
  ) -> Result<Option<Self::DocIdSetIteratorRef<'_>>> {
    Ok(None)
  }

  /// Informs this leaf comparator that the hit's threshold is reached.
  ///
  /// This method is called from a collector when the hit's threshold is
  /// reached.
  ///
  /// # Arguments
  /// - `comparator`: The parent field comparator associated with this leaf comparator.
  fn set_hits_threshold_reached(&mut self, _comparator: &mut Self::FieldComparator) -> Result<()> {
    Ok(())
  }
}

pub type LeafFieldComparatorDocIdSetIterator<LR> = DocIdSetIteratorEnum3<
  DocComparatorIterator,
  NumericCompetitiveIterator<LR>,
  TermOrdValCompetitiveIterator<LR>,
>;
pub type LeafFieldComparatorDocIdSetIteratorRef<'a, LR> = DocIdSetIteratorEnum3<
  <DocLeafComparator as LeafFieldComparator>::DocIdSetIteratorRef<'a>,
  <DoubleLeafComparator<LR> as LeafFieldComparator>::DocIdSetIteratorRef<'a>,
  <TermOrdValLeafComparator<LR> as LeafFieldComparator>::DocIdSetIteratorRef<'a>,
>;

pub enum LeafFieldComparatorEnum<LR>
where
  LR: LeafReader,
{
  Relevance(RelevanceLeafComparator),
  Doc(DocLeafComparator),
  Double(DoubleLeafComparator<LR>),
  Float(FloatLeafComparator<LR>),
  Int(IntLeafComparator<LR>),
  LatLonPointDistance(LatLonPointDistanceLeafComparator<SortedNumeric<LR>>),
  Long(LongLeafComparator<LR>),
  TermVal(TermValLeafComparator<Binary<LR>>),
  TermOrdVal(TermOrdValLeafComparator<LR>),
  XYPointDistance(XYPointDistanceLeafComparator<SortedNumeric<LR>>),
}

impl<LR> LeafFieldComparator for LeafFieldComparatorEnum<LR>
where
  LR: LeafReader,
{
  type FieldComparator = FieldComparatorEnum;

  fn set_bottom(&mut self, slot: usize, comparator: &mut Self::FieldComparator) -> Result<()> {
    match (self, comparator) {
      (Self::Relevance(comparator), FieldComparatorEnum::Relevance(c)) => {
        comparator.set_bottom(slot, c)
      },
      (Self::Doc(comparator), FieldComparatorEnum::Doc(c)) => comparator.set_bottom(slot, c),
      (Self::Double(comparator), FieldComparatorEnum::Double(c)) => comparator.set_bottom(slot, c),
      (Self::Double(comparator), FieldComparatorEnum::SortedNumericDouble(c)) => {
        comparator.set_bottom(slot, &mut c.base)
      },
      (Self::Float(comparator), FieldComparatorEnum::Float(c)) => comparator.set_bottom(slot, c),
      (Self::Float(comparator), FieldComparatorEnum::SortedNumericFloat(c)) => {
        comparator.set_bottom(slot, &mut c.base)
      },
      (Self::Int(comparator), FieldComparatorEnum::Int(c)) => comparator.set_bottom(slot, c),
      (Self::Int(comparator), FieldComparatorEnum::SortedNumericInt(c)) => {
        comparator.set_bottom(slot, &mut c.base)
      },
      (Self::Long(comparator), FieldComparatorEnum::Long(c)) => comparator.set_bottom(slot, c),
      (Self::Long(comparator), FieldComparatorEnum::SortedNumericLong(c)) => {
        comparator.set_bottom(slot, &mut c.base)
      },
      (Self::TermVal(comparator), FieldComparatorEnum::TermVal(c)) => {
        comparator.set_bottom(slot, c)
      },
      (Self::TermOrdVal(comparator), FieldComparatorEnum::TermOrdValue(c)) => {
        comparator.set_bottom(slot, c)
      },

      (Self::TermOrdVal(comparator), FieldComparatorEnum::SortedDocValuesTermOrdVal(c)) => {
        comparator.set_bottom(slot, &mut c.base)
      },
      (Self::LatLonPointDistance(comparator), FieldComparatorEnum::LatLonPointDistance(c)) => {
        comparator.set_bottom(slot, c)
      },
      (Self::XYPointDistance(comparator), FieldComparatorEnum::XYPointDistance(c)) => {
        comparator.set_bottom(slot, c)
      },
      _ => Err(LuceneError::illegal_state("Mismatched comparator types")),
    }
  }

  fn compare_bottom<S>(
    &mut self,
    doc: i32,
    scorer: &mut S,
    comparator: &mut Self::FieldComparator,
  ) -> Result<i32>
  where
    S: Scorable + ?Sized,
  {
    match (self, comparator) {
      (Self::Relevance(comparator), FieldComparatorEnum::Relevance(c)) => {
        comparator.compare_bottom(doc, scorer, c)
      },
      (Self::Doc(comparator), FieldComparatorEnum::Doc(c)) => {
        comparator.compare_bottom(doc, scorer, c)
      },
      (Self::Double(comparator), FieldComparatorEnum::Double(c)) => {
        comparator.compare_bottom(doc, scorer, c)
      },
      (Self::Double(comparator), FieldComparatorEnum::SortedNumericDouble(c)) => {
        comparator.compare_bottom(doc, scorer, &mut c.base)
      },
      (Self::Float(comparator), FieldComparatorEnum::Float(c)) => {
        comparator.compare_bottom(doc, scorer, c)
      },
      (Self::Float(comparator), FieldComparatorEnum::SortedNumericFloat(c)) => {
        comparator.compare_bottom(doc, scorer, &mut c.base)
      },
      (Self::Int(comparator), FieldComparatorEnum::Int(c)) => {
        comparator.compare_bottom(doc, scorer, c)
      },
      (Self::Int(comparator), FieldComparatorEnum::SortedNumericInt(c)) => {
        comparator.compare_bottom(doc, scorer, &mut c.base)
      },
      (Self::Long(comparator), FieldComparatorEnum::Long(c)) => {
        comparator.compare_bottom(doc, scorer, c)
      },
      (Self::Long(comparator), FieldComparatorEnum::SortedNumericLong(c)) => {
        comparator.compare_bottom(doc, scorer, &mut c.base)
      },
      (Self::TermVal(comparator), FieldComparatorEnum::TermVal(c)) => {
        comparator.compare_bottom(doc, scorer, c)
      },
      (Self::TermOrdVal(comparator), FieldComparatorEnum::TermOrdValue(c)) => {
        comparator.compare_bottom(doc, scorer, c)
      },

      (Self::TermOrdVal(comparator), FieldComparatorEnum::SortedDocValuesTermOrdVal(c)) => {
        comparator.compare_bottom(doc, scorer, &mut c.base)
      },
      (Self::LatLonPointDistance(comparator), FieldComparatorEnum::LatLonPointDistance(c)) => {
        comparator.compare_bottom(doc, scorer, c)
      },
      (Self::XYPointDistance(comparator), FieldComparatorEnum::XYPointDistance(c)) => {
        comparator.compare_bottom(doc, scorer, c)
      },
      _ => Err(LuceneError::illegal_state("Mismatched comparator types")),
    }
  }

  fn compare_top<S>(
    &mut self,
    doc: i32,
    scorer: &mut S,
    comparator: &mut Self::FieldComparator,
  ) -> Result<i32>
  where
    S: Scorable + ?Sized,
  {
    match (self, comparator) {
      (Self::Relevance(comparator), FieldComparatorEnum::Relevance(c)) => {
        comparator.compare_top(doc, scorer, c)
      },
      (Self::Doc(comparator), FieldComparatorEnum::Doc(c)) => {
        comparator.compare_top(doc, scorer, c)
      },
      (Self::Double(comparator), FieldComparatorEnum::Double(c)) => {
        comparator.compare_top(doc, scorer, c)
      },
      (Self::Double(comparator), FieldComparatorEnum::SortedNumericDouble(c)) => {
        comparator.compare_top(doc, scorer, &mut c.base)
      },
      (Self::Float(comparator), FieldComparatorEnum::Float(c)) => {
        comparator.compare_top(doc, scorer, c)
      },
      (Self::Float(comparator), FieldComparatorEnum::SortedNumericFloat(c)) => {
        comparator.compare_top(doc, scorer, &mut c.base)
      },
      (Self::Int(comparator), FieldComparatorEnum::Int(c)) => {
        comparator.compare_top(doc, scorer, c)
      },
      (Self::Int(comparator), FieldComparatorEnum::SortedNumericInt(c)) => {
        comparator.compare_top(doc, scorer, &mut c.base)
      },
      (Self::Long(comparator), FieldComparatorEnum::Long(c)) => {
        comparator.compare_top(doc, scorer, c)
      },
      (Self::Long(comparator), FieldComparatorEnum::SortedNumericLong(c)) => {
        comparator.compare_top(doc, scorer, &mut c.base)
      },
      (Self::TermVal(comparator), FieldComparatorEnum::TermVal(c)) => {
        comparator.compare_top(doc, scorer, c)
      },
      (Self::TermOrdVal(comparator), FieldComparatorEnum::TermOrdValue(c)) => {
        comparator.compare_top(doc, scorer, c)
      },

      (Self::TermOrdVal(comparator), FieldComparatorEnum::SortedDocValuesTermOrdVal(c)) => {
        comparator.compare_top(doc, scorer, &mut c.base)
      },
      (Self::LatLonPointDistance(comparator), FieldComparatorEnum::LatLonPointDistance(c)) => {
        comparator.compare_top(doc, scorer, c)
      },
      (Self::XYPointDistance(comparator), FieldComparatorEnum::XYPointDistance(c)) => {
        comparator.compare_top(doc, scorer, c)
      },
      _ => Err(LuceneError::illegal_state("Mismatched comparator types")),
    }
  }

  fn copy<S>(
    &mut self,
    slot: usize,
    doc: i32,
    scorer: &mut S,
    comparator: &mut Self::FieldComparator,
  ) -> Result<()>
  where
    S: Scorable + ?Sized,
  {
    match (self, comparator) {
      (Self::Relevance(comparator), FieldComparatorEnum::Relevance(c)) => {
        comparator.copy(slot, doc, scorer, c)
      },
      (Self::Doc(comparator), FieldComparatorEnum::Doc(c)) => comparator.copy(slot, doc, scorer, c),
      (Self::Double(comparator), FieldComparatorEnum::Double(c)) => {
        comparator.copy(slot, doc, scorer, c)
      },
      (Self::Double(comparator), FieldComparatorEnum::SortedNumericDouble(c)) => {
        comparator.copy(slot, doc, scorer, &mut c.base)
      },
      (Self::Float(comparator), FieldComparatorEnum::Float(c)) => {
        comparator.copy(slot, doc, scorer, c)
      },
      (Self::Float(comparator), FieldComparatorEnum::SortedNumericFloat(c)) => {
        comparator.copy(slot, doc, scorer, &mut c.base)
      },
      (Self::Int(comparator), FieldComparatorEnum::Int(c)) => comparator.copy(slot, doc, scorer, c),
      (Self::Int(comparator), FieldComparatorEnum::SortedNumericInt(c)) => {
        comparator.copy(slot, doc, scorer, &mut c.base)
      },
      (Self::Long(comparator), FieldComparatorEnum::Long(c)) => {
        comparator.copy(slot, doc, scorer, c)
      },
      (Self::Long(comparator), FieldComparatorEnum::SortedNumericLong(c)) => {
        comparator.copy(slot, doc, scorer, &mut c.base)
      },
      (Self::TermVal(comparator), FieldComparatorEnum::TermVal(c)) => {
        comparator.copy(slot, doc, scorer, c)
      },
      (Self::TermOrdVal(comparator), FieldComparatorEnum::TermOrdValue(c)) => {
        comparator.copy(slot, doc, scorer, c)
      },

      (Self::TermOrdVal(comparator), FieldComparatorEnum::SortedDocValuesTermOrdVal(c)) => {
        comparator.copy(slot, doc, scorer, &mut c.base)
      },
      (Self::LatLonPointDistance(comparator), FieldComparatorEnum::LatLonPointDistance(c)) => {
        comparator.copy(slot, doc, scorer, c)
      },
      (Self::XYPointDistance(comparator), FieldComparatorEnum::XYPointDistance(c)) => {
        comparator.copy(slot, doc, scorer, c)
      },
      _ => Err(LuceneError::illegal_state("Mismatched comparator types")),
    }
  }

  fn set_scorer<S>(&mut self, scorer: &mut S, comparator: &mut Self::FieldComparator) -> Result<()>
  where
    S: Scorable + ?Sized,
  {
    match (self, comparator) {
      (Self::Relevance(comparator), FieldComparatorEnum::Relevance(c)) => {
        comparator.set_scorer(scorer, c)
      },
      (Self::Doc(comparator), FieldComparatorEnum::Doc(c)) => comparator.set_scorer(scorer, c),
      (Self::Double(comparator), FieldComparatorEnum::Double(c)) => {
        comparator.set_scorer(scorer, c)
      },
      (Self::Double(comparator), FieldComparatorEnum::SortedNumericDouble(c)) => {
        comparator.set_scorer(scorer, &mut c.base)
      },
      (Self::Float(comparator), FieldComparatorEnum::Float(c)) => comparator.set_scorer(scorer, c),
      (Self::Float(comparator), FieldComparatorEnum::SortedNumericFloat(c)) => {
        comparator.set_scorer(scorer, &mut c.base)
      },
      (Self::Int(comparator), FieldComparatorEnum::Int(c)) => comparator.set_scorer(scorer, c),
      (Self::Int(comparator), FieldComparatorEnum::SortedNumericInt(c)) => {
        comparator.set_scorer(scorer, &mut c.base)
      },
      (Self::Long(comparator), FieldComparatorEnum::Long(c)) => comparator.set_scorer(scorer, c),
      (Self::Long(comparator), FieldComparatorEnum::SortedNumericLong(c)) => {
        comparator.set_scorer(scorer, &mut c.base)
      },
      (Self::TermVal(comparator), FieldComparatorEnum::TermVal(c)) => {
        comparator.set_scorer(scorer, c)
      },
      (Self::TermOrdVal(comparator), FieldComparatorEnum::TermOrdValue(c)) => {
        comparator.set_scorer(scorer, c)
      },
      (Self::TermOrdVal(comparator), FieldComparatorEnum::SortedDocValuesTermOrdVal(c)) => {
        comparator.set_scorer(scorer, &mut c.base)
      },
      (Self::LatLonPointDistance(comparator), FieldComparatorEnum::LatLonPointDistance(c)) => {
        comparator.set_scorer(scorer, c)
      },
      (Self::XYPointDistance(comparator), FieldComparatorEnum::XYPointDistance(c)) => {
        comparator.set_scorer(scorer, c)
      },
      _ => Err(LuceneError::illegal_state("Mismatched comparator types")),
    }
  }

  type DocIdSetIteratorRef<'a>
    = LeafFieldComparatorDocIdSetIteratorRef<'a, LR>
  where
    LR: 'a;

  fn competitive_iterator(
    &mut self,
    comparator: &mut Self::FieldComparator,
  ) -> Result<Option<Self::DocIdSetIteratorRef<'_>>> {
    match (self, comparator) {
      (Self::Relevance(_comparator), FieldComparatorEnum::Relevance(_c)) => Ok(None),
      (Self::Doc(comparator), FieldComparatorEnum::Doc(c)) => comparator
        .competitive_iterator(c)
        .map(|opt| opt.map(DocIdSetIteratorEnum3::A)),
      (Self::Double(comparator), FieldComparatorEnum::Double(c)) => comparator
        .competitive_iterator(c)
        .map(|opt| opt.map(DocIdSetIteratorEnum3::B)),
      (Self::Double(comparator), FieldComparatorEnum::SortedNumericDouble(c)) => comparator
        .competitive_iterator(&mut c.base)
        .map(|opt| opt.map(DocIdSetIteratorEnum3::B)),
      (Self::Float(comparator), FieldComparatorEnum::Float(c)) => comparator
        .competitive_iterator(c)
        .map(|opt| opt.map(DocIdSetIteratorEnum3::B)),
      (Self::Float(comparator), FieldComparatorEnum::SortedNumericFloat(c)) => comparator
        .competitive_iterator(&mut c.base)
        .map(|opt| opt.map(DocIdSetIteratorEnum3::B)),
      (Self::Int(comparator), FieldComparatorEnum::Int(c)) => comparator
        .competitive_iterator(c)
        .map(|opt| opt.map(DocIdSetIteratorEnum3::B)),
      (Self::Int(comparator), FieldComparatorEnum::SortedNumericInt(c)) => comparator
        .competitive_iterator(&mut c.base)
        .map(|opt| opt.map(DocIdSetIteratorEnum3::B)),
      (Self::Long(comparator), FieldComparatorEnum::Long(c)) => comparator
        .competitive_iterator(c)
        .map(|opt| opt.map(DocIdSetIteratorEnum3::B)),
      (Self::Long(comparator), FieldComparatorEnum::SortedNumericLong(c)) => comparator
        .competitive_iterator(&mut c.base)
        .map(|opt| opt.map(DocIdSetIteratorEnum3::B)),
      (Self::TermVal(_comparator), FieldComparatorEnum::TermVal(_c)) => Ok(None),
      (Self::TermOrdVal(comparator), FieldComparatorEnum::TermOrdValue(c)) => comparator
        .competitive_iterator(c)
        .map(|opt| opt.map(DocIdSetIteratorEnum3::C)),

      (Self::TermOrdVal(comparator), FieldComparatorEnum::SortedDocValuesTermOrdVal(c)) => {
        comparator
          .competitive_iterator(&mut c.base)
          .map(|opt| opt.map(DocIdSetIteratorEnum3::C))
      },
      (Self::LatLonPointDistance(_comparator), FieldComparatorEnum::LatLonPointDistance(_c)) => {
        Ok(None)
      },
      (Self::XYPointDistance(_comparator), FieldComparatorEnum::XYPointDistance(_c)) => Ok(None),
      _ => Ok(None),
    }
  }

  fn set_hits_threshold_reached(&mut self, comparator: &mut Self::FieldComparator) -> Result<()> {
    match (self, comparator) {
      (Self::Relevance(comparator), FieldComparatorEnum::Relevance(c)) => {
        comparator.set_hits_threshold_reached(c)
      },
      (Self::Doc(comparator), FieldComparatorEnum::Doc(c)) => {
        comparator.set_hits_threshold_reached(c)
      },
      (Self::Double(comparator), FieldComparatorEnum::Double(c)) => {
        comparator.set_hits_threshold_reached(c)
      },
      (Self::Double(comparator), FieldComparatorEnum::SortedNumericDouble(c)) => {
        comparator.set_hits_threshold_reached(&mut c.base)
      },
      (Self::Float(comparator), FieldComparatorEnum::Float(c)) => {
        comparator.set_hits_threshold_reached(c)
      },
      (Self::Float(comparator), FieldComparatorEnum::SortedNumericFloat(c)) => {
        comparator.set_hits_threshold_reached(&mut c.base)
      },
      (Self::Int(comparator), FieldComparatorEnum::Int(c)) => {
        comparator.set_hits_threshold_reached(c)
      },
      (Self::Int(comparator), FieldComparatorEnum::SortedNumericInt(c)) => {
        comparator.set_hits_threshold_reached(&mut c.base)
      },
      (Self::Long(comparator), FieldComparatorEnum::Long(c)) => {
        comparator.set_hits_threshold_reached(c)
      },
      (Self::Long(comparator), FieldComparatorEnum::SortedNumericLong(c)) => {
        comparator.set_hits_threshold_reached(&mut c.base)
      },
      (Self::TermVal(comparator), FieldComparatorEnum::TermVal(c)) => {
        comparator.set_hits_threshold_reached(c)
      },
      (Self::TermOrdVal(comparator), FieldComparatorEnum::TermOrdValue(c)) => {
        comparator.set_hits_threshold_reached(c)
      },

      (Self::TermOrdVal(comparator), FieldComparatorEnum::SortedDocValuesTermOrdVal(c)) => {
        comparator.set_hits_threshold_reached(&mut c.base)
      },
      (Self::LatLonPointDistance(comparator), FieldComparatorEnum::LatLonPointDistance(c)) => {
        comparator.set_hits_threshold_reached(c)
      },
      (Self::XYPointDistance(comparator), FieldComparatorEnum::XYPointDistance(c)) => {
        comparator.set_hits_threshold_reached(c)
      },
      _ => Err(LuceneError::illegal_state("Mismatched comparator types")),
    }
  }
}