sectorsync-core 2026.713.0

Core spatial indexing, authority, AOI, and replication planning primitives for SectorSync
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
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
//! Low-level cell index for station-local AOI candidate queries.

use std::collections::{HashMap, HashSet};

use crate::ids::EntityHandle;
use crate::spatial::{Aabb3, Bounds, CellCoord3, GridSpec, Position3};

const MAX_DENSE_DEDUP_SLOTS: usize = 262_144;

/// Occupancy count for one non-empty cell.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct CellOccupancy {
    /// Cell coordinate.
    pub cell: CellCoord3,
    /// Number of indexed entity handles in the cell.
    pub entities: usize,
}

/// Result of inserting or updating one entity in a [`CellIndex`].
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum CellIndexUpdate {
    /// The handle was not indexed and has been inserted.
    Inserted,
    /// The handle already occupied the same cells; index storage was untouched.
    Unchanged,
    /// The handle moved to a different set of cells.
    Relocated,
}

/// Work performed while changing one entity's spatial membership.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct CellIndexUpdateReport {
    /// High-level membership outcome.
    pub update: CellIndexUpdate,
    /// Existing cells retained without bucket mutation.
    pub retained_cells: usize,
    /// Cells whose bucket membership was removed.
    pub removed_cells: usize,
    /// Cells whose bucket membership was inserted.
    pub inserted_cells: usize,
    /// Whether sorted multi-cell membership was updated by merge-diff.
    pub incremental_diff: bool,
}

/// Caller-owned storage for allocation-light multi-cell membership changes.
#[derive(Clone, Debug, Default)]
pub struct CellIndexUpdateScratch {
    cells: Vec<CellCoord3>,
}

impl CellIndexUpdateScratch {
    /// Cell-coordinate capacity retained for the next membership change.
    pub fn retained_cell_capacity(&self) -> usize {
        self.cells.capacity()
    }

    /// Releases unused retained cell-coordinate storage.
    pub fn reclaim_retained_capacity(&mut self) {
        self.cells.clear();
        self.cells.shrink_to_fit();
    }
}

/// Strategy used by the last scratch-backed cell query.
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
pub enum CellQueryStrategy {
    /// Probe every cell touched by the query bounds.
    #[default]
    Grid,
    /// Scan non-empty cells when the query covers a larger sparse volume.
    OccupiedCells,
}

/// Work counters from the last scratch-backed cell query.
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
pub struct CellQueryStats {
    /// Query strategy selected from query volume and current index occupancy.
    pub strategy: CellQueryStrategy,
    /// Grid cells probed directly by a grid query.
    pub grid_cells_probed: usize,
    /// Non-empty cells inspected by an occupied-cell scan.
    pub occupied_cells_scanned: usize,
    /// Non-empty cells overlapping the query bounds.
    pub matched_cells: usize,
    /// Unique candidate handles produced by the query.
    pub candidate_handles: usize,
}

/// Reusable scratch storage for allocation-aware cell queries.
#[derive(Clone, Debug, Default)]
pub struct CellQueryScratch {
    seen_dense: Vec<u64>,
    seen_collisions: Vec<u32>,
    seen_sparse: HashSet<EntityHandle>,
    query_epoch: u32,
    handles: Vec<EntityHandle>,
    matching_cells: Vec<CellCoord3>,
    stats: CellQueryStats,
}

impl CellQueryScratch {
    /// Clears retained query results while keeping allocated capacity.
    pub fn clear(&mut self) {
        self.begin_query();
        self.handles.clear();
        self.matching_cells.clear();
        self.stats = CellQueryStats::default();
    }

    /// Returns handles produced by the last query.
    pub fn handles(&self) -> &[EntityHandle] {
        &self.handles
    }

    /// Number of handles produced by the last query.
    pub fn len(&self) -> usize {
        self.handles.len()
    }

    /// Returns whether the last query produced no handles.
    pub fn is_empty(&self) -> bool {
        self.handles.is_empty()
    }

    /// Work counters produced by the last query.
    pub const fn stats(&self) -> CellQueryStats {
        self.stats
    }

