jdb_pgm 0.3.4

Ultra-fast single-threaded PGM-Index optimized for thread-per-core architecture / 专为单线程一核架构优化的超快 PGM 索引
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
use aok::{OK, Void};
use jdb_pgm::PGMIndex;
use log::trace;

#[static_init::constructor(0)]
extern "C" fn _log_init() {
  log_init::init();
}

// ============================================================================
// Normal Tests / 普通测试
// ============================================================================

/// Test basic get functionality
/// 测试基本的 get 功能
#[test]
fn test_basic_get() -> Void {
  let data: Vec<u64> = (0..10_000).collect();
  let index = PGMIndex::load(data, 32, true).unwrap();

  assert_eq!(index.get(0), Some(0));
  assert_eq!(index.get(5000), Some(5000));
  assert_eq!(index.get(9999), Some(9999));
  assert_eq!(index.get(10000), None);

  trace!("basic_get passed");
  OK
}

/// Test with different epsilon values
/// 测试不同的 epsilon 值
#[test]
fn test_different_epsilon() -> Void {
  let data: Vec<u64> = (0..50_000).collect();

  for &eps in &[1usize, 4, 16, 32, 64, 128, 256] {
    let index = PGMIndex::load(data.clone(), eps, true).unwrap();
    assert!(index.segment_count() >= 1);

    for &k in &[0u64, 1000, 25000, 49999] {
      assert_eq!(index.get(k), Some(k as usize), "eps={eps}, key={k}");
    }
  }

  trace!("different_epsilon passed");
  OK
}

/// Test querying non-existent keys
/// 测试查询不存在的键
#[test]
fn test_non_existent() -> Void {
  // Even numbers only
  // 仅偶数
  let data: Vec<u64> = (0..1000).step_by(2).collect();
  let index = PGMIndex::load(data, 16, true).unwrap();

  // Odd numbers not found
  // 奇数找不到
  assert_eq!(index.get(1), None);
  assert_eq!(index.get(3), None);
  assert_eq!(index.get(999), None);

  // Even numbers found
  // 偶数能找到
  assert_eq!(index.get(0), Some(0));
  assert_eq!(index.get(2), Some(1));
  assert_eq!(index.get(998), Some(499));

  trace!("non_existent passed");
  OK
}

/// Test statistics functionality
/// 测试统计功能
#[test]
fn test_stats() -> Void {
  let data: Vec<u64> = (0..10_000).collect();
  let index = PGMIndex::load(data, 32, true).unwrap();
  let stats = index.stats();

  assert!(stats.segments >= 1);
  assert!(stats.avg_segment_size > 0.0);
  assert!(stats.memory_bytes > 0);

  trace!(
    "stats: segments={}, avg={:.2}, mem={}",
    stats.segments, stats.avg_segment_size, stats.memory_bytes
  );
  OK
}

/// Test batch lookup
/// 测试批量查找
#[test]
fn test_batch_lookup() -> Void {
  let data: Vec<u64> = (0..100_000).collect();
  let index = PGMIndex::load(data, 32, true).unwrap();

  let keys: Vec<u64> = (0..1000).map(|i| i * 100).collect();
  let results: Vec<Option<usize>> = index.get_many(keys.iter().copied()).collect();

  for (i, &k) in keys.iter().enumerate() {
    assert_eq!(results[i], Some(k as usize));
  }

  trace!("batch_lookup passed");
  OK
}

/// Test hit counting
/// 测试命中计数
#[test]
fn test_count_hits() -> Void {
  let data: Vec<u64> = (0..10_000).collect();
  let index = PGMIndex::load(data, 32, true).unwrap();

  let keys: Vec<u64> = (0..100).collect();
  assert_eq!(index.count_hits(keys.iter().copied()), 100);

  // Mix existing and non-existing
  // 混合存在和不存在的键
  let mixed: Vec<u64> = (9990..10010).collect();
  assert_eq!(index.count_hits(mixed.iter().copied()), 10);

  trace!("count_hits passed");
  OK
}

// ============================================================================
// Boundary Tests / 边界测试
// ============================================================================

/// Test with single element
/// 测试单元素
#[test]
fn test_single_element() -> Void {
  let data = vec![42u64];
  let index = PGMIndex::load(data, 1, true).unwrap();

  assert_eq!(index.get(42), Some(0));
  assert_eq!(index.get(41), None);
  assert_eq!(index.get(43), None);
  assert_eq!(index.segment_count(), 1);

  trace!("single_element passed");
  OK
}

