src/libcollections/vec_map.rs

   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.
   4 //
   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.
  10
  11 //! A simple map based on a vector for small integer keys. Space requirements
  12 //! are O(highest integer key).
  13
  14 #![allow(missing_docs)]
  15
  16 use core::prelude::*;
  17
  18 use core::cmp::Ordering;
  19 use core::default::Default;
  20 use core::fmt;
  21 use core::hash::{Hash, Writer, Hasher};
  22 use core::iter::{Enumerate, FilterMap, Map, FromIterator};
  23 use core::iter;
  24 use core::mem::replace;
  25 use core::ops::{Index, IndexMut};
  26
  27 use {vec, slice};
  28 use vec::Vec;
  29
  30 // FIXME(conventions): capacity management???
  31
  32 /// A map optimized for small integer keys.
  33 ///
  34 /// # Examples
  35 ///
  36 /// ```
  37 /// use std::collections::VecMap;
  38 ///
  39 /// let mut months = VecMap::new();
  40 /// months.insert(1, "Jan");
  41 /// months.insert(2, "Feb");
  42 /// months.insert(3, "Mar");
  43 ///
  44 /// if !months.contains_key(&12) {
  45 ///     println!("The end is near!");
  46 /// }
  47 ///
  48 /// assert_eq!(months.get(&1), Some(&"Jan"));
  49 ///
  50 /// match months.get_mut(&3) {
  51 ///     Some(value) => *value = "Venus",
  52 ///     None => (),
  53 /// }
  54 ///
  55 /// assert_eq!(months.get(&3), Some(&"Venus"));
  56 ///
  57 /// // Print out all months
  58 /// for (key, value) in months.iter() {
  59 ///     println!("month {} is {}", key, value);
  60 /// }
  61 ///
  62 /// months.clear();
  63 /// assert!(months.is_empty());
  64 /// ```
  65 pub struct VecMap<V> {
  66     v: Vec<Option<V>>,
  67 }
  68
  69 #[stable]
  70 impl<V> Default for VecMap<V> {
  71     #[stable]
  72     #[inline]
  73     fn default() -> VecMap<V> { VecMap::new() }
  74 }
  75
  76 impl<V:Clone> Clone for VecMap<V> {
  77     #[inline]
  78     fn clone(&self) -> VecMap<V> {
  79         VecMap { v: self.v.clone() }
  80     }
  81
  82     #[inline]
  83     fn clone_from(&mut self, source: &VecMap<V>) {
  84         self.v.clone_from(&source.v);
  85     }
  86 }
  87
  88 impl<S: Writer + Hasher, V: Hash<S>> Hash<S> for VecMap<V> {
  89     fn hash(&self, state: &mut S) {
  90         // In order to not traverse the `VecMap` twice, count the elements
  91         // during iteration.
  92         let mut count: uint = 0;
  93         for elt in self.iter() {
  94             elt.hash(state);
  95             count += 1;
  96         }
  97         count.hash(state);
  98     }
  99 }
 100
 101 impl<V> VecMap<V> {
 102     /// Creates an empty `VecMap`.
 103     ///
 104     /// # Examples
 105     ///
 106     /// ```
 107     /// use std::collections::VecMap;
 108     /// let mut map: VecMap<&str> = VecMap::new();
 109     /// ```
 110     #[stable]
 111     pub fn new() -> VecMap<V> { VecMap { v: vec![] } }
 112
 113     /// Creates an empty `VecMap` with space for at least `capacity`
 114     /// elements before resizing.
 115     ///
 116     /// # Examples
 117     ///
 118     /// ```
 119     /// use std::collections::VecMap;
 120     /// let mut map: VecMap<&str> = VecMap::with_capacity(10);
 121     /// ```
 122     #[stable]
 123     pub fn with_capacity(capacity: uint) -> VecMap<V> {
 124         VecMap { v: Vec::with_capacity(capacity) }
 125     }
 126
 127     /// Returns the number of elements the `VecMap` can hold without
 128     /// reallocating.
 129     ///
 130     /// # Examples
 131     ///
 132     /// ```
 133     /// use std::collections::VecMap;
 134     /// let map: VecMap<String> = VecMap::with_capacity(10);
 135     /// assert!(map.capacity() >= 10);
 136     /// ```
 137     #[inline]
 138     #[stable]
 139     pub fn capacity(&self) -> uint {
 140         self.v.capacity()
 141     }
 142
 143     /// Reserves capacity for the given `VecMap` to contain `len` distinct keys.
 144     /// In the case of `VecMap` this means reallocations will not occur as long
 145     /// as all inserted keys are less than `len`.
 146     ///
 147     /// The collection may reserve more space to avoid frequent reallocations.
 148     ///
 149     /// # Examples
 150     ///
 151     /// ```
 152     /// use std::collections::VecMap;
 153     /// let mut map: VecMap<&str> = VecMap::new();
 154     /// map.reserve_len(10);
 155     /// assert!(map.capacity() >= 10);
 156     /// ```
 157     #[stable]
 158     pub fn reserve_len(&mut self, len: uint) {
 159         let cur_len = self.v.len();
 160         if len >= cur_len {
 161             self.v.reserve(len - cur_len);
 162         }
 163     }
 164
 165     /// Reserves the minimum capacity for the given `VecMap` to contain `len` distinct keys.
 166     /// In the case of `VecMap` this means reallocations will not occur as long as all inserted
 167     /// keys are less than `len`.
 168     ///
 169     /// Note that the allocator may give the collection more space than it requests.
 170     /// Therefore capacity cannot be relied upon to be precisely minimal.  Prefer
 171     /// `reserve_len` if future insertions are expected.
 172     ///
 173     /// # Examples
 174     ///
 175     /// ```
 176     /// use std::collections::VecMap;
 177     /// let mut map: VecMap<&str> = VecMap::new();
 178     /// map.reserve_len_exact(10);
 179     /// assert!(map.capacity() >= 10);
 180     /// ```
 181     #[stable]
 182     pub fn reserve_len_exact(&mut self, len: uint) {
 183         let cur_len = self.v.len();
 184         if len >= cur_len {
 185             self.v.reserve_exact(len - cur_len);
 186         }
 187     }
 188
 189     /// Returns an iterator visiting all keys in ascending order by the keys.
 190     /// The iterator's element type is `uint`.
 191     #[stable]
 192     pub fn keys<'r>(&'r self) -> Keys<'r, V> {
 193         fn first<A, B>((a, _): (A, B)) -> A { a }
 194         let first: fn((uint, &'r V)) -> uint = first; // coerce to fn pointer
 195
 196         Keys { iter: self.iter().map(first) }
 197     }
 198
 199     /// Returns an iterator visiting all values in ascending order by the keys.
 200     /// The iterator's element type is `&'r V`.
 201     #[stable]
 202     pub fn values<'r>(&'r self) -> Values<'r, V> {
 203         fn second<A, B>((_, b): (A, B)) -> B { b }
 204         let second: fn((uint, &'r V)) -> &'r V = second; // coerce to fn pointer
 205
 206         Values { iter: self.iter().map(second) }
 207     }
 208
 209     /// Returns an iterator visiting all key-value pairs in ascending order by the keys.
 210     /// The iterator's element type is `(uint, &'r V)`.
 211     ///
 212     /// # Examples
 213     ///
 214     /// ```
 215     /// use std::collections::VecMap;
 216     ///
 217     /// let mut map = VecMap::new();
 218     /// map.insert(1, "a");
 219     /// map.insert(3, "c");
 220     /// map.insert(2, "b");
 221     ///
 222     /// // Print `1: a` then `2: b` then `3: c`
 223     /// for (key, value) in map.iter() {
 224     ///     println!("{}: {}", key, value);
 225     /// }
 226     /// ```
 227     #[stable]
 228     pub fn iter<'r>(&'r self) -> Iter<'r, V> {
 229         Iter {
 230             front: 0,
 231             back: self.v.len(),
 232             iter: self.v.iter()
 233         }
 234     }
 235
 236     /// Returns an iterator visiting all key-value pairs in ascending order by the keys,
 237     /// with mutable references to the values.
 238     /// The iterator's element type is `(uint, &'r mut V)`.
 239     ///
 240     /// # Examples
 241     ///
 242     /// ```
 243     /// use std::collections::VecMap;
 244     ///
 245     /// let mut map = VecMap::new();
 246     /// map.insert(1, "a");
 247     /// map.insert(2, "b");
 248     /// map.insert(3, "c");
 249     ///
 250     /// for (key, value) in map.iter_mut() {
 251     ///     *value = "x";
 252     /// }
 253     ///
 254     /// for (key, value) in map.iter() {
 255     ///     assert_eq!(value, &"x");
 256     /// }
 257     /// ```
 258     #[stable]
 259     pub fn iter_mut<'r>(&'r mut self) -> IterMut<'r, V> {
 260         IterMut {
 261             front: 0,
 262             back: self.v.len(),
 263             iter: self.v.iter_mut()
 264         }
 265     }
 266
 267     /// Returns an iterator visiting all key-value pairs in ascending order by
 268     /// the keys, emptying (but not consuming) the original `VecMap`.
 269     /// The iterator's element type is `(uint, &'r V)`.
 270     ///
 271     /// # Examples
 272     ///
 273     /// ```
 274     /// use std::collections::VecMap;
 275     ///
 276     /// let mut map = VecMap::new();
 277     /// map.insert(1, "a");
 278     /// map.insert(3, "c");
 279     /// map.insert(2, "b");
 280     ///
 281     /// // Not possible with .iter()
 282     /// let vec: Vec<(uint, &str)> = map.into_iter().collect();
 283     ///
 284     /// assert_eq!(vec, vec![(1, "a"), (2, "b"), (3, "c")]);
 285     /// ```
 286     #[stable]
 287     pub fn into_iter(&mut self) -> IntoIter<V> {
 288         fn filter<A>((i, v): (uint, Option<A>)) -> Option<(uint, A)> {
 289             v.map(|v| (i, v))
 290         }
 291         let filter: fn((uint, Option<V>)) -> Option<(uint, V)> = filter; // coerce to fn ptr
 292
 293         let values = replace(&mut self.v, vec!());
 294         IntoIter { iter: values.into_iter().enumerate().filter_map(filter) }
 295     }
 296
 297     /// Return the number of elements in the map.
 298     ///
 299     /// # Examples
 300     ///
 301     /// ```
 302     /// use std::collections::VecMap;
 303     ///
 304     /// let mut a = VecMap::new();
 305     /// assert_eq!(a.len(), 0);
 306     /// a.insert(1, "a");
 307     /// assert_eq!(a.len(), 1);
 308     /// ```
 309     #[stable]
 310     pub fn len(&self) -> uint {
 311         self.v.iter().filter(|elt| elt.is_some()).count()
 312     }
 313
 314     /// Return true if the map contains no elements.
 315     ///
 316     /// # Examples
 317     ///
 318     /// ```
 319     /// use std::collections::VecMap;
 320     ///
 321     /// let mut a = VecMap::new();
 322     /// assert!(a.is_empty());
 323     /// a.insert(1, "a");
 324     /// assert!(!a.is_empty());
 325     /// ```
 326     #[stable]
 327     pub fn is_empty(&self) -> bool {
 328         self.v.iter().all(|elt| elt.is_none())
 329     }
 330
 331     /// Clears the map, removing all key-value pairs.
 332     ///
 333     /// # Examples
 334     ///
 335     /// ```
 336     /// use std::collections::VecMap;
 337     ///
 338     /// let mut a = VecMap::new();
 339     /// a.insert(1, "a");
 340     /// a.clear();
 341     /// assert!(a.is_empty());
 342     /// ```
 343     #[stable]
 344     pub fn clear(&mut self) { self.v.clear() }
 345
 346     /// Returns a reference to the value corresponding to the key.
 347     ///
 348     /// # Examples
 349     ///
 350     /// ```
 351     /// use std::collections::VecMap;
 352     ///
 353     /// let mut map = VecMap::new();
 354     /// map.insert(1, "a");
 355     /// assert_eq!(map.get(&1), Some(&"a"));
 356     /// assert_eq!(map.get(&2), None);
 357     /// ```
 358     #[stable]
 359     pub fn get(&self, key: &uint) -> Option<&V> {
 360         if *key < self.v.len() {
 361             match self.v[*key] {
 362               Some(ref value) => Some(value),
 363               None => None
 364             }
 365         } else {
 366             None
 367         }
 368     }
 369
 370     /// Returns true if the map contains a value for the specified key.
 371     ///
 372     /// # Examples
 373     ///
 374     /// ```
 375     /// use std::collections::VecMap;
 376     ///
 377     /// let mut map = VecMap::new();
 378     /// map.insert(1, "a");
 379     /// assert_eq!(map.contains_key(&1), true);
 380     /// assert_eq!(map.contains_key(&2), false);
 381     /// ```
 382     #[inline]
 383     #[stable]
 384     pub fn contains_key(&self, key: &uint) -> bool {
 385         self.get(key).is_some()
 386     }
 387
 388     /// Returns a mutable reference to the value corresponding to the key.
 389     ///
 390     /// # Examples
 391     ///
 392     /// ```
 393     /// use std::collections::VecMap;
 394     ///
 395     /// let mut map = VecMap::new();
 396     /// map.insert(1, "a");
 397     /// match map.get_mut(&1) {
 398     ///     Some(x) => *x = "b",
 399     ///     None => (),
 400     /// }
 401     /// assert_eq!(map[1], "b");
 402     /// ```
 403     #[stable]
 404     pub fn get_mut(&mut self, key: &uint) -> Option<&mut V> {
 405         if *key < self.v.len() {
 406             match *(&mut self.v[*key]) {
 407               Some(ref mut value) => Some(value),
 408               None => None
 409             }
 410         } else {
 411             None
 412         }
 413     }
 414
 415     /// Inserts a key-value pair from the map. If the key already had a value
 416     /// present in the map, that value is returned. Otherwise, `None` is returned.
 417     ///
 418     /// # Examples
 419     ///
 420     /// ```
 421     /// use std::collections::VecMap;
 422     ///
 423     /// let mut map = VecMap::new();
 424     /// assert_eq!(map.insert(37, "a"), None);
 425     /// assert_eq!(map.is_empty(), false);
 426     ///
 427     /// map.insert(37, "b");
 428     /// assert_eq!(map.insert(37, "c"), Some("b"));
 429     /// assert_eq!(map[37], "c");
 430     /// ```
 431     #[stable]
 432     pub fn insert(&mut self, key: uint, value: V) -> Option<V> {
 433         let len = self.v.len();
 434         if len <= key {
 435             self.v.extend(range(0, key - len + 1).map(|_| None));
 436         }
 437         replace(&mut self.v[key], Some(value))
 438     }
 439
 440     /// Removes a key from the map, returning the value at the key if the key
 441     /// was previously in the map.
 442     ///
 443     /// # Examples
 444     ///
 445     /// ```
 446     /// use std::collections::VecMap;
 447     ///
 448     /// let mut map = VecMap::new();
 449     /// map.insert(1, "a");
 450     /// assert_eq!(map.remove(&1), Some("a"));
 451     /// assert_eq!(map.remove(&1), None);
 452     /// ```
 453     #[stable]
 454     pub fn remove(&mut self, key: &uint) -> Option<V> {
 455         if *key >= self.v.len() {
 456             return None;
 457         }
 458         let result = &mut self.v[*key];
 459         result.take()
 460     }
 461 }
 462
 463 #[stable]
 464 impl<V: PartialEq> PartialEq for VecMap<V> {
 465     fn eq(&self, other: &VecMap<V>) -> bool {
 466         iter::order::eq(self.iter(), other.iter())
 467     }
 468 }
 469
 470 #[stable]
 471 impl<V: Eq> Eq for VecMap<V> {}
 472
 473 #[stable]
 474 impl<V: PartialOrd> PartialOrd for VecMap<V> {
 475     #[inline]
 476     fn partial_cmp(&self, other: &VecMap<V>) -> Option<Ordering> {
 477         iter::order::partial_cmp(self.iter(), other.iter())
 478     }
 479 }
 480
 481 #[stable]
 482 impl<V: Ord> Ord for VecMap<V> {
 483     #[inline]
 484     fn cmp(&self, other: &VecMap<V>) -> Ordering {
 485         iter::order::cmp(self.iter(), other.iter())
 486     }
 487 }
 488
 489 #[stable]
 490 impl<V: fmt::Show> fmt::Show for VecMap<V> {
 491     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 492         try!(write!(f, "VecMap {{"));
 493
 494         for (i, (k, v)) in self.iter().enumerate() {
 495             if i != 0 { try!(write!(f, ", ")); }
 496             try!(write!(f, "{}: {:?}", k, *v));
 497         }
 498
 499         write!(f, "}}")
 500     }
 501 }
 502
 503 #[stable]
 504 impl<V> FromIterator<(uint, V)> for VecMap<V> {
 505     fn from_iter<Iter: Iterator<Item=(uint, V)>>(iter: Iter) -> VecMap<V> {
 506         let mut map = VecMap::new();
 507         map.extend(iter);
 508         map
 509     }
 510 }
 511
 512 #[stable]
 513 impl<V> Extend<(uint, V)> for VecMap<V> {
 514     fn extend<Iter: Iterator<Item=(uint, V)>>(&mut self, mut iter: Iter) {
 515         for (k, v) in iter {
 516             self.insert(k, v);
 517         }
 518     }
 519 }
 520
 521 impl<V> Index<uint> for VecMap<V> {
 522     type Output = V;
 523
 524     #[inline]
 525     fn index<'a>(&'a self, i: &uint) -> &'a V {
 526         self.get(i).expect("key not present")
 527     }
 528 }
 529
 530 #[stable]
 531 impl<V> IndexMut<uint> for VecMap<V> {
 532     type Output = V;
 533
 534     #[inline]
 535     fn index_mut<'a>(&'a mut self, i: &uint) -> &'a mut V {
 536         self.get_mut(i).expect("key not present")
 537     }
 538 }
 539
 540 macro_rules! iterator {
 541     (impl $name:ident -> $elem:ty, $($getter:ident),+) => {
 542         #[stable]
 543         impl<'a, V> Iterator for $name<'a, V> {
 544             type Item = $elem;
 545
 546             #[inline]
 547             fn next(&mut self) -> Option<$elem> {
 548                 while self.front < self.back {
 549                     match self.iter.next() {
 550                         Some(elem) => {
 551                             match elem$(. $getter ())+ {
 552                                 Some(x) => {
 553                                     let index = self.front;
 554                                     self.front += 1;
 555                                     return Some((index, x));
 556                                 },
 557                                 None => {},
 558                             }
 559                         }
 560                         _ => ()
 561                     }
 562                     self.front += 1;
 563                 }
 564                 None
 565             }
 566
 567             #[inline]
 568             fn size_hint(&self) -> (uint, Option<uint>) {
 569                 (0, Some(self.back - self.front))
 570             }
 571         }
 572     }
 573 }
 574
 575 macro_rules! double_ended_iterator {
 576     (impl $name:ident -> $elem:ty, $($getter:ident),+) => {
 577         #[stable]
 578         impl<'a, V> DoubleEndedIterator for $name<'a, V> {
 579             #[inline]
 580             fn next_back(&mut self) -> Option<$elem> {
 581                 while self.front < self.back {
 582                     match self.iter.next_back() {
 583                         Some(elem) => {
 584                             match elem$(. $getter ())+ {
 585                                 Some(x) => {
 586                                     self.back -= 1;
 587                                     return Some((self.back, x));
 588                                 },
 589                                 None => {},
 590                             }
 591                         }
 592                         _ => ()
 593                     }
 594                     self.back -= 1;
 595                 }
 596                 None
 597             }
 598         }
 599     }
 600 }
 601
 602 /// An iterator over the key-value pairs of a map.
 603 #[stable]
 604 pub struct Iter<'a, V:'a> {
 605     front: uint,
 606     back: uint,
 607     iter: slice::Iter<'a, Option<V>>
 608 }
 609
 610 // FIXME(#19839) Remove in favor of `#[derive(Clone)]`
 611 impl<'a, V> Clone for Iter<'a, V> {
 612     fn clone(&self) -> Iter<'a, V> {
 613         Iter {
 614             front: self.front,
 615             back: self.back,
 616             iter: self.iter.clone()
 617         }
 618     }
 619 }
 620
 621 iterator! { impl Iter -> (uint, &'a V), as_ref }
 622 double_ended_iterator! { impl Iter -> (uint, &'a V), as_ref }
 623
 624 /// An iterator over the key-value pairs of a map, with the
 625 /// values being mutable.
 626 #[stable]
 627 pub struct IterMut<'a, V:'a> {
 628     front: uint,
 629     back: uint,
 630     iter: slice::IterMut<'a, Option<V>>
 631 }
 632
 633 iterator! { impl IterMut -> (uint, &'a mut V), as_mut }
 634 double_ended_iterator! { impl IterMut -> (uint, &'a mut V), as_mut }
 635
 636 /// An iterator over the keys of a map.
 637 #[stable]
 638 pub struct Keys<'a, V: 'a> {
 639     iter: Map<(uint, &'a V), uint, Iter<'a, V>, fn((uint, &'a V)) -> uint>
 640 }
 641
 642 // FIXME(#19839) Remove in favor of `#[derive(Clone)]`
 643 impl<'a, V> Clone for Keys<'a, V> {
 644     fn clone(&self) -> Keys<'a, V> {
 645         Keys {
 646             iter: self.iter.clone()
 647         }
 648     }
 649 }
 650
 651 /// An iterator over the values of a map.
 652 #[stable]
 653 pub struct Values<'a, V: 'a> {
 654     iter: Map<(uint, &'a V), &'a V, Iter<'a, V>, fn((uint, &'a V)) -> &'a V>
 655 }
 656
 657 // FIXME(#19839) Remove in favor of `#[derive(Clone)]`
 658 impl<'a, V> Clone for Values<'a, V> {
 659     fn clone(&self) -> Values<'a, V> {
 660         Values {
 661             iter: self.iter.clone()
 662         }
 663     }
 664 }
 665
 666 /// A consuming iterator over the key-value pairs of a map.
 667 #[stable]
 668 pub struct IntoIter<V> {
 669     iter: FilterMap<
 670     (uint, Option<V>),
 671     (uint, V),
 672     Enumerate<vec::IntoIter<Option<V>>>,
 673     fn((uint, Option<V>)) -> Option<(uint, V)>>
 674 }
 675
 676 #[stable]
 677 impl<'a, V> Iterator for Keys<'a, V> {
 678     type Item = uint;
 679
 680     fn next(&mut self) -> Option<uint> { self.iter.next() }
 681     fn size_hint(&self) -> (uint, Option<uint>) { self.iter.size_hint() }
 682 }
 683 #[stable]
 684 impl<'a, V> DoubleEndedIterator for Keys<'a, V> {
 685     fn next_back(&mut self) -> Option<uint> { self.iter.next_back() }
 686 }
 687
 688 #[stable]
 689 impl<'a, V> Iterator for Values<'a, V> {
 690     type Item = &'a V;
 691
 692     fn next(&mut self) -> Option<(&'a V)> { self.iter.next() }
 693     fn size_hint(&self) -> (uint, Option<uint>) { self.iter.size_hint() }
 694 }
 695 #[stable]
 696 impl<'a, V> DoubleEndedIterator for Values<'a, V> {
 697     fn next_back(&mut self) -> Option<(&'a V)> { self.iter.next_back() }
 698 }
 699
 700 #[stable]
 701 impl<V> Iterator for IntoIter<V> {
 702     type Item = (uint, V);
 703
 704     fn next(&mut self) -> Option<(uint, V)> { self.iter.next() }
 705     fn size_hint(&self) -> (uint, Option<uint>) { self.iter.size_hint() }
 706 }
 707 #[stable]
 708 impl<V> DoubleEndedIterator for IntoIter<V> {
 709     fn next_back(&mut self) -> Option<(uint, V)> { self.iter.next_back() }
 710 }
 711
 712 #[cfg(test)]
 713 mod test_map {
 714     use prelude::*;
 715     use core::hash::{hash, SipHasher};
 716
 717     use super::VecMap;
 718
 719     #[test]
 720     fn test_get_mut() {
 721         let mut m = VecMap::new();
 722         assert!(m.insert(1, 12i).is_none());
 723         assert!(m.insert(2, 8).is_none());
 724         assert!(m.insert(5, 14).is_none());
 725         let new = 100;
 726         match m.get_mut(&5) {
 727             None => panic!(), Some(x) => *x = new
 728         }
 729         assert_eq!(m.get(&5), Some(&new));
 730     }
 731
 732     #[test]
 733     fn test_len() {
 734         let mut map = VecMap::new();
 735         assert_eq!(map.len(), 0);
 736         assert!(map.is_empty());
 737         assert!(map.insert(5, 20i).is_none());
 738         assert_eq!(map.len(), 1);
 739         assert!(!map.is_empty());
 740         assert!(map.insert(11, 12).is_none());
 741         assert_eq!(map.len(), 2);
 742         assert!(!map.is_empty());
 743         assert!(map.insert(14, 22).is_none());
 744         assert_eq!(map.len(), 3);
 745         assert!(!map.is_empty());
 746     }
 747
 748     #[test]
 749     fn test_clear() {
 750         let mut map = VecMap::new();
 751         assert!(map.insert(5, 20i).is_none());
 752         assert!(map.insert(11, 12).is_none());
 753         assert!(map.insert(14, 22).is_none());
 754         map.clear();
 755         assert!(map.is_empty());
 756         assert!(map.get(&5).is_none());
 757         assert!(map.get(&11).is_none());
 758         assert!(map.get(&14).is_none());
 759     }
 760
 761     #[test]
 762     fn test_insert() {
 763         let mut m = VecMap::new();
 764         assert_eq!(m.insert(1, 2i), None);
 765         assert_eq!(m.insert(1, 3i), Some(2));
 766         assert_eq!(m.insert(1, 4i), Some(3));
 767     }
 768
 769     #[test]
 770     fn test_remove() {
 771         let mut m = VecMap::new();
 772         m.insert(1, 2i);
 773         assert_eq!(m.remove(&1), Some(2));
 774         assert_eq!(m.remove(&1), None);
 775     }
 776
 777     #[test]
 778     fn test_keys() {
 779         let mut map = VecMap::new();
 780         map.insert(1, 'a');
 781         map.insert(2, 'b');
 782         map.insert(3, 'c');
 783         let keys = map.keys().collect::<Vec<uint>>();
 784         assert_eq!(keys.len(), 3);
 785         assert!(keys.contains(&1));
 786         assert!(keys.contains(&2));
 787         assert!(keys.contains(&3));
 788     }
 789
 790     #[test]
 791     fn test_values() {
 792         let mut map = VecMap::new();
 793         map.insert(1, 'a');
 794         map.insert(2, 'b');
 795         map.insert(3, 'c');
 796         let values = map.values().map(|&v| v).collect::<Vec<char>>();
 797         assert_eq!(values.len(), 3);
 798         assert!(values.contains(&'a'));
 799         assert!(values.contains(&'b'));
 800         assert!(values.contains(&'c'));
 801     }
 802
 803     #[test]
 804     fn test_iterator() {
 805         let mut m = VecMap::new();
 806
 807         assert!(m.insert(0, 1i).is_none());
 808         assert!(m.insert(1, 2).is_none());
 809         assert!(m.insert(3, 5).is_none());
 810         assert!(m.insert(6, 10).is_none());
 811         assert!(m.insert(10, 11).is_none());
 812
 813         let mut it = m.iter();
 814         assert_eq!(it.size_hint(), (0, Some(11)));
 815         assert_eq!(it.next().unwrap(), (0, &1));
 816         assert_eq!(it.size_hint(), (0, Some(10)));
 817         assert_eq!(it.next().unwrap(), (1, &2));
 818         assert_eq!(it.size_hint(), (0, Some(9)));
 819         assert_eq!(it.next().unwrap(), (3, &5));
 820         assert_eq!(it.size_hint(), (0, Some(7)));
 821         assert_eq!(it.next().unwrap(), (6, &10));
 822         assert_eq!(it.size_hint(), (0, Some(4)));
 823         assert_eq!(it.next().unwrap(), (10, &11));
 824         assert_eq!(it.size_hint(), (0, Some(0)));
 825         assert!(it.next().is_none());
 826     }
 827
 828     #[test]
 829     fn test_iterator_size_hints() {
 830         let mut m = VecMap::new();
 831
 832         assert!(m.insert(0, 1i).is_none());
 833         assert!(m.insert(1, 2).is_none());
 834         assert!(m.insert(3, 5).is_none());
 835         assert!(m.insert(6, 10).is_none());
 836         assert!(m.insert(10, 11).is_none());
 837
 838         assert_eq!(m.iter().size_hint(), (0, Some(11)));
 839         assert_eq!(m.iter().rev().size_hint(), (0, Some(11)));
 840         assert_eq!(m.iter_mut().size_hint(), (0, Some(11)));
 841         assert_eq!(m.iter_mut().rev().size_hint(), (0, Some(11)));
 842     }
 843
 844     #[test]
 845     fn test_mut_iterator() {
 846         let mut m = VecMap::new();
 847
 848         assert!(m.insert(0, 1i).is_none());
 849         assert!(m.insert(1, 2).is_none());
 850         assert!(m.insert(3, 5).is_none());
 851         assert!(m.insert(6, 10).is_none());
 852         assert!(m.insert(10, 11).is_none());
 853
 854         for (k, v) in m.iter_mut() {
 855             *v += k as int;
 856         }
 857
 858         let mut it = m.iter();
 859         assert_eq!(it.next().unwrap(), (0, &1));
 860         assert_eq!(it.next().unwrap(), (1, &3));
 861         assert_eq!(it.next().unwrap(), (3, &8));
 862         assert_eq!(it.next().unwrap(), (6, &16));
 863         assert_eq!(it.next().unwrap(), (10, &21));
 864         assert!(it.next().is_none());
 865     }
 866
 867     #[test]
 868     fn test_rev_iterator() {
 869         let mut m = VecMap::new();
 870
 871         assert!(m.insert(0, 1i).is_none());
 872         assert!(m.insert(1, 2).is_none());
 873         assert!(m.insert(3, 5).is_none());
 874         assert!(m.insert(6, 10).is_none());
 875         assert!(m.insert(10, 11).is_none());
 876
 877         let mut it = m.iter().rev();
 878         assert_eq!(it.next().unwrap(), (10, &11));
 879         assert_eq!(it.next().unwrap(), (6, &10));
 880         assert_eq!(it.next().unwrap(), (3, &5));
 881         assert_eq!(it.next().unwrap(), (1, &2));
 882         assert_eq!(it.next().unwrap(), (0, &1));
 883         assert!(it.next().is_none());
 884     }
 885
 886     #[test]
 887     fn test_mut_rev_iterator() {
 888         let mut m = VecMap::new();
 889
 890         assert!(m.insert(0, 1i).is_none());
 891         assert!(m.insert(1, 2).is_none());
 892         assert!(m.insert(3, 5).is_none());
 893         assert!(m.insert(6, 10).is_none());
 894         assert!(m.insert(10, 11).is_none());
 895
 896         for (k, v) in m.iter_mut().rev() {
 897             *v += k as int;
 898         }
 899
 900         let mut it = m.iter();
 901         assert_eq!(it.next().unwrap(), (0, &1));
 902         assert_eq!(it.next().unwrap(), (1, &3));
 903         assert_eq!(it.next().unwrap(), (3, &8));
 904         assert_eq!(it.next().unwrap(), (6, &16));
 905         assert_eq!(it.next().unwrap(), (10, &21));
 906         assert!(it.next().is_none());
 907     }
 908
 909     #[test]
 910     fn test_move_iter() {
 911         let mut m = VecMap::new();
 912         m.insert(1, box 2i);
 913         let mut called = false;
 914         for (k, v) in m.into_iter() {
 915             assert!(!called);
 916             called = true;
 917             assert_eq!(k, 1);
 918             assert_eq!(v, box 2i);
 919         }
 920         assert!(called);
 921         m.insert(2, box 1i);
 922     }
 923
 924     #[test]
 925     fn test_show() {
 926         let mut map = VecMap::new();
 927         let empty = VecMap::<int>::new();
 928
 929         map.insert(1, 2i);
 930         map.insert(3, 4i);
 931
 932         let map_str = format!("{:?}", map);
 933         assert!(map_str == "VecMap {1: 2i, 3: 4i}" || map_str == "{3: 4i, 1: 2i}");
 934         assert_eq!(format!("{:?}", empty), "VecMap {}");
 935     }
 936
 937     #[test]
 938     fn test_clone() {
 939         let mut a = VecMap::new();
 940
 941         a.insert(1, 'x');
 942         a.insert(4, 'y');
 943         a.insert(6, 'z');
 944
 945         assert!(a.clone() == a);
 946     }
 947
 948     #[test]
 949     fn test_eq() {
 950         let mut a = VecMap::new();
 951         let mut b = VecMap::new();
 952
 953         assert!(a == b);
 954         assert!(a.insert(0, 5i).is_none());
 955         assert!(a != b);
 956         assert!(b.insert(0, 4i).is_none());
 957         assert!(a != b);
 958         assert!(a.insert(5, 19).is_none());
 959         assert!(a != b);
 960         assert!(!b.insert(0, 5).is_none());
 961         assert!(a != b);
 962         assert!(b.insert(5, 19).is_none());
 963         assert!(a == b);
 964
 965         a = VecMap::new();
 966         b = VecMap::with_capacity(1);
 967         assert!(a == b);
 968     }
 969
 970     #[test]
 971     fn test_lt() {
 972         let mut a = VecMap::new();
 973         let mut b = VecMap::new();
 974
 975         assert!(!(a < b) && !(b < a));
 976         assert!(b.insert(2u, 5i).is_none());
 977         assert!(a < b);
 978         assert!(a.insert(2, 7).is_none());
 979         assert!(!(a < b) && b < a);
 980         assert!(b.insert(1, 0).is_none());
 981         assert!(b < a);
 982         assert!(a.insert(0, 6).is_none());
 983         assert!(a < b);
 984         assert!(a.insert(6, 2).is_none());
 985         assert!(a < b && !(b < a));
 986     }
 987
 988     #[test]
 989     fn test_ord() {
 990         let mut a = VecMap::new();
 991         let mut b = VecMap::new();
 992
 993         assert!(a <= b && a >= b);
 994         assert!(a.insert(1u, 1i).is_none());
 995         assert!(a > b && a >= b);
 996         assert!(b < a && b <= a);
 997         assert!(b.insert(2, 2).is_none());
 998         assert!(b > a && b >= a);
 999         assert!(a < b && a <= b);
1000     }
1001
1002     #[test]
1003     fn test_hash() {
1004         let mut x = VecMap::new();
1005         let mut y = VecMap::new();
1006
1007         assert!(hash::<_, SipHasher>(&x) == hash::<_, SipHasher>(&y));
1008         x.insert(1, 'a');
1009         x.insert(2, 'b');
1010         x.insert(3, 'c');
1011
1012         y.insert(3, 'c');
1013         y.insert(2, 'b');
1014         y.insert(1, 'a');
1015
1016         assert!(hash::<_, SipHasher>(&x) == hash::<_, SipHasher>(&y));
1017
1018         x.insert(1000, 'd');
1019         x.remove(&1000);
1020
1021         assert!(hash::<_, SipHasher>(&x) == hash::<_, SipHasher>(&y));
1022     }
1023
1024     #[test]
1025     fn test_from_iter() {
1026         let xs: Vec<(uint, char)> = vec![(1u, 'a'), (2, 'b'), (3, 'c'), (4, 'd'), (5, 'e')];
1027
1028         let map: VecMap<char> = xs.iter().map(|&x| x).collect();
1029
1030         for &(k, v) in xs.iter() {
1031             assert_eq!(map.get(&k), Some(&v));
1032         }
1033     }
1034
1035     #[test]
1036     fn test_index() {
1037         let mut map: VecMap<int> = VecMap::new();
1038
1039         map.insert(1, 2);
1040         map.insert(2, 1);
1041         map.insert(3, 4);
1042
1043         assert_eq!(map[3], 4);
1044     }
1045
1046     #[test]
1047     #[should_fail]
1048     fn test_index_nonexistent() {
1049         let mut map: VecMap<int> = VecMap::new();
1050
1051         map.insert(1, 2);
1052         map.insert(2, 1);
1053         map.insert(3, 4);
1054
1055         map[4];
1056     }
1057 }
1058
1059 #[cfg(test)]
1060 mod bench {
1061     use test::Bencher;
1062     use super::VecMap;
1063     use bench::{insert_rand_n, insert_seq_n, find_rand_n, find_seq_n};
1064
1065     #[bench]
1066     pub fn insert_rand_100(b: &mut Bencher) {
1067         let mut m : VecMap<uint> = VecMap::new();
1068         insert_rand_n(100, &mut m, b,
1069                       |m, i| { m.insert(i, 1); },
1070                       |m, i| { m.remove(&i); });
1071     }
1072
1073     #[bench]
1074     pub fn insert_rand_10_000(b: &mut Bencher) {
1075         let mut m : VecMap<uint> = VecMap::new();
1076         insert_rand_n(10_000, &mut m, b,
1077                       |m, i| { m.insert(i, 1); },
1078                       |m, i| { m.remove(&i); });
1079     }
1080
1081     // Insert seq
1082     #[bench]
1083     pub fn insert_seq_100(b: &mut Bencher) {
1084         let mut m : VecMap<uint> = VecMap::new();
1085         insert_seq_n(100, &mut m, b,
1086                      |m, i| { m.insert(i, 1); },
1087                      |m, i| { m.remove(&i); });
1088     }
1089
1090     #[bench]
1091     pub fn insert_seq_10_000(b: &mut Bencher) {
1092         let mut m : VecMap<uint> = VecMap::new();
1093         insert_seq_n(10_000, &mut m, b,
1094                      |m, i| { m.insert(i, 1); },
1095                      |m, i| { m.remove(&i); });
1096     }
1097
1098     // Find rand
1099     #[bench]
1100     pub fn find_rand_100(b: &mut Bencher) {
1101         let mut m : VecMap<uint> = VecMap::new();
1102         find_rand_n(100, &mut m, b,
1103                     |m, i| { m.insert(i, 1); },
1104                     |m, i| { m.get(&i); });
1105     }
1106
1107     #[bench]
1108     pub fn find_rand_10_000(b: &mut Bencher) {
1109         let mut m : VecMap<uint> = VecMap::new();
1110         find_rand_n(10_000, &mut m, b,
1111                     |m, i| { m.insert(i, 1); },
1112                     |m, i| { m.get(&i); });
1113     }
1114
1115     // Find seq
1116     #[bench]
1117     pub fn find_seq_100(b: &mut Bencher) {
1118         let mut m : VecMap<uint> = VecMap::new();
1119         find_seq_n(100, &mut m, b,
1120                    |m, i| { m.insert(i, 1); },
1121                    |m, i| { m.get(&i); });
1122     }
1123
1124     #[bench]
1125     pub fn find_seq_10_000(b: &mut Bencher) {
1126         let mut m : VecMap<uint> = VecMap::new();
1127         find_seq_n(10_000, &mut m, b,
1128                    |m, i| { m.insert(i, 1); },
1129                    |m, i| { m.get(&i); });
1130     }
1131 }