    /// Capacity retained for unique candidate handles.
    pub fn handle_capacity(&self) -> usize {
        self.handles.capacity()
    }

    /// Capacity retained by the candidate deduplication set.
    pub fn dedup_capacity(&self) -> usize {
        self.seen_dense
            .capacity()
            .saturating_add(self.seen_collisions.capacity())
            .saturating_add(self.seen_sparse.capacity())
    }

    /// Capacity retained for occupied cells matched by sparse queries.
    pub fn matching_cell_capacity(&self) -> usize {
        self.matching_cells.capacity()
    }

    fn begin_query(&mut self) {
        self.query_epoch = self.query_epoch.wrapping_add(1);
        if self.query_epoch == 0 {
            self.seen_dense.fill(0);
            self.seen_collisions.fill(0);
            self.query_epoch = 1;
        }
        self.seen_sparse.clear();
    }

    fn insert_seen(&mut self, handle: EntityHandle) -> bool {
        let Ok(index) = usize::try_from(handle.index()) else {
            return self.seen_sparse.insert(handle);
        };
        if index >= MAX_DENSE_DEDUP_SLOTS {
            return self.seen_sparse.insert(handle);
        }
        if index >= self.seen_dense.len() {
            self.seen_dense.resize(index + 1, 0);
            self.seen_collisions.resize(index + 1, 0);
        }
        let marker = (u64::from(self.query_epoch) << 32) | u64::from(handle.generation());
        let previous = self.seen_dense[index];
        let previous_epoch = u32::try_from(previous >> 32).expect("marker epoch fits u32");
        if previous_epoch != self.query_epoch {
            self.seen_dense[index] = marker;
            true
        } else if self.seen_collisions[index] == self.query_epoch {
            self.seen_sparse.insert(handle)
        } else if previous == marker {
            false
        } else {
            self.seen_collisions[index] = self.query_epoch;
            let previous_generation =
                u32::try_from(previous & u64::from(u32::MAX)).expect("marker generation fits u32");
            self.seen_sparse
                .insert(EntityHandle::new(handle.index(), previous_generation));
            self.seen_sparse.insert(handle)
        }
    }
}

/// Internal compact membership representation for point and bounded entities.
#[derive(Clone, Debug)]
enum CellMembership {
    Point(CellCoord3),
    Multiple(Vec<CellCoord3>),
}

impl CellMembership {
    fn as_slice(&self) -> &[CellCoord3] {
        match self {
            Self::Point(cell) => std::slice::from_ref(cell),
            Self::Multiple(cells) => cells,
        }
    }

    fn matches_range(&self, min: CellCoord3, max: CellCoord3) -> bool {
        cells_match_range(self.as_slice(), min, max)
    }
}

/// Station-local 3D cell index.
#[derive(Clone, Debug)]
pub struct CellIndex {
    grid: GridSpec,
    cells: HashMap<CellCoord3, Vec<EntityHandle>>,
    entity_cells: HashMap<EntityHandle, CellMembership>,
}

impl CellIndex {
    /// Creates an empty cell index.
    pub fn new(grid: GridSpec) -> Self {
        Self::with_capacity(grid, 0, 0)
    }

    /// Creates an empty index with explicit entity and occupied-cell capacity.
    pub fn with_capacity(
        grid: GridSpec,
        entity_capacity: usize,
        occupied_cell_capacity: usize,
    ) -> Self {
        Self {
            grid,
            cells: HashMap::with_capacity(occupied_cell_capacity),
            entity_cells: HashMap::with_capacity(entity_capacity),
        }
    }

    /// Reserves capacity for additional indexed entities and occupied cells.
    pub fn reserve(&mut self, additional_entities: usize, additional_cells: usize) {
        self.entity_cells.reserve(additional_entities);
        self.cells.reserve(additional_cells);
    }

    /// Releases unused retained map, bucket, and multi-cell membership storage.
    pub fn reclaim_retained_capacity(&mut self) {
        for handles in self.cells.values_mut() {
            handles.shrink_to_fit();
        }
        for membership in self.entity_cells.values_mut() {
            if let CellMembership::Multiple(cells) = membership {
                cells.shrink_to_fit();
            }
        }
        self.cells.shrink_to_fit();
        self.entity_cells.shrink_to_fit();
    }

