range-filters 0.1.0

High-performance range filter implementation - DIVA (VLDB 2025 Best Research Paper)
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
use crate::Key;
use crate::infix_store::InfixStore;
use std::fmt;
use std::sync::{Arc, RwLock};

// #[derive(Debug, Default)]
// pub struct InfixStore;

// TODO: add cached count
#[derive(Debug, Default)]
pub struct BinarySearchTreeGroup {
    pub root: Option<Box<TreeNode>>,
}

#[derive(Clone, Debug)]
pub struct TreeNode {
    pub key: Key,
    pub left: Option<Box<TreeNode>>,
    pub right: Option<Box<TreeNode>>,
    pub infix_store: Option<Arc<RwLock<InfixStore>>>,
}

impl BinarySearchTreeGroup {
    pub fn new() -> Self {
        Self { root: None }
    }

    pub fn new_with_keys(keys: &[Key]) -> Self {
        if keys.is_empty() {
            return Self { root: None };
        }

        let mut sorted_keys = keys.to_vec();
        sorted_keys.sort();

        let root = Self::top_down_bst_insertion(&sorted_keys, 0, sorted_keys.len() as isize - 1);
        Self { root }
    }

    fn top_down_bst_insertion(keys: &[Key], start: isize, end: isize) -> Option<Box<TreeNode>> {
        if start > end {
            return None;
        }

        let mid = ((start + end) / 2) as usize;
        let root = Box::new(TreeNode {
            key: keys[mid],
            left: Self::top_down_bst_insertion(keys, start, mid as isize - 1),
            right: Self::top_down_bst_insertion(keys, mid as isize + 1, end),
            infix_store: None,
        });
        Some(root)
    }

    // TODO: use cached length
    pub fn len(&self) -> usize {
        Self::len_recursive(&self.root)
    }

    fn len_recursive(node: &Option<Box<TreeNode>>) -> usize {
        match node {
            None => 0,
            Some(n) => 1 + Self::len_recursive(&n.left) + Self::len_recursive(&n.right),
        }
    }

    pub fn insert(&mut self, key: Key) {
        Self::insert_recursive(&mut self.root, key);
    }

    fn insert_recursive(node: &mut Option<Box<TreeNode>>, key: Key) {
        match node {
            None => {
                *node = Some(Box::new(TreeNode {
                    key,
                    left: None,
                    right: None,
                    infix_store: None,
                }));
            }
            Some(n) => {
                if key < n.key {
                    Self::insert_recursive(&mut n.left, key);
                } else {
                    Self::insert_recursive(&mut n.right, key);
                }
            }
        }
    }

    pub fn contains(&self, key: Key) -> bool {
        Self::contains_recursive(&self.root, key)
    }

    fn contains_recursive(node: &Option<Box<TreeNode>>, key: Key) -> bool {
        match node {
            None => false,
            Some(n) => {
                if key == n.key {
                    true
                } else if key < n.key {
                    Self::contains_recursive(&n.left, key)
                } else {
                    Self::contains_recursive(&n.right, key)
                }
            }
        }
    }

    fn find_node_mut(node: &mut Option<Box<TreeNode>>, key: Key) -> Option<&mut TreeNode> {
        match node {
            None => None,
            Some(n) => {
                if key == n.key {
                    Some(n.as_mut())
                } else if key < n.key {
                    Self::find_node_mut(&mut n.left, key)
                } else {
                    Self::find_node_mut(&mut n.right, key)
                }
            }
        }
    }

    pub fn set_infix_store(&mut self, key: Key, infix_store: InfixStore) {
        if let Some(node) = Self::find_node_mut(&mut self.root, key) {
            node.infix_store = Some(Arc::new(RwLock::new(infix_store)));
        }
    }

    pub fn get_infix_store(&self, key: Key) -> Option<Arc<RwLock<InfixStore>>> {
        Self::get_infix_store_recursive(&self.root, key)
    }

