ferntree 0.6.0

Concurrent in-memory B+ Tree featuring optimistic lock coupling
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
//! # Integration Tests for Ferntree B+ Tree
//!
//! This module contains end-to-end integration tests that exercise the tree
//! through its public API with realistic workloads.

use ferntree::Tree;
use rand::prelude::*;

// ===========================================================================
// Large Scale Operation Tests
// ===========================================================================

#[test]
fn large_scale_insert_and_lookup() {
	let tree: Tree<i32, i32> = Tree::new();

	// Insert 10,000 entries
	for i in 0..10_000 {
		tree.insert(i, i * 10);
	}

	tree.assert_invariants();
	assert_eq!(tree.len(), 10_000);

	// Verify all entries are findable
	for i in 0..10_000 {
		assert_eq!(tree.lookup(&i, |v| *v), Some(i * 10), "Failed to find key {}", i);
	}
}

#[test]
fn large_scale_insert_and_remove() {
	let tree: Tree<i32, i32> = Tree::new();

	// Insert 10,000 entries
	for i in 0..10_000 {
		tree.insert(i, i);
	}

	tree.assert_invariants();

	// Remove all entries
	for i in 0..10_000 {
		assert_eq!(tree.remove(&i), Some(i), "Failed to remove key {}", i);
	}

	tree.assert_invariants();
	assert!(tree.is_empty());
}

#[test]
fn large_scale_random_operations() {
	let tree: Tree<i32, i32> = Tree::new();
	let mut rng = rand::rng();

	// Random insert/delete/lookup operations
	let mut expected: std::collections::BTreeMap<i32, i32> = std::collections::BTreeMap::new();

	for _ in 0..10_000 {
		let key: i32 = rng.random_range(0..1000);
		let op: u8 = rng.random_range(0..3);

		match op {
			0 => {
				// Insert
				let value = key * 10;
				tree.insert(key, value);
				expected.insert(key, value);
			}
			1 => {
				// Remove
				let tree_result = tree.remove(&key);
				let expected_result = expected.remove(&key);
				assert_eq!(tree_result, expected_result);
			}
			2 => {
				// Lookup
				let tree_result = tree.lookup(&key, |v| *v);
				let expected_result = expected.get(&key).copied();
				assert_eq!(tree_result, expected_result);
			}
			_ => unreachable!(),
		}
	}

	tree.assert_invariants();

	// Verify final state matches
	assert_eq!(tree.len(), expected.len());

	for (k, v) in expected.iter() {
		assert_eq!(tree.lookup(k, |val| *val), Some(*v));
	}
}

// ===========================================================================
// Sequential and Random Key Pattern Tests
// ===========================================================================

#[test]
fn sequential_keys_ascending() {
	let tree: Tree<i32, i32> = Tree::new();

	for i in 0..5000 {
		tree.insert(i, i);
	}

	tree.assert_invariants();

	// Verify sorted order
	let mut iter = tree.raw_iter();
	iter.seek_to_first();

	let mut prev = -1;
	while let Some((k, _)) = iter.next() {
		assert!(*k > prev);
		prev = *k;
	}
	assert_eq!(prev, 4999);
}

#[test]
fn sequential_keys_descending() {
	let tree: Tree<i32, i32> = Tree::new();

	for i in (0..5000).rev() {
		tree.insert(i, i);
	}

	tree.assert_invariants();

	// Verify sorted order
	let mut iter = tree.raw_iter();
	iter.seek_to_first();

	let mut prev = -1;
	while let Some((k, _)) = iter.next() {
		assert!(*k > prev);
		prev = *k;
	}
	assert_eq!(prev, 4999);
}

#[test]
fn random_keys() {
	let tree: Tree<i32, i32> = Tree::new();
	let mut rng = rand::rng();

	let mut keys: Vec<i32> = (0..5000).collect();
	keys.shuffle(&mut rng);

	for k in &keys {
		tree.insert(*k, *k * 10);
	}

	tree.assert_invariants();

	// Verify all entries
	for k in &keys {
		assert_eq!(tree.lookup(k, |v| *v), Some(*k * 10));
	}

	// Verify sorted order
	let mut iter = tree.raw_iter();
	iter.seek_to_first();

	let mut prev = -1;
	while let Some((k, _)) = iter.next() {
		assert!(*k > prev);
		prev = *k;
	}
}

