1 // Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 //! A simple map based on a vector for small integer keys. Space requirements
12 //! are O(highest integer key).
14 #![allow(missing_docs)]
20 use core::cmp::Ordering;
21 use core::default::Default;
23 use core::hash::{Hash, Writer, Hasher};
24 use core::iter::{Enumerate, FilterMap, Map, FromIterator, IntoIterator};
26 use core::mem::replace;
27 use core::ops::{Index, IndexMut};
32 /// A map optimized for small integer keys.
37 /// use std::collections::VecMap;
39 /// let mut months = VecMap::new();
40 /// months.insert(1, "Jan");
41 /// months.insert(2, "Feb");
42 /// months.insert(3, "Mar");
44 /// if !months.contains_key(&12) {
45 /// println!("The end is near!");
48 /// assert_eq!(months.get(&1), Some(&"Jan"));
50 /// match months.get_mut(&3) {
51 /// Some(value) => *value = "Venus",
55 /// assert_eq!(months.get(&3), Some(&"Venus"));
57 /// // Print out all months
58 /// for (key, value) in months.iter() {
59 /// println!("month {} is {}", key, value);
63 /// assert!(months.is_empty());
65 pub struct VecMap<V> {
69 /// A view into a single entry in a map, which may either be vacant or occupied.
70 #[unstable(feature = "collections",
71 reason = "precise API still under development")]
72 pub enum Entry<'a, V:'a> {
74 Vacant(VacantEntry<'a, V>),
76 Occupied(OccupiedEntry<'a, V>),
80 #[unstable(feature = "collections",
81 reason = "precise API still under development")]
82 pub struct VacantEntry<'a, V:'a> {
83 map: &'a mut VecMap<V>,
87 /// An occupied Entry.
88 #[unstable(feature = "collections",
89 reason = "precise API still under development")]
90 pub struct OccupiedEntry<'a, V:'a> {
91 map: &'a mut VecMap<V>,
95 #[stable(feature = "rust1", since = "1.0.0")]
96 impl<V> Default for VecMap<V> {
97 #[stable(feature = "rust1", since = "1.0.0")]
99 fn default() -> VecMap<V> { VecMap::new() }
102 impl<V:Clone> Clone for VecMap<V> {
104 fn clone(&self) -> VecMap<V> {
105 VecMap { v: self.v.clone() }
109 fn clone_from(&mut self, source: &VecMap<V>) {
110 self.v.clone_from(&source.v);
114 impl<S: Writer + Hasher, V: Hash<S>> Hash<S> for VecMap<V> {
115 fn hash(&self, state: &mut S) {
116 // In order to not traverse the `VecMap` twice, count the elements
118 let mut count: usize = 0;
128 /// Creates an empty `VecMap`.
133 /// use std::collections::VecMap;
134 /// let mut map: VecMap<&str> = VecMap::new();
136 #[stable(feature = "rust1", since = "1.0.0")]
137 pub fn new() -> VecMap<V> { VecMap { v: vec![] } }
139 /// Creates an empty `VecMap` with space for at least `capacity`
140 /// elements before resizing.
145 /// use std::collections::VecMap;
146 /// let mut map: VecMap<&str> = VecMap::with_capacity(10);
148 #[stable(feature = "rust1", since = "1.0.0")]
149 pub fn with_capacity(capacity: usize) -> VecMap<V> {
150 VecMap { v: Vec::with_capacity(capacity) }
153 /// Returns the number of elements the `VecMap` can hold without
159 /// use std::collections::VecMap;
160 /// let map: VecMap<String> = VecMap::with_capacity(10);
161 /// assert!(map.capacity() >= 10);
164 #[stable(feature = "rust1", since = "1.0.0")]
165 pub fn capacity(&self) -> usize {
169 /// Reserves capacity for the given `VecMap` to contain `len` distinct keys.
170 /// In the case of `VecMap` this means reallocations will not occur as long
171 /// as all inserted keys are less than `len`.
173 /// The collection may reserve more space to avoid frequent reallocations.
178 /// use std::collections::VecMap;
179 /// let mut map: VecMap<&str> = VecMap::new();
180 /// map.reserve_len(10);
181 /// assert!(map.capacity() >= 10);
183 #[stable(feature = "rust1", since = "1.0.0")]
184 pub fn reserve_len(&mut self, len: usize) {
185 let cur_len = self.v.len();
187 self.v.reserve(len - cur_len);
191 /// Reserves the minimum capacity for the given `VecMap` to contain `len` distinct keys.
192 /// In the case of `VecMap` this means reallocations will not occur as long as all inserted
193 /// keys are less than `len`.
195 /// Note that the allocator may give the collection more space than it requests.
196 /// Therefore capacity cannot be relied upon to be precisely minimal. Prefer
197 /// `reserve_len` if future insertions are expected.
202 /// use std::collections::VecMap;
203 /// let mut map: VecMap<&str> = VecMap::new();
204 /// map.reserve_len_exact(10);
205 /// assert!(map.capacity() >= 10);
207 #[stable(feature = "rust1", since = "1.0.0")]
208 pub fn reserve_len_exact(&mut self, len: usize) {
209 let cur_len = self.v.len();
211 self.v.reserve_exact(len - cur_len);
215 /// Returns an iterator visiting all keys in ascending order of the keys.
216 /// The iterator's element type is `usize`.
217 #[stable(feature = "rust1", since = "1.0.0")]
218 pub fn keys<'r>(&'r self) -> Keys<'r, V> {
219 fn first<A, B>((a, _): (A, B)) -> A { a }
220 let first: fn((usize, &'r V)) -> usize = first; // coerce to fn pointer
222 Keys { iter: self.iter().map(first) }
225 /// Returns an iterator visiting all values in ascending order of the keys.
226 /// The iterator's element type is `&'r V`.
227 #[stable(feature = "rust1", since = "1.0.0")]
228 pub fn values<'r>(&'r self) -> Values<'r, V> {
229 fn second<A, B>((_, b): (A, B)) -> B { b }
230 let second: fn((usize, &'r V)) -> &'r V = second; // coerce to fn pointer
232 Values { iter: self.iter().map(second) }
235 /// Returns an iterator visiting all key-value pairs in ascending order of the keys.
236 /// The iterator's element type is `(usize, &'r V)`.
241 /// use std::collections::VecMap;
243 /// let mut map = VecMap::new();
244 /// map.insert(1, "a");
245 /// map.insert(3, "c");
246 /// map.insert(2, "b");
248 /// // Print `1: a` then `2: b` then `3: c`
249 /// for (key, value) in map.iter() {
250 /// println!("{}: {}", key, value);
253 #[stable(feature = "rust1", since = "1.0.0")]
254 pub fn iter<'r>(&'r self) -> Iter<'r, V> {
262 /// Returns an iterator visiting all key-value pairs in ascending order of the keys,
263 /// with mutable references to the values.
264 /// The iterator's element type is `(usize, &'r mut V)`.
269 /// use std::collections::VecMap;
271 /// let mut map = VecMap::new();
272 /// map.insert(1, "a");
273 /// map.insert(2, "b");
274 /// map.insert(3, "c");
276 /// for (key, value) in map.iter_mut() {
280 /// for (key, value) in map.iter() {
281 /// assert_eq!(value, &"x");
284 #[stable(feature = "rust1", since = "1.0.0")]
285 pub fn iter_mut<'r>(&'r mut self) -> IterMut<'r, V> {
289 iter: self.v.iter_mut()
293 /// Returns an iterator visiting all key-value pairs in ascending order of
294 /// the keys, consuming the original `VecMap`.
295 /// The iterator's element type is `(usize, &'r V)`.
300 /// use std::collections::VecMap;
302 /// let mut map = VecMap::new();
303 /// map.insert(1, "a");
304 /// map.insert(3, "c");
305 /// map.insert(2, "b");
307 /// let vec: Vec<(usize, &str)> = map.into_iter().collect();
309 /// assert_eq!(vec, vec![(1, "a"), (2, "b"), (3, "c")]);
311 #[stable(feature = "rust1", since = "1.0.0")]
312 pub fn into_iter(self) -> IntoIter<V> {
313 fn filter<A>((i, v): (usize, Option<A>)) -> Option<(usize, A)> {
316 let filter: fn((usize, Option<V>)) -> Option<(usize, V)> = filter; // coerce to fn ptr
318 IntoIter { iter: self.v.into_iter().enumerate().filter_map(filter) }
321 /// Returns an iterator visiting all key-value pairs in ascending order of
322 /// the keys, emptying (but not consuming) the original `VecMap`.
323 /// The iterator's element type is `(usize, &'r V)`. Keeps the allocated memory for reuse.
328 /// use std::collections::VecMap;
330 /// let mut map = VecMap::new();
331 /// map.insert(1, "a");
332 /// map.insert(3, "c");
333 /// map.insert(2, "b");
335 /// let vec: Vec<(usize, &str)> = map.drain().collect();
337 /// assert_eq!(vec, vec![(1, "a"), (2, "b"), (3, "c")]);
339 #[unstable(feature = "collections",
340 reason = "matches collection reform specification, waiting for dust to settle")]
341 pub fn drain<'a>(&'a mut self) -> Drain<'a, V> {
342 fn filter<A>((i, v): (usize, Option<A>)) -> Option<(usize, A)> {
345 let filter: fn((usize, Option<V>)) -> Option<(usize, V)> = filter; // coerce to fn ptr
347 Drain { iter: self.v.drain().enumerate().filter_map(filter) }
350 /// Return the number of elements in the map.
355 /// use std::collections::VecMap;
357 /// let mut a = VecMap::new();
358 /// assert_eq!(a.len(), 0);
359 /// a.insert(1, "a");
360 /// assert_eq!(a.len(), 1);
362 #[stable(feature = "rust1", since = "1.0.0")]
363 pub fn len(&self) -> usize {
364 self.v.iter().filter(|elt| elt.is_some()).count()
367 /// Return true if the map contains no elements.
372 /// use std::collections::VecMap;
374 /// let mut a = VecMap::new();
375 /// assert!(a.is_empty());
376 /// a.insert(1, "a");
377 /// assert!(!a.is_empty());
379 #[stable(feature = "rust1", since = "1.0.0")]
380 pub fn is_empty(&self) -> bool {
381 self.v.iter().all(|elt| elt.is_none())
384 /// Clears the map, removing all key-value pairs.
389 /// use std::collections::VecMap;
391 /// let mut a = VecMap::new();
392 /// a.insert(1, "a");
394 /// assert!(a.is_empty());
396 #[stable(feature = "rust1", since = "1.0.0")]
397 pub fn clear(&mut self) { self.v.clear() }
399 /// Returns a reference to the value corresponding to the key.
404 /// use std::collections::VecMap;
406 /// let mut map = VecMap::new();
407 /// map.insert(1, "a");
408 /// assert_eq!(map.get(&1), Some(&"a"));
409 /// assert_eq!(map.get(&2), None);
411 #[stable(feature = "rust1", since = "1.0.0")]
412 pub fn get(&self, key: &usize) -> Option<&V> {
413 if *key < self.v.len() {
415 Some(ref value) => Some(value),
423 /// Returns true if the map contains a value for the specified key.
428 /// use std::collections::VecMap;
430 /// let mut map = VecMap::new();
431 /// map.insert(1, "a");
432 /// assert_eq!(map.contains_key(&1), true);
433 /// assert_eq!(map.contains_key(&2), false);
436 #[stable(feature = "rust1", since = "1.0.0")]
437 pub fn contains_key(&self, key: &usize) -> bool {
438 self.get(key).is_some()
441 /// Returns a mutable reference to the value corresponding to the key.
446 /// use std::collections::VecMap;
448 /// let mut map = VecMap::new();
449 /// map.insert(1, "a");
450 /// match map.get_mut(&1) {
451 /// Some(x) => *x = "b",
454 /// assert_eq!(map[1], "b");
456 #[stable(feature = "rust1", since = "1.0.0")]
457 pub fn get_mut(&mut self, key: &usize) -> Option<&mut V> {
458 if *key < self.v.len() {
459 match *(&mut self.v[*key]) {
460 Some(ref mut value) => Some(value),
468 /// Inserts a key-value pair from the map. If the key already had a value
469 /// present in the map, that value is returned. Otherwise, `None` is returned.
474 /// use std::collections::VecMap;
476 /// let mut map = VecMap::new();
477 /// assert_eq!(map.insert(37, "a"), None);
478 /// assert_eq!(map.is_empty(), false);
480 /// map.insert(37, "b");
481 /// assert_eq!(map.insert(37, "c"), Some("b"));
482 /// assert_eq!(map[37], "c");
484 #[stable(feature = "rust1", since = "1.0.0")]
485 pub fn insert(&mut self, key: usize, value: V) -> Option<V> {
486 let len = self.v.len();
488 self.v.extend((0..key - len + 1).map(|_| None));
490 replace(&mut self.v[key], Some(value))
493 /// Removes a key from the map, returning the value at the key if the key
494 /// was previously in the map.
499 /// use std::collections::VecMap;
501 /// let mut map = VecMap::new();
502 /// map.insert(1, "a");
503 /// assert_eq!(map.remove(&1), Some("a"));
504 /// assert_eq!(map.remove(&1), None);
506 #[stable(feature = "rust1", since = "1.0.0")]
507 pub fn remove(&mut self, key: &usize) -> Option<V> {
508 if *key >= self.v.len() {
511 let result = &mut self.v[*key];
515 /// Gets the given key's corresponding entry in the map for in-place manipulation.
520 /// use std::collections::VecMap;
521 /// use std::collections::vec_map::Entry;
523 /// let mut count: VecMap<u32> = VecMap::new();
525 /// // count the number of occurrences of numbers in the vec
526 /// for x in vec![1, 2, 1, 2, 3, 4, 1, 2, 4].iter() {
527 /// match count.entry(*x) {
528 /// Entry::Vacant(view) => {
531 /// Entry::Occupied(mut view) => {
532 /// let v = view.get_mut();
538 /// assert_eq!(count[1], 3);
540 #[stable(feature = "rust1", since = "1.0.0")]
541 pub fn entry(&mut self, key: usize) -> Entry<V> {
542 // FIXME(Gankro): this is basically the dumbest implementation of
543 // entry possible, because weird non-lexical borrows issues make it
544 // completely insane to do any other way. That said, Entry is a border-line
545 // useless construct on VecMap, so it's hardly a big loss.
546 if self.contains_key(&key) {
547 Occupied(OccupiedEntry {
561 impl<'a, V> Entry<'a, V> {
562 #[unstable(feature = "collections",
563 reason = "matches collection reform v2 specification, waiting for dust to settle")]
564 /// Returns a mutable reference to the entry if occupied, or the VacantEntry if vacant
565 pub fn get(self) -> Result<&'a mut V, VacantEntry<'a, V>> {
567 Occupied(entry) => Ok(entry.into_mut()),
568 Vacant(entry) => Err(entry),
573 impl<'a, V> VacantEntry<'a, V> {
574 /// Sets the value of the entry with the VacantEntry's key,
575 /// and returns a mutable reference to it.
576 #[stable(feature = "rust1", since = "1.0.0")]
577 pub fn insert(self, value: V) -> &'a mut V {
578 let index = self.index;
579 self.map.insert(index, value);
584 impl<'a, V> OccupiedEntry<'a, V> {
585 /// Gets a reference to the value in the entry.
586 #[stable(feature = "rust1", since = "1.0.0")]
587 pub fn get(&self) -> &V {
588 let index = self.index;
592 /// Gets a mutable reference to the value in the entry.
593 #[stable(feature = "rust1", since = "1.0.0")]
594 pub fn get_mut(&mut self) -> &mut V {
595 let index = self.index;
599 /// Converts the entry into a mutable reference to its value.
600 #[stable(feature = "rust1", since = "1.0.0")]
601 pub fn into_mut(self) -> &'a mut V {
602 let index = self.index;
606 /// Sets the value of the entry with the OccupiedEntry's key,
607 /// and returns the entry's old value.
608 #[stable(feature = "rust1", since = "1.0.0")]
609 pub fn insert(&mut self, value: V) -> V {
610 let index = self.index;
611 self.map.insert(index, value).unwrap()
614 /// Takes the value of the entry out of the map, and returns it.
615 #[stable(feature = "rust1", since = "1.0.0")]
616 pub fn remove(self) -> V {
617 let index = self.index;
618 self.map.remove(&index).unwrap()
622 #[stable(feature = "rust1", since = "1.0.0")]
623 impl<V: PartialEq> PartialEq for VecMap<V> {
624 fn eq(&self, other: &VecMap<V>) -> bool {
625 iter::order::eq(self.iter(), other.iter())
629 #[stable(feature = "rust1", since = "1.0.0")]
630 impl<V: Eq> Eq for VecMap<V> {}
632 #[stable(feature = "rust1", since = "1.0.0")]
633 impl<V: PartialOrd> PartialOrd for VecMap<V> {
635 fn partial_cmp(&self, other: &VecMap<V>) -> Option<Ordering> {
636 iter::order::partial_cmp(self.iter(), other.iter())
640 #[stable(feature = "rust1", since = "1.0.0")]
641 impl<V: Ord> Ord for VecMap<V> {
643 fn cmp(&self, other: &VecMap<V>) -> Ordering {
644 iter::order::cmp(self.iter(), other.iter())
648 #[stable(feature = "rust1", since = "1.0.0")]
649 impl<V: fmt::Debug> fmt::Debug for VecMap<V> {
650 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
651 try!(write!(f, "VecMap {{"));
653 for (i, (k, v)) in self.iter().enumerate() {
654 if i != 0 { try!(write!(f, ", ")); }
655 try!(write!(f, "{}: {:?}", k, *v));
662 #[stable(feature = "rust1", since = "1.0.0")]
663 impl<V> FromIterator<(usize, V)> for VecMap<V> {
664 fn from_iter<Iter: Iterator<Item=(usize, V)>>(iter: Iter) -> VecMap<V> {
665 let mut map = VecMap::new();
671 impl<T> IntoIterator for VecMap<T> {
672 type Iter = IntoIter<T>;
674 fn into_iter(self) -> IntoIter<T> {
679 impl<'a, T> IntoIterator for &'a VecMap<T> {
680 type Iter = Iter<'a, T>;
682 fn into_iter(self) -> Iter<'a, T> {
687 impl<'a, T> IntoIterator for &'a mut VecMap<T> {
688 type Iter = IterMut<'a, T>;
690 fn into_iter(mut self) -> IterMut<'a, T> {
695 #[stable(feature = "rust1", since = "1.0.0")]
696 impl<V> Extend<(usize, V)> for VecMap<V> {
697 fn extend<Iter: Iterator<Item=(usize, V)>>(&mut self, iter: Iter) {
704 impl<V> Index<usize> for VecMap<V> {
708 fn index<'a>(&'a self, i: &usize) -> &'a V {
709 self.get(i).expect("key not present")
713 #[stable(feature = "rust1", since = "1.0.0")]
714 impl<V> IndexMut<usize> for VecMap<V> {
718 fn index_mut<'a>(&'a mut self, i: &usize) -> &'a mut V {
719 self.get_mut(i).expect("key not present")
723 macro_rules! iterator {
724 (impl $name:ident -> $elem:ty, $($getter:ident),+) => {
725 #[stable(feature = "rust1", since = "1.0.0")]
726 impl<'a, V> Iterator for $name<'a, V> {
730 fn next(&mut self) -> Option<$elem> {
731 while self.front < self.back {
732 match self.iter.next() {
734 match elem$(. $getter ())+ {
736 let index = self.front;
738 return Some((index, x));
751 fn size_hint(&self) -> (usize, Option<usize>) {
752 (0, Some(self.back - self.front))
758 macro_rules! double_ended_iterator {
759 (impl $name:ident -> $elem:ty, $($getter:ident),+) => {
760 #[stable(feature = "rust1", since = "1.0.0")]
761 impl<'a, V> DoubleEndedIterator for $name<'a, V> {
763 fn next_back(&mut self) -> Option<$elem> {
764 while self.front < self.back {
765 match self.iter.next_back() {
767 match elem$(. $getter ())+ {
770 return Some((self.back, x));
785 /// An iterator over the key-value pairs of a map.
786 #[stable(feature = "rust1", since = "1.0.0")]
787 pub struct Iter<'a, V:'a> {
790 iter: slice::Iter<'a, Option<V>>
793 // FIXME(#19839) Remove in favor of `#[derive(Clone)]`
794 impl<'a, V> Clone for Iter<'a, V> {
795 fn clone(&self) -> Iter<'a, V> {
799 iter: self.iter.clone()
804 iterator! { impl Iter -> (usize, &'a V), as_ref }
805 double_ended_iterator! { impl Iter -> (usize, &'a V), as_ref }
807 /// An iterator over the key-value pairs of a map, with the
808 /// values being mutable.
809 #[stable(feature = "rust1", since = "1.0.0")]
810 pub struct IterMut<'a, V:'a> {
813 iter: slice::IterMut<'a, Option<V>>
816 iterator! { impl IterMut -> (usize, &'a mut V), as_mut }
817 double_ended_iterator! { impl IterMut -> (usize, &'a mut V), as_mut }
819 /// An iterator over the keys of a map.
820 #[stable(feature = "rust1", since = "1.0.0")]
821 pub struct Keys<'a, V: 'a> {
822 iter: Map<Iter<'a, V>, fn((usize, &'a V)) -> usize>
825 // FIXME(#19839) Remove in favor of `#[derive(Clone)]`
826 impl<'a, V> Clone for Keys<'a, V> {
827 fn clone(&self) -> Keys<'a, V> {
829 iter: self.iter.clone()
834 /// An iterator over the values of a map.
835 #[stable(feature = "rust1", since = "1.0.0")]
836 pub struct Values<'a, V: 'a> {
837 iter: Map<Iter<'a, V>, fn((usize, &'a V)) -> &'a V>
840 // FIXME(#19839) Remove in favor of `#[derive(Clone)]`
841 impl<'a, V> Clone for Values<'a, V> {
842 fn clone(&self) -> Values<'a, V> {
844 iter: self.iter.clone()
849 /// A consuming iterator over the key-value pairs of a map.
850 #[stable(feature = "rust1", since = "1.0.0")]
851 pub struct IntoIter<V> {
853 Enumerate<vec::IntoIter<Option<V>>>,
854 fn((usize, Option<V>)) -> Option<(usize, V)>>
857 #[unstable(feature = "collections")]
858 pub struct Drain<'a, V> {
860 Enumerate<vec::Drain<'a, Option<V>>>,
861 fn((usize, Option<V>)) -> Option<(usize, V)>>
864 #[unstable(feature = "collections")]
865 impl<'a, V> Iterator for Drain<'a, V> {
866 type Item = (usize, V);
868 fn next(&mut self) -> Option<(usize, V)> { self.iter.next() }
869 fn size_hint(&self) -> (usize, Option<usize>) { self.iter.size_hint() }
872 #[unstable(feature = "collections")]
873 impl<'a, V> DoubleEndedIterator for Drain<'a, V> {
874 fn next_back(&mut self) -> Option<(usize, V)> { self.iter.next_back() }
877 #[stable(feature = "rust1", since = "1.0.0")]
878 impl<'a, V> Iterator for Keys<'a, V> {
881 fn next(&mut self) -> Option<usize> { self.iter.next() }
882 fn size_hint(&self) -> (usize, Option<usize>) { self.iter.size_hint() }
884 #[stable(feature = "rust1", since = "1.0.0")]
885 impl<'a, V> DoubleEndedIterator for Keys<'a, V> {
886 fn next_back(&mut self) -> Option<usize> { self.iter.next_back() }
889 #[stable(feature = "rust1", since = "1.0.0")]
890 impl<'a, V> Iterator for Values<'a, V> {
893 fn next(&mut self) -> Option<(&'a V)> { self.iter.next() }
894 fn size_hint(&self) -> (usize, Option<usize>) { self.iter.size_hint() }
896 #[stable(feature = "rust1", since = "1.0.0")]
897 impl<'a, V> DoubleEndedIterator for Values<'a, V> {
898 fn next_back(&mut self) -> Option<(&'a V)> { self.iter.next_back() }
901 #[stable(feature = "rust1", since = "1.0.0")]
902 impl<V> Iterator for IntoIter<V> {
903 type Item = (usize, V);
905 fn next(&mut self) -> Option<(usize, V)> { self.iter.next() }
906 fn size_hint(&self) -> (usize, Option<usize>) { self.iter.size_hint() }
908 #[stable(feature = "rust1", since = "1.0.0")]
909 impl<V> DoubleEndedIterator for IntoIter<V> {
910 fn next_back(&mut self) -> Option<(usize, V)> { self.iter.next_back() }
916 use core::hash::{hash, SipHasher};
918 use super::{VecMap, Occupied, Vacant};
922 let mut m = VecMap::new();
923 assert!(m.insert(1, 12).is_none());
924 assert!(m.insert(2, 8).is_none());
925 assert!(m.insert(5, 14).is_none());
927 match m.get_mut(&5) {
928 None => panic!(), Some(x) => *x = new
930 assert_eq!(m.get(&5), Some(&new));
935 let mut map = VecMap::new();
936 assert_eq!(map.len(), 0);
937 assert!(map.is_empty());
938 assert!(map.insert(5, 20).is_none());
939 assert_eq!(map.len(), 1);
940 assert!(!map.is_empty());
941 assert!(map.insert(11, 12).is_none());
942 assert_eq!(map.len(), 2);
943 assert!(!map.is_empty());
944 assert!(map.insert(14, 22).is_none());
945 assert_eq!(map.len(), 3);
946 assert!(!map.is_empty());
951 let mut map = VecMap::new();
952 assert!(map.insert(5, 20).is_none());
953 assert!(map.insert(11, 12).is_none());
954 assert!(map.insert(14, 22).is_none());
956 assert!(map.is_empty());
957 assert!(map.get(&5).is_none());
958 assert!(map.get(&11).is_none());
959 assert!(map.get(&14).is_none());
964 let mut m = VecMap::new();
965 assert_eq!(m.insert(1, 2), None);
966 assert_eq!(m.insert(1, 3), Some(2));
967 assert_eq!(m.insert(1, 4), Some(3));
972 let mut m = VecMap::new();
974 assert_eq!(m.remove(&1), Some(2));
975 assert_eq!(m.remove(&1), None);
980 let mut map = VecMap::new();
984 let keys: Vec<_> = map.keys().collect();
985 assert_eq!(keys.len(), 3);
986 assert!(keys.contains(&1));
987 assert!(keys.contains(&2));
988 assert!(keys.contains(&3));
993 let mut map = VecMap::new();
997 let values: Vec<_> = map.values().cloned().collect();
998 assert_eq!(values.len(), 3);
999 assert!(values.contains(&'a'));
1000 assert!(values.contains(&'b'));
1001 assert!(values.contains(&'c'));
1005 fn test_iterator() {
1006 let mut m = VecMap::new();
1008 assert!(m.insert(0, 1).is_none());
1009 assert!(m.insert(1, 2).is_none());
1010 assert!(m.insert(3, 5).is_none());
1011 assert!(m.insert(6, 10).is_none());
1012 assert!(m.insert(10, 11).is_none());
1014 let mut it = m.iter();
1015 assert_eq!(it.size_hint(), (0, Some(11)));
1016 assert_eq!(it.next().unwrap(), (0, &1));
1017 assert_eq!(it.size_hint(), (0, Some(10)));
1018 assert_eq!(it.next().unwrap(), (1, &2));
1019 assert_eq!(it.size_hint(), (0, Some(9)));
1020 assert_eq!(it.next().unwrap(), (3, &5));
1021 assert_eq!(it.size_hint(), (0, Some(7)));
1022 assert_eq!(it.next().unwrap(), (6, &10));
1023 assert_eq!(it.size_hint(), (0, Some(4)));
1024 assert_eq!(it.next().unwrap(), (10, &11));
1025 assert_eq!(it.size_hint(), (0, Some(0)));
1026 assert!(it.next().is_none());
1030 fn test_iterator_size_hints() {
1031 let mut m = VecMap::new();
1033 assert!(m.insert(0, 1).is_none());
1034 assert!(m.insert(1, 2).is_none());
1035 assert!(m.insert(3, 5).is_none());
1036 assert!(m.insert(6, 10).is_none());
1037 assert!(m.insert(10, 11).is_none());
1039 assert_eq!(m.iter().size_hint(), (0, Some(11)));
1040 assert_eq!(m.iter().rev().size_hint(), (0, Some(11)));
1041 assert_eq!(m.iter_mut().size_hint(), (0, Some(11)));
1042 assert_eq!(m.iter_mut().rev().size_hint(), (0, Some(11)));
1046 fn test_mut_iterator() {
1047 let mut m = VecMap::new();
1049 assert!(m.insert(0, 1).is_none());
1050 assert!(m.insert(1, 2).is_none());
1051 assert!(m.insert(3, 5).is_none());
1052 assert!(m.insert(6, 10).is_none());
1053 assert!(m.insert(10, 11).is_none());
1055 for (k, v) in &mut m {
1059 let mut it = m.iter();
1060 assert_eq!(it.next().unwrap(), (0, &1));
1061 assert_eq!(it.next().unwrap(), (1, &3));
1062 assert_eq!(it.next().unwrap(), (3, &8));
1063 assert_eq!(it.next().unwrap(), (6, &16));
1064 assert_eq!(it.next().unwrap(), (10, &21));
1065 assert!(it.next().is_none());
1069 fn test_rev_iterator() {
1070 let mut m = VecMap::new();
1072 assert!(m.insert(0, 1).is_none());
1073 assert!(m.insert(1, 2).is_none());
1074 assert!(m.insert(3, 5).is_none());
1075 assert!(m.insert(6, 10).is_none());
1076 assert!(m.insert(10, 11).is_none());
1078 let mut it = m.iter().rev();
1079 assert_eq!(it.next().unwrap(), (10, &11));
1080 assert_eq!(it.next().unwrap(), (6, &10));
1081 assert_eq!(it.next().unwrap(), (3, &5));
1082 assert_eq!(it.next().unwrap(), (1, &2));
1083 assert_eq!(it.next().unwrap(), (0, &1));
1084 assert!(it.next().is_none());
1088 fn test_mut_rev_iterator() {
1089 let mut m = VecMap::new();
1091 assert!(m.insert(0, 1).is_none());
1092 assert!(m.insert(1, 2).is_none());
1093 assert!(m.insert(3, 5).is_none());
1094 assert!(m.insert(6, 10).is_none());
1095 assert!(m.insert(10, 11).is_none());
1097 for (k, v) in m.iter_mut().rev() {
1101 let mut it = m.iter();
1102 assert_eq!(it.next().unwrap(), (0, &1));
1103 assert_eq!(it.next().unwrap(), (1, &3));
1104 assert_eq!(it.next().unwrap(), (3, &8));
1105 assert_eq!(it.next().unwrap(), (6, &16));
1106 assert_eq!(it.next().unwrap(), (10, &21));
1107 assert!(it.next().is_none());
1111 fn test_move_iter() {
1112 let mut m = VecMap::new();
1114 let mut called = false;
1119 assert_eq!(v, box 2);
1125 fn test_drain_iterator() {
1126 let mut map = VecMap::new();
1131 let vec: Vec<_> = map.drain().collect();
1133 assert_eq!(vec, vec![(1, "a"), (2, "b"), (3, "c")]);
1134 assert_eq!(map.len(), 0);
1139 let mut map = VecMap::new();
1140 let empty = VecMap::<i32>::new();
1145 let map_str = format!("{:?}", map);
1146 assert!(map_str == "VecMap {1: 2, 3: 4}" || map_str == "{3: 4, 1: 2}");
1147 assert_eq!(format!("{:?}", empty), "VecMap {}");
1152 let mut a = VecMap::new();
1158 assert!(a.clone() == a);
1163 let mut a = VecMap::new();
1164 let mut b = VecMap::new();
1167 assert!(a.insert(0, 5).is_none());
1169 assert!(b.insert(0, 4).is_none());
1171 assert!(a.insert(5, 19).is_none());
1173 assert!(!b.insert(0, 5).is_none());
1175 assert!(b.insert(5, 19).is_none());
1179 b = VecMap::with_capacity(1);
1185 let mut a = VecMap::new();
1186 let mut b = VecMap::new();
1188 assert!(!(a < b) && !(b < a));
1189 assert!(b.insert(2, 5).is_none());
1191 assert!(a.insert(2, 7).is_none());
1192 assert!(!(a < b) && b < a);
1193 assert!(b.insert(1, 0).is_none());
1195 assert!(a.insert(0, 6).is_none());
1197 assert!(a.insert(6, 2).is_none());
1198 assert!(a < b && !(b < a));
1203 let mut a = VecMap::new();
1204 let mut b = VecMap::new();
1206 assert!(a <= b && a >= b);
1207 assert!(a.insert(1, 1).is_none());
1208 assert!(a > b && a >= b);
1209 assert!(b < a && b <= a);
1210 assert!(b.insert(2, 2).is_none());
1211 assert!(b > a && b >= a);
1212 assert!(a < b && a <= b);
1217 let mut x = VecMap::new();
1218 let mut y = VecMap::new();
1220 assert!(hash::<_, SipHasher>(&x) == hash::<_, SipHasher>(&y));
1229 assert!(hash::<_, SipHasher>(&x) == hash::<_, SipHasher>(&y));
1231 x.insert(1000, 'd');
1234 assert!(hash::<_, SipHasher>(&x) == hash::<_, SipHasher>(&y));
1238 fn test_from_iter() {
1239 let xs = vec![(1, 'a'), (2, 'b'), (3, 'c'), (4, 'd'), (5, 'e')];
1241 let map: VecMap<_> = xs.iter().cloned().collect();
1243 for &(k, v) in &xs {
1244 assert_eq!(map.get(&k), Some(&v));
1250 let mut map = VecMap::new();
1256 assert_eq!(map[3], 4);
1261 fn test_index_nonexistent() {
1262 let mut map = VecMap::new();
1273 let xs = [(1, 10), (2, 20), (3, 30), (4, 40), (5, 50), (6, 60)];
1275 let mut map: VecMap<_> = xs.iter().cloned().collect();
1277 // Existing key (insert)
1278 match map.entry(1) {
1279 Vacant(_) => unreachable!(),
1280 Occupied(mut view) => {
1281 assert_eq!(view.get(), &10);
1282 assert_eq!(view.insert(100), 10);
1285 assert_eq!(map.get(&1).unwrap(), &100);
1286 assert_eq!(map.len(), 6);
1289 // Existing key (update)
1290 match map.entry(2) {
1291 Vacant(_) => unreachable!(),
1292 Occupied(mut view) => {
1293 let v = view.get_mut();
1297 assert_eq!(map.get(&2).unwrap(), &200);
1298 assert_eq!(map.len(), 6);
1300 // Existing key (take)
1301 match map.entry(3) {
1302 Vacant(_) => unreachable!(),
1304 assert_eq!(view.remove(), 30);
1307 assert_eq!(map.get(&3), None);
1308 assert_eq!(map.len(), 5);
1311 // Inexistent key (insert)
1312 match map.entry(10) {
1313 Occupied(_) => unreachable!(),
1315 assert_eq!(*view.insert(1000), 1000);
1318 assert_eq!(map.get(&10).unwrap(), &1000);
1319 assert_eq!(map.len(), 6);
1327 use bench::{insert_rand_n, insert_seq_n, find_rand_n, find_seq_n};
1330 pub fn insert_rand_100(b: &mut Bencher) {
1331 let mut m = VecMap::new();
1332 insert_rand_n(100, &mut m, b,
1333 |m, i| { m.insert(i, 1); },
1334 |m, i| { m.remove(&i); });
1338 pub fn insert_rand_10_000(b: &mut Bencher) {
1339 let mut m = VecMap::new();
1340 insert_rand_n(10_000, &mut m, b,
1341 |m, i| { m.insert(i, 1); },
1342 |m, i| { m.remove(&i); });
1347 pub fn insert_seq_100(b: &mut Bencher) {
1348 let mut m = VecMap::new();
1349 insert_seq_n(100, &mut m, b,
1350 |m, i| { m.insert(i, 1); },
1351 |m, i| { m.remove(&i); });
1355 pub fn insert_seq_10_000(b: &mut Bencher) {
1356 let mut m = VecMap::new();
1357 insert_seq_n(10_000, &mut m, b,
1358 |m, i| { m.insert(i, 1); },
1359 |m, i| { m.remove(&i); });
1364 pub fn find_rand_100(b: &mut Bencher) {
1365 let mut m = VecMap::new();
1366 find_rand_n(100, &mut m, b,
1367 |m, i| { m.insert(i, 1); },
1368 |m, i| { m.get(&i); });
1372 pub fn find_rand_10_000(b: &mut Bencher) {
1373 let mut m = VecMap::new();
1374 find_rand_n(10_000, &mut m, b,
1375 |m, i| { m.insert(i, 1); },
1376 |m, i| { m.get(&i); });
1381 pub fn find_seq_100(b: &mut Bencher) {
1382 let mut m = VecMap::new();
1383 find_seq_n(100, &mut m, b,
1384 |m, i| { m.insert(i, 1); },
1385 |m, i| { m.get(&i); });
1389 pub fn find_seq_10_000(b: &mut Bencher) {
1390 let mut m = VecMap::new();
1391 find_seq_n(10_000, &mut m, b,
1392 |m, i| { m.insert(i, 1); },
1393 |m, i| { m.get(&i); });