    fn get_infix_store_recursive(
        node: &Option<Box<TreeNode>>,
        key: Key,
    ) -> Option<Arc<RwLock<InfixStore>>> {
        match node {
            None => None,
            Some(n) => {
                if key == n.key {
                    n.infix_store.clone()
                } else if key < n.key {
                    Self::get_infix_store_recursive(&n.left, key)
                } else {
                    Self::get_infix_store_recursive(&n.right, key)
                }
            }
        }
    }

    pub fn predecessor_infix_store(&self, key: Key) -> Option<Arc<RwLock<InfixStore>>> {
        Self::predecessor_store_recursive(&self.root, key, None)
    }

    pub fn predecessor(&self, key: Key) -> Option<Key> {
        Self::predecessor_recursive(&self.root, key, None)
    }

    fn predecessor_recursive(
        node: &Option<Box<TreeNode>>,
        key: Key,
        best: Option<Key>,
    ) -> Option<Key> {
        match node {
            None => best,
            Some(n) => {
                if n.key == key {
                    Some(n.key)
                } else if key < n.key {
                    Self::predecessor_recursive(&n.left, key, best)
                } else {
                    Self::predecessor_recursive(&n.right, key, Some(n.key))
                }
            }
        }
    }

    pub fn successor(&self, key: Key) -> Option<Key> {
        Self::successor_recursive(&self.root, key, None)
    }

    fn successor_recursive(
        node: &Option<Box<TreeNode>>,
        key: Key,
        best: Option<Key>,
    ) -> Option<Key> {
        match node {
            None => best,
            Some(n) => {
                if n.key == key {
                    Some(n.key)
                } else if key < n.key {
                    Self::successor_recursive(&n.left, key, Some(n.key))
                } else {
                    Self::successor_recursive(&n.right, key, best)
                }
            }
        }
    }

    fn predecessor_store_recursive(
        node: &Option<Box<TreeNode>>,
        key: Key,
        best: Option<Arc<RwLock<InfixStore>>>,
    ) -> Option<Arc<RwLock<InfixStore>>> {
        match node {
            None => best,
            Some(n) => {
                if n.key == key {
                    n.infix_store.clone().or(best)
                } else if key < n.key {
                    Self::predecessor_store_recursive(&n.left, key, best)
                } else {
                    Self::predecessor_store_recursive(&n.right, key, n.infix_store.clone())
                }
            }
        }
    }

    pub fn successor_infix_store(&self, key: Key) -> Option<Arc<RwLock<InfixStore>>> {
        Self::successor_store_recursive(&self.root, key, None)
    }

    fn successor_store_recursive(
        node: &Option<Box<TreeNode>>,
        key: Key,
        best: Option<Arc<RwLock<InfixStore>>>,
    ) -> Option<Arc<RwLock<InfixStore>>> {
        match node {
            None => best,
            Some(n) => {
                if n.key == key {
                    n.infix_store.clone().or(best)
                } else if key < n.key {
                    Self::successor_store_recursive(&n.left, key, n.infix_store.clone())
                } else {
                    Self::successor_store_recursive(&n.right, key, best)
                }
            }
        }
    }

    #[allow(dead_code)]
    fn min_key(node: &Option<Box<TreeNode>>) -> Option<Key> {
        match node {
            None => None,
            Some(n) => {
                if n.left.is_none() {
                    Some(n.key)
                } else {
                    Self::min_key(&n.left)
                }
            }
        }
    }

    #[allow(dead_code)]
    fn max_key(node: &Option<Box<TreeNode>>) -> Option<Key> {
        match node {
            None => None,
            Some(n) => {
                if n.right.is_none() {
                    Some(n.key)
                } else {
                    Self::max_key(&n.right)
                }
            }
        }
    }

    #[allow(dead_code)]
    fn min_node(node: &Option<Box<TreeNode>>) -> Option<&TreeNode> {
        match node {
            None => None,
            Some(n) => {
                if n.left.is_none() {
                    Some(n)
                } else {
                    Self::min_node(&n.left)
                }
            }
        }
    }

    #[allow(dead_code)]
    fn max_node(node: &Option<Box<TreeNode>>) -> Option<&TreeNode> {
        match node {
            None => None,
            Some(n) => {
                if n.right.is_none() {
                    Some(n)
                } else {
                    Self::max_node(&n.right)
                }
            }
        }
    }