/// Test with two elements
/// 测试两个元素
#[test]
fn test_two_elements() -> Void {
  let data = vec![10u64, 20u64];
  let index = PGMIndex::load(data, 1, true).unwrap();

  assert_eq!(index.get(10), Some(0));
  assert_eq!(index.get(20), Some(1));
  assert_eq!(index.get(15), None);
  assert_eq!(index.get(9), None);
  assert_eq!(index.get(21), None);

  trace!("two_elements passed");
  OK
}

/// Test with duplicate values
/// 测试重复值
#[test]
fn test_duplicates() -> Void {
  let data = vec![1u64, 1, 1, 2, 2, 3, 3, 3, 3];
  let index = PGMIndex::load(data, 1, true).unwrap();

  let pos = index.get(1);
  assert!(pos.is_some());
  assert!(pos.unwrap() <= 2);

  let pos = index.get(2);
  assert!(pos.is_some());

  let pos = index.get(3);
  assert!(pos.is_some());

  assert_eq!(index.get(0), None);
  assert_eq!(index.get(4), None);

  trace!("duplicates passed");
  OK
}

/// Test with minimum epsilon (1)
/// 测试最小 epsilon (1)
#[test]
fn test_min_epsilon() -> Void {
  let data: Vec<u64> = (0..1000).collect();
  let index = PGMIndex::load(data, 1, true).unwrap();

  assert_eq!(index.get(0), Some(0));
  assert_eq!(index.get(500), Some(500));
  assert_eq!(index.get(999), Some(999));

  trace!("min_epsilon passed");
  OK
}

/// Test with large epsilon
/// 测试大 epsilon
#[test]
fn test_large_epsilon() -> Void {
  let data: Vec<u64> = (0..10_000).collect();
  let index = PGMIndex::load(data, 1000, true).unwrap();

  assert_eq!(index.get(0), Some(0));
  assert_eq!(index.get(5000), Some(5000));
  assert_eq!(index.get(9999), Some(9999));

  trace!("large_epsilon passed");
  OK
}

/// Test boundary keys (first and last)
/// 测试边界键(第一个和最后一个)
#[test]
fn test_boundary_keys() -> Void {
  let data: Vec<u64> = (100..200).collect();
  let index = PGMIndex::load(data, 16, true).unwrap();

  assert_eq!(index.get(100), Some(0));
  assert_eq!(index.get(199), Some(99));
  assert_eq!(index.get(99), None);
  assert_eq!(index.get(200), None);

  trace!("boundary_keys passed");
  OK
}

/// Test with sparse data (large gaps)
/// 测试稀疏数据(大间隔)
#[test]
fn test_sparse_data() -> Void {
  let data: Vec<u64> = vec![1, 100, 10000, 1000000, 100000000];
  let index = PGMIndex::load(data, 4, true).unwrap();

  assert_eq!(index.get(1), Some(0));
  assert_eq!(index.get(100), Some(1));
  assert_eq!(index.get(10000), Some(2));
  assert_eq!(index.get(1000000), Some(3));
  assert_eq!(index.get(100000000), Some(4));

  assert_eq!(index.get(50), None);
  assert_eq!(index.get(5000), None);

  trace!("sparse_data passed");
  OK
}

/// Test with dense consecutive data
/// 测试密集连续数据
#[test]
fn test_dense_data() -> Void {
  let data: Vec<u64> = (0..100_000).collect();
  let index = PGMIndex::load(data, 32, true).unwrap();

  for k in [0u64, 1, 100, 1000, 50000, 99998, 99999] {
    assert_eq!(index.get(k), Some(k as usize));
  }

  trace!("dense_data passed");
  OK
}

// ============================================================================
// Type Tests / 类型测试
// ============================================================================

/// Test with different key types (u8, i32, u16)
/// 测试不同的键类型 (u8, i32, u16)
#[test]
fn test_key_types() -> Void {
  // u8
  let data_u8: Vec<u8> = (0..=255).collect();
  let idx = PGMIndex::load(data_u8, 4, true).unwrap();
  assert_eq!(idx.get(0u8), Some(0));
  assert_eq!(idx.get(255u8), Some(255));

  // i32
  let data_i32: Vec<i32> = (-500..500).collect();
  let idx = PGMIndex::load(data_i32, 16, true).unwrap();
  assert_eq!(idx.get(-500i32), Some(0));
  assert_eq!(idx.get(0i32), Some(500));
  assert_eq!(idx.get(499i32), Some(999));

  // u16
  let data_u16: Vec<u16> = (0..10000).map(|x| x as u16).collect();
  let idx = PGMIndex::load(data_u16, 16, true).unwrap();
  assert_eq!(idx.get(0u16), Some(0));
  assert_eq!(idx.get(9999u16), Some(9999));

  trace!("key_types passed");
  OK
}

