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
/*
 * 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::util::error::lucene_error::{LuceneError, Result};
use std::cmp::Ordering;

use crate::core::util::packed::bulk_operation::BulkOperation;
use crate::core::util::packed::{Decoder, Encoder, PackedInts};

pub(crate) struct BulkOperationPacked {
  bits_per_value: i32,
  long_block_count: usize,
  long_value_count: usize,
  byte_block_count: usize,
  byte_value_count: usize,
  mask: u64,
  int_mask: u32,
}
impl BulkOperationPacked {
  pub const fn new(bits_per_value: usize) -> Self {
    debug_assert!(
      bits_per_value > 0 && bits_per_value <= 64,
      "bitsPerValue must be > 0 and <= 64"
    );

    let mut blocks = bits_per_value;
    while blocks & 1 == 0 {
      blocks >>= 1;
    }
    let long_block_count = blocks;
    let long_value_count = 64 * long_block_count / bits_per_value;

    let mut byte_block_count = 8 * long_block_count;
    let mut byte_value_count = long_value_count;
    while byte_block_count & 1 == 0 && byte_value_count & 1 == 0 {
      byte_block_count >>= 1;
      byte_value_count >>= 1;
    }

    let mask = if bits_per_value == 64 {
      !0u64
    } else {
      (1u64 << bits_per_value) - 1
    };

    let int_mask = mask as u32;

    debug_assert!(
      long_value_count * bits_per_value == 64 * long_block_count,
      "longValueCount * bitsPerValue must equal 64 * longBlockCount"
    );
    BulkOperationPacked {
      bits_per_value: bits_per_value as i32,
      long_block_count,
      long_value_count,
      byte_block_count,
      byte_value_count,
      mask,
      int_mask,
    }
  }
}
impl Decoder for BulkOperationPacked {
  fn long_block_count(&self) -> usize {
    self.long_block_count
  }

  fn long_value_count(&self) -> usize {
    self.long_value_count
  }

  fn byte_block_count(&self) -> usize {
    self.byte_block_count
  }

  fn byte_value_count(&self) -> usize {
    self.byte_value_count
  }

  fn decode_u64_to_i64(
    &self,
    blocks: &[u64],
    mut blocks_offset: usize,
    values: &mut [i64],
    mut values_offset: usize,
    iterations: usize,
  ) {
    let mut bits_left: i32 = 64;
    for _ in 0..(self.long_value_count * iterations) {
      bits_left -= self.bits_per_value;

      if bits_left < 0 {
        let lower_part = (blocks[blocks_offset]
          & (1u64
            .wrapping_shl((self.bits_per_value + bits_left) as u32)
            .wrapping_sub(1)))
        .wrapping_shl((-bits_left) as u32);

        blocks_offset += 1;
        let upper_part = blocks[blocks_offset].wrapping_shr((64 + bits_left) as u32);

        values[values_offset] = (lower_part | upper_part) as i64;
        bits_left += 64;
      } else {
        values[values_offset] = ((blocks[blocks_offset] >> bits_left) & self.mask) as i64;
      }
      values_offset += 1;
    }
  }

  fn decode_u8_to_i64(
    &self,
    blocks: &[u8],
    mut blocks_offset: usize,
    values: &mut [i64],
    mut values_offset: usize,
    iterations: usize,
  ) {
    let mut next_value: i64 = 0;
    let mut bits_left: i32 = self.bits_per_value;

    for _ in 0..(iterations * self.byte_block_count) {
      let bytes = blocks[blocks_offset] as i64;
      blocks_offset += 1;

      if bits_left > 8 {
        // Buffer the value
        bits_left -= 8;
        next_value |= bytes << bits_left;
      } else {
        // Flush the value
        let mut bits = 8 - bits_left;
        values[values_offset] = next_value | (bytes as u64 >> bits) as i64;
        values_offset += 1;

        while bits >= self.bits_per_value {
          bits -= self.bits_per_value;
          values[values_offset] = ((bytes as u64 >> bits) & self.mask) as i64;
          values_offset += 1;
        }

        bits_left = self.bits_per_value - bits;
        next_value =
          ((bytes as u64 & (1u64 << bits).wrapping_sub(1)).wrapping_shl(bits_left as u32)) as i64;
      }
    }

    debug_assert_eq!(bits_left, { self.bits_per_value });
  }

  fn decode_u64_to_i32(
    &self,
    blocks: &[u64],
    mut blocks_offset: usize,
    values: &mut [i32],
    mut values_offset: usize,
    iterations: usize,
  ) -> Result<()> {
    if self.bits_per_value > 32 {
      return Err(LuceneError::unsupported_operation(format!(
        "Cannot decode {}-bits values into an i32 slice",
        self.bits_per_value
      )));
    }

    let mut bits_left: i32 = 64;

    for _ in 0..(self.long_value_count * iterations) {
      bits_left -= self.bits_per_value;

      if bits_left < 0 {
        // Handle case where bits_left is negative
        let lower_part = (blocks[blocks_offset]
          & (1u64
            .wrapping_shl((self.bits_per_value + bits_left) as u32)
            .wrapping_sub(1)))
        .wrapping_shl((-bits_left) as u32);

        blocks_offset += 1;

        let upper_part = blocks[blocks_offset].wrapping_shr((64 + bits_left) as u32);

        values[values_offset] = (lower_part | upper_part) as i32;
        bits_left += 64;
      } else {
        values[values_offset] = ((blocks[blocks_offset] >> bits_left) & self.mask) as i32;
      }

      values_offset += 1;
    }
    Ok(())
  }

  fn decode_u8_to_i32(
    &self,
    blocks: &[u8],
    mut blocks_offset: usize,
    values: &mut [i32],
    mut values_offset: usize,
    iterations: usize,
  ) -> Result<()> {
    let mut next_value: i32 = 0;
    let mut bits_left: i32 = self.bits_per_value;

    for _ in 0..(iterations * self.byte_block_count) {
      let bytes = blocks[blocks_offset] as i32;
      blocks_offset += 1;

      if bits_left > 8 {
        // Just buffer the value
        bits_left -= 8;
        next_value |= bytes.wrapping_shl(bits_left as u32);
      } else {
        // Flush the value
        let mut bits = 8 - bits_left;
        values[values_offset] = next_value | (bytes as u32 >> bits) as i32;
        values_offset += 1;

        while bits >= self.bits_per_value {
          bits -= self.bits_per_value;
          values[values_offset] = ((bytes as u32 >> bits) & self.int_mask) as i32;
          values_offset += 1;
        }

        // Then buffer the remaining bits
        bits_left = self.bits_per_value - bits;
        next_value =
          ((bytes as u32 & (1u32 << bits).wrapping_sub(1)).wrapping_shl(bits_left as u32)) as i32;
      }
    }

    debug_assert!(bits_left == self.bits_per_value);
    Ok(())
  }
}
impl Encoder for BulkOperationPacked {
  fn long_block_count(&self) -> usize {
    Decoder::long_block_count(self)
  }

  fn long_value_count(&self) -> usize {
    Decoder::long_value_count(self)
  }

  fn byte_block_count(&self) -> usize {
    Decoder::byte_block_count(self)
  }

  fn byte_value_count(&self) -> usize {
    Decoder::byte_value_count(self)
  }

  // Match the integer directly while keeping the three encoding cases unchanged.
  fn encode_i64_to_u64(
    &self,
    values: &[i64],
    mut values_offset: usize,
    blocks: &mut [u64],
    mut blocks_offset: usize,
    iterations: usize,
  ) {
    let mut remaining_values = self.long_value_count * iterations;
    if iterations >= 2
      && matches!(self.bits_per_value, 16 | 32)
      && let Some(input) = values
        .get(values_offset..)
        .and_then(|values| values.get(..remaining_values))
      && let Some(output) = blocks
        .get_mut(blocks_offset..)
        .and_then(|blocks| blocks.get_mut(..iterations))
    {
      use wide::{bytemuck::cast, u64x2};

      let (pairs, _) = output.as_chunks_mut::<2>();
      if self.bits_per_value == 16 {
        for (pair, group) in pairs.iter_mut().zip(input.as_chunks::<8>().0) {
          let [ab, cd, ef, gh]: [u64x2; 4] = cast(*group);
          let [a, b] = u64x2::transpose([ab, ef]);
          let [c, d] = u64x2::transpose([cd, gh]);
          *pair = ((a << 48u32) | (b << 32u32) | (c << 16u32) | d).to_array();
        }
      } else {
        for (pair, group) in pairs.iter_mut().zip(input.as_chunks::<4>().0) {
          let [ab, cd]: [u64x2; 2] = cast(*group);
          let [high, low] = u64x2::transpose([ab, cd]);
          *pair = ((high << 32u32) | low).to_array();
        }
      }
      let written = pairs.len() * 2;
      let consumed = written * self.long_value_count;
      values_offset += consumed;
      blocks_offset += written;
      remaining_values -= consumed;
    }

    let mut next_block: u64 = 0;
    let mut bits_left: i32 = 64;

    for _ in 0..remaining_values {
      bits_left -= self.bits_per_value;

      match bits_left {
        0 => {
          next_block |= values[values_offset] as u64;
          values_offset += 1;
          blocks[blocks_offset] = next_block;
          blocks_offset += 1;
          next_block = 0;
          bits_left = 64;
        },
        1.. => {
          // Buffer the value
          next_block |= (values[values_offset] << bits_left) as u64;
          values_offset += 1;
        },
        _ => {
          // Handle case where bits_left < 0
          next_block |= (values[values_offset] as u64).wrapping_shr((-bits_left) as u32);

          blocks[blocks_offset] = next_block;
          blocks_offset += 1;

          next_block = ((values[values_offset] as u64)
            & 1u64.wrapping_shl((-bits_left) as u32).wrapping_sub(1))
          .wrapping_shl((64 + bits_left) as u32);
          values_offset += 1;
          bits_left += 64;
        },
      }
    }
  }

  fn encode_i64_to_u8(
    &self,
    values: &[i64],
    mut values_offset: usize,
    blocks: &mut [u8],
    mut blocks_offset: usize,
    iterations: usize,
  ) {
    let mut next_block: i32 = 0;
    let mut bits_left: i32 = 8;

    for _ in 0..(self.byte_value_count * iterations) {
      let v = values[values_offset];
      values_offset += 1;
      debug_assert!(
        self.bits_per_value >= PackedInts::unsigned_bits_required(v),
        "Value requires more bits than allowed by bits_per_value"
      );
      if self.bits_per_value < bits_left {
        // Just buffer the value
        debug_assert!(v << (bits_left - self.bits_per_value) <= i32::MAX as i64);
        next_block |= (v << (bits_left - self.bits_per_value)) as i32;
        bits_left -= self.bits_per_value;
      } else {
        let mut bits = self.bits_per_value - bits_left;
        debug_assert!(bits >= 0);
        blocks[blocks_offset] = (next_block as u64 | ((v as u64) >> bits as u64)) as u8;
        blocks_offset += 1;

        while bits >= 8 {
          bits -= 8;
          blocks[blocks_offset] = (v as u64 >> bits) as u8;
          blocks_offset += 1;
        }
        bits_left = 8 - bits;
        debug_assert!(bits_left >= 0);
        next_block = ((v as u64 & ((1u64 << bits) - 1)) << bits_left as u64) as i32;
      }
    }

    debug_assert!(
      bits_left == 8,
      "bits_left must be reset to 8, but was {bits_left}"
    );
  }

  fn encode_i32_to_u64(
    &self,
    values: &[i32],
    mut values_offset: usize,
    blocks: &mut [u64],
    mut blocks_offset: usize,
    iterations: usize,
  ) {
    let mut next_block: u64 = 0;
    let mut bits_left: i32 = 64;

    for _ in 0..(self.long_value_count * iterations) {
      bits_left -= self.bits_per_value;
      match bits_left.cmp(&0) {
        Ordering::Greater => {
          next_block |= (values[values_offset] as u64 & 0xFFFFFFFF) << bits_left;
          values_offset += 1;
        },
        Ordering::Equal => {
          next_block |= values[values_offset] as u64 & 0xFFFFFFFF;
          values_offset += 1;
          blocks[blocks_offset] = next_block;
          blocks_offset += 1;
          next_block = 0;
          bits_left = 64;
        },
        Ordering::Less => {
          next_block |=
            (values[values_offset] as u64 & 0xFFFFFFFF).wrapping_shr((-bits_left) as u32);
          blocks[blocks_offset] = next_block;
          blocks_offset += 1;
          next_block = ((values[values_offset] as u64)
            & 1u64.wrapping_shl((-bits_left) as u32).wrapping_sub(1))
          .wrapping_shl((64 + bits_left) as u32);
          values_offset += 1;
          bits_left += 64;
        },
      }
    }
  }

  fn encode_i32_to_u8(
    &self,
    values: &[i32],
    mut values_offset: usize,
    blocks: &mut [u8],
    mut blocks_offset: usize,
    iterations: usize,
  ) {
    let mut next_block: i32 = 0;
    let mut bits_left: i32 = 8;

    for _ in 0..(self.byte_value_count * iterations) {
      let v = values[values_offset];
      values_offset += 1;
      debug_assert!(
        PackedInts::unsigned_bits_required(((v as u64) & 0xFFFFFFFF) as i64) <= self.bits_per_value,
        "Value requires more bits than allowed by bits_per_value"
      );
      if self.bits_per_value < bits_left {
        next_block |= v << (bits_left - self.bits_per_value);
        bits_left -= self.bits_per_value;
      } else {
        let mut bits = self.bits_per_value - bits_left;
        blocks[blocks_offset] = (next_block as u32 | (v as u32).wrapping_shr(bits as u32)) as u8;
        blocks_offset += 1;

        while bits >= 8 {
          bits -= 8;
          blocks[blocks_offset] = (v as u32).wrapping_shr(bits as u32) as u8;
          blocks_offset += 1;
        }
        bits_left = 8 - bits;
        next_block = (v & ((1 << bits) - 1)) << bits_left;
      }
    }
    debug_assert!(
      bits_left == 8,
      "bits_left must be reset to 8, but was {bits_left}"
    );
  }
}
impl BulkOperation for BulkOperationPacked {}

macro_rules! define_bulk_operation_packed_specialized {
  ($name:ident, $bits_per_value:literal) => {
    pub(crate) struct $name {
      base: crate::core::util::packed::bulk_operation_packed::BulkOperationPacked,
    }

    impl $name {
      pub const fn new() -> Self {
        Self {
          base: crate::core::util::packed::bulk_operation_packed::BulkOperationPacked::new(
            $bits_per_value,
          ),
        }
      }
    }

    impl Default for $name {
      fn default() -> Self {
        Self::new()
      }
    }
  };
}
pub(crate) use define_bulk_operation_packed_specialized;

macro_rules! delegate_bulk_operation_packed_decoder_counts {
  () => {
    fn long_block_count(&self) -> usize {
      crate::core::util::packed::Decoder::long_block_count(&self.base)
    }

    fn long_value_count(&self) -> usize {
      crate::core::util::packed::Decoder::long_value_count(&self.base)
    }

    fn byte_block_count(&self) -> usize {
      crate::core::util::packed::Decoder::byte_block_count(&self.base)
    }

    fn byte_value_count(&self) -> usize {
      crate::core::util::packed::Decoder::byte_value_count(&self.base)
    }
  };
}
pub(crate) use delegate_bulk_operation_packed_decoder_counts;

macro_rules! impl_bulk_operation_packed_encoder {
  ($name:ty) => {
    impl crate::core::util::packed::Encoder for $name {
      fn long_block_count(&self) -> usize {
        crate::core::util::packed::Encoder::long_block_count(&self.base)
      }

      fn long_value_count(&self) -> usize {
        crate::core::util::packed::Encoder::long_value_count(&self.base)
      }

      fn byte_block_count(&self) -> usize {
        crate::core::util::packed::Encoder::byte_block_count(&self.base)
      }

      fn byte_value_count(&self) -> usize {
        crate::core::util::packed::Encoder::byte_value_count(&self.base)
      }

      fn encode_i64_to_u64(
        &self,
        values: &[i64],
        values_offset: usize,
        blocks: &mut [u64],
        blocks_offset: usize,
        iterations: usize,
      ) {
        crate::core::util::packed::Encoder::encode_i64_to_u64(
          &self.base,
          values,
          values_offset,
          blocks,
          blocks_offset,
          iterations,
        )
      }

      fn encode_i64_to_u8(
        &self,
        values: &[i64],
        values_offset: usize,
        blocks: &mut [u8],
        blocks_offset: usize,
        iterations: usize,
      ) {
        crate::core::util::packed::Encoder::encode_i64_to_u8(
          &self.base,
          values,
          values_offset,
          blocks,
          blocks_offset,
          iterations,
        )
      }

      fn encode_i32_to_u64(
        &self,
        values: &[i32],
        values_offset: usize,
        blocks: &mut [u64],
        blocks_offset: usize,
        iterations: usize,
      ) {
        crate::core::util::packed::Encoder::encode_i32_to_u64(
          &self.base,
          values,
          values_offset,
          blocks,
          blocks_offset,
          iterations,
        )
      }

      fn encode_i32_to_u8(
        &self,
        values: &[i32],
        values_offset: usize,
        blocks: &mut [u8],
        blocks_offset: usize,
        iterations: usize,
      ) {
        crate::core::util::packed::Encoder::encode_i32_to_u8(
          &self.base,
          values,
          values_offset,
          blocks,
          blocks_offset,
          iterations,
        )
      }
    }
  };
}
pub(crate) use impl_bulk_operation_packed_encoder;