|
| 1 | +# TrieMap |
| 2 | + |
| 3 | +A Rust implementation of a map data structure backed by a trie (prefix tree). |
| 4 | + |
| 5 | +## Features |
| 6 | + |
| 7 | +- Fast key lookups with O(k) complexity where k is the key length |
| 8 | +- Prefix-based operations (matching keys with a common prefix) |
| 9 | +- Intuitive API similar to Rust's standard collections |
| 10 | +- Full iterator support |
| 11 | +- Entry API for in-place updates |
| 12 | + |
| 13 | +## Usage |
| 14 | + |
| 15 | +Add to your `Cargo.toml`: |
| 16 | + |
| 17 | +```toml |
| 18 | +[dependencies] |
| 19 | +triemap = { git = "https://github.com/yourusername/triemap" } |
| 20 | +``` |
| 21 | + |
| 22 | +### Basic Operations |
| 23 | + |
| 24 | +```rust |
| 25 | +use triemap::TrieMap; |
| 26 | + |
| 27 | +// Create a new map |
| 28 | +let mut map = TrieMap::new(); |
| 29 | + |
| 30 | +// Insert key-value pairs |
| 31 | +map.insert("apple", 1); |
| 32 | +map.insert("banana", 2); |
| 33 | +map.insert("cherry", 3); |
| 34 | + |
| 35 | +// Check if a key exists |
| 36 | +assert!(map.contains_key("apple")); |
| 37 | +assert!(!map.contains_key("grape")); |
| 38 | + |
| 39 | +// Get a value |
| 40 | +assert_eq!(map.get("banana"), Some(&2)); |
| 41 | + |
| 42 | +// Update a value |
| 43 | +map.insert("apple", 10); |
| 44 | +assert_eq!(map.get("apple"), Some(&10)); |
| 45 | + |
| 46 | +// Remove a value |
| 47 | +assert_eq!(map.remove("cherry"), Some(3)); |
| 48 | +assert_eq!(map.get("cherry"), None); |
| 49 | +``` |
| 50 | + |
| 51 | +### Prefix Operations |
| 52 | + |
| 53 | +One of TrieMap's strengths is working with key prefixes: |
| 54 | + |
| 55 | +```rust |
| 56 | +use triemap::TrieMap; |
| 57 | + |
| 58 | +let mut map = TrieMap::new(); |
| 59 | +map.insert("apple", 1); |
| 60 | +map.insert("application", 2); |
| 61 | +map.insert("banana", 3); |
| 62 | + |
| 63 | +// Check if any keys start with a prefix |
| 64 | +assert!(map.starts_with("app")); |
| 65 | + |
| 66 | +// Get all key-value pairs with a certain prefix |
| 67 | +let matches = map.get_prefix_matches("app"); |
| 68 | +assert_eq!(matches.len(), 2); |
| 69 | + |
| 70 | +// Iterate over keys with a prefix |
| 71 | +for key in map.prefix_keys("app") { |
| 72 | + println!("Key: {}", String::from_utf8_lossy(&key)); |
| 73 | +} |
| 74 | + |
| 75 | +// Remove all keys with a prefix |
| 76 | +let removed = map.remove_prefix_matches("app"); |
| 77 | +assert_eq!(removed.len(), 2); |
| 78 | +``` |
| 79 | + |
| 80 | +### Entry API |
| 81 | + |
| 82 | +```rust |
| 83 | +use triemap::{TrieMap, Entry}; |
| 84 | + |
| 85 | +let mut map = TrieMap::new(); |
| 86 | + |
| 87 | +// Insert a value if the key doesn't exist |
| 88 | +map.entry("a").or_insert(1); |
| 89 | + |
| 90 | +// Update a value if the key exists |
| 91 | +match map.entry("a") { |
| 92 | + Entry::Occupied(mut entry) => { |
| 93 | + *entry.get_mut() += 10; |
| 94 | + } |
| 95 | + Entry::Vacant(_) => {} |
| 96 | +} |
| 97 | + |
| 98 | +// Or more concisely: |
| 99 | +*map.entry("a").or_insert(0) += 5; |
| 100 | +``` |
| 101 | + |
| 102 | +### Iterators |
| 103 | + |
| 104 | +```rust |
| 105 | +use triemap::TrieMap; |
| 106 | + |
| 107 | +let mut map = TrieMap::new(); |
| 108 | +map.insert("a", 1); |
| 109 | +map.insert("b", 2); |
| 110 | +map.insert("c", 3); |
| 111 | + |
| 112 | +// Iterate over key-value pairs |
| 113 | +for (key, value) in &map { |
| 114 | + println!("{}: {}", String::from_utf8_lossy(&key), value); |
| 115 | +} |
| 116 | + |
| 117 | +// Iterate over keys |
| 118 | +for key in map.keys() { |
| 119 | + println!("Key: {}", String::from_utf8_lossy(&key)); |
| 120 | +} |
| 121 | + |
| 122 | +// Iterate over values |
| 123 | +for value in map.values() { |
| 124 | + println!("Value: {}", value); |
| 125 | +} |
| 126 | + |
| 127 | +// Mutable iteration |
| 128 | +for value in map.values_mut() { |
| 129 | + *value *= 2; |
| 130 | +} |
| 131 | +``` |
| 132 | + |
| 133 | +### Set Operations |
| 134 | + |
| 135 | +```rust |
| 136 | +use triemap::TrieMap; |
| 137 | + |
| 138 | +let mut map1 = TrieMap::new(); |
| 139 | +map1.insert("a", 1); |
| 140 | +map1.insert("b", 2); |
| 141 | + |
| 142 | +let mut map2 = TrieMap::new(); |
| 143 | +map2.insert("b", 20); |
| 144 | +map2.insert("c", 30); |
| 145 | + |
| 146 | +// Intersection |
| 147 | +let intersection = map1.intersect_ref(&map2); |
| 148 | +assert_eq!(intersection.len(), 1); |
| 149 | +assert_eq!(intersection.get("b"), Some(&2)); |
| 150 | + |
| 151 | +// Difference |
| 152 | +let difference = map1.difference_ref(&map2); |
| 153 | +assert_eq!(difference.len(), 1); |
| 154 | +assert_eq!(difference.get("a"), Some(&1)); |
| 155 | + |
| 156 | +// Union |
| 157 | +let union = map1.clone().union(map2.clone()); |
| 158 | +assert_eq!(union.len(), 3); |
| 159 | +``` |
| 160 | + |
| 161 | +## Contributing |
| 162 | + |
| 163 | +Contributions are welcome! Here are some ways you can contribute: |
| 164 | + |
| 165 | +- Improve documentation |
| 166 | +- Add new features |
| 167 | +- Fix bugs |
| 168 | +- Optimize performance |
| 169 | +- Add more tests |
| 170 | + |
| 171 | +Please feel free to submit issues and pull requests. |
| 172 | + |
| 173 | +## License |
| 174 | + |
| 175 | +This project is licensed under the MIT License - see the LICENSE file for details. |
0 commit comments