deferred-map 0.3.1

High-performance generational arena using handle-based deferred insertion with O(1) operations
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
// Removal and slot recycling comprehensive tests
// 删除和槽位回收的全面测试

use crate::{DeferredMap, Key};

#[test]
fn test_basic_removal() {
    let mut map = DeferredMap::new();

    let h = map.allocate_handle();
    let k = h.key();
    map.insert(h, 42);

    assert_eq!(map.remove(k), Some(42));
    assert_eq!(map.len(), 0);
    assert_eq!(map.get(k), None);
}

#[test]
fn test_removal_returns_correct_value() {
    let mut map = DeferredMap::new();

    let h = map.allocate_handle();
    let k = h.key();
    map.insert(h, "Hello".to_string());

    let removed = map.remove(k);
    assert_eq!(removed, Some("Hello".to_string()));
}

#[test]
fn test_removal_of_nonexistent_key() {
    let mut map = DeferredMap::<i32>::new();

    // Allocate a handle but don't insert
    // 分配 handle 但不插入
    let h = map.allocate_handle();
    let k = h.key();

    // Attempt removal - should return None as slot is reserved but not occupied
    // 尝试删除 - 应该返回 None,因为 slot 是 reserved 但未 occupied
    let result = map.remove(k);
    assert_eq!(result, None);
}

#[test]
fn test_removal_with_outdated_key() {
    let mut map = DeferredMap::new();

    let h = map.allocate_handle();
    let k1 = h.key();
    map.insert(h, 42);

    // Remove once
    // 删除一次
    map.remove(k1);

    // Try to remove again with outdated key
    // 尝试用过时的 key 再次删除
    let result = map.remove(k1);
    assert_eq!(result, None);
}

#[test]
fn test_removal_decrements_len() {
    let mut map = DeferredMap::new();

    let mut keys = Vec::new();
    for i in 0..10 {
        let h = map.allocate_handle();
        let k = h.key();
        map.insert(h, i);
        keys.push(k);
    }

    assert_eq!(map.len(), 10);

    for key in keys {
        map.remove(key);
    }

    assert_eq!(map.len(), 0);
}

#[test]
fn test_removal_allows_slot_reuse() {
    let mut map = DeferredMap::new();

    let h1 = map.allocate_handle();
    let k1 = h1.key();
    map.insert(h1, 42);
    let index1 = k1.index();

    // Remove to free slot
    // 删除以释放 slot
    map.remove(k1);

    // Allocate new handle, should reuse same slot
    // 分配新 handle,应该复用相同的 slot
    let h2 = map.allocate_handle();
    let index2 = h2.index();

    assert_eq!(index1, index2);
}

#[test]
fn test_removal_increments_generation() {
    let mut map = DeferredMap::new();

    let h1 = map.allocate_handle();
    let gen1 = h1.generation();
    let k1 = h1.key();
    map.insert(h1, 42);

    // Remove to increment generation
    // 删除以递增 generation
    map.remove(k1);

    let h2 = map.allocate_handle();
    let gen2 = h2.generation();

    // Generation (high 30 bits) should increment by 1
    // Generation(高 30 位)应该递增 1
    assert_eq!(gen2.get(), gen1.get() + 1);
}

#[test]
fn test_removal_of_multiple_elements() {
    let mut map = DeferredMap::new();

    let mut keys = Vec::new();
    for i in 0..100 {
        let h = map.allocate_handle();
        let k = h.key();
        map.insert(h, i);
        keys.push(k);
    }

    // Remove even indexed elements
    // 删除偶数索引的元素
    for i in (0..100).step_by(2) {
        let removed = map.remove(keys[i]);
        assert_eq!(removed, Some(i));
    }

    assert_eq!(map.len(), 50);

    // Verify odd indexed elements still exist
    // 验证奇数索引的元素仍然存在
    for i in (1..100).step_by(2) {
        assert_eq!(map.get(keys[i]), Some(&i));
    }
}

#[test]
fn test_removal_and_reinsertion_cycle() {
    let mut map = DeferredMap::new();

    for cycle in 0..10 {
        let h = map.allocate_handle();
        let k = h.key();
        map.insert(h, cycle);

        assert_eq!(map.get(k), Some(&cycle));
        assert_eq!(map.remove(k), Some(cycle));
        assert_eq!(map.get(k), None);
    }
}

#[test]
fn test_removal_with_custom_drop() {
    use std::sync::{
        Arc,
        atomic::{AtomicUsize, Ordering},
    };

    let drop_count = Arc::new(AtomicUsize::new(0));

    struct DropCounter {
        count: Arc<AtomicUsize>,
    }

    impl Drop for DropCounter {
        fn drop(&mut self) {
            self.count.fetch_add(1, Ordering::SeqCst);
        }
    }

    let mut map = DeferredMap::new();

    let h = map.allocate_handle();
    let k = h.key();
    map.insert(
        h,
        DropCounter {
            count: drop_count.clone(),
        },
    );

    // Drop count should be 0 before removal
    // 删除前 drop 计数应该是 0
    assert_eq!(drop_count.load(Ordering::SeqCst), 0);

    map.remove(k);

    // Drop count should be 1 after removal
    // 删除后 drop 计数应该是 1
    assert_eq!(drop_count.load(Ordering::SeqCst), 1);
}

