Skip to content

Commit

Permalink
Implement mut_chunks() method for MutableVector trait.
Browse files Browse the repository at this point in the history
mut_chunks() returns an iterator that produces mutable slices. This is the
mutable version of the existing chunks() method on the ImmutableVector trait.
  • Loading branch information
Palmer Cox committed Dec 1, 2013
1 parent dfe46f7 commit f2a01ea
Showing 1 changed file with 73 additions and 0 deletions.
73 changes: 73 additions & 0 deletions src/libstd/vec.rs
Expand Up @@ -1933,6 +1933,18 @@ pub trait MutableVector<'self, T> {
/// Returns a reversed iterator that allows modifying each value
fn mut_rev_iter(self) -> MutRevIterator<'self, T>;

/**
* Returns an iterator over `size` elements of the vector at a time.
* The chunks are mutable and do not overlap. If `size` does not divide the
* length of the vector, then the last chunk will not have length
* `size`.
*
* # Failure
*
* Fails if `size` is 0.
*/
fn mut_chunks(self, chunk_size: uint) -> MutChunkIter<'self, T>;

/**
* Returns a mutable reference to the first element in this slice
* and adjusts the slice in place so that it no longer contains
Expand Down Expand Up @@ -2069,6 +2081,13 @@ impl<'self,T> MutableVector<'self, T> for &'self mut [T] {
self.mut_iter().invert()
}

#[inline]
fn mut_chunks(self, chunk_size: uint) -> MutChunkIter<'self, T> {
assert!(chunk_size > 0);
let len = self.len();
MutChunkIter { v: self, chunk_size: chunk_size, remaining: len }
}

fn mut_shift_ref(&mut self) -> &'self mut T {
unsafe {
let s: &mut Slice<T> = cast::transmute(self);
Expand Down Expand Up @@ -2556,6 +2575,42 @@ impl<'self, T> Clone for VecIterator<'self, T> {
iterator!{struct VecMutIterator -> *mut T, &'self mut T}
pub type MutRevIterator<'self, T> = Invert<VecMutIterator<'self, T>>;

/// An iterator over a vector in (non-overlapping) mutable chunks (`size` elements at a time). When
/// the vector len is not evenly divided by the chunk size, the last slice of the iteration will be
/// the remainder.
pub struct MutChunkIter<'self, T> {
priv v: &'self mut [T],
priv chunk_size: uint,
priv remaining: uint
}

impl<'self, T> Iterator<&'self mut [T]> for MutChunkIter<'self, T> {
#[inline]
fn next(&mut self) -> Option<&'self mut [T]> {
if self.remaining == 0 {
None
} else {
let sz = cmp::min(self.remaining, self.chunk_size);
let tmp = util::replace(&mut self.v, &mut []);
let (head, tail) = tmp.mut_split(sz);
self.v = tail;
self.remaining -= sz;
Some(head)
}
}

#[inline]
fn size_hint(&self) -> (uint, Option<uint>) {
if self.remaining == 0 {
(0, Some(0))
} else {
let (n, rem) = self.remaining.div_rem(&self.chunk_size);
let n = if rem > 0 { n + 1 } else { n };
(n, Some(n))
}
}
}

/// An iterator that moves out of a vector.
#[deriving(Clone)]
pub struct MoveIterator<T> {
Expand Down Expand Up @@ -3966,6 +4021,24 @@ mod tests {
x.pop_ref();
}

#[test]
fn test_mut_chunks() {
let mut v = [0u8, 1, 2, 3, 4, 5, 6];
for (i, chunk) in v.mut_chunks(3).enumerate() {
for x in chunk.mut_iter() {
*x = i as u8;
}
}
let result = [0u8, 0, 0, 1, 1, 1, 2];
assert_eq!(v, result);
}

#[test]
#[should_fail]
fn test_mut_chunks_0() {
let mut v = [1, 2, 3, 4];
let _it = v.mut_chunks(0);
}

#[test]
fn test_mut_shift_ref() {
Expand Down

0 comments on commit f2a01ea

Please sign in to comment.