#[test]
fn sparse_keys() {
	let tree: Tree<i64, i64> = Tree::new();

	// Insert keys that are far apart
	let keys = [0, 1000, 2000, 10000, 100000, 1000000, i64::MAX - 1];

	for k in keys {
		tree.insert(k, k);
	}

	tree.assert_invariants();

	for k in keys {
		assert_eq!(tree.lookup(&k, |v| *v), Some(k));
	}
}

// ===========================================================================
// Full Tree Deletion Tests
// ===========================================================================

#[test]
fn delete_all_forward() {
	let tree: Tree<i32, i32> = Tree::new();

	for i in 0..1000 {
		tree.insert(i, i);
	}

	tree.assert_invariants();

	for i in 0..1000 {
		tree.remove(&i);
	}

	tree.assert_invariants();
	assert!(tree.is_empty());
}

#[test]
fn delete_all_reverse() {
	let tree: Tree<i32, i32> = Tree::new();

	for i in 0..1000 {
		tree.insert(i, i);
	}

	tree.assert_invariants();

	for i in (0..1000).rev() {
		tree.remove(&i);
	}

	tree.assert_invariants();
	assert!(tree.is_empty());
}

#[test]
fn delete_all_random() {
	let tree: Tree<i32, i32> = Tree::new();
	let mut rng = rand::rng();

	for i in 0..1000 {
		tree.insert(i, i);
	}

	tree.assert_invariants();

	let mut keys: Vec<i32> = (0..1000).collect();
	keys.shuffle(&mut rng);

	for k in keys {
		tree.remove(&k);
	}

	tree.assert_invariants();
	assert!(tree.is_empty());
}

#[test]
fn delete_every_other() {
	let tree: Tree<i32, i32> = Tree::new();

	for i in 0..1000 {
		tree.insert(i, i);
	}

	tree.assert_invariants();

	// Delete even keys
	for i in (0..1000).step_by(2) {
		tree.remove(&i);
	}

	tree.assert_invariants();
	assert_eq!(tree.len(), 500);

	// Verify remaining keys
	for i in 0..1000 {
		if i % 2 == 0 {
			assert_eq!(tree.lookup(&i, |v| *v), None);
		} else {
			assert_eq!(tree.lookup(&i, |v| *v), Some(i));
		}
	}
}

// ===========================================================================
// Iterator Full Scan Tests
// ===========================================================================

#[test]
fn full_forward_scan() {
	let tree: Tree<i32, i32> = Tree::new();

	for i in 0..5000 {
		tree.insert(i, i * 2);
	}

	tree.assert_invariants();

	let mut iter = tree.raw_iter();
	iter.seek_to_first();

	let mut count = 0;
	while let Some((k, v)) = iter.next() {
		assert_eq!(*k, count);
		assert_eq!(*v, count * 2);
		count += 1;
	}
	assert_eq!(count, 5000);
}

#[test]
fn full_reverse_scan() {
	let tree: Tree<i32, i32> = Tree::new();

	for i in 0..5000 {
		tree.insert(i, i * 2);
	}

	tree.assert_invariants();

	let mut iter = tree.raw_iter();
	iter.seek_to_last();

	let mut count = 4999i32;
	while let Some((k, v)) = iter.prev() {
		assert_eq!(*k, count);
		assert_eq!(*v, count * 2);
		count -= 1;
	}
	assert_eq!(count, -1);
}

#[test]
fn forward_then_reverse_scan() {
	let tree: Tree<i32, i32> = Tree::new();

	for i in 0..100 {
		tree.insert(i, i);
	}

	tree.assert_invariants();

	let mut iter = tree.raw_iter();
	iter.seek_to_first();

	// Forward to middle
	for _ in 0..50 {
		iter.next();
	}

	// Reverse to beginning
	let mut collected = Vec::new();
	while let Some((k, _)) = iter.prev() {
		collected.push(*k);
	}

	// Should have 50 elements (49 down to 0)
	assert_eq!(collected.len(), 50);
	assert_eq!(collected[0], 49);
	assert_eq!(collected[49], 0);
}