/// Test with negative keys
/// 测试负数键
#[test]
fn test_negative_keys() -> Void {
  let data: Vec<i64> = (-1000..1000).collect();
  let index = PGMIndex::load(data, 32, true).unwrap();

  assert_eq!(index.get(-1000i64), Some(0));
  assert_eq!(index.get(-1i64), Some(999));
  assert_eq!(index.get(0i64), Some(1000));
  assert_eq!(index.get(999i64), Some(1999));
  assert_eq!(index.get(-1001i64), None);
  assert_eq!(index.get(1000i64), None);

  trace!("negative_keys passed");
  OK
}

// ============================================================================
// Memory Tests / 内存测试
// ============================================================================

/// Test memory usage calculation
/// 测试内存使用计算
#[test]
fn test_memory_usage() -> Void {
  let data: Vec<u64> = (0..100_000).collect();
  let index = PGMIndex::load(data, 32, true).unwrap();

  let mem = index.memory_usage();
  // Min: data (100k * 8 bytes) = 800KB
  // 最小:数据 (100k * 8 字节) = 800KB
  assert!(mem >= 800_000);

  trace!("memory_usage: {mem} bytes");
  OK
}

/// Test segment count varies with epsilon
/// 测试段数随 epsilon 变化
#[test]
fn test_segment_count_vs_epsilon() -> Void {
  let data: Vec<u64> = (0..100_000).collect();

  let idx_small = PGMIndex::load(data.clone(), 8, true).unwrap();
  let idx_large = PGMIndex::load(data, 128, true).unwrap();

  // Smaller epsilon -> more segments
  // 更小的 epsilon -> 更多的段
  assert!(idx_small.segment_count() >= idx_large.segment_count());

  trace!(
    "segment_count: small={}, large={}",
    idx_small.segment_count(),
    idx_large.segment_count()
  );
  OK
}

// ============================================================================
// Edge Cases / 极端情况
// ============================================================================

/// Test with all same values
/// 测试所有相同的值
#[test]
fn test_all_same() -> Void {
  let data = vec![42u64; 100];
  let index = PGMIndex::load(data, 1, true).unwrap();

  let pos = index.get(42);
  assert!(pos.is_some());
  assert!(pos.unwrap() < 100);

  assert_eq!(index.get(41), None);
  assert_eq!(index.get(43), None);

  trace!("all_same passed");
  OK
}

/// Test with large u64 values near MAX
/// 测试接近 MAX 的大 u64 值
#[test]
fn test_large_values() -> Void {
  let base = u64::MAX - 1000;
  let data: Vec<u64> = (0..1000).map(|i| base + i).collect();
  let index = PGMIndex::load(data, 16, true).unwrap();

  assert_eq!(index.get(base), Some(0));
  assert_eq!(index.get(base + 500), Some(500));
  assert_eq!(index.get(base + 999), Some(999));
  assert_eq!(index.get(base - 1), None);

  trace!("large_values passed");
  OK
}

/// Test batch lookup with empty keys
/// 测试空键的批量查找
#[test]
fn test_empty_batch() -> Void {
  let data: Vec<u64> = (0..1000).collect();
  let index = PGMIndex::load(data, 16, true).unwrap();

  let empty: Vec<u64> = vec![];
  let results: Vec<Option<usize>> = index.get_many(empty).collect();
  assert!(results.is_empty());

  trace!("empty_batch passed");
  OK
}

// ============================================================================
// Additional Tests / 补充测试
// ============================================================================

/// Test with random sorted data
/// 测试随机排序数据
#[test]
fn test_random_data() -> Void {
  use rand::{Rng, SeedableRng, rngs::StdRng};

  let mut rng = StdRng::seed_from_u64(12345);
  let mut data: Vec<u64> = (0..10_000)
    .map(|_| rng.random_range(0..1_000_000))
    .collect();
  data.sort();
  data.dedup();

  let n = data.len();
  let index = PGMIndex::load(data.clone(), 32, true).unwrap();

  // Verify all elements can be found
  // 验证所有元素都能找到
  for (i, &k) in data.iter().enumerate() {
    assert_eq!(index.get(k), Some(i), "key={k} at index {i}");
  }

  assert_eq!(index.get(1_000_001), None);

  trace!("random_data passed, n={n}");
  OK
}

