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 432 433 434 435 436 437
use std::{collections::BTreeMap, iter::FusedIterator}; /// A node in the graph is identified by the key. /// Keys are stored in the order they were inserted, a redundant copy is stored in the index. /// Values don't have this redundancy. /// There could be more than one values for a key. #[derive(Debug, Clone)] pub struct IndexedGraph<K, V> { keys: Vec<K>, values: Vec<V>, edges: BTreeMap<K, K>, i: BTreeMap<K, Vec<usize>>, // phantom: PhantomData<&'a V>, } impl<K: Ord + Clone, V> IndexedGraph<K, V> { /// Makes a new, empty `IndexedGraph`. /// /// # Examples /// /// ``` /// use std::collections::BTreeMap; /// let mut map = BTreeMap::<u8,u8>::new(); /// assert_eq!(core::mem::size_of::<BTreeMap<u8,u8>>(), 24); /// assert_eq!(core::mem::size_of_val(&map), 24); /// /// use igraph::IndexedGraph; /// let mut graph = IndexedGraph::new(); /// /// assert_eq!(core::mem::size_of::<IndexedGraph<u8,u8>>(), 96); /// assert_eq!(core::mem::size_of_val(&graph), 96); /// /// // entries can now be inserted into the empty graph /// graph.insert(1, "a"); /// ``` pub fn new() -> IndexedGraph<K, V> { IndexedGraph { keys: vec![], values: vec![], edges: BTreeMap::new(), i: BTreeMap::new(), // phantom: PhantomData, } } /// Clears the graph, removing all elements. /// /// # Examples /// /// ``` /// use igraph::IndexedGraph; /// /// let mut graph = IndexedGraph::new(); /// graph.insert(1, "a"); /// graph.clear(); /// // assert!(graph.is_empty()); /// ``` pub fn clear(&mut self) { // Let's just drop everything. *self = IndexedGraph::new(); } /// Returns a reference to the values corresponding to the key. /// /// # Examples /// /// ``` /// use igraph::IndexedGraph; /// /// let mut graph = IndexedGraph::new(); /// graph.insert(1, "a"); /// assert_eq!(graph.get(&1), vec![&"a"]); /// assert_eq!(graph.get(&2), Vec::<&&str>::new()); /// ``` pub fn get(&self, key: &K) -> Vec<&V> { let mut res = vec![]; if let Some(indexes) = self.i.get(key) { for idx in indexes { res.push(&self.values[*idx]); } } return res; } /// Returns the key-value pairs corresponding to the supplied key. /// /// # Examples /// /// ``` /// use igraph::IndexedGraph; /// /// let mut graph = IndexedGraph::new(); /// graph.insert(1, "a"); /// assert_eq!(graph.get_key_values(&1), vec![(&1, &"a")]); /// assert_eq!(graph.get_key_values(&2), vec![]); /// ``` pub fn get_key_values(&self, key: &K) -> Vec<(&K, &V)> { let mut res = vec![]; if let Some(tup) = self.i.get_key_value(key) { for idx in tup.1 { res.push((tup.0, &self.values[*idx])); } } return res; } /// Returns the first key-value pair in the graph. /// The key in this pair is the minimum key in the graph. /// /// # Examples /// /// ``` /// use igraph::IndexedGraph; /// /// let mut graph = IndexedGraph::new(); /// assert_eq!(graph.first_key_value(), None); /// graph.insert(1, "b"); /// graph.insert(2, "a"); /// assert_eq!(graph.first_key_value(), Some((&1, &"b"))); /// ``` pub fn first_key_value(&self) -> Option<(&K, &V)> { if let Some(key) = self.keys.first() { Some((key, &self.values[0])) } else { None } } /// Removes and returns the first element in the graph. /// The key of this element is the key first inserted into the graph. /// /// # Examples /// /// ``` /// use igraph::IndexedGraph; /// /// let mut graph = IndexedGraph::new(); /// graph.insert(1, "a"); /// graph.insert(2, "b"); /// while let Some((key, _val)) = graph.pop_first() { /// assert!(graph.iter().all(|(k, _v)| *k > key)); /// } /// for item in graph.iter() { /// assert!(*item.0 < 3); /// assert!(*item.1 == "a" || *item.1 == "b"); /// } /// assert!(graph.is_empty()); /// ``` pub fn pop_first(&mut self) -> Option<(K, V)> { if self.keys.is_empty() { None } else { let key = self.keys.remove(0); let value = self.values.remove(0); self.i.remove(&key); Some((key, value)) } } /// Returns the last key-value pair in the graph. /// The key in this pair is last inserted in the graph. /// /// # Examples /// /// ``` /// use igraph::IndexedGraph; /// /// let mut graph = IndexedGraph::new(); /// graph.insert(1, "b"); /// graph.insert(2, "a"); /// assert_eq!(graph.last_key_value(), Some((&2, &"a"))); /// ``` pub fn last_key_value(&self) -> Option<(&K, &V)> { if let Some(key) = self.keys.last() { Some((key, &self.values.last().unwrap())) } else { None } } /// Removes and returns the last element in the graph. /// The key of this element is the last inserted in the graph. /// /// # Examples /// /// Draining elements in descending order, while keeping a usable graph each iteration. /// /// ``` /// use igraph::IndexedGraph; /// /// let mut graph = IndexedGraph::new(); /// graph.insert(1, "a"); /// graph.insert(2, "b"); /// while let Some((key, _val)) = graph.pop_last() { /// assert!(graph.iter().all(|(k, _v)| *k < key)); /// } /// assert!(graph.is_empty()); /// ``` pub fn pop_last(&mut self) -> Option<(K, V)> { if self.keys.is_empty() { None } else { let key = self.keys.pop().unwrap(); let value = self.values.pop().unwrap(); self.i.remove(&key); Some((key, value)) } } /// Returns `true` if the graph contains a value for the specified key using the internal index. /// /// # Examples /// /// ``` /// use igraph::IndexedGraph; /// /// let mut graph = IndexedGraph::new(); /// graph.insert(1, "a"); /// assert_eq!(graph.contains_key(&1), true); /// assert_eq!(graph.contains_key(&2), false); /// ``` pub fn contains_key(&self, key: &K) -> bool { self.i.get(key).is_some() } /// Inserts a key-value pair into the graph. /// /// If the graph did not have this key present, `None` is returned. /// /// If the graph did have this key present, the value is inserted after the existing one. /// Then the new value is returned. /// The key is not updated, only inserted the first time. /// /// # Examples /// /// ``` /// use igraph::IndexedGraph; /// /// let mut graph = IndexedGraph::new(); /// assert_eq!(graph.insert(37, "a"), Some(&"a")); /// assert_eq!(graph.is_empty(), false); /// /// graph.insert(37, "b"); /// assert_eq!(graph.insert(37, "c"), Some(&"c")); /// //assert_eq!(graph[&37], "c"); /// ``` pub fn insert(&mut self, key: K, value: V) -> Option<&V> { if let Some(indexes) = self.i.get_mut(&key) { indexes.push(self.values.len()); } else { self.i.insert(key.clone(), vec![self.values.len()]); } self.values.push(value); self.keys.push(key); return self.values.last(); } /// Inserts a key-value pair into the graph. /// /// If the graph did not have this key present, `None` is returned. /// /// If the graph did have this key present, the value is inserted after the existing one. /// Then the new value is returned. /// The key is not updated, only inserted the first time. /// /// # Examples /// /// ``` /// use igraph::IndexedGraph; /// /// let mut graph = IndexedGraph::new(); /// assert_eq!(graph.insert(37, "a"), Some(&"a")); /// assert_eq!(graph.insert(12, "b"), Some(&"b")); /// assert_eq!(graph.is_empty(), false); /// /// graph.insert_edge(12, 37); /// assert_eq!(graph.insert(37, "c"), Some(&"c")); /// //assert_eq!(graph[&37], "c"); /// ``` pub fn insert_edge(&mut self, from: K, to: K) -> Option<(&K, &K)> { self.edges.insert(from.clone(), to); self.edges.get_key_value(&from) } /// Returns the number of elements in the graph. /// /// # Examples /// /// ``` /// use igraph::IndexedGraph; /// /// let mut a = IndexedGraph::new(); /// assert_eq!(a.len(), 0); /// a.insert(1, "a"); /// assert_eq!(a.len(), 1); /// ``` pub fn len(&self) -> usize { self.i.len() } /// Returns `true` if the graph contains no elements. /// /// # Examples /// /// ``` /// use igraph::IndexedGraph; /// /// let mut a = IndexedGraph::new(); /// assert!(a.is_empty()); /// a.insert(1, "a"); /// assert!(!a.is_empty()); /// ``` pub fn is_empty(&self) -> bool { self.i.len() == 0 } pub fn index_copy(&self) -> BTreeMap<K, Vec<usize>> { self.i.clone().into() } /// Returns a Vec of references to the values corresponding to the supplied key. /// /// # Examples /// /// ``` /// use igraph::IndexedGraph; /// /// let mut a = IndexedGraph::new(); /// a.insert(1, "a"); /// assert_eq!(*a.index(1), [&"a"]); /// ``` #[inline] pub fn index(&self, key: K) -> Vec<&V> { self.get(&key) } /// Gets an iterator over the entries of the graph, sorted by key. /// `IndexedGraph` preserves the order of insertion for `iter()`. /// /// # Examples /// /// ``` /// use igraph::IndexedGraph; /// /// let mut graph = IndexedGraph::new(); /// graph.insert(3, "c"); /// graph.insert(2, "b"); /// graph.insert(1, "a"); /// /// for (key, value) in graph.iter() { /// println!("{}: {}", key, value); /// } /// /// let (first_key, first_value) = graph.iter().next().unwrap(); /// assert_eq!((*first_key, *first_value), (3, "c")); /// ``` pub fn iter(&self) -> Iter<'_, K, V> { Iter { graph: &self, length: self.len(), } } } #[derive(Debug, Clone)] pub struct Iter<'a, K: 'a, V: 'a> { graph: &'a IndexedGraph<K, V>, length: usize, } impl<'a, K: Ord + Clone, V> IntoIterator for &'a IndexedGraph<K, V> { type Item = (&'a K, &'a V); type IntoIter = Iter<'a, K, V>; fn into_iter(self) -> Iter<'a, K, V> { self.iter() } } impl<'a, K: 'a + Ord + Clone, V: 'a> Iterator for Iter<'a, K, V> { type Item = (&'a K, &'a V); fn next(&mut self) -> Option<(&'a K, &'a V)> { if self.length == 0 { None } else { self.length -= 1; let idx = &self.graph.len() - 1 - self.length; Some((&self.graph.keys[idx], &self.graph.values[idx])) } } fn size_hint(&self) -> (usize, Option<usize>) { (self.length, Some(self.length)) } fn last(self) -> Option<(&'a K, &'a V)> { self.graph.last_key_value() } fn min(mut self) -> Option<(&'a K, &'a V)> { self.next() } fn max(self) -> Option<(&'a K, &'a V)> { self.last() } } impl<K: Ord + Clone, V> FusedIterator for Iter<'_, K, V> {} impl<'a, K: 'a + Ord + Clone, V: 'a> DoubleEndedIterator for Iter<'a, K, V> { fn next_back(&mut self) -> Option<(&'a K, &'a V)> { if self.length == 0 { None } else { self.length -= 1; let idx = self.length; Some((&self.graph.keys[idx], &self.graph.values[idx])) } } } impl<K: Ord + Clone, V> ExactSizeIterator for Iter<'_, K, V> { fn len(&self) -> usize { self.length } } // impl<'a, K: Ord+Clone, V> Index<K> for &'a IndexedGraph<K, V> { // type Output = [&'a V]; // #[inline] // fn index(&self, index: K) -> &[&'a V] { // self.get(&index).as_slice() // } // }