// ===========================================================================
// Range Query Tests
// ===========================================================================

#[test]
fn range_query_forward() {
	let tree: Tree<i32, i32> = Tree::new();

	for i in 0..1000 {
		tree.insert(i, i);
	}

	tree.assert_invariants();

	// Query range [250, 750)
	let mut iter = tree.raw_iter();
	iter.seek(&250);

	let mut collected = Vec::new();
	while let Some((k, _)) = iter.next() {
		if *k >= 750 {
			break;
		}
		collected.push(*k);
	}

	assert_eq!(collected.len(), 500);
	assert_eq!(collected[0], 250);
	assert_eq!(collected[499], 749);
}

#[test]
fn range_query_reverse() {
	let tree: Tree<i32, i32> = Tree::new();

	for i in 0..1000 {
		tree.insert(i, i);
	}

	tree.assert_invariants();

	// Query range (250, 750] in reverse
	let mut iter = tree.raw_iter();
	iter.seek_for_prev(&750);

	let mut collected = Vec::new();
	while let Some((k, _)) = iter.prev() {
		if *k <= 250 {
			break;
		}
		collected.push(*k);
	}

	// 750 down to 251 = 500 elements
	assert_eq!(collected.len(), 500);
	assert_eq!(collected[0], 750);
	assert_eq!(collected[499], 251);
}

#[test]
fn range_query_nonexistent_bounds() {
	let tree: Tree<i32, i32> = Tree::new();

	// Insert only even numbers
	for i in (0..1000).step_by(2) {
		tree.insert(i, i);
	}

	tree.assert_invariants();

	// Seek to 251 (doesn't exist, should position at 252)
	let mut iter = tree.raw_iter();
	iter.seek(&251);

	let (k, _) = iter.next().unwrap();
	assert_eq!(*k, 252);
}

// ===========================================================================
// Remove During Iteration Tests
// ===========================================================================

#[test]
fn remove_via_exclusive_iterator() {
	let tree: Tree<i32, i32> = Tree::new();

	for i in 0..100 {
		tree.insert(i, i);
	}

	tree.assert_invariants();

	// Remove every other element using exclusive iterator
	{
		let mut iter = tree.raw_iter_mut();
		for i in (0..100).step_by(2) {
			iter.remove(&i);
		}
	}

	tree.assert_invariants();
	assert_eq!(tree.len(), 50);

	// Verify remaining elements
	for i in 0..100 {
		if i % 2 == 0 {
			assert_eq!(tree.lookup(&i, |v| *v), None);
		} else {
			assert_eq!(tree.lookup(&i, |v| *v), Some(i));
		}
	}
}

#[test]
fn insert_via_exclusive_iterator() {
	let tree: Tree<i32, i32> = Tree::new();

	{
		let mut iter = tree.raw_iter_mut();
		for i in 0..100 {
			iter.insert(i, i * 10);
		}
	}

	tree.assert_invariants();
	assert_eq!(tree.len(), 100);

	for i in 0..100 {
		assert_eq!(tree.lookup(&i, |v| *v), Some(i * 10));
	}
}

// ===========================================================================
// Edge Case Tests
// ===========================================================================

#[test]
fn single_element_operations() {
	let tree: Tree<i32, i32> = Tree::new();

	tree.insert(42, 420);
	tree.assert_invariants();
	assert_eq!(tree.len(), 1);
	assert_eq!(tree.height(), 1);
	assert_eq!(tree.lookup(&42, |v| *v), Some(420));

	tree.remove(&42);
	tree.assert_invariants();
	assert!(tree.is_empty());
}

#[test]
fn two_element_operations() {
	let tree: Tree<i32, i32> = Tree::new();

	tree.insert(1, 10);
	tree.insert(2, 20);
	tree.assert_invariants();

	// Forward iteration
	let mut iter = tree.raw_iter();
	iter.seek_to_first();
	assert_eq!(*iter.next().unwrap().0, 1);
	assert_eq!(*iter.next().unwrap().0, 2);
	assert!(iter.next().is_none());

	// Reverse iteration
	iter.seek_to_last();
	assert_eq!(*iter.prev().unwrap().0, 2);
	assert_eq!(*iter.prev().unwrap().0, 1);
	assert!(iter.prev().is_none());
}

