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
use std::usize;
use std::{cmp, mem};

use super::iterator::TriePrefixIterator;
use super::node::{InternalNode, LeafNode, Node};
use super::sparse_array::SparseArray;

const COMPLETE_KEY_NIBBLE: usize = 0;

/// A qp-trie.
#[derive(Clone, Debug)]
pub struct Trie<TK: PartialEq + AsRef<[u8]>, TV> {
    root: Option<Node<TK, TV>>,
    max_height: usize,
}

impl<TK: PartialEq + AsRef<[u8]>, TV> Default for Trie<TK, TV> {
    fn default() -> Self {
        Trie {
            root: None,
            max_height: usize::MAX,
        }
    }
}

impl<TK: PartialEq + AsRef<[u8]>, TV> Trie<TK, TV> {
    fn nibble(key: &[u8], index: usize) -> usize {
        let key_len = key.len();
        if index / 2 >= key_len {
            COMPLETE_KEY_NIBBLE
        } else {
            let nibble = key[index / 2];
            if (index & 1) == 0 {
                1 + (nibble >> 4) as usize
            } else {
                1 + (nibble & 0xf) as usize
            }
        }
    }

    fn find_closest_leaf_mut(
        root: &mut Node<TK, TV>,
        key: &[u8],
    ) -> (*mut LeafNode<TK, TV>, usize) {
        let mut height = 0;
        let mut t: *mut Node<TK, TV> = root;
        unsafe {
            while let Node::Internal(ref mut internal) = *t {
                let internal_index = internal.index;
                let nibble = Self::nibble(key, internal_index);
                t = internal.nibbles.get_or_head_mut(nibble);
                height += 1;
            }
            ((*t).as_mut_leaf(), height)
        }
    }