#[test]
fn test_removal_frees_memory() {
    let mut map = DeferredMap::new();

    // Insert large strings
    // 插入大字符串
    let mut keys = Vec::new();
    for _ in 0..100 {
        let large_string = format!("{}", "a".repeat(1000));
        let h = map.allocate_handle();
        let k = h.key();
        map.insert(h, large_string);
        keys.push(k);
    }

    // Remove all
    // 全部删除
    for key in keys {
        map.remove(key);
    }

    assert_eq!(map.len(), 0);
}

#[test]
fn test_removal_maintains_other_elements() {
    let mut map = DeferredMap::new();

    let mut keys = Vec::new();
    for i in 0..10 {
        let h = map.allocate_handle();
        let k = h.key();
        map.insert(h, i * 10);
        keys.push(k);
    }

    // Remove middle element
    // 删除中间元素
    map.remove(keys[5]);

    // Verify other elements unchanged
    // 验证其他元素不变
    for (i, &key) in keys.iter().enumerate() {
        if i == 5 {
            assert_eq!(map.get(key), None);
        } else {
            assert_eq!(map.get(key), Some(&(i * 10)));
        }
    }
}

#[test]
fn test_removal_pattern_lifo() {
    let mut map = DeferredMap::new();

    let mut keys = Vec::new();
    for i in 0..10 {
        let h = map.allocate_handle();
        let k = h.key();
        map.insert(h, i);
        keys.push(k);
    }

    // Remove in LIFO order (last in, first out)
    // 以 LIFO 顺序删除(后进先出)
    for i in (0..10).rev() {
        let removed = map.remove(keys[i]);
        assert_eq!(removed, Some(i));
    }

    assert!(map.is_empty());
}

#[test]
fn test_removal_pattern_fifo() {
    let mut map = DeferredMap::new();

    let mut keys = Vec::new();
    for i in 0..10 {
        let h = map.allocate_handle();
        let k = h.key();
        map.insert(h, i);
        keys.push(k);
    }

    // Remove in FIFO order (first in, first out)
    // 以 FIFO 顺序删除(先进先出)
    for i in 0..10 {
        let removed = map.remove(keys[i]);
        assert_eq!(removed, Some(i));
    }

    assert!(map.is_empty());
}

#[test]
fn test_removal_pattern_random() {
    let mut map = DeferredMap::new();

    let mut keys = Vec::new();
    for i in 0..20 {
        let h = map.allocate_handle();
        let k = h.key();
        map.insert(h, i);
        keys.push(k);
    }

    // Remove in pseudo-random pattern
    // 以伪随机模式删除
    let remove_order = vec![
        5, 15, 2, 18, 0, 10, 7, 12, 3, 17, 1, 14, 8, 19, 4, 11, 6, 13, 9, 16,
    ];

    for idx in remove_order {
        map.remove(keys[idx]);
    }

    assert!(map.is_empty());
}

#[test]
fn test_removal_after_clear() {
    let mut map = DeferredMap::new();

    let h = map.allocate_handle();
    let k = h.key();
    map.insert(h, 42);

    map.clear();

    // Try to remove after clear
    // 在 clear 后尝试删除
    let result = map.remove(k);
    assert_eq!(result, None);
}

#[test]
fn test_removal_slot_added_to_free_list() {
    let mut map = DeferredMap::new();

    // Insert and remove to create free list
    // 插入并删除以创建空闲列表
    let h1 = map.allocate_handle();
    let k1 = h1.key();
    map.insert(h1, 1);
    map.remove(k1);

    let h2 = map.allocate_handle();
    let k2 = h2.key();
    map.insert(h2, 2);
    map.remove(k2);

    let h3 = map.allocate_handle();
    let k3 = h3.key();
    map.insert(h3, 3);
    map.remove(k3);

    // Allocating new handles should reuse slots in LIFO order
    // 分配新 handle 应该以 LIFO 顺序复用 slot
    let h4 = map.allocate_handle();
    let index4 = h4.index();

    // Should reuse the last removed slot
    // 应该复用最后删除的 slot
    let index3 = k3.index();
    assert_eq!(index4, index3);
}

#[test]
fn test_removal_with_box_type() {
    let mut map = DeferredMap::new();

    let h = map.allocate_handle();
    let k = h.key();
    map.insert(h, Box::new(42));

    let removed = map.remove(k);
    assert_eq!(removed, Some(Box::new(42)));
}

#[test]
fn test_removal_doesnt_affect_capacity() {
    let mut map = DeferredMap::new();

    for i in 0..10 {
        let h = map.allocate_handle();
        map.insert(h, i);
    }

    let capacity_before = map.capacity();

    // Remove some elements
    // 删除一些元素
    let h = map.allocate_handle();
    let k = h.key();
    map.insert(h, 0);
    map.remove(k);

    let capacity_after = map.capacity();

    // Capacity shouldn't decrease after removal
    // 删除后容量不应该减少
    assert!(capacity_after >= capacity_before);
}

#[test]
fn test_double_removal_fails() {
    let mut map = DeferredMap::new();

    let h = map.allocate_handle();
    let k = h.key();
    map.insert(h, 42);

    // First removal succeeds
    // 第一次删除成功
    assert_eq!(map.remove(k), Some(42));

    // Second removal fails
    // 第二次删除失败
    assert_eq!(map.remove(k), None);
}