Skip to content

Commit

Permalink
Clean up libcollections::VecMap
Browse files Browse the repository at this point in the history
- Introduce a named type for the return type of `VecMap::move_iter`
- Rename all type parameters to `V` for "Value".
- Remove unnecessary call to an `Option::unwrap`, use pattern matching instead.
- Remove incorrect `Hash` implementation which took the `VecMap`'s capacity
  into account.

This is a [breaking-change], however whoever used the `Hash` implementation
relied on an incorrect implementation.
  • Loading branch information
tbu- committed Dec 9, 2014
1 parent 95d1771 commit 67ae3a4
Showing 1 changed file with 35 additions and 54 deletions.
89 changes: 35 additions & 54 deletions src/libcollections/vec_map.rs
Expand Up @@ -23,8 +23,6 @@ use core::mem::replace;

use {vec, slice};
use vec::Vec;
use hash;
use hash::Hash;

// FIXME(conventions): capacity management???

Expand Down Expand Up @@ -62,8 +60,8 @@ use hash::Hash;
/// assert!(months.is_empty());
/// ```
#[deriving(PartialEq, Eq)]
pub struct VecMap<T> {
v: Vec<Option<T>>,
pub struct VecMap<V> {
v: Vec<Option<V>>,
}

impl<V> Default for VecMap<V> {
Expand All @@ -83,12 +81,6 @@ impl<V:Clone> Clone for VecMap<V> {
}
}

impl <S: hash::Writer, T: Hash<S>> Hash<S> for VecMap<T> {
fn hash(&self, state: &mut S) {
self.v.hash(state)
}
}

impl<V> VecMap<V> {
/// Creates an empty `VecMap`.
///
Expand All @@ -99,7 +91,7 @@ impl<V> VecMap<V> {
/// let mut map: VecMap<&str> = VecMap::new();
/// ```
#[unstable = "matches collection reform specification, waiting for dust to settle"]
pub fn new() -> VecMap<V> { VecMap{v: vec!()} }
pub fn new() -> VecMap<V> { VecMap { v: vec![] } }

/// Creates an empty `VecMap` with space for at least `capacity`
/// elements before resizing.
Expand Down Expand Up @@ -207,10 +199,7 @@ impl<V> VecMap<V> {
/// assert_eq!(vec, vec![(1, "a"), (2, "b"), (3, "c")]);
/// ```
#[unstable = "matches collection reform specification, waiting for dust to settle"]
pub fn into_iter(&mut self)
-> FilterMap<(uint, Option<V>), (uint, V),
Enumerate<vec::MoveItems<Option<V>>>>
{
pub fn into_iter(&mut self) -> MoveItems<V> {
let values = replace(&mut self.v, vec!());
values.into_iter().enumerate().filter_map(|(i, v)| {
v.map(|v| (i, v))
Expand Down Expand Up @@ -523,16 +512,19 @@ impl<V> IndexMut<uint, V> for VecMap<V> {

macro_rules! iterator {
(impl $name:ident -> $elem:ty, $($getter:ident),+) => {
impl<'a, T> Iterator<$elem> for $name<'a, T> {
impl<'a, V> Iterator<$elem> for $name<'a, V> {
#[inline]
fn next(&mut self) -> Option<$elem> {
while self.front < self.back {
match self.iter.next() {
Some(elem) => {
if elem.is_some() {
let index = self.front;
self.front += 1;
return Some((index, elem $(. $getter ())+));
match elem$(. $getter ())+ {
Some(x) => {
let index = self.front;
self.front += 1;
return Some((index, x));
},
None => {},
}
}
_ => ()
Expand All @@ -552,15 +544,18 @@ macro_rules! iterator {

macro_rules! double_ended_iterator {
(impl $name:ident -> $elem:ty, $($getter:ident),+) => {
impl<'a, T> DoubleEndedIterator<$elem> for $name<'a, T> {
impl<'a, V> DoubleEndedIterator<$elem> for $name<'a, V> {
#[inline]
fn next_back(&mut self) -> Option<$elem> {
while self.front < self.back {
match self.iter.next_back() {
Some(elem) => {
if elem.is_some() {
self.back -= 1;
return Some((self.back, elem$(. $getter ())+));
match elem$(. $getter ())+ {
Some(x) => {
self.back -= 1;
return Some((self.back, x));
},
None => {},
}
}
_ => ()
Expand All @@ -574,39 +569,42 @@ macro_rules! double_ended_iterator {
}

/// Forward iterator over a map.
pub struct Entries<'a, T:'a> {
pub struct Entries<'a, V:'a> {
front: uint,
back: uint,
iter: slice::Items<'a, Option<T>>
iter: slice::Items<'a, Option<V>>
}

iterator!(impl Entries -> (uint, &'a T), as_ref, unwrap)
double_ended_iterator!(impl Entries -> (uint, &'a T), as_ref, unwrap)
iterator!(impl Entries -> (uint, &'a V), as_ref)
double_ended_iterator!(impl Entries -> (uint, &'a V), as_ref)

/// Forward iterator over the key-value pairs of a map, with the
/// values being mutable.
pub struct MutEntries<'a, T:'a> {
pub struct MutEntries<'a, V:'a> {
front: uint,
back: uint,
iter: slice::MutItems<'a, Option<T>>
iter: slice::MutItems<'a, Option<V>>
}

iterator!(impl MutEntries -> (uint, &'a mut T), as_mut, unwrap)
double_ended_iterator!(impl MutEntries -> (uint, &'a mut T), as_mut, unwrap)
iterator!(impl MutEntries -> (uint, &'a mut V), as_mut)
double_ended_iterator!(impl MutEntries -> (uint, &'a mut V), as_mut)

/// Forward iterator over the keys of a map
pub type Keys<'a, T> =
iter::Map<'static, (uint, &'a T), uint, Entries<'a, T>>;
pub type Keys<'a, V> =
iter::Map<'static, (uint, &'a V), uint, Entries<'a, V>>;

/// Forward iterator over the values of a map
pub type Values<'a, T> =
iter::Map<'static, (uint, &'a T), &'a T, Entries<'a, T>>;
pub type Values<'a, V> =
iter::Map<'static, (uint, &'a V), &'a V, Entries<'a, V>>;

/// Iterator over the key-value pairs of a map, the iterator consumes the map
pub type MoveItems<V> =
FilterMap<'static, (uint, Option<V>), (uint, V), Enumerate<vec::MoveItems<Option<V>>>>;

#[cfg(test)]
mod test_map {
use std::prelude::*;
use vec::Vec;
use hash;

use super::VecMap;

Expand Down Expand Up @@ -920,23 +918,6 @@ mod test_map {
assert!(a < b && a <= b);
}

#[test]
fn test_hash() {
let mut x = VecMap::new();
let mut y = VecMap::new();

assert!(hash::hash(&x) == hash::hash(&y));
x.insert(1, 'a');
x.insert(2, 'b');
x.insert(3, 'c');

y.insert(3, 'c');
y.insert(2, 'b');
y.insert(1, 'a');

assert!(hash::hash(&x) == hash::hash(&y));
}

#[test]
fn test_from_iter() {
let xs: Vec<(uint, char)> = vec![(1u, 'a'), (2, 'b'), (3, 'c'), (4, 'd'), (5, 'e')];
Expand Down

0 comments on commit 67ae3a4

Please sign in to comment.