    #[allow(dead_code)]
    fn find_closest_leaf<'t>(root: &'t Node<TK, TV>, key: &[u8]) -> (&'t LeafNode<TK, TV>, usize) {
        let mut height = 0;
        let mut t: &Node<TK, TV> = root;
        while let Node::Internal(ref internal) = *t {
            let internal_index = internal.index;
            let nibble = Self::nibble(key, internal_index);
            t = internal.nibbles.get_or_head(nibble);
            height += 1;
        }
        (t.as_leaf(), height)
    }

    fn find_exact_leaf_mut(root: &mut Node<TK, TV>, key: &[u8]) -> Option<*mut LeafNode<TK, TV>> {
        let mut t: *mut Node<TK, TV> = root;
        unsafe {
            while let Node::Internal(ref mut internal) = *t {
                let internal_index = internal.index;
                let nibble = Self::nibble(key, internal_index);
                t = match internal.nibbles.get_mut(nibble) {
                    None => return None,
                    Some(t) => t,
                };
            }
            let leaf = (*t).as_mut_leaf();
            if key != leaf.key.as_ref() {
                return None;
            }
            Some(leaf)
        }
    }

    fn find_exact_leaf<'t>(root: &'t Node<TK, TV>, key: &[u8]) -> Option<&'t LeafNode<TK, TV>> {
        let mut t: &Node<TK, TV> = root;
        while let Node::Internal(ref internal) = *t {
            let internal_index = internal.index;
            let nibble = Self::nibble(key, internal_index);
            t = match internal.nibbles.get(nibble) {
                None => return None,
                Some(t) => t,
            };
        }
        let leaf = t.as_leaf();
        if key != leaf.key.as_ref() {
            return None;
        }
        Some(leaf)
    }

    fn new_internal_for_shorter_index(
        t: *mut Node<TK, TV>,
        leaf_key: &TK,
        index: usize,
        key: TK,
        val: TV,
    ) {
        let mut new_internal = InternalNode {
            nibbles: SparseArray::with_capacity(2),
            index,
        };
        let orig_nibble = Self::nibble(leaf_key.as_ref(), index);
        let new_nibble = Self::nibble(key.as_ref(), index);
        let new_leaf = Node::Leaf(LeafNode { key, val });
        debug_assert!(orig_nibble != new_nibble);
        let orig_node = unsafe { mem::replace(&mut *t, Node::Empty) };
        new_internal.nibbles.set(orig_nibble, orig_node);
        new_internal.nibbles.set(new_nibble, new_leaf);
        unsafe { *t = Node::Internal(new_internal) };
    }

    fn replace_leaf_with_internal_node(
        t: *mut Node<TK, TV>,
        leaf: &LeafNode<TK, TV>,
        index: usize,
        key: TK,
        val: TV,
    ) {
        let mut new_internal = InternalNode {
            nibbles: SparseArray::with_capacity(2),
            index,
        };
        let orig_nibble = Self::nibble(leaf.key.as_ref(), index);
        let new_nibble = Self::nibble(key.as_ref(), index);
        let new_leaf = Node::Leaf(LeafNode { key, val });
        debug_assert!(orig_nibble != new_nibble);
        let orig_node = unsafe { mem::replace(&mut *t, Node::Empty) };
        new_internal.nibbles.set(orig_nibble, orig_node);
        new_internal.nibbles.set(new_nibble, new_leaf);
        unsafe { *t = Node::Internal(new_internal) };
    }

    /// Creates a new, empty qp-trie.
    pub fn new() -> Self {
        Self::default()
    }

    /// Refuses to insert nodes that would make the trie height greater than
    /// `max_height`.
    pub fn max_height(mut self, max_height: usize) -> Self {
        self.max_height = max_height;
        self
    }

    /// Returns `true` if the trie is empty.
    #[inline]
    pub fn is_empty(&self) -> bool {
        self.root.is_none()
    }

    #[doc(hidden)]
    #[inline]
    pub fn root(&self) -> Option<&Node<TK, TV>> {
        self.root.as_ref()
    }

    /// Inserts a new node with the key `key`.
    pub fn insert(&mut self, key: TK, val: TV) -> bool {
        if self.root.is_none() {
            let leaf = LeafNode { key, val };
            self.root = Some(Node::Leaf(leaf));
            return true;
        }
        let (leaf, height) = unsafe {
            let closest = Self::find_closest_leaf_mut(self.root.as_mut().unwrap(), key.as_ref());
            (&mut *closest.0, closest.1)
        };
        let leaf_key = &leaf.key;
        let mut i = 0;
        let mut x = 0;
        let key_len = key.as_ref().len();
        let leaf_key_len = leaf_key.as_ref().len();
        let min_keys_len = cmp::min(key_len, leaf_key_len);
        while i < min_keys_len {
            x = key.as_ref()[i] ^ leaf_key.as_ref()[i];
            if x != 0 {
                break;
            }
            i += 1;
        }
        if x == 0 {
            if key_len == leaf_key_len {
                leaf.val = val;
                return false;
            }
            x = 0xff;
        }
        let mut index = i * 2;
        if (x & 0xf0) == 0 {
            index += 1;
        }
        let mut t: *mut Node<TK, TV> = self.root.as_mut().unwrap();
        loop {
            match *unsafe { &mut *t } {
                Node::Leaf(ref leaf) => {
                    if height >= self.max_height {
                        return false;
                    }
                    Self::replace_leaf_with_internal_node(t, leaf, index, key, val);
                    return true;
                }
                Node::Internal(ref mut internal) => {
                    if internal.index <= index {
                        let new_nibble = Self::nibble(key.as_ref(), internal.index);
                        if let Some(t_next) = internal.nibbles.get_mut(new_nibble) {
                            t = t_next;
                            continue;
                        }
                        let new_leaf = Node::Leaf(LeafNode { key, val });
                        internal.nibbles.set(new_nibble, new_leaf);
                        return true;
                    }
                    if height >= self.max_height {
                        return false;
                    }
                    Self::new_internal_for_shorter_index(t, leaf_key, index, key, val);
                    return true;
                }
                _ => unsafe { debug_unreachable!() },
            }
        }
    }

    /// Returns the value associated with the key `key`, or `None` if the key is
    /// not present in the trie.
    pub fn get(&self, key: &TK) -> Option<&TV> {
        let root = match self.root.as_ref() {
            None => return None,
            Some(root) => root,
        };
        let leaf = match Self::find_exact_leaf(root, key.as_ref()) {
            None => return None,
            Some(leaf) => leaf,
        };
        Some(&leaf.val)
    }

    /// Returns a mutable value associated with the key `key`, or `None` if the
    /// key is not present in the trie.
    pub fn get_mut(&mut self, key: &TK) -> Option<&mut TV> {
        let root = match self.root.as_mut() {
            None => return None,
            Some(root) => root,
        };
        let leaf = match Self::find_exact_leaf_mut(root, key.as_ref()) {
            None => return None,
            Some(leaf) => leaf,
        };
        Some(unsafe { &mut (*leaf).val })
    }

    /// Removes the node associated with the key `key`.
    ///
    /// Returns `true` if the key was found, or `false` if the operation was a
    /// no-op.
    pub fn remove(&mut self, key: &TK) -> bool {
        if self.root.is_none() {
            return false;
        }
        let mut t: *mut Node<TK, TV> = self.root.as_mut().unwrap();
        let (leaf, parent, nibble) = unsafe {
            let mut parent = None;
            let mut nibble = 0;
            while let Node::Internal(ref mut internal) = *t {
                let internal_index = internal.index;
                nibble = Self::nibble(key.as_ref(), internal_index);
                parent = Some(&mut *t);
                t = match internal.nibbles.get_mut(nibble) {
                    None => return false,
                    Some(t) => t,
                };
            }
            (&mut *t, parent, nibble)
        };
        if key.as_ref()[..] != leaf.as_leaf().key.as_ref()[..] {
            return false;
        }
        let parent: &mut Node<TK, TV> = match parent {
            None => {
                self.root = None;
                return true;
            }
            Some(parent) => parent,
        };
        parent.as_mut_internal().nibbles.remove(nibble);
        debug_assert!(!parent.as_internal().nibbles.is_empty());
        if parent.as_internal().nibbles.len() == 1 {
            *parent = parent.as_mut_internal().nibbles.pop();
        }
        true
    }

    #[doc(hidden)]
    pub fn prefix_find_next<'t>(
        &self,
        prefix: &TK,
        todo: &mut Vec<&'t Node<TK, TV>>,
        include_prefix: bool,
    ) -> Option<&'t LeafNode<TK, TV>> {
        let prefix_len = prefix.as_ref().len();
        while let Some(t) = todo.pop() {
            match *t {
                Node::Leaf(ref leaf) => {
                    if leaf.key.as_ref().starts_with(prefix.as_ref())
                        && (include_prefix || leaf.key.as_ref() != prefix.as_ref())
                    {
                        return Some(leaf);
                    }
                }
                Node::Internal(ref internal) => {
                    if internal.index / 2 >= prefix_len {
                        for node in internal.nibbles.all().iter().rev() {
                            todo.push(node);
                        }
                    } else {
                        let nibble = Self::nibble(prefix.as_ref(), internal.index);
                        if let Some(node) = internal.nibbles.get(nibble) {
                            todo.push(node)
                        }
                    }
                }
                _ => unreachable!(),
            }
        }
        None
    }

    /// Creates a new iterator over all the nodes whose key includes `prefix` as
    /// a prefix.
    pub fn prefix_iter<'t>(&'t self, prefix: &'t TK) -> TriePrefixIterator<TK, TV> {
        TriePrefixIterator::new(self, prefix, false)
    }
}