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
use std::iter::FromIterator; use tree::{ Tree, Iter as TreeIter, Matches as TreeMatches, }; use key::Key; /// A map based on a [Radix tree](https://en.wikipedia.org/wiki/Radix_tree). /// /// Radix trees are a implementation of the [Trie](https://en.wikipedia.org/wiki/Trie) data /// structure, where any node can have N edges, and the keys are split on the edges to save memory. /// There are no duplicate keys and values aren't only stored on the leaves of the tree. /// /// This structure has the advantage of being fairly memory-efficient by compromising on key /// insertion speed. There is also quite a bit of fragmentation due to the abundance of heap memory /// usage in both the tree's structure and the data it contains. /// /// You should probably only use this if you need to search by prefix in a large dataset of /// strings. Consider using a sorted tree structure, such as a /// [`BTreeMap`](https://doc.rust-lang.org/std/collections/struct.BTreeMap.html) or any /// implementation of a [Binary tree](https://en.wikipedia.org/wiki/Binary_tree) available on /// [crates.io](https://crates.io/search?q=binary%20tree). /// /// The `Key` trait is left private for safety (see the implementation for `str` for an /// explanation). You can think of it as an abstraction over both `T` slices and `str` slices. /// Therefore when specifying the type of `K`, you'll give either `[T]` or `str`. pub struct RadixMap<K: Key + ?Sized, V> { tree: Tree<<K as Key>::Component, V>, } impl<K: Key + ?Sized, V> RadixMap<K, V> { /// Makes a new empty RadixMap. /// /// # Examples /// /// Basic usage: /// /// ``` /// use panoradix::RadixMap; /// /// let mut map = RadixMap::new(); /// /// // entries can now be inserted into the empty map /// map.insert("a", 1); /// ``` pub fn new() -> RadixMap<K, V> { RadixMap { tree: Tree::new() } } /// Clears the map, removing all values. /// /// # Examples /// /// Basic usage: /// /// ``` /// use panoradix::RadixMap; /// /// let mut m = RadixMap::new(); /// m.insert("a", 1); /// m.clear(); /// assert!(m.is_empty()); /// ``` pub fn clear(&mut self) { self.tree.clear(); } /// Return the number of elements in the map. /// /// # Examples /// /// Basic usage: /// /// ``` /// use panoradix::RadixMap; /// /// let mut m = RadixMap::new(); /// m.insert("a", 1); /// m.insert("b", 2); /// m.insert("c", 3); /// assert_eq!(m.len(), 3); /// ``` pub fn len(&self) -> usize { self.tree.len() } /// Inserts a key-value pair into the map. /// /// If the map did not have this key present, `None` is returned. /// /// If the map did have this key present, the value is updated, and the old /// value is returned. /// /// # Examples /// /// Basic usage: /// /// ``` /// use panoradix::RadixMap; /// /// let mut map = RadixMap::new(); /// assert_eq!(map.insert("a", 37), None); /// assert_eq!(map.is_empty(), false); /// /// map.insert("a", 42); /// assert_eq!(map.insert("a", 1337), Some(42)); /// ``` pub fn insert(&mut self, key: &K, value: V) -> Option<V> { self.tree.insert(key.as_slice(), value) } /// Returns a reference to the value corresponding to the key. /// /// # Examples /// /// Basic usage: /// /// ``` /// use panoradix::RadixMap; /// /// let mut map = RadixMap::new(); /// map.insert("a", 1); /// assert_eq!(map.get("a"), Some(&1)); /// assert_eq!(map.get("b"), None); /// ``` pub fn get(&self, key: &K) -> Option<&V> { self.tree.get(key.as_slice()) } /// Returns a mutable reference to the value corresponding to the key. /// map.insert("a", 0); /// *map.get_mut("a").unwrap() += 1; /// *map.get_mut("a").unwrap() += 1; /// assert_eq!(map.get("a"), Some(&2)); /// ``` pub fn get_mut(&mut self, key: &K) -> Option<&mut V> { self.tree.get_mut(key.as_slice()) } /// Returns if the key was inserted in the map. /// /// Note: this is equivalent to calling `get(key).is_some()` /// /// # Examples /// /// Basic usage: /// /// ``` /// use panoradix::RadixMap; /// /// let mut map = RadixMap::new(); /// map.insert("a", 1); /// map.insert("b", 2); /// assert!(map.contains_key("a")); /// assert!(map.contains_key("b")); /// assert!(!map.contains_key("c")); /// ``` #[inline] pub fn contains_key(&self, key: &K) -> bool { self.get(key).is_some() } /// Returns `true` if the map contains no elements. /// /// # Examples /// /// Basic usage: /// /// ``` /// use panoradix::RadixMap; /// /// let mut a = RadixMap::new(); /// assert!(a.is_empty()); /// a.insert("a", ()); /// assert!(!a.is_empty()); /// ``` pub fn is_empty(&self) -> bool { self.tree.is_empty() } /// Removes a key from the map, returning the value at the key if the key /// was previously in the map. /// /// # Examples /// /// Basic usage: /// /// ``` /// use panoradix::RadixMap; /// /// let mut map = RadixMap::new(); /// map.insert("a", 1); /// assert_eq!(map.remove("a"), Some(1)); /// assert_eq!(map.remove("a"), None); /// ``` pub fn remove(&mut self, key: &K) -> Option<V> { self.tree.remove(key.as_slice()) } /// Gets an iterator over the entries of the map, sorted by key. /// /// # Examples /// /// Basic usage: /// /// ``` /// use panoradix::RadixMap; /// /// let mut map = RadixMap::new(); /// map.insert("c", 3); /// map.insert("b", 2); /// map.insert("a", 1); /// /// for (key, value) in map.iter() { /// println!("{}: {}", key, value); /// } /// /// let (first_key, first_value) = map.iter().next().unwrap(); /// assert_eq!((first_key, *first_value), ("a".to_string(), 1)); /// ``` pub fn iter(&self) -> Iter<K, V> { Iter { iter: self.tree.iter(), } } /// Gets an iterator over the keys of the map (sorted). /// /// # Examples /// /// Basic usage: /// /// ``` /// use panoradix::RadixMap; /// /// let mut map = RadixMap::new(); /// map.insert("c", 3); /// map.insert("b", 2); /// map.insert("a", 1); /// /// for key in map.keys() { /// println!("{}", key); /// } /// /// let first_key = map.keys().next().unwrap(); /// assert_eq!(first_key, "a".to_string()); /// ``` pub fn keys(&self) -> Keys<K, V> { Keys { iter: self.iter(), } } /// Gets an iterator over the values of the map, sorted by corresponding key. /// /// # Examples /// /// Basic usage: /// /// ``` /// use panoradix::RadixMap; /// /// let mut map = RadixMap::new(); /// map.insert("c", 3); /// map.insert("b", 2); /// map.insert("a", 1); /// /// for value in map.values() { /// println!("{}", value); /// } /// /// let first_value = map.values().next().unwrap(); /// assert_eq!(first_value, &1); /// ``` pub fn values(&self) -> Values<K, V> { Values { iter: self.iter(), } } /// Gets an iterator over a filtered subset of the map, sorted by key. /// /// The iterator resembles `iter()` since it yields key-value pairs from the map. Note that /// the full key will be yielded each time, not just the filtered suffix. /// /// # Examples /// /// Basic usage: /// /// ``` /// use panoradix::RadixMap; /// /// let mut map = RadixMap::new(); /// map.insert("abc", 1); /// map.insert("acd", 2); /// map.insert("abd", 3); /// map.insert("bbb", 1); /// map.insert("ccc", 1); /// /// for (key, value) in map.find("a") { /// println!("{}: {}", key, value); /// } /// /// let (first_key, first_value) = map.find("a").next().unwrap(); /// assert_eq!((first_key, first_value), ("abc".to_string(), &1)); /// ``` pub fn find<'a>(&'a self, key: &K) -> Matches<'a, K, V> { Matches { matches: self.tree.find(key.as_slice()), } } } impl<K: Key + ?Sized, V> Default for RadixMap<K, V> { fn default() -> Self { Self::new() } } impl<K, V, T> FromIterator<(T, V)> for RadixMap<K, V> where K: Key + ?Sized, T: AsRef<K>, { fn from_iter<It>(iter: It) -> Self where It: IntoIterator<Item=(T, V)>, { let mut tree = Tree::new(); for (t, v) in iter { tree.insert(t.as_ref().as_slice(), v); } RadixMap { tree } } } /// An iterator over a `RadixMap`'s (key, value) pairs. pub struct Iter<'a, K: 'a + Key + ?Sized, V: 'a> { iter: TreeIter<'a, K::Component, V>, } impl<'a, K: 'a + Key + ?Sized, V: 'a> Iterator for Iter<'a, K, V> { type Item = (K::Owned, &'a V); fn next(&mut self) -> Option<Self::Item> { self.iter.next().map(|(k, v)| (K::from_vec(k), v)) } } /// An iterator over a `RadixMap`'s keys. pub struct Keys<'a, K: 'a + Key + ?Sized, V: 'a> { iter: Iter<'a, K, V>, } impl<'a, K: 'a + Key + ?Sized, V: 'a> Iterator for Keys<'a, K, V> { type Item = K::Owned; fn next(&mut self) -> Option<Self::Item> { self.iter.next().map(|(k, _)| k) } } /// An iterator over a `RadixMap`'s values. pub struct Values<'a, K: 'a + Key + ?Sized, V: 'a> { iter: Iter<'a, K, V>, } impl<'a, K: 'a + Key + ?Sized, V: 'a> Iterator for Values<'a, K, V> { type Item = &'a V; fn next(&mut self) -> Option<Self::Item> { self.iter.next().map(|(_, v)| v) } } /// An iterator over the elements matching a call to [`find`]. /// /// [`find`]: struct.RadixMap.html#method.find pub struct Matches<'a, K: 'a + Key + ?Sized, V: 'a> { matches: TreeMatches<'a, K::Component, V>, } impl<'a, K: 'a + Key + ?Sized, V: 'a> Iterator for Matches<'a, K, V> { type Item = (K::Owned, &'a V); fn next(&mut self) -> Option<Self::Item> { self.matches.next().map(|(k, v)| (K::from_vec(k), v)) } } #[cfg(test)] mod tests { use super::RadixMap; #[test] fn it_can_lookup_elements() { let mut map: RadixMap<str, i32> = RadixMap::new(); map.insert("a", 0); map.insert("ac", 1); let v = map.get("a"); assert_eq!(v.map(|x| *x), Some(0)); let v = map.get("ac"); assert_eq!(v.map(|x| *x), Some(1)); } #[test] fn it_has_a_key_iterator() { let mut map: RadixMap<str, ()> = RadixMap::new(); map.insert("foo", ()); map.insert("bar", ()); map.insert("baz", ()); let keys: Vec<_> = map.keys().collect(); assert_eq!(keys, vec!["bar", "baz", "foo"]); } #[test] fn it_has_a_value_iterator() { let mut map: RadixMap<str, i32> = RadixMap::new(); map.insert("foo", 0); map.insert("bar", 1); map.insert("baz", 2); let values: Vec<_> = map.values().collect(); assert_eq!(values, vec![&1, &2, &0]); } }