    /// Indexed-entity entries currently retained without another rehash.
    pub fn entity_capacity(&self) -> usize {
        self.entity_cells.capacity()
    }

    /// Occupied-cell entries currently retained without another rehash.
    pub fn occupied_cell_capacity(&self) -> usize {
        self.cells.capacity()
    }

    /// Returns the grid spec.
    pub const fn grid(&self) -> GridSpec {
        self.grid
    }

    /// Inserts or updates an entity in all cells touched by its bounds.
    pub fn upsert(&mut self, handle: EntityHandle, position: Position3, bounds: Bounds) {
        self.upsert_tracked(handle, position, bounds);
    }

    /// Inserts or updates an entity and reports whether index membership changed.
    pub fn upsert_tracked(
        &mut self,
        handle: EntityHandle,
        position: Position3,
        bounds: Bounds,
    ) -> CellIndexUpdate {
        let mut scratch = CellIndexUpdateScratch::default();
        self.upsert_with_scratch(handle, position, bounds, &mut scratch)
            .update
    }

    /// Inserts or updates membership with reusable storage and detailed work counters.
    pub fn upsert_with_scratch(
        &mut self,
        handle: EntityHandle,
        position: Position3,
        bounds: Bounds,
        scratch: &mut CellIndexUpdateScratch,
    ) -> CellIndexUpdateReport {
        if bounds == Bounds::Point {
            return self.upsert_point(handle, self.grid.cell_at(position), scratch);
        }

        let aabb = bounds.to_aabb(position);
        let min = self.grid.cell_at(aabb.min);
        let max = self.grid.cell_at(aabb.max);
        if let Some(current) = self.entity_cells.get(&handle)
            && current.matches_range(min, max)
        {
            return CellIndexUpdateReport {
                update: CellIndexUpdate::Unchanged,
                retained_cells: current.as_slice().len(),
                removed_cells: 0,
                inserted_cells: 0,
                incremental_diff: false,
            };
        }

        scratch.cells.clear();
        extend_cell_range(&mut scratch.cells, min, max);
        let Some(previous) = self.entity_cells.remove(&handle) else {
            for cell in &scratch.cells {
                self.cells.entry(*cell).or_default().push(handle);
            }
            let inserted_cells = scratch.cells.len();
            self.entity_cells.insert(
                handle,
                CellMembership::Multiple(std::mem::take(&mut scratch.cells)),
            );
            return CellIndexUpdateReport {
                update: CellIndexUpdate::Inserted,
                retained_cells: 0,
                removed_cells: 0,
                inserted_cells,
                incremental_diff: false,
            };
        };

        let incremental_diff = matches!(&previous, CellMembership::Multiple(_));
        let (retained_cells, removed_cells, inserted_cells) =
            self.apply_membership_diff(handle, previous.as_slice(), &scratch.cells);
        let new_cells = std::mem::take(&mut scratch.cells);
        if let CellMembership::Multiple(previous_cells) = previous {
            scratch.cells = previous_cells;
        }
        self.entity_cells
            .insert(handle, CellMembership::Multiple(new_cells));
        CellIndexUpdateReport {
            update: CellIndexUpdate::Relocated,
            retained_cells,
            removed_cells,
            inserted_cells,
            incremental_diff,
        }
    }

