nodedb-spatial 0.0.0-beta.3

Spatial indexing and query operations shared between NodeDB Origin and NodeDB-Lite
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

//! R-tree node types and constants.

use nodedb_types::BoundingBox;
use serde::{Deserialize, Serialize};
use zerompk::{FromMessagePack, ToMessagePack};

pub const LEAF_CAPACITY: usize = 32;
pub const INTERNAL_CAPACITY: usize = 16;
pub const MIN_FILL_LEAF: usize = LEAF_CAPACITY * 2 / 5;
pub const MIN_FILL_INTERNAL: usize = INTERNAL_CAPACITY * 2 / 5;
pub const REINSERT_COUNT_LEAF: usize = LEAF_CAPACITY * 3 / 10;

/// Unique identifier for a spatial entry (document RID or opaque u64).
pub type EntryId = u64;

/// A spatial entry stored in an R-tree leaf.
#[derive(
    Debug,
    Clone,
    Serialize,
    Deserialize,
    ToMessagePack,
    FromMessagePack,
    rkyv::Archive,
    rkyv::Serialize,
    rkyv::Deserialize,
)]
pub struct RTreeEntry {
    pub id: EntryId,
    pub bbox: BoundingBox,
}

/// Internal node child reference.
#[derive(Debug, Clone)]
pub(crate) struct ChildRef {
    pub bbox: BoundingBox,
    pub node_idx: usize,
}

/// A node in the R-tree (either internal or leaf).
#[derive(Debug, Clone)]
pub(crate) enum NodeKind {
    Internal { children: Vec<ChildRef> },
    Leaf { entries: Vec<RTreeEntry> },
}

#[derive(Debug, Clone)]
pub(crate) struct Node {
    pub kind: NodeKind,
    pub bbox: BoundingBox,
    pub level: u32,
}

impl Node {
    pub fn new_leaf() -> Self {
        Self {
            kind: NodeKind::Leaf {
                entries: Vec::with_capacity(LEAF_CAPACITY),
            },
            bbox: BoundingBox::new(
                f64::INFINITY,
                f64::INFINITY,
                f64::NEG_INFINITY,
                f64::NEG_INFINITY,
            ),
            level: 0,
        }
    }

    pub fn new_internal(level: u32) -> Self {
        Self {
            kind: NodeKind::Internal {
                children: Vec::with_capacity(INTERNAL_CAPACITY),
            },
            bbox: BoundingBox::new(
                f64::INFINITY,
                f64::INFINITY,
                f64::NEG_INFINITY,
                f64::NEG_INFINITY,
            ),
            level,
        }
    }

    pub fn is_leaf(&self) -> bool {
        matches!(self.kind, NodeKind::Leaf { .. })
    }

    pub fn capacity(&self) -> usize {
        if self.is_leaf() {
            LEAF_CAPACITY
        } else {
            INTERNAL_CAPACITY
        }
    }

    pub fn len(&self) -> usize {
        match &self.kind {
            NodeKind::Internal { children } => children.len(),
            NodeKind::Leaf { entries } => entries.len(),
        }
    }

    pub fn is_overflow(&self) -> bool {
        self.len() > self.capacity()
    }

    pub fn min_fill(&self) -> usize {
        if self.is_leaf() {
            MIN_FILL_LEAF
        } else {
            MIN_FILL_INTERNAL
        }
    }

    pub fn is_underflow(&self) -> bool {
        self.len() < self.min_fill()
    }

    pub fn recompute_bbox(&mut self) {
        match &self.kind {
            NodeKind::Internal { children } => {
                if children.is_empty() {
                    self.bbox = BoundingBox::new(0.0, 0.0, 0.0, 0.0);
                    return;
                }
                let mut bb = children[0].bbox;
                for c in &children[1..] {
                    bb = bb.union(&c.bbox);
                }
                self.bbox = bb;
            }
            NodeKind::Leaf { entries } => {
                if entries.is_empty() {
                    self.bbox = BoundingBox::new(0.0, 0.0, 0.0, 0.0);
                    return;
                }
                let mut bb = entries[0].bbox;
                for e in &entries[1..] {
                    bb = bb.union(&e.bbox);
                }
                self.bbox = bb;
            }
        }
    }
}