#[test]
fn boundary_keys_i32() {
	let tree: Tree<i32, i32> = Tree::new();

	tree.insert(i32::MIN, 1);
	tree.insert(0, 2);
	tree.insert(i32::MAX, 3);

	tree.assert_invariants();

	assert_eq!(tree.lookup(&i32::MIN, |v| *v), Some(1));
	assert_eq!(tree.lookup(&0, |v| *v), Some(2));
	assert_eq!(tree.lookup(&i32::MAX, |v| *v), Some(3));

	// Verify order
	let mut iter = tree.raw_iter();
	iter.seek_to_first();
	assert_eq!(*iter.next().unwrap().0, i32::MIN);
	assert_eq!(*iter.next().unwrap().0, 0);
	assert_eq!(*iter.next().unwrap().0, i32::MAX);
}

#[test]
fn string_keys_various_lengths() {
	let tree: Tree<String, i32> = Tree::new();

	let keys = [
		"".to_string(),
		"a".to_string(),
		"ab".to_string(),
		"abc".to_string(),
		"x".repeat(100),
		"x".repeat(1000),
	];

	for (i, k) in keys.iter().enumerate() {
		tree.insert(k.clone(), i as i32);
	}

	tree.assert_invariants();

	for (i, k) in keys.iter().enumerate() {
		assert_eq!(tree.lookup(k, |v| *v), Some(i as i32));
	}
}

#[test]
fn consecutive_duplicates() {
	let tree: Tree<i32, i32> = Tree::new();

	// Insert same key multiple times
	for i in 0..100 {
		tree.insert(42, i);
	}

	tree.assert_invariants();

	// Only the last value should be stored
	assert_eq!(tree.len(), 1);
	assert_eq!(tree.lookup(&42, |v| *v), Some(99));
}

// ===========================================================================
// Tree Height Tests
// ===========================================================================

#[test]
fn height_increases_with_inserts() {
	let tree: Tree<i32, i32> = Tree::new();

	tree.assert_invariants();
	assert_eq!(tree.height(), 1);

	// Insert enough to cause at least one level of splits
	for i in 0..200 {
		tree.insert(i, i);
	}

	tree.assert_invariants();
	assert!(tree.height() >= 2);
}

#[test]
fn height_with_many_inserts() {
	let tree: Tree<i32, i32> = Tree::new();

	// Insert many elements
	for i in 0..10_000 {
		tree.insert(i, i);
	}

	tree.assert_invariants();

	// With leaf capacity 64 and internal capacity 64,
	// 10000 entries should result in height >= 3
	let height = tree.height();
	assert!(height >= 2, "Height was {} but expected >= 2", height);
}

// ===========================================================================
// Value Types Tests
// ===========================================================================

#[test]
fn complex_value_type() {
	#[derive(Clone, Debug, PartialEq)]
	struct ComplexValue {
		data: Vec<u8>,
		count: usize,
		name: String,
	}

	// SAFETY: BoxedSlot synchronises all access via AtomicPtr; the
	// displaced Box is returned for epoch-defer drop. ComplexValue is
	// Send + Sync + Clone + 'static.
	unsafe impl ferntree::OptimisticRead for ComplexValue {
		const EPOCH_DEFERRED_DROP: bool = true;
		type Slot = ferntree::atomic_slot::BoxedSlot<Self>;
	}

	let tree: Tree<i32, ComplexValue> = Tree::new();

	for i in 0..100 {
		tree.insert(
			i,
			ComplexValue {
				data: vec![i as u8; 10],
				count: i as usize,
				name: format!("item_{}", i),
			},
		);
	}

	tree.assert_invariants();

	let result = tree.lookup(&50, |v| v.clone());
	assert!(result.is_some());
	let value = result.unwrap();
	assert_eq!(value.count, 50);
	assert_eq!(value.name, "item_50");
	assert_eq!(value.data, vec![50u8; 10]);
}

#[test]
fn zero_sized_value() {
	let tree: Tree<i32, ()> = Tree::new();

	for i in 0..100 {
		tree.insert(i, ());
	}

	tree.assert_invariants();
	assert_eq!(tree.len(), 100);
	assert!(tree.lookup(&50, |_| true).unwrap());
}