/// Test epsilon actually bounds prediction error
/// 测试 epsilon 确实限制了预测误差
#[test]
fn test_epsilon_bound() -> Void {
  let data: Vec<u64> = (0..10_000).collect();

  for &eps in &[1usize, 4, 16, 64] {
    let index = PGMIndex::load(data.clone(), eps, true).unwrap();

    for &k in &[0u64, 100, 500, 1000, 5000, 9999] {
      assert_eq!(index.get(k), Some(k as usize), "eps={eps}, key={k}");
    }
  }

  trace!("epsilon_bound passed");
  OK
}

/// Test epsilon larger than data size
/// 测试 epsilon 大于数据大小
#[test]
fn test_epsilon_larger_than_data() -> Void {
  let data: Vec<u64> = (0..100).collect();
  let index = PGMIndex::load(data, 1000, true).unwrap();

  assert_eq!(index.get(0), Some(0));
  assert_eq!(index.get(50), Some(50));
  assert_eq!(index.get(99), Some(99));
  assert_eq!(index.get(100), None);

  trace!("epsilon_larger_than_data passed");
  OK
}

/// Test i8 full range (-128 to 127)
/// 测试 i8 完整范围 (-128 到 127)
#[test]
fn test_i8_bounds() -> Void {
  let data: Vec<i8> = (-128..=127).collect();
  let index = PGMIndex::load(data, 4, true).unwrap();

  assert_eq!(index.get(-128i8), Some(0));
  assert_eq!(index.get(0i8), Some(128));
  assert_eq!(index.get(127i8), Some(255));

  trace!("i8_bounds passed");
  OK
}

/// Test segment properties
/// 测试段属性
#[test]
fn test_segment_properties() -> Void {
  let data: Vec<u64> = (0..1000).collect();
  let index = PGMIndex::load(data, 16, true).unwrap();

  assert!(index.segment_count() >= 1);
  assert!(index.avg_segment_size() > 0.0);
  assert!(index.memory_usage() > 0);

  trace!("segment_properties passed");
  OK
}

/// Test quadratic distribution (i^2)
/// 测试二次分布 (i^2)
#[test]
fn test_quadratic_data() -> Void {
  let data: Vec<u64> = (0..1000u64).map(|i| i * i).collect();
  let index = PGMIndex::load(data.clone(), 16, true).unwrap();

  for (i, &k) in data.iter().enumerate() {
    assert_eq!(index.get(k), Some(i), "key={k}");
  }

  // Not perfect squares
  // 非完全平方数
  assert_eq!(index.get(2), None);
  assert_eq!(index.get(5), None);

  trace!("quadratic_data passed");
  OK
}

/// Test exponential distribution (2^i)
/// 测试指数分布 (2^i)
#[test]
fn test_exponential_data() -> Void {
  let data: Vec<u64> = (0..20).map(|i| 1u64 << i).collect();
  let index = PGMIndex::load(data.clone(), 4, true).unwrap();

  for (i, &k) in data.iter().enumerate() {
    assert_eq!(index.get(k), Some(i), "key={k}");
  }

  assert_eq!(index.get(3), None);
  assert_eq!(index.get(5), None);

  trace!("exponential_data passed");
  OK
}

/// Test batch with mixed existing and non-existing keys
/// 测试混合存在和不存在键的批量查找
#[test]
fn test_batch_mixed() -> Void {
  // Even only
  // 仅偶数
  let data: Vec<u64> = (0..1000).step_by(2).collect();
  let index = PGMIndex::load(data, 8, true).unwrap();

  let keys: Vec<u64> = (0..20).collect();
  let results: Vec<Option<usize>> = index.get_many(keys.iter().copied()).collect();

  for (i, &k) in keys.iter().enumerate() {
    if k % 2 == 0 {
      assert_eq!(results[i], Some((k / 2) as usize));
    } else {
      assert_eq!(results[i], None);
    }
  }

  trace!("batch_mixed passed");
  OK
}

/// Test with three elements
/// 测试三个元素
#[test]
fn test_three_elements() -> Void {
  let data = vec![1u64, 50, 100];
  let index = PGMIndex::load(data, 1, true).unwrap();

  assert_eq!(index.get(1), Some(0));
  assert_eq!(index.get(50), Some(1));
  assert_eq!(index.get(100), Some(2));
  assert_eq!(index.get(0), None);
  assert_eq!(index.get(25), None);
  assert_eq!(index.get(101), None);

  trace!("three_elements passed");
  OK
}

#[test]
fn test() -> Void {
  trace!("All pgm_index tests passed!");
  OK
}