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
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
/*
 * 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::index::index_writer::Inner;
use crate::core::index::merge_policy::{
  DefaultMergeSpecification, MergeContext, MergePolicy, MergePolicyBase, MergeSpecification,
  OneMerge, assert_del_count, size,
};
use crate::core::index::merge_trigger::MergeTrigger;
use crate::core::index::segment_commit_info::SegmentCommitInfo;
use crate::core::index::segment_infos::SegmentInfos;
use crate::core::index::tiered_merge_policy::SegmentDocAndID;
use crate::core::store::directory::Directory;
use crate::core::util::TryIntoInt;
use crate::core::util::core_helper::CoreHelper;
use crate::core::util::error::lucene_error::LuceneError;
use crate::core::util::error::lucene_error::Result;
use std::collections::HashMap;
use std::fmt::{Display, Formatter};

/// Defines the allowed range of log(size) for each level. A level is computed by taking the max
/// segment log size, minus LEVEL_LOG_SPAN, and finding all segments falling within that range.
pub const LEVEL_LOG_SPAN: f64 = 0.75;
/// Default merge factor, which is how many segments are merged at a time
pub const DEFAULT_MERGE_FACTOR: usize = 10;
/// Default maximum segment size. A segment of this size or larger will never be merged.
/// See [`LogMergePolicy::set_max_merge_docs`].
pub const DEFAULT_MAX_MERGE_DOCS: i32 = i32::MAX;
/// Default noCFSRatio. If a merge's size is `>= 10%` of the index, then we disable compound
/// file for it.
///
/// See [`MergePolicyBase::set_no_cfs_ratio`](crate::core::index::merge_policy::MergePolicyBase::set_no_cfs_ratio).
pub const DEFAULT_NO_CFS_RATIO: f64 = 0.1;

/// This struct implements a [`MergePolicy`] that tries to merge segments into levels of
/// exponentially increasing size, where each level has fewer segments than the value of the merge
/// factor. Whenever extra segments (beyond the merge factor upper bound) are encountered, all
/// segments within the level are merged. You can get or set the merge factor using
/// [`LogMergePolicy::get_merge_factor()`] and [`LogMergePolicy::set_merge_factor()`] respectively.
///
/// Implementations define the [`LogMergePolicy::size`] method,
/// which specifies how a segment's size is determined. [`LogDocMergePolicy`](crate::core::index::log_doc_merge_policy::LogDocMergePolicy) is one implementation that
/// measures size by document count in the segment. [`LogByteSizeMergePolicy`](crate::core::index::log_byte_size_merge_policy::LogByteSizeMergePolicy) is another
/// implementation that measures size as the total byte size of the segment's files.
///
/// **NOTE**: This policy returns natural merges whose size is below the [`LogByteSizeMergePolicy::set_min_merge_mb`](crate::core::index::log_merge_policy::LogMergePolicy::set_min_merge_mb)
/// minimum merge size for [`LogMergePolicy::find_full_flush_merges`] full-flush merges.
#[derive(Clone)]
pub struct LogMergePolicy<T> {
  /// How many segments to merge at a time.
  pub(crate) merge_factor: usize,
  /// Any segments whose size is smaller than this value will be candidates for full-flush merges and
  /// merged more aggressively.
  pub(crate) min_merge_size: i64,
  /// If the size of a segment exceeds this value then it will never be merged.
  pub(crate) max_merge_size: i64,
  /// Although the core MPs set it explicitly, we must default in case someone
  /// out there wrote his own LMP ...
  /// If the size of a segment exceeds this value then it will never be merged during
  /// [`IndexWriter::force_merge`].
  pub(crate) max_merge_size_for_forced_merge: i64,
  /// If a segment has more than this many documents then it will never be merged.
  pub(crate) max_merge_docs: i32,
  /// If true, we pro-rate a segment's size by the percentage of non-deleted documents.
  pub(crate) calibrate_size_by_deletes: bool,
  /// Target search concurrency. This merge policy will avoid creating segments that have more than
  /// `maxDoc / targetSearchConcurrency` documents.
  pub(crate) target_search_concurrency: i32,
  pub(crate) base: MergePolicyBase,
  pub(crate) sub: T,
}

impl<T> LogMergePolicy<T> {
  /// Returns the number of segments that are merged at once and also controls the total number of
  /// segments allowed to accumulate in the index.
  pub fn get_merge_factor(&self) -> usize {
    self.merge_factor
  }
  /// Determines how often segment indices are merged by addDocument(). With smaller values, less RAM
  /// is used while indexing, and searches are faster, but indexing speed is slower. With larger
  /// values, more RAM is used during indexing, and while searches is slower, indexing is faster.
  /// Thus larger values (`> 10`) are best for batch index creation, and smaller values (`< 10`)
  /// for indices that are interactively maintained.
  pub fn set_merge_factor(&mut self, merge_factor: usize) -> Result<()> {
    if merge_factor < 2 {
      return Err(LuceneError::illegal_argument(
        "mergeFactor cannot be less than 2",
      ));
    }
    self.merge_factor = merge_factor;
    Ok(())
  }
  /// Sets whether the segment size should be calibrated by the number of deletes when choosing
  /// segments for merge.
  pub fn set_calibrate_size_by_deletes(&mut self, calibrate_size_by_deletes: bool) {
    self.calibrate_size_by_deletes = calibrate_size_by_deletes;
  }
  /// Returns true if the segment size should be calibrated by the number of deletes when choosing
  /// segments for merge.
  pub fn get_calibrate_size_by_deletes(&self) -> bool {
    self.calibrate_size_by_deletes
  }
  /// Sets the target search concurrency. This prevents creating segments that are bigger than
  /// maxDoc/targetSearchConcurrency, which in turn makes the work parallelizable into
  /// targetSearchConcurrency slices of similar doc counts.
  ///
  /// **NOTE:** Configuring a value greater than 1 will increase the number of segments in the
  /// index linearly with the value of `targetSearchConcurrency` and also increase write
  /// amplification.
  pub fn set_target_search_concurrency(&mut self, target_search_concurrency: i32) -> Result<()> {
    if target_search_concurrency < 1 {
      return Err(LuceneError::illegal_argument(format!(
        "targetSearchConcurrency must be >= 1 (got {})",
        target_search_concurrency
      )));
    }
    self.target_search_concurrency = target_search_concurrency;
    Ok(())
  }

  /// Returns the target search concurrency.
  pub fn get_target_search_concurrency(&self) -> i32 {
    self.target_search_concurrency
  }

  /// Returns true if the number of segments eligible for merging is less than or equal to the
  /// specified `maxNumSegments`.
  pub(crate) fn is_merged<D, MC>(
    &self,
    infos: &SegmentInfos<D>,
    max_num_segments: usize,
    segments_to_merge: &HashMap<String, Option<bool>>,
    merge_context: &MC,
  ) -> Result<bool>
  where
    D: Directory,
    MC: MergeContext<D>,
    T: LogMergePolicyBase,
  {
    let num_segments = infos.size();
    let mut num_to_merge = 0;
    let mut merge_info = None;
    let mut segment_is_original = false;

    let mut i = 0;
    while i < num_segments && num_to_merge <= max_num_segments {
      let info = infos
        .info(i)
        .ok_or_else(|| LuceneError::illegal_state("segment missing?"))?;
      let seg_id = info.info.get_id_key();
      let is_original = segments_to_merge.get(seg_id).copied();
      if let Some(Some(v)) = is_original {
        segment_is_original = v;
        num_to_merge += 1;
        merge_info = Some(info);
      }
      i += 1;
    }

    Ok(
      num_to_merge <= max_num_segments
        && (num_to_merge != 1 || !segment_is_original || {
          let info = merge_info.ok_or_else(|| LuceneError::illegal_state(""))?;
          self.has_merged(infos, info, merge_context)?
        }),
    )
  }

  /// Returns the merges necessary to merge the index, taking the max merge size or max merge docs
  /// into consideration. This method attempts to respect the `maxNumSegments` parameter,
  /// however it might be, due to size constraints, that more than that number of segments will
  /// remain in the index. Also, this method does not guarantee that exactly `maxNumSegments`
  /// will remain, but <= that number.
  pub(crate) fn find_forced_merges_size_limit<D, MC>(
    &self,
    infos: &SegmentInfos<D>,
    mut last: i32,
    merge_context: &MC,
  ) -> Result<Option<DefaultMergeSpecification<D>>>
  where
    D: Directory,
    MC: MergeContext<D>,
    T: LogMergePolicyBase,
  {
    debug_assert!(last > 0);
    let mut spec = MergeSpecification::new();
    let segments = infos.iter();

    let mut start = last - 1;
    while start >= 0 {
      let start_idx = start as usize;
      let info = infos
        .info(start_idx)
        .ok_or_else(|| LuceneError::illegal_state("segment missing?"))?;
      if self.size(info, merge_context)? > self.max_merge_size_for_forced_merge
        || size_docs(info, merge_context, self.calibrate_size_by_deletes)?
          > self.max_merge_docs as i64
      {
        // need to skip that segment + add a merge for the 'right' segments,
        // unless there is only 1 which is merged.
        if last - start - 1 > 1
          || (start != last - 1 && {
            let info = infos
              .info(start_idx + 1)
              .ok_or_else(|| LuceneError::illegal_state("segment missing?"))?;
            !self.has_merged(infos, info, merge_context)?
          })
        {
          // there is more than 1 segment to the right of
          // this one, or a mergeable single segment.
          spec.add(OneMerge::try_from_segments(Self::segment_metadata(
            start_idx + 1,
            last as usize,
            segments,
          ))?);
        }
        last = start;
      } else if last - start == self.merge_factor as i32 {
        // mergeFactor eligible segments were found, add them as a merge.
        spec.add(OneMerge::try_from_segments(Self::segment_metadata(
          start_idx,
          last as usize,
          segments,
        ))?);
        last = start;
      }
      start -= 1;
    }

    // Add any left-over segments, unless there is just 1
    // already fully merged
    start += 1;
    if last > 0
      && (start + 1 < last || {
        let info = infos
          .info(start as usize)
          .ok_or_else(|| LuceneError::illegal_state("segment missing?"))?;
        !self.has_merged(infos, info, merge_context)?
      })
    {
      spec.add(OneMerge::try_from_segments(Self::segment_metadata(
        start as usize,
        last as usize,
        segments,
      ))?);
    }

    if spec.merges.is_empty() {
      Ok(None)
    } else {
      Ok(Some(spec))
    }
  }
  /// Returns the merges necessary to forceMerge the index. This method constraints the returned
  /// merges only by the `maxNumSegments` parameter, and guaranteed that exactly that number of
  /// segments will remain in the index.
  pub(crate) fn find_forced_merges_max_num_segments<D, MC>(
    &self,
    infos: &SegmentInfos<D>,
    max_num_segments: usize,
    mut last: usize,
    merge_context: &MC,
  ) -> Result<Option<DefaultMergeSpecification<D>>>
  where
    D: Directory,
    MC: MergeContext<D>,
    T: LogMergePolicyBase,
  {
    let mut spec = MergeSpecification::new();
    let segments = infos.iter();

    // First, enroll all "full" merges (size
    // mergeFactor) to potentially be run concurrently:
    while last + 1 >= self.merge_factor + max_num_segments {
      let start = last - self.merge_factor;
      spec.add(OneMerge::try_from_segments(Self::segment_metadata(
        start, last, segments,
      ))?);
      last -= self.merge_factor;
    }

    // Only if there are no full merges pending do we
    // add a final partial (< mergeFactor segments) merge:
    if spec.merges.is_empty() {
      if max_num_segments == 1 {
        // Since we must merge down to 1 segment, the
        // choice is simple:
        if last > 1 || {
          let info = infos
            .info(0)
            .ok_or_else(|| LuceneError::illegal_state("segment missing?"))?;
          !self.has_merged(infos, info, merge_context)?
        } {
          spec.add(OneMerge::try_from_segments(Self::segment_metadata(
            0, last, segments,
          ))?);
        }
      } else if last > max_num_segments {
        // Take care to pick a partial merge that is
        // least cost, but does not make the index too
        // lopsided.  If we always just picked the
        // partial tail then we could produce a highly
        // lopsided index over time:

        // We must merge this many segments to leave
        // maxNumSegments in the index (from when
        // forceMerge was first kicked off):
        let final_merge_size = last - max_num_segments + 1;

        // Consider all possible starting points:
        let mut best_size = 0;
        let mut best_start = 0;

        let limit = last - final_merge_size + 1;
        let mut i = 0;
        while i < limit {
          let mut sum_size = 0;
          let mut j = 0;
          while j < final_merge_size {
            let idx = j + i;
            let info = infos
              .info(idx)
              .ok_or_else(|| LuceneError::illegal_state("segment missing?"))?;
            sum_size += self.size(info, merge_context)?;
            j += 1;
          }

          if i == 0
            || (sum_size
              < 2 * {
                let prev = infos
                  .info(i - 1)
                  .ok_or_else(|| LuceneError::illegal_state("segment missing?"))?;
                self.size(prev, merge_context)?
              }
              && sum_size < best_size)
          {
            best_start = i;
            best_size = sum_size;
          }

          i += 1;
        }

        let start = best_start;
        let end = best_start + final_merge_size;
        spec.add(OneMerge::try_from_segments(Self::segment_metadata(
          start, end, segments,
        ))?);
      }
    }

    if spec.merges.is_empty() {
      Ok(None)
    } else {
      Ok(Some(spec))
    }
  }
  /// Determines the largest segment (measured by document count) that may be merged with other
  /// segments. Small values (e.g., less than 10,000) are best for interactive indexing, as this
  /// limits the length of pauses while indexing to a few seconds. Larger values are best for batched
  /// indexing and speedier searches.
  ///
  /// The default value is [`i32::MAX`].
  ///
  /// The default merge policy ([`LogByteSizeMergePolicy`](crate::core::index::log_byte_size_merge_policy::LogByteSizeMergePolicy)) also allows you to set this limit
  /// by net size (in MB) of the segment, using [`LogMergePolicy::set_max_merge_mb`](crate::core::index::log_merge_policy::LogMergePolicy::set_max_merge_mb).
  pub fn set_max_merge_docs(&mut self, max_merge_docs: i32) {
    self.max_merge_docs = max_merge_docs;
  }
  /// Returns the largest segment (measured by document count) that may be merged with other
  /// segments.
  pub fn get_max_merge_docs(&self) -> i32 {
    self.max_merge_docs
  }
  pub fn get_meta<D>(
    start: usize,
    end: usize,
    sci: &[SegmentCommitInfo<D>],
  ) -> Result<Vec<SegmentDocAndID>> {
    let segments = Self::segment_metadata(start, end, sci);
    let mut meta = Vec::with_capacity(segments.len());
    for segment in segments {
      meta.push(segment?);
    }
    Ok(meta)
  }

  fn segment_metadata<D>(
    start: usize,
    end: usize,
    segments: &[SegmentCommitInfo<D>],
  ) -> impl ExactSizeIterator<Item = Result<SegmentDocAndID>> + '_ {
    segments.iter().take(end).skip(start).map(|segment| {
      Ok(SegmentDocAndID::new(
        segment.info.id_key.clone(),
        segment.info.max_doc()?,
      ))
    })
  }
}
/// Return the number of documents in the provided [`SegmentCommitInfo`], pro-rated by
/// percentage of non-deleted documents if [`LogMergePolicy::set_calibrate_size_by_deletes`]
/// is set.
pub(crate) fn size_docs<D, MC>(
  info: &SegmentCommitInfo<D>,
  merge_context: &MC,
  calibrate_size_by_deletes: bool,
) -> Result<i64>
where
  D: Directory,
  MC: MergeContext<D>,
{
  if calibrate_size_by_deletes {
    let del_count = merge_context.num_deletes_to_merge(info)?;
    debug_assert!(assert_del_count(del_count, info)?);
    Ok((info.info.max_doc()? - del_count) as i64)
  } else {
    Ok(info.info.max_doc()? as i64)
  }
}
/// Return the byte size of the provided [`SegmentCommitInfo`], pro-rated by percentage of
/// non-deleted documents if [`LogMergePolicy::set_calibrate_size_by_deletes`]
/// is set.
pub(crate) fn size_bytes<D, MC>(
  info: &SegmentCommitInfo<D>,
  merge_context: &MC,
  calibrate_size_by_deletes: bool,
) -> Result<i64>
where
  D: Directory,
  MC: MergeContext<D>,
{
  if calibrate_size_by_deletes {
    size(info, merge_context)
  } else {
    Ok(info.size_in_bytes()?)
  }
}

impl<T> Display for LogMergePolicy<T>
where
  T: LogMergePolicyBase,
{
  fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
    write!(
      f,
      "[{}: minMergeSize={}, mergeFactor={}, maxMergeSize={}, maxMergeSizeForForcedMerge={}, calibrateSizeByDeletes={}, maxMergeDocs={}, maxCFSSegmentSizeMB={}, noCFSRatio={}]",
      std::any::type_name::<Self>()
        .rsplit("::")
        .next()
        .unwrap_or("LogMergePolicy"),
      self.min_merge_size,
      self.merge_factor,
      self.max_merge_size,
      self.max_merge_size_for_forced_merge,
      self.calibrate_size_by_deletes,
      self.max_merge_docs,
      self.base.get_max_cfs_segment_size_mb(),
      self.base.no_cfs_ratio,
    )
  }
}

pub trait LogMergePolicyBase {
  fn size<D, MC>(
    &self,
    info: &SegmentCommitInfo<D>,
    merge_context: &MC,
    calibrate_size_by_deletes: bool,
  ) -> Result<i64>
  where
    D: Directory,
    MC: MergeContext<D>;
}

impl<D, T> MergePolicy<D> for LogMergePolicy<T>
where
  D: Directory,
  T: LogMergePolicyBase,
{
  fn get_base(&self) -> &MergePolicyBase {
    &self.base
  }

  fn get_base_mut(&mut self) -> &mut MergePolicyBase {
    &mut self.base
  }
  /// Checks if any merges are now necessary and returns a [`MergeSpecification`] if
  /// so. A merge is necessary when there are more than [`LogMergePolicy::set_merge_factor`] segments
  /// at a given level. When multiple levels have too many segments, this method will return multiple
  /// merges, allowing the [`MergeScheduler`](crate::core::index::merge_scheduler::MergeScheduler) to use concurrency.
  fn find_merges<MC>(
    &self,
    _merge_trigger: MergeTrigger,
    infos: &SegmentInfos<D>,
    inner: Option<&Inner<D>>,
    merge_context: &MC,
  ) -> Result<Option<DefaultMergeSpecification<D>>>
  where
    MC: MergeContext<D>,
  {
    let num_segments = infos.size();

    // Compute levels, which is just log (base mergeFactor)
    // of the size of each segment

    let norm: f32 = (self.merge_factor as f64).ln() as f32;

    let merging_segments = merge_context.get_merging_segments(inner);

    let mut total_doc_count: i64 = 0;
    let mut levels =
      smallvec::SmallVec::<[SegmentInfoAndLevel<'_, D>; 4]>::with_capacity(num_segments);

    for i in 0..num_segments {
      let info = infos
        .info(i)
        .ok_or_else(|| LuceneError::illegal_state("segment missing?"))?;

      total_doc_count += size_docs(info, merge_context, self.calibrate_size_by_deletes)?;
      let mut size = self.size(info, merge_context)?;

      // Floor tiny segments
      if size < 1 {
        size = 1;
      }

      let level = ((size as f64).ln() as f32) / norm;
      levels.push(SegmentInfoAndLevel::new(info, level));
    }

    let level_floor: f32 = if self.min_merge_size <= 0 {
      0.0
    } else {
      ((self.min_merge_size as f64).ln() / norm as f64) as f32
    };

    // Now, we quantize the log values into levels.  The
    // first level is any segment whose log size is within
    // LEVEL_LOG_SPAN of the max size, or, who has such as
    // segment "to the right".  Then, we find the max of all
    // other segments and use that to define the next level
    // segment, etc.

    let mut spec = None;

    let num_mergeable_segments = levels.len();

    // precompute the max level on the right side.
    // arr size is numMergeableSegments + 1 to handle the case
    // when numMergeableSegments is 0.
    let mut max_levels: smallvec::SmallVec<[f32; 16]> =
      smallvec::smallvec![0.0; num_mergeable_segments + 1];
    // -1 is definitely the minimum value, because ln(1) is 0.
    max_levels[num_mergeable_segments] = -1.0;
    for i in (0..num_mergeable_segments).rev() {
      max_levels[i] = CoreHelper::max_f32(levels[i].level, max_levels[i + 1]);
    }

    let mut start = 0;
    while start < num_mergeable_segments {
      // Find max level of all segments not already
      // quantized.
      let max_level = max_levels[start];

      // Now search backwards for the rightmost segment that
      // falls into this level:
      let level_bottom: f32 = if max_level > level_floor {
        // With a merge factor of 10, this means that the biggest segment and the smallest segment
        // that take part of a merge have a size difference of at most 5.6x.
        (max_level as f64 - LEVEL_LOG_SPAN) as f32
      } else {
        // For segments below the floor size, we allow more unbalanced merges, but still somewhat
        // balanced to avoid running into O(n^2) merging.
        // With a merge factor of 10, this means that the biggest segment and the smallest segment
        // that take part of a merge have a size difference of at most 31.6x.
        (max_level as f64 - 2.0 * LEVEL_LOG_SPAN) as f32
      };

      let mut upto = num_mergeable_segments - 1;
      while upto >= start {
        if levels[upto].level >= level_bottom {
          break;
        }
        upto -= 1;
      }

      let max_merge_docs: i64 = {
        let tsc = self.target_search_concurrency as i64;
        let ceil_div = (total_doc_count + tsc - 1) / tsc;
        (self.max_merge_docs as i64).min(ceil_div)
      };

      // Finally, record all merges that are viable at this level:
      let mut end = start + self.merge_factor;
      while end <= 1 + upto {
        let mut any_merging = false;
        let mut merge_size = 0;
        let mut merge_docs = 0;

        let mut i = start;
        while i < end {
          let seg_level = &levels[i];
          let info = seg_level.info;

          if merging_segments.contains(info.info.get_id_key()) {
            any_merging = true;
            break;
          }

          let segment_size = self.size(info, merge_context)?;
          let segment_docs = size_docs(info, merge_context, self.calibrate_size_by_deletes)?;

          if merge_size + segment_size > self.max_merge_size
            || merge_docs + segment_docs > max_merge_docs
          {
            // This merge is full, stop adding more segments to it
            if i == start {
              // This segment alone is too large, return a singleton merge
              end = i + 1;
            } else {
              // Previous segments are under the max merge size, return them
              end = i;
            }
            break;
          }

          merge_size += segment_size;
          merge_docs += segment_docs;

          i += 1;
        }

        if any_merging || end - start <= 1 {
          // skip: there is an ongoing merge at the current level or the computed merge has a single
          // segment and this merge policy doesn't do singleton merges
        } else {
          let v = spec.get_or_insert_with(MergeSpecification::new);

          let meta = levels.iter().take(end).skip(start).map(|level| {
            let info = level.info;
            debug_assert!(infos.contains(info.info.get_id_key()));
            Ok(SegmentDocAndID::new(
              info.info.id_key.clone(),
              info.info.max_doc()?,
            ))
          });
          v.add(OneMerge::try_from_segments(meta)?);
        }

        start = end;
        end = start + self.merge_factor;
      }

      start = 1 + upto;
    }

    Ok(spec)
  }
  /// Returns the merges necessary to merge the index down to a specified number of segments. This
  /// respects the [`LogMergePolicy::set_max_merge_mb_for_forced_merge`](crate::core::index::log_merge_policy::LogMergePolicy::set_max_merge_mb_for_forced_merge) setting. By default, and assuming
  /// `maxNumSegments=1`, only one segment will be left in the index, where that segment has no
  /// deletions pending nor separate norms, and it is in compound file format if the current
  /// useCompoundFile setting is true. This method returns multiple merges (mergeFactor at a time) so
  /// the [`MergeScheduler`](crate::core::index::merge_scheduler::MergeScheduler) in use may make use of concurrency.
  fn find_forced_merges<MC>(
    &self,
    segment_infos: &SegmentInfos<D>,
    max_segment_count: usize,
    segments_to_merge: &HashMap<String, Option<bool>>,
    _inner: Option<&Inner<D>>,
    merge_context: &MC,
  ) -> Result<Option<DefaultMergeSpecification<D>>>
  where
    MC: MergeContext<D>,
  {
    debug_assert!(max_segment_count > 0);

    // If the segments are already merged (e.g. there's only 1 segment), or
    // there are <maxNumSegments:.
    if self.is_merged(
      segment_infos,
      max_segment_count,
      segments_to_merge,
      merge_context,
    )? {
      return Ok(None);
    }

    // Find the newest (rightmost) segment that needs to
    // be merged (other segments may have been flushed
    // since merging started):
    let mut last = segment_infos.size();
    while last > 0 {
      last -= 1;
      let info = segment_infos
        .info(last)
        .ok_or_else(|| LuceneError::illegal_state("segment missing?"))?;
      if segments_to_merge.get(info.info.get_id_key()).is_some() {
        last += 1;
        break;
      }
    }

    if last == 0 {
      return Ok(None);
    }

    // There is only one segment already, and it is merged
    if max_segment_count == 1 && last == 1 && {
      let info0 = segment_infos
        .info(0)
        .ok_or_else(|| LuceneError::illegal_state("segment missing?"))?;
      self.has_merged(segment_infos, info0, merge_context)?
    } {
      return Ok(None);
    }

    // Check if there are any segments above the threshold
    let mut any_too_large = false;
    let mut i = 0;
    while i < last {
      let info = segment_infos
        .info(i)
        .ok_or_else(|| LuceneError::illegal_state("segment missing?"))?;
      if self.size(info, merge_context)? > self.max_merge_size_for_forced_merge
        || size_docs(info, merge_context, self.calibrate_size_by_deletes)?
          > self.max_merge_docs as i64
      {
        any_too_large = true;
        break;
      }
      i += 1;
    }

    if any_too_large {
      self.find_forced_merges_size_limit(segment_infos, last.try_convert()?, merge_context)
    } else {
      self.find_forced_merges_max_num_segments(
        segment_infos,
        max_segment_count,
        last,
        merge_context,
      )
    }
  }
  /// Finds merges necessary to force-merge all deletes from the index.
  /// We simply merge adjacent segments that have deletes, up to mergeFactor at a time.
  fn find_forced_deletes_merges<MC>(
    &self,
    segment_infos: &SegmentInfos<D>,
    _inner: Option<&Inner<D>>,
    merge_context: &MC,
  ) -> Result<Option<DefaultMergeSpecification<D>>>
  where
    MC: MergeContext<D>,
  {
    let segments = segment_infos.iter();
    let num_segments = segments.len();

    let mut spec = MergeSpecification::new();
    let mut first_segment_with_deletions: Option<usize> = None;

    let merge_factor = self.merge_factor;

    let mut i: usize = 0;
    while i < num_segments {
      let info = segment_infos
        .info(i)
        .ok_or_else(|| LuceneError::illegal_state("segment missing?"))?;
      let del_count = merge_context.num_deletes_to_merge(info)?;
      debug_assert!(assert_del_count(del_count, info)?);

      if del_count > 0 {
        match first_segment_with_deletions {
          None => {
            first_segment_with_deletions = Some(i);
          },
          Some(first) => {
            if i == first + merge_factor {
              // We've seen mergeFactor segments in a row with deletions, so force a merge now:
              spec.add(OneMerge::try_from_segments(Self::segment_metadata(
                first, i, segments,
              ))?);
              first_segment_with_deletions = Some(i);
            }
          },
        }
      } else if let Some(first) = first_segment_with_deletions {
        // End of a sequence of segments with deletions, so,
        // merge those past segments even if it's fewer than
        // mergeFactor segments
        spec.add(OneMerge::try_from_segments(Self::segment_metadata(
          first, i, segments,
        ))?);
        first_segment_with_deletions = None;
      }

      i += 1;
    }

    if let Some(first) = first_segment_with_deletions {
      spec.add(OneMerge::try_from_segments(Self::segment_metadata(
        first,
        num_segments,
        segments,
      ))?);
    }

    Ok(Some(spec))
  }

  fn size<MC>(&self, info: &SegmentCommitInfo<D>, merge_context: &MC) -> Result<i64>
  where
    MC: MergeContext<D>,
  {
    self
      .sub
      .size(info, merge_context, self.calibrate_size_by_deletes)
  }

  fn max_full_flush_merge_size(&self) -> i64 {
    self.max_merge_size
  }
}
#[derive(Clone)]
pub(crate) struct SegmentInfoAndLevel<'a, D> {
  pub(crate) info: &'a SegmentCommitInfo<D>,
  pub(crate) level: f32,
}
impl<'a, D> SegmentInfoAndLevel<'a, D> {
  fn new(info: &'a SegmentCommitInfo<D>, level: f32) -> Self {
    Self { info, level }
  }
}

impl<D> Ord for SegmentInfoAndLevel<'_, D> {
  fn cmp(&self, other: &Self) -> std::cmp::Ordering {
    CoreHelper::compare_f32(other.level, self.level)
  }
}

impl<D> PartialOrd for SegmentInfoAndLevel<'_, D> {
  fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
    Some(self.cmp(other))
  }
}

impl<D> PartialEq for SegmentInfoAndLevel<'_, D> {
  fn eq(&self, other: &Self) -> bool {
    CoreHelper::compare_f32(self.level, other.level).is_eq()
  }
}

impl<D> Eq for SegmentInfoAndLevel<'_, D> {}