    fn upsert_point(
        &mut self,
        handle: EntityHandle,
        cell: CellCoord3,
        scratch: &mut CellIndexUpdateScratch,
    ) -> CellIndexUpdateReport {
        let Some(previous) = self.entity_cells.remove(&handle) else {
            self.cells.entry(cell).or_default().push(handle);
            self.entity_cells
                .insert(handle, CellMembership::Point(cell));
            return CellIndexUpdateReport {
                update: CellIndexUpdate::Inserted,
                retained_cells: 0,
                removed_cells: 0,
                inserted_cells: 1,
                incremental_diff: false,
            };
        };
        if matches!(&previous, CellMembership::Point(current) if *current == cell) {
            self.entity_cells.insert(handle, previous);
            return CellIndexUpdateReport {
                update: CellIndexUpdate::Unchanged,
                retained_cells: 1,
                removed_cells: 0,
                inserted_cells: 0,
                incremental_diff: false,
            };
        }

        let target = [cell];
        let (retained_cells, removed_cells, inserted_cells) =
            self.apply_membership_diff(handle, previous.as_slice(), &target);
        if let CellMembership::Multiple(previous_cells) = previous {
            scratch.cells = previous_cells;
        }
        self.entity_cells
            .insert(handle, CellMembership::Point(cell));
        CellIndexUpdateReport {
            update: CellIndexUpdate::Relocated,
            retained_cells,
            removed_cells,
            inserted_cells,
            incremental_diff: false,
        }
    }

    fn apply_membership_diff(
        &mut self,
        handle: EntityHandle,
        previous: &[CellCoord3],
        next: &[CellCoord3],
    ) -> (usize, usize, usize) {
        let (mut old_index, mut new_index) = (0, 0);
        let (mut retained, mut removed, mut inserted) = (0, 0, 0);
        while old_index < previous.len() || new_index < next.len() {
            match (previous.get(old_index), next.get(new_index)) {
                (Some(old), Some(new)) if old == new => {
                    retained += 1;
                    old_index += 1;
                    new_index += 1;
                }
                (Some(old), Some(new)) if old < new => {
                    self.remove_handle_from_cell(*old, handle);
                    removed += 1;
                    old_index += 1;
                }
                (_, Some(new)) => {
                    self.cells.entry(*new).or_default().push(handle);
                    inserted += 1;
                    new_index += 1;
                }
                (Some(old), None) => {
                    self.remove_handle_from_cell(*old, handle);
                    removed += 1;
                    old_index += 1;
                }
                (None, None) => break,
            }
        }
        (retained, removed, inserted)
    }

    /// Removes an entity from the index.
    pub fn remove(&mut self, handle: EntityHandle) -> bool {
        let Some(cells) = self.entity_cells.remove(&handle) else {
            return false;
        };

        for cell in cells.as_slice() {
            self.remove_handle_from_cell(*cell, handle);
        }

        true
    }

    fn remove_handle_from_cell(&mut self, cell: CellCoord3, handle: EntityHandle) {
        let remove_cell = if let Some(handles) = self.cells.get_mut(&cell) {
            if let Some(index) = handles.iter().position(|candidate| *candidate == handle) {
                handles.remove(index);
            }
            handles.is_empty()
        } else {
            false
        };
        if remove_cell {
            self.cells.remove(&cell);
        }
    }

    /// Queries candidate handles overlapping an AABB.
    pub fn query_aabb(&self, aabb: Aabb3) -> Vec<EntityHandle> {
        let mut scratch = CellQueryScratch::default();
        self.query_aabb_into(aabb, &mut scratch);
        scratch.handles
    }