    pub fn pretty_print(&self) {
        print!("{}", self);
    }

    fn format_tree(
        node: &Option<Box<TreeNode>>,
        prefix: &str,
        is_tail: bool,
        f: &mut fmt::Formatter,
    ) -> fmt::Result {
        if let Some(n) = node {
            writeln!(
                f,
                "{}{} {}",
                prefix,
                if is_tail { "└──" } else { "├──" },
                n.key
            )?;

            let new_prefix = format!("{}{}", prefix, if is_tail { "    " } else { "│   " });

            if n.right.is_some() || n.left.is_some() {
                if n.right.is_some() {
                    Self::format_tree(&n.right, &new_prefix, false, f)?;
                }
                if n.left.is_some() {
                    Self::format_tree(&n.left, &new_prefix, true, f)?;
                }
            }
        }
        Ok(())
    }
}

impl fmt::Display for BinarySearchTreeGroup {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        writeln!(f, "\n=== Binary Search Tree ===")?;
        if self.root.is_none() {
            writeln!(f, "  (empty tree)")?;
        } else {
            Self::format_tree(&self.root, "", true, f)?;
        }
        writeln!(f, "=========================\n")?;
        Ok(())
    }
}

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

    #[test]
    fn test_tree_construction() {
        let bst = BinarySearchTreeGroup::new_with_keys(&[1, 2, 3, 20, 30, 4, 5, 6, 7]);
        assert!(bst.contains(1));
        assert!(bst.contains(2));
        assert!(bst.contains(30));
        assert!(bst.contains(4));
        assert!(bst.contains(5));
        assert!(bst.contains(6));
        assert!(bst.contains(7));
        assert!(!bst.contains(8));
        assert!(!bst.contains(9));
        assert!(!bst.contains(10));
    }

    #[test]
    fn test_tree_insertion() {
        let mut bst = BinarySearchTreeGroup::new();
        bst.insert(1);
        bst.insert(2);
        bst.insert(3);
        bst.insert(20);
        bst.insert(30);
        bst.insert(4);
        bst.insert(5);
        bst.insert(6);
        bst.insert(7);
        assert!(bst.contains(1));
        assert!(bst.contains(2));
        assert!(bst.contains(3));
        assert!(bst.contains(20));
        assert!(bst.contains(30));
        assert!(bst.contains(4));
        assert!(bst.contains(5));
        assert!(bst.contains(6));
        assert!(bst.contains(7));
        assert!(!bst.contains(8));
        assert!(!bst.contains(9));
        assert!(!bst.contains(10));
    }

    #[test]
    fn test_predecessor_infix_store() {
        let mut bst = BinarySearchTreeGroup::new_with_keys(&[10, 20, 30, 40, 50]);

        bst.set_infix_store(10, InfixStore::default());
        bst.set_infix_store(20, InfixStore::default());
        bst.set_infix_store(30, InfixStore::default());
        bst.set_infix_store(40, InfixStore::default());
        bst.set_infix_store(50, InfixStore::default());

        // exact match returns own store
        let store_30 = bst.get_infix_store(30).unwrap();
        let pred_30 = bst.predecessor_infix_store(30).unwrap();
        assert!(Arc::ptr_eq(&store_30, &pred_30));

        // between keys returns predecessor's store
        let pred_35 = bst.predecessor_infix_store(35).unwrap();
        assert!(Arc::ptr_eq(&store_30, &pred_35));

        let store_20 = bst.get_infix_store(20).unwrap();
        let pred_25 = bst.predecessor_infix_store(25).unwrap();
        assert!(Arc::ptr_eq(&store_20, &pred_25));

        // before first key
        assert!(bst.predecessor_infix_store(5).is_none());

        // after last key
        let store_50 = bst.get_infix_store(50).unwrap();
        let pred_60 = bst.predecessor_infix_store(60).unwrap();
        assert!(Arc::ptr_eq(&store_50, &pred_60));
    }
}