    /// Queries candidate handles overlapping an AABB using caller scratch.
    pub fn query_aabb_into<'a>(
        &self,
        aabb: Aabb3,
        scratch: &'a mut CellQueryScratch,
    ) -> &'a [EntityHandle] {
        scratch.clear();
        let min = self.grid.cell_at(aabb.min);
        let max = self.grid.cell_at(aabb.max);

        let grid_cells = query_cell_volume(min, max);
        if grid_cells <= self.cells.len() {
            scratch.stats.strategy = CellQueryStrategy::Grid;
            scratch.stats.grid_cells_probed = grid_cells;
            for x in min.x..=max.x {
                for y in min.y..=max.y {
                    for z in min.z..=max.z {
                        self.collect_cell(CellCoord3::new(x, y, z), scratch);
                    }
                }
            }
        } else {
            scratch.stats.strategy = CellQueryStrategy::OccupiedCells;
            scratch.stats.occupied_cells_scanned = self.cells.len();
            scratch.matching_cells.extend(
                self.cells
                    .keys()
                    .copied()
                    .filter(|cell| cell_in_range(*cell, min, max)),
            );
            scratch.matching_cells.sort_unstable();
            for index in 0..scratch.matching_cells.len() {
                self.collect_cell(scratch.matching_cells[index], scratch);
            }
        }

        scratch.stats.candidate_handles = scratch.handles.len();

        scratch.handles()
    }

    /// Queries candidate handles inside cells touched by a sphere.
    pub fn query_sphere(&self, center: Position3, radius: f32) -> Vec<EntityHandle> {
        self.query_aabb(Bounds::Sphere { radius }.to_aabb(center))
    }

    /// Queries candidate handles inside cells touched by a sphere using caller scratch.
    pub fn query_sphere_into<'a>(
        &self,
        center: Position3,
        radius: f32,
        scratch: &'a mut CellQueryScratch,
    ) -> &'a [EntityHandle] {
        self.query_aabb_into(Bounds::Sphere { radius }.to_aabb(center), scratch)
    }

    fn collect_cell(&self, cell: CellCoord3, scratch: &mut CellQueryScratch) {
        if let Some(handles) = self.cells.get(&cell) {
            scratch.stats.matched_cells = scratch.stats.matched_cells.saturating_add(1);
            for handle in handles {
                if scratch.insert_seen(*handle) {
                    scratch.handles.push(*handle);
                }
            }
        }
    }

    /// Returns handles indexed directly in one cell.
    pub fn handles_in_cell(&self, cell: CellCoord3) -> Vec<EntityHandle> {
        self.cells.get(&cell).cloned().unwrap_or_default()
    }

    /// Returns handles indexed directly in one cell without allocating.
    pub fn handles_in_cell_slice(&self, cell: CellCoord3) -> &[EntityHandle] {
        self.cells.get(&cell).map_or(&[], Vec::as_slice)
    }

    /// Returns cells currently occupied by one entity handle.
    pub fn cells_for_handle(&self, handle: EntityHandle) -> Option<&[CellCoord3]> {
        self.entity_cells.get(&handle).map(CellMembership::as_slice)
    }

    /// Number of indexed entities.
    pub fn entity_count(&self) -> usize {
        self.entity_cells.len()
    }

    /// Number of entities using allocation-free single-cell membership.
    pub fn point_membership_count(&self) -> usize {
        self.entity_cells
            .values()
            .filter(|membership| matches!(membership, CellMembership::Point(_)))
            .count()
    }

    /// Number of non-empty cells.
    pub fn occupied_cell_count(&self) -> usize {
        self.cells.len()
    }

    /// Returns deterministic occupancy counts for all non-empty cells.
    pub fn cell_occupancy(&self) -> Vec<CellOccupancy> {
        let mut cells = Vec::with_capacity(self.cells.len());
        self.cell_occupancy_into(&mut cells);
        cells
    }

    /// Writes deterministic occupancy counts into caller-owned reusable storage.
    pub fn cell_occupancy_into(&self, out: &mut Vec<CellOccupancy>) {
        out.clear();
        out.extend(self.cells.iter().map(|(cell, handles)| CellOccupancy {
            cell: *cell,
            entities: handles.len(),
        }));
        out.sort_by_key(|occupancy| occupancy.cell);
    }
}

fn cells_match_range(cells: &[CellCoord3], min: CellCoord3, max: CellCoord3) -> bool {
    if cells.len() != query_cell_volume(min, max) {
        return false;
    }
    let mut cells = cells.iter();
    for x in min.x..=max.x {
        for y in min.y..=max.y {
            for z in min.z..=max.z {
                if cells.next() != Some(&CellCoord3::new(x, y, z)) {
                    return false;
                }
            }
        }
    }
    cells.next().is_none()
}

fn extend_cell_range(cells: &mut Vec<CellCoord3>, min: CellCoord3, max: CellCoord3) {
    cells.reserve(query_cell_volume(min, max));
    for x in min.x..=max.x {
        for y in min.y..=max.y {
            for z in min.z..=max.z {
                cells.push(CellCoord3::new(x, y, z));
            }
        }
    }
}

fn query_cell_volume(min: CellCoord3, max: CellCoord3) -> usize {
    fn axis_cells(min: i32, max: i32) -> usize {
        if max < min {
            return 0;
        }
        usize::try_from(i64::from(max) - i64::from(min) + 1).unwrap_or(usize::MAX)
    }

    axis_cells(min.x, max.x)
        .saturating_mul(axis_cells(min.y, max.y))
        .saturating_mul(axis_cells(min.z, max.z))
}

const fn cell_in_range(cell: CellCoord3, min: CellCoord3, max: CellCoord3) -> bool {
    cell.x >= min.x
        && cell.x <= max.x
        && cell.y >= min.y
        && cell.y <= max.y
        && cell.z >= min.z
        && cell.z <= max.z
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn explicit_index_capacity_is_retained_and_grows_on_request() {
        let grid = GridSpec::new(10.0).expect("valid grid");
        let mut index = CellIndex::with_capacity(grid, 8, 4);

        assert!(index.entity_capacity() >= 8);
        assert!(index.occupied_cell_capacity() >= 4);
        index.reserve(32, 16);
        assert!(index.entity_capacity() >= 32);
        assert!(index.occupied_cell_capacity() >= 16);

        let handle = EntityHandle::new(1, 0);
        index.upsert(handle, Position3::new(1.0, 2.0, 3.0), Bounds::Point);
        assert_eq!(
            index.query_sphere(Position3::new(1.0, 2.0, 3.0), 1.0),
            vec![handle]
        );
    }

    #[test]
    fn reclaim_retained_capacity_preserves_queries_and_membership() {
        let grid = GridSpec::new(10.0).expect("valid grid");
        let mut index = CellIndex::with_capacity(grid, 64, 64);
        let handle = EntityHandle::new(1, 0);
        let position = Position3::new(9.0, 0.0, 0.0);
        index.upsert(handle, position, Bounds::Sphere { radius: 2.0 });
        let expected = index.query_sphere(position, 4.0);

        index.reclaim_retained_capacity();

        assert_eq!(index.query_sphere(position, 4.0), expected);
        assert!(
            !index
                .cells_for_handle(handle)
                .expect("membership")
                .is_empty()
        );
    }

    #[test]
    fn tracked_upsert_skips_same_cell_point_updates() {
        let grid = GridSpec::new(10.0).expect("valid grid");
        let mut index = CellIndex::with_capacity(grid, 1, 2);
        let handle = EntityHandle::new(1, 0);
        let first_cell = grid.cell_at(Position3::new(1.0, 2.0, 3.0));
        let second_cell = grid.cell_at(Position3::new(11.0, 2.0, 3.0));

        assert_eq!(
            index.upsert_tracked(handle, Position3::new(1.0, 2.0, 3.0), Bounds::Point),
            CellIndexUpdate::Inserted
        );
        let entity_capacity = index.entity_capacity();
        let cell_capacity = index.occupied_cell_capacity();
        assert_eq!(
            index.upsert_tracked(handle, Position3::new(9.0, 2.0, 3.0), Bounds::Point),
            CellIndexUpdate::Unchanged
        );
        assert_eq!(index.handles_in_cell_slice(first_cell), &[handle]);
        assert_eq!(index.entity_capacity(), entity_capacity);
        assert_eq!(index.occupied_cell_capacity(), cell_capacity);

        assert!(matches!(
            index.entity_cells.get(&handle),
            Some(CellMembership::Point(cell)) if *cell == first_cell
        ));
        assert_eq!(
            index.upsert_tracked(handle, Position3::new(11.0, 2.0, 3.0), Bounds::Point),
            CellIndexUpdate::Relocated
        );
        assert!(matches!(
            index.entity_cells.get(&handle),
            Some(CellMembership::Point(cell)) if *cell == second_cell
        ));
        assert_eq!(index.point_membership_count(), 1);
        assert!(index.handles_in_cell_slice(first_cell).is_empty());
        assert_eq!(index.handles_in_cell_slice(second_cell), &[handle]);
    }

    #[test]
    fn tracked_upsert_skips_unchanged_multi_cell_bounds() {
        let grid = GridSpec::new(10.0).expect("valid grid");
        let mut index = CellIndex::new(grid);
        let handle = EntityHandle::new(1, 0);
        let bounds = Bounds::Sphere { radius: 2.0 };

        assert_eq!(
            index.upsert_tracked(handle, Position3::new(9.0, 0.0, 0.0), bounds),
            CellIndexUpdate::Inserted
        );
        let retained_cells = index
            .entity_cells
            .get(&handle)
            .expect("bounded entity has cells")
            .as_slice()
            .as_ptr();
        assert_eq!(
            index.upsert_tracked(handle, Position3::new(9.5, 0.0, 0.0), bounds),
            CellIndexUpdate::Unchanged
        );
        assert_eq!(
            index
                .entity_cells
                .get(&handle)
                .expect("unchanged bounds retain cells")
                .as_slice()
                .as_ptr(),
            retained_cells
        );

        let relocated_position = Position3::new(12.5, 0.0, 0.0);
        assert_eq!(
            index.upsert_tracked(handle, relocated_position, bounds),
            CellIndexUpdate::Relocated
        );
        assert_eq!(
            index.cells_for_handle(handle),
            Some(grid.cells_for_bounds(relocated_position, bounds).as_slice())
        );
    }

    #[test]
    fn multi_cell_crossing_updates_only_membership_difference() {
        let grid = GridSpec::new(32.0).expect("valid grid");
        let bounds = Bounds::Sphere { radius: 20.0 };
        let handle = EntityHandle::new(1, 0);
        let start = Position3::new(16.0, 16.0, 16.0);
        let moved = Position3::new(48.0, 16.0, 16.0);
        let mut index = CellIndex::new(grid);
        let mut scratch = CellIndexUpdateScratch::default();

        let inserted = index.upsert_with_scratch(handle, start, bounds, &mut scratch);
        assert_eq!(inserted.update, CellIndexUpdate::Inserted);
        assert_eq!(inserted.inserted_cells, 27);

        let relocated = index.upsert_with_scratch(handle, moved, bounds, &mut scratch);
        assert_eq!(
            relocated,
            CellIndexUpdateReport {
                update: CellIndexUpdate::Relocated,
                retained_cells: 18,
                removed_cells: 9,
                inserted_cells: 9,
                incremental_diff: true,
            }
        );
        assert!(scratch.retained_cell_capacity() >= 27);

        let returned = index.upsert_with_scratch(handle, start, bounds, &mut scratch);
        assert_eq!(returned.retained_cells, 18);
        assert_eq!(returned.removed_cells, 9);
        assert_eq!(returned.inserted_cells, 9);
        assert!(returned.incremental_diff);

        let mut rebuilt = CellIndex::new(grid);
        rebuilt.upsert(handle, start, bounds);
        assert_eq!(
            index.cells_for_handle(handle),
            rebuilt.cells_for_handle(handle)
        );
        assert_eq!(
            index.query_sphere(start, 64.0),
            rebuilt.query_sphere(start, 64.0)
        );
    }

    #[test]
    fn index_exposes_handles_by_cell() {
        let grid = GridSpec::new(10.0).expect("valid grid");
        let mut index = CellIndex::new(grid);
        let handle = EntityHandle::new(1, 0);
        index.upsert(handle, Position3::new(1.0, 2.0, 3.0), Bounds::Point);
        let cell = grid.cell_at(Position3::new(1.0, 2.0, 3.0));

        assert_eq!(index.handles_in_cell(cell), vec![handle]);
        assert_eq!(index.handles_in_cell_slice(cell), &[handle]);
        assert!(
            index
                .handles_in_cell_slice(CellCoord3::new(99, 99, 99))
                .is_empty()
        );
        assert_eq!(index.cells_for_handle(handle), Some([cell].as_slice()));
    }

    #[test]
    fn occupancy_output_is_sorted_and_reuses_capacity() {
        let grid = GridSpec::new(10.0).expect("valid grid");
        let mut index = CellIndex::new(grid);
        let left = EntityHandle::new(1, 0);
        let right = EntityHandle::new(2, 0);
        index.upsert(right, Position3::new(21.0, 0.0, 0.0), Bounds::Point);
        index.upsert(left, Position3::new(-11.0, 0.0, 0.0), Bounds::Point);

        let expected = index.cell_occupancy();
        let mut occupancy = Vec::new();
        index.cell_occupancy_into(&mut occupancy);
        assert_eq!(occupancy, expected);
        assert!(
            occupancy
                .windows(2)
                .all(|cells| cells[0].cell < cells[1].cell)
        );

        let retained = occupancy.as_ptr();
        index.cell_occupancy_into(&mut occupancy);
        assert_eq!(occupancy, expected);
        assert_eq!(occupancy.as_ptr(), retained);
    }

    #[test]
    fn scratch_query_deduplicates_and_reuses_storage() {
        let grid = GridSpec::new(10.0).expect("valid grid");
        let mut index = CellIndex::new(grid);
        let handle = EntityHandle::new(1, 0);
        index.upsert(
            handle,
            Position3::new(9.0, 0.0, 0.0),
            Bounds::Sphere { radius: 2.0 },
        );
        let mut scratch = CellQueryScratch::default();

        let first = index.query_aabb_into(
            Bounds::Sphere { radius: 4.0 }.to_aabb(Position3::new(10.0, 0.0, 0.0)),
            &mut scratch,
        );
        assert_eq!(first, &[handle]);
        assert_eq!(scratch.len(), 1);
        assert_eq!(scratch.stats().strategy, CellQueryStrategy::Grid);
        assert_eq!(scratch.stats().candidate_handles, 1);
        assert!(scratch.handle_capacity() >= 1);
        assert!(scratch.dedup_capacity() >= 1);

        let second = index.query_aabb_into(
            Bounds::Point.to_aabb(Position3::new(100.0, 0.0, 0.0)),
            &mut scratch,
        );
        assert!(second.is_empty());
        assert!(scratch.is_empty());
    }

    #[test]
    fn dense_dedup_preserves_generations_and_bounds_sparse_handles() {
        let grid = GridSpec::new(10.0).expect("valid grid");
        let mut index = CellIndex::new(grid);
        let old = EntityHandle::new(7, 1);
        let current = EntityHandle::new(7, 2);
        let sparse = EntityHandle::new(u32::MAX, 0);
        let spanning = Bounds::Sphere { radius: 2.0 };
        index.upsert(old, Position3::new(9.0, 0.0, 0.0), spanning);
        index.upsert(current, Position3::new(9.0, 0.0, 0.0), spanning);
        index.upsert(sparse, Position3::new(9.0, 0.0, 0.0), Bounds::Point);
        let mut scratch = CellQueryScratch::default();

        let handles = index.query_aabb_into(
            spanning.to_aabb(Position3::new(10.0, 0.0, 0.0)),
            &mut scratch,
        );

        assert_eq!(handles, &[old, current, sparse]);
        assert!(scratch.dedup_capacity() < MAX_DENSE_DEDUP_SLOTS);
    }

    #[test]
    fn sparse_large_query_scans_occupied_cells_deterministically() {
        let grid = GridSpec::new(10.0).expect("valid grid");
        let mut index = CellIndex::new(grid);
        let high = EntityHandle::new(2, 0);
        let low = EntityHandle::new(1, 0);
        index.upsert(high, Position3::new(95.0, 0.0, 0.0), Bounds::Point);
        index.upsert(low, Position3::new(-95.0, 0.0, 0.0), Bounds::Point);
        let mut scratch = CellQueryScratch::default();

        let handles = index.query_aabb_into(
            Aabb3::new(
                Position3::new(-100.0, -100.0, -100.0),
                Position3::new(100.0, 100.0, 100.0),
            ),
            &mut scratch,
        );

        assert_eq!(handles, &[low, high]);
        assert_eq!(scratch.stats().strategy, CellQueryStrategy::OccupiedCells);
        assert_eq!(scratch.stats().occupied_cells_scanned, 2);
        assert_eq!(scratch.stats().matched_cells, 2);
        assert_eq!(scratch.stats().candidate_handles, 2);
        assert!(scratch.matching_cell_capacity() >= 2);
    }
}