]> git.lizzy.rs Git - rust.git/blob - src/libcollections/slice.rs
Use the slice repr for ~[T]
[rust.git] / src / libcollections / slice.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 //! Utilities for slice manipulation
12 //!
13 //! The `slice` module contains useful code to help work with slice values.
14 //! Slices are a view into a block of memory represented as a pointer and a length.
15 //!
16 //! ```rust
17 //! // slicing a Vec
18 //! let vec = vec!(1i, 2, 3);
19 //! let int_slice = vec.as_slice();
20 //! // coercing an array to a slice
21 //! let str_slice: &[&str] = ["one", "two", "three"];
22 //! ```
23 //!
24 //! Slices are either mutable or shared. The shared slice type is `&[T]`,
25 //! while the mutable slice type is `&mut[T]`. For example, you can mutate the
26 //! block of memory that a mutable slice points to:
27 //!
28 //! ```rust
29 //! let x: &mut[int] = [1i, 2, 3];
30 //! x[1] = 7;
31 //! assert_eq!(x[0], 1);
32 //! assert_eq!(x[1], 7);
33 //! assert_eq!(x[2], 3);
34 //! ```
35 //!
36 //! Here are some of the things this module contains:
37 //!
38 //! ## Structs
39 //!
40 //! There are several structs that are useful for slices, such as `Items`, which
41 //! represents iteration over a slice.
42 //!
43 //! ## Traits
44 //!
45 //! A number of traits add methods that allow you to accomplish tasks with slices.
46 //! These traits include `ImmutableSlice`, which is defined for `&[T]` types,
47 //! and `MutableSlice`, defined for `&mut [T]` types.
48 //!
49 //! An example is the method `.slice(a, b)` that returns an immutable "view" into
50 //! a `Vec` or another slice from the index interval `[a, b)`:
51 //!
52 //! ```rust
53 //! let numbers = [0i, 1i, 2i];
54 //! let last_numbers = numbers.slice(1, 3);
55 //! // last_numbers is now &[1i, 2i]
56 //! ```
57 //!
58 //! ## Implementations of other traits
59 //!
60 //! There are several implementations of common traits for slices. Some examples
61 //! include:
62 //!
63 //! * `Clone`
64 //! * `Eq`, `Ord` - for immutable slices whose element type are `Eq` or `Ord`.
65 //! * `Hash` - for slices whose element type is `Hash`
66 //!
67 //! ## Iteration
68 //!
69 //! The method `iter()` returns an iteration value for a slice. The iterator
70 //! yields references to the slice's elements, so if the element
71 //! type of the slice is `int`, the element type of the iterator is `&int`.
72 //!
73 //! ```rust
74 //! let numbers = [0i, 1i, 2i];
75 //! for &x in numbers.iter() {
76 //!     println!("{} is a number!", x);
77 //! }
78 //! ```
79 //!
80 //! * `.mut_iter()` returns an iterator that allows modifying each value.
81 //! * Further iterators exist that split, chunk or permute the slice.
82
83 #![doc(primitive = "slice")]
84
85 use core::cmp;
86 use core::mem::size_of;
87 use core::mem;
88 use core::prelude::{Clone, Collection, Greater, Iterator, Less, None, Option};
89 use core::prelude::{Ord, Ordering, RawPtr, Some, range};
90 use core::ptr;
91 use core::iter::{range_step, MultiplicativeIterator};
92
93 use MutableSeq;
94 use vec::Vec;
95 #[cfg(not(stage0))]
96 use raw::Slice;
97
98 pub use core::slice::{Chunks, Slice, ImmutableSlice, ImmutablePartialEqSlice};
99 pub use core::slice::{ImmutableOrdSlice, MutableSlice, Items, MutItems};
100 pub use core::slice::{MutSplits, MutChunks, Splits};
101 pub use core::slice::{bytes, ref_slice, MutableCloneableSlice};
102 pub use core::slice::{Found, NotFound};
103
104 // Functional utilities
105
106 #[allow(missing_doc)]
107 pub trait VectorVector<T> {
108     // FIXME #5898: calling these .concat and .connect conflicts with
109     // StrVector::con{cat,nect}, since they have generic contents.
110     /// Flattens a vector of vectors of `T` into a single `Vec<T>`.
111     fn concat_vec(&self) -> Vec<T>;
112
113     /// Concatenate a vector of vectors, placing a given separator between each.
114     fn connect_vec(&self, sep: &T) -> Vec<T>;
115 }
116
117 impl<'a, T: Clone, V: Slice<T>> VectorVector<T> for &'a [V] {
118     fn concat_vec(&self) -> Vec<T> {
119         let size = self.iter().fold(0u, |acc, v| acc + v.as_slice().len());
120         let mut result = Vec::with_capacity(size);
121         for v in self.iter() {
122             result.push_all(v.as_slice())
123         }
124         result
125     }
126
127     fn connect_vec(&self, sep: &T) -> Vec<T> {
128         let size = self.iter().fold(0u, |acc, v| acc + v.as_slice().len());
129         let mut result = Vec::with_capacity(size + self.len());
130         let mut first = true;
131         for v in self.iter() {
132             if first { first = false } else { result.push(sep.clone()) }
133             result.push_all(v.as_slice())
134         }
135         result
136     }
137 }
138
139 /// An iterator that yields the element swaps needed to produce
140 /// a sequence of all possible permutations for an indexed sequence of
141 /// elements. Each permutation is only a single swap apart.
142 ///
143 /// The Steinhaus-Johnson-Trotter algorithm is used.
144 ///
145 /// Generates even and odd permutations alternately.
146 ///
147 /// The last generated swap is always (0, 1), and it returns the
148 /// sequence to its initial order.
149 pub struct ElementSwaps {
150     sdir: Vec<SizeDirection>,
151     /// If `true`, emit the last swap that returns the sequence to initial
152     /// state.
153     emit_reset: bool,
154     swaps_made : uint,
155 }
156
157 impl ElementSwaps {
158     /// Creates an `ElementSwaps` iterator for a sequence of `length` elements.
159     pub fn new(length: uint) -> ElementSwaps {
160         // Initialize `sdir` with a direction that position should move in
161         // (all negative at the beginning) and the `size` of the
162         // element (equal to the original index).
163         ElementSwaps{
164             emit_reset: true,
165             sdir: range(0, length).map(|i| SizeDirection{ size: i, dir: Neg }).collect(),
166             swaps_made: 0
167         }
168     }
169 }
170
171 enum Direction { Pos, Neg }
172
173 /// An `Index` and `Direction` together.
174 struct SizeDirection {
175     size: uint,
176     dir: Direction,
177 }
178
179 impl Iterator<(uint, uint)> for ElementSwaps {
180     #[inline]
181     fn next(&mut self) -> Option<(uint, uint)> {
182         fn new_pos(i: uint, s: Direction) -> uint {
183             i + match s { Pos => 1, Neg => -1 }
184         }
185
186         // Find the index of the largest mobile element:
187         // The direction should point into the vector, and the
188         // swap should be with a smaller `size` element.
189         let max = self.sdir.iter().map(|&x| x).enumerate()
190                            .filter(|&(i, sd)|
191                                 new_pos(i, sd.dir) < self.sdir.len() &&
192                                 self.sdir[new_pos(i, sd.dir)].size < sd.size)
193                            .max_by(|&(_, sd)| sd.size);
194         match max {
195             Some((i, sd)) => {
196                 let j = new_pos(i, sd.dir);
197                 self.sdir.as_mut_slice().swap(i, j);
198
199                 // Swap the direction of each larger SizeDirection
200                 for x in self.sdir.mut_iter() {
201                     if x.size > sd.size {
202                         x.dir = match x.dir { Pos => Neg, Neg => Pos };
203                     }
204                 }
205                 self.swaps_made += 1;
206                 Some((i, j))
207             },
208             None => if self.emit_reset {
209                 self.emit_reset = false;
210                 if self.sdir.len() > 1 {
211                     // The last swap
212                     self.swaps_made += 1;
213                     Some((0, 1))
214                 } else {
215                     // Vector is of the form [] or [x], and the only permutation is itself
216                     self.swaps_made += 1;
217                     Some((0,0))
218                 }
219             } else { None }
220         }
221     }
222
223     #[inline]
224     fn size_hint(&self) -> (uint, Option<uint>) {
225         // For a vector of size n, there are exactly n! permutations.
226         let n = range(2, self.sdir.len() + 1).product();
227         (n - self.swaps_made, Some(n - self.swaps_made))
228     }
229 }
230
231 /// An iterator that uses `ElementSwaps` to iterate through
232 /// all possible permutations of a vector.
233 ///
234 /// The first iteration yields a clone of the vector as it is,
235 /// then each successive element is the vector with one
236 /// swap applied.
237 ///
238 /// Generates even and odd permutations alternately.
239 pub struct Permutations<T> {
240     swaps: ElementSwaps,
241     v: Vec<T>,
242 }
243
244 impl<T: Clone> Iterator<Vec<T>> for Permutations<T> {
245     #[inline]
246     fn next(&mut self) -> Option<Vec<T>> {
247         match self.swaps.next() {
248             None => None,
249             Some((0,0)) => Some(self.v.clone()),
250             Some((a, b)) => {
251                 let elt = self.v.clone();
252                 self.v.as_mut_slice().swap(a, b);
253                 Some(elt)
254             }
255         }
256     }
257
258     #[inline]
259     fn size_hint(&self) -> (uint, Option<uint>) {
260         self.swaps.size_hint()
261     }
262 }
263
264 /// Extension methods for vector slices with cloneable elements
265 pub trait CloneableVector<T> {
266     /// Copies `self` into a new `Vec`.
267     fn to_vec(&self) -> Vec<T>;
268
269     /// Deprecated. Use `to_vec`.
270     #[deprecated = "Replaced by `to_vec`"]
271     fn to_owned(&self) -> Vec<T> {
272         self.to_vec()
273     }
274
275     /// Converts `self` into an owned vector, not making a copy if possible.
276     fn into_vec(self) -> Vec<T>;
277
278     /// Deprecated. Use `into_vec`
279     #[deprecated = "Replaced by `into_vec`"]
280     fn into_owned(self) -> Vec<T> {
281         self.into_vec()
282     }
283 }
284
285 impl<'a, T: Clone> CloneableVector<T> for &'a [T] {
286     /// Returns a copy of `v`.
287     #[cfg(not(stage0))]
288     fn to_owned(&self) -> ~[T] {
289         use num::CheckedMul;
290         use option::Expect;
291
292         let len = self.len();
293
294         if len == 0 {
295             unsafe {
296                 let slice: Slice<T> = Slice{data: 0 as *T, len: 0};
297                 mem::transmute(slice)
298             }
299         } else {
300             let unit_size = mem::size_of::<T>();
301             let data_size = if unit_size == 0 {
302                 len
303             } else {
304                 let data_size = len.checked_mul(&unit_size);
305                 data_size.expect("overflow in from_iter()")
306             };
307
308             unsafe {
309                 // this should pass the real required alignment
310                 let ret = allocate(data_size, 8) as *mut T;
311
312                 if unit_size > 0 {
313                     // Be careful with the following loop. We want it to be optimized
314                     // to a memcpy (or something similarly fast) when T is Copy. LLVM
315                     // is easily confused, so any extra operations during the loop can
316                     // prevent this optimization.
317                     let mut i = 0;
318                     let p = &mut (*ret) as *mut _ as *mut T;
319                     try_finally(
320                         &mut i, (),
321                         |i, ()| while *i < len {
322                             mem::move_val_init(
323                                 &mut(*p.offset(*i as int)),
324                                 self.unsafe_ref(*i).clone());
325                             *i += 1;
326                         },
327                         |i| if *i < len {
328                             // we must be failing, clean up after ourselves
329                             for j in range(0, *i as int) {
330                                 ptr::read(&*p.offset(j));
331                             }
332                             // FIXME: #13994 (should pass align and size here)
333                             deallocate(ret as *mut u8, 0, 8);
334                         });
335                 }
336                 let slice: Slice<T> = Slice{data: ret as *T, len: len};
337                 mem::transmute(slice)
338             }
339         }
340     }
341
342     /// Returns a copy of `v`.
343     // NOTE: remove after snapshot
344     #[cfg(stage0)]
345     #[inline]
346     fn to_vec(&self) -> Vec<T> { Vec::from_slice(*self) }
347
348     #[inline(always)]
349     fn into_vec(self) -> Vec<T> { self.to_vec() }
350 }
351
352 /// Extension methods for vectors containing `Clone` elements.
353 pub trait ImmutableCloneableVector<T> {
354     /// Partitions the vector into two vectors `(a, b)`, where all
355     /// elements of `a` satisfy `f` and all elements of `b` do not.
356     fn partitioned(&self, f: |&T| -> bool) -> (Vec<T>, Vec<T>);
357
358     /// Creates an iterator that yields every possible permutation of the
359     /// vector in succession.
360     ///
361     /// # Example
362     ///
363     /// ```rust
364     /// let v = [1i, 2, 3];
365     /// let mut perms = v.permutations();
366     ///
367     /// for p in perms {
368     ///   println!("{}", p);
369     /// }
370     /// ```
371     ///
372     /// # Example 2: iterating through permutations one by one.
373     ///
374     /// ```rust
375     /// let v = [1i, 2, 3];
376     /// let mut perms = v.permutations();
377     ///
378     /// assert_eq!(Some(vec![1i, 2, 3]), perms.next());
379     /// assert_eq!(Some(vec![1i, 3, 2]), perms.next());
380     /// assert_eq!(Some(vec![3i, 1, 2]), perms.next());
381     /// ```
382     fn permutations(self) -> Permutations<T>;
383 }
384
385 impl<'a,T:Clone> ImmutableCloneableVector<T> for &'a [T] {
386     #[inline]
387     fn partitioned(&self, f: |&T| -> bool) -> (Vec<T>, Vec<T>) {
388         let mut lefts  = Vec::new();
389         let mut rights = Vec::new();
390
391         for elt in self.iter() {
392             if f(elt) {
393                 lefts.push((*elt).clone());
394             } else {
395                 rights.push((*elt).clone());
396             }
397         }
398
399         (lefts, rights)
400     }
401
402     /// Returns an iterator over all permutations of a vector.
403     fn permutations(self) -> Permutations<T> {
404         Permutations{
405             swaps: ElementSwaps::new(self.len()),
406             v: self.to_vec(),
407         }
408     }
409
410 }
411
412 fn insertion_sort<T>(v: &mut [T], compare: |&T, &T| -> Ordering) {
413     let len = v.len() as int;
414     let buf_v = v.as_mut_ptr();
415
416     // 1 <= i < len;
417     for i in range(1, len) {
418         // j satisfies: 0 <= j <= i;
419         let mut j = i;
420         unsafe {
421             // `i` is in bounds.
422             let read_ptr = buf_v.offset(i) as *const T;
423
424             // find where to insert, we need to do strict <,
425             // rather than <=, to maintain stability.
426
427             // 0 <= j - 1 < len, so .offset(j - 1) is in bounds.
428             while j > 0 &&
429                     compare(&*read_ptr, &*buf_v.offset(j - 1)) == Less {
430                 j -= 1;
431             }
432
433             // shift everything to the right, to make space to
434             // insert this value.
435
436             // j + 1 could be `len` (for the last `i`), but in
437             // that case, `i == j` so we don't copy. The
438             // `.offset(j)` is always in bounds.
439
440             if i != j {
441                 let tmp = ptr::read(read_ptr);
442                 ptr::copy_memory(buf_v.offset(j + 1),
443                                  &*buf_v.offset(j),
444                                  (i - j) as uint);
445                 ptr::copy_nonoverlapping_memory(buf_v.offset(j),
446                                                 &tmp as *const T,
447                                                 1);
448                 mem::forget(tmp);
449             }
450         }
451     }
452 }
453
454 fn merge_sort<T>(v: &mut [T], compare: |&T, &T| -> Ordering) {
455     // warning: this wildly uses unsafe.
456     static BASE_INSERTION: uint = 32;
457     static LARGE_INSERTION: uint = 16;
458
459     // FIXME #12092: smaller insertion runs seems to make sorting
460     // vectors of large elements a little faster on some platforms,
461     // but hasn't been tested/tuned extensively
462     let insertion = if size_of::<T>() <= 16 {
463         BASE_INSERTION
464     } else {
465         LARGE_INSERTION
466     };
467
468     let len = v.len();
469
470     // short vectors get sorted in-place via insertion sort to avoid allocations
471     if len <= insertion {
472         insertion_sort(v, compare);
473         return;
474     }
475
476     // allocate some memory to use as scratch memory, we keep the
477     // length 0 so we can keep shallow copies of the contents of `v`
478     // without risking the dtors running on an object twice if
479     // `compare` fails.
480     let mut working_space = Vec::with_capacity(2 * len);
481     // these both are buffers of length `len`.
482     let mut buf_dat = working_space.as_mut_ptr();
483     let mut buf_tmp = unsafe {buf_dat.offset(len as int)};
484
485     // length `len`.
486     let buf_v = v.as_ptr();
487
488     // step 1. sort short runs with insertion sort. This takes the
489     // values from `v` and sorts them into `buf_dat`, leaving that
490     // with sorted runs of length INSERTION.
491
492     // We could hardcode the sorting comparisons here, and we could
493     // manipulate/step the pointers themselves, rather than repeatedly
494     // .offset-ing.
495     for start in range_step(0, len, insertion) {
496         // start <= i < len;
497         for i in range(start, cmp::min(start + insertion, len)) {
498             // j satisfies: start <= j <= i;
499             let mut j = i as int;
500             unsafe {
501                 // `i` is in bounds.
502                 let read_ptr = buf_v.offset(i as int);
503
504                 // find where to insert, we need to do strict <,
505                 // rather than <=, to maintain stability.
506
507                 // start <= j - 1 < len, so .offset(j - 1) is in
508                 // bounds.
509                 while j > start as int &&
510                         compare(&*read_ptr, &*buf_dat.offset(j - 1)) == Less {
511                     j -= 1;
512                 }
513
514                 // shift everything to the right, to make space to
515                 // insert this value.
516
517                 // j + 1 could be `len` (for the last `i`), but in
518                 // that case, `i == j` so we don't copy. The
519                 // `.offset(j)` is always in bounds.
520                 ptr::copy_memory(buf_dat.offset(j + 1),
521                                  &*buf_dat.offset(j),
522                                  i - j as uint);
523                 ptr::copy_nonoverlapping_memory(buf_dat.offset(j), read_ptr, 1);
524             }
525         }
526     }
527
528     // step 2. merge the sorted runs.
529     let mut width = insertion;
530     while width < len {
531         // merge the sorted runs of length `width` in `buf_dat` two at
532         // a time, placing the result in `buf_tmp`.
533
534         // 0 <= start <= len.
535         for start in range_step(0, len, 2 * width) {
536             // manipulate pointers directly for speed (rather than
537             // using a `for` loop with `range` and `.offset` inside
538             // that loop).
539             unsafe {
540                 // the end of the first run & start of the
541                 // second. Offset of `len` is defined, since this is
542                 // precisely one byte past the end of the object.
543                 let right_start = buf_dat.offset(cmp::min(start + width, len) as int);
544                 // end of the second. Similar reasoning to the above re safety.
545                 let right_end_idx = cmp::min(start + 2 * width, len);
546                 let right_end = buf_dat.offset(right_end_idx as int);
547
548                 // the pointers to the elements under consideration
549                 // from the two runs.
550
551                 // both of these are in bounds.
552                 let mut left = buf_dat.offset(start as int);
553                 let mut right = right_start;
554
555                 // where we're putting the results, it is a run of
556                 // length `2*width`, so we step it once for each step
557                 // of either `left` or `right`.  `buf_tmp` has length
558                 // `len`, so these are in bounds.
559                 let mut out = buf_tmp.offset(start as int);
560                 let out_end = buf_tmp.offset(right_end_idx as int);
561
562                 while out < out_end {
563                     // Either the left or the right run are exhausted,
564                     // so just copy the remainder from the other run
565                     // and move on; this gives a huge speed-up (order
566                     // of 25%) for mostly sorted vectors (the best
567                     // case).
568                     if left == right_start {
569                         // the number remaining in this run.
570                         let elems = (right_end as uint - right as uint) / mem::size_of::<T>();
571                         ptr::copy_nonoverlapping_memory(out, &*right, elems);
572                         break;
573                     } else if right == right_end {
574                         let elems = (right_start as uint - left as uint) / mem::size_of::<T>();
575                         ptr::copy_nonoverlapping_memory(out, &*left, elems);
576                         break;
577                     }
578
579                     // check which side is smaller, and that's the
580                     // next element for the new run.
581
582                     // `left < right_start` and `right < right_end`,
583                     // so these are valid.
584                     let to_copy = if compare(&*left, &*right) == Greater {
585                         step(&mut right)
586                     } else {
587                         step(&mut left)
588                     };
589                     ptr::copy_nonoverlapping_memory(out, &*to_copy, 1);
590                     step(&mut out);
591                 }
592             }
593         }
594
595         mem::swap(&mut buf_dat, &mut buf_tmp);
596
597         width *= 2;
598     }
599
600     // write the result to `v` in one go, so that there are never two copies
601     // of the same object in `v`.
602     unsafe {
603         ptr::copy_nonoverlapping_memory(v.as_mut_ptr(), &*buf_dat, len);
604     }
605
606     // increment the pointer, returning the old pointer.
607     #[inline(always)]
608     unsafe fn step<T>(ptr: &mut *mut T) -> *mut T {
609         let old = *ptr;
610         *ptr = ptr.offset(1);
611         old
612     }
613 }
614
615 /// Extension methods for vectors such that their elements are
616 /// mutable.
617 pub trait MutableSliceAllocating<'a, T> {
618     /// Sorts the slice, in place, using `compare` to compare
619     /// elements.
620     ///
621     /// This sort is `O(n log n)` worst-case and stable, but allocates
622     /// approximately `2 * n`, where `n` is the length of `self`.
623     ///
624     /// # Example
625     ///
626     /// ```rust
627     /// let mut v = [5i, 4, 1, 3, 2];
628     /// v.sort_by(|a, b| a.cmp(b));
629     /// assert!(v == [1, 2, 3, 4, 5]);
630     ///
631     /// // reverse sorting
632     /// v.sort_by(|a, b| b.cmp(a));
633     /// assert!(v == [5, 4, 3, 2, 1]);
634     /// ```
635     fn sort_by(self, compare: |&T, &T| -> Ordering);
636
637     /// Consumes `src` and moves as many elements as it can into `self`
638     /// from the range [start,end).
639     ///
640     /// Returns the number of elements copied (the shorter of `self.len()`
641     /// and `end - start`).
642     ///
643     /// # Arguments
644     ///
645     /// * src - A mutable vector of `T`
646     /// * start - The index into `src` to start copying from
647     /// * end - The index into `src` to stop copying from
648     ///
649     /// # Example
650     ///
651     /// ```rust
652     /// let mut a = [1i, 2, 3, 4, 5];
653     /// let b = vec![6i, 7, 8];
654     /// let num_moved = a.move_from(b, 0, 3);
655     /// assert_eq!(num_moved, 3);
656     /// assert!(a == [6i, 7, 8, 4, 5]);
657     /// ```
658     fn move_from(self, src: Vec<T>, start: uint, end: uint) -> uint;
659 }
660
661 impl<'a,T> MutableSliceAllocating<'a, T> for &'a mut [T] {
662     #[inline]
663     fn sort_by(self, compare: |&T, &T| -> Ordering) {
664         merge_sort(self, compare)
665     }
666
667     #[inline]
668     fn move_from(self, mut src: Vec<T>, start: uint, end: uint) -> uint {
669         for (a, b) in self.mut_iter().zip(src.mut_slice(start, end).mut_iter()) {
670             mem::swap(a, b);
671         }
672         cmp::min(self.len(), end-start)
673     }
674 }
675
676 /// Methods for mutable vectors with orderable elements, such as
677 /// in-place sorting.
678 pub trait MutableOrdSlice<T> {
679     /// Sorts the slice, in place.
680     ///
681     /// This is equivalent to `self.sort_by(|a, b| a.cmp(b))`.
682     ///
683     /// # Example
684     ///
685     /// ```rust
686     /// let mut v = [-5i, 4, 1, -3, 2];
687     ///
688     /// v.sort();
689     /// assert!(v == [-5i, -3, 1, 2, 4]);
690     /// ```
691     fn sort(self);
692
693     /// Mutates the slice to the next lexicographic permutation.
694     ///
695     /// Returns `true` if successful and `false` if the slice is at the
696     /// last-ordered permutation.
697     ///
698     /// # Example
699     ///
700     /// ```rust
701     /// let v = &mut [0i, 1, 2];
702     /// v.next_permutation();
703     /// assert_eq!(v, &mut [0i, 2, 1]);
704     /// v.next_permutation();
705     /// assert_eq!(v, &mut [1i, 0, 2]);
706     /// ```
707     fn next_permutation(self) -> bool;
708
709     /// Mutates the slice to the previous lexicographic permutation.
710     ///
711     /// Returns `true` if successful and `false` if the slice is at the
712     /// first-ordered permutation.
713     ///
714     /// # Example
715     ///
716     /// ```rust
717     /// let v = &mut [1i, 0, 2];
718     /// v.prev_permutation();
719     /// assert_eq!(v, &mut [0i, 2, 1]);
720     /// v.prev_permutation();
721     /// assert_eq!(v, &mut [0i, 1, 2]);
722     /// ```
723     fn prev_permutation(self) -> bool;
724 }
725
726 impl<'a, T: Ord> MutableOrdSlice<T> for &'a mut [T] {
727     #[inline]
728     fn sort(self) {
729         self.sort_by(|a,b| a.cmp(b))
730     }
731
732     fn next_permutation(self) -> bool {
733         // These cases only have 1 permutation each, so we can't do anything.
734         if self.len() < 2 { return false; }
735
736         // Step 1: Identify the longest, rightmost weakly decreasing part of the vector
737         let mut i = self.len() - 1;
738         while i > 0 && self[i-1] >= self[i] {
739             i -= 1;
740         }
741
742         // If that is the entire vector, this is the last-ordered permutation.
743         if i == 0 {
744             return false;
745         }
746
747         // Step 2: Find the rightmost element larger than the pivot (i-1)
748         let mut j = self.len() - 1;
749         while j >= i && self[j] <= self[i-1]  {
750             j -= 1;
751         }
752
753         // Step 3: Swap that element with the pivot
754         self.swap(j, i-1);
755
756         // Step 4: Reverse the (previously) weakly decreasing part
757         self.mut_slice_from(i).reverse();
758
759         true
760     }
761
762     fn prev_permutation(self) -> bool {
763         // These cases only have 1 permutation each, so we can't do anything.
764         if self.len() < 2 { return false; }
765
766         // Step 1: Identify the longest, rightmost weakly increasing part of the vector
767         let mut i = self.len() - 1;
768         while i > 0 && self[i-1] <= self[i] {
769             i -= 1;
770         }
771
772         // If that is the entire vector, this is the first-ordered permutation.
773         if i == 0 {
774             return false;
775         }
776
777         // Step 2: Reverse the weakly increasing part
778         self.mut_slice_from(i).reverse();
779
780         // Step 3: Find the rightmost element equal to or bigger than the pivot (i-1)
781         let mut j = self.len() - 1;
782         while j >= i && self[j-1] < self[i-1]  {
783             j -= 1;
784         }
785
786         // Step 4: Swap that element with the pivot
787         self.swap(i-1, j);
788
789         true
790     }
791 }
792
793 /// Unsafe operations
794 pub mod raw {
795     pub use core::slice::raw::{buf_as_slice, mut_buf_as_slice};
796     pub use core::slice::raw::{shift_ptr, pop_ptr};
797 }
798
799 #[cfg(test)]
800 mod tests {
801     use std::cell::Cell;
802     use std::default::Default;
803     use std::mem;
804     use std::prelude::*;
805     use std::rand::{Rng, task_rng};
806     use std::rc::Rc;
807     use std::rt;
808     use slice::*;
809
810     use {Mutable, MutableSeq};
811     use vec::Vec;
812
813     fn square(n: uint) -> uint { n * n }
814
815     fn is_odd(n: &uint) -> bool { *n % 2u == 1u }
816
817     #[test]
818     fn test_from_fn() {
819         // Test on-stack from_fn.
820         let mut v = Vec::from_fn(3u, square);
821         {
822             let v = v.as_slice();
823             assert_eq!(v.len(), 3u);
824             assert_eq!(v[0], 0u);
825             assert_eq!(v[1], 1u);
826             assert_eq!(v[2], 4u);
827         }
828
829         // Test on-heap from_fn.
830         v = Vec::from_fn(5u, square);
831         {
832             let v = v.as_slice();
833             assert_eq!(v.len(), 5u);
834             assert_eq!(v[0], 0u);
835             assert_eq!(v[1], 1u);
836             assert_eq!(v[2], 4u);
837             assert_eq!(v[3], 9u);
838             assert_eq!(v[4], 16u);
839         }
840     }
841
842     #[test]
843     fn test_from_elem() {
844         // Test on-stack from_elem.
845         let mut v = Vec::from_elem(2u, 10u);
846         {
847             let v = v.as_slice();
848             assert_eq!(v.len(), 2u);
849             assert_eq!(v[0], 10u);
850             assert_eq!(v[1], 10u);
851         }
852
853         // Test on-heap from_elem.
854         v = Vec::from_elem(6u, 20u);
855         {
856             let v = v.as_slice();
857             assert_eq!(v[0], 20u);
858             assert_eq!(v[1], 20u);
859             assert_eq!(v[2], 20u);
860             assert_eq!(v[3], 20u);
861             assert_eq!(v[4], 20u);
862             assert_eq!(v[5], 20u);
863         }
864     }
865
866     #[test]
867     fn test_is_empty() {
868         let xs: [int, ..0] = [];
869         assert!(xs.is_empty());
870         assert!(![0i].is_empty());
871     }
872
873     #[test]
874     fn test_len_divzero() {
875         type Z = [i8, ..0];
876         let v0 : &[Z] = &[];
877         let v1 : &[Z] = &[[]];
878         let v2 : &[Z] = &[[], []];
879         assert_eq!(mem::size_of::<Z>(), 0);
880         assert_eq!(v0.len(), 0);
881         assert_eq!(v1.len(), 1);
882         assert_eq!(v2.len(), 2);
883     }
884
885     #[test]
886     fn test_get() {
887         let mut a = vec![11i];
888         assert_eq!(a.as_slice().get(1), None);
889         a = vec![11i, 12];
890         assert_eq!(a.as_slice().get(1).unwrap(), &12);
891         a = vec![11i, 12, 13];
892         assert_eq!(a.as_slice().get(1).unwrap(), &12);
893     }
894
895     #[test]
896     fn test_head() {
897         let mut a = vec![];
898         assert_eq!(a.as_slice().head(), None);
899         a = vec![11i];
900         assert_eq!(a.as_slice().head().unwrap(), &11);
901         a = vec![11i, 12];
902         assert_eq!(a.as_slice().head().unwrap(), &11);
903     }
904
905     #[test]
906     fn test_tail() {
907         let mut a = vec![11i];
908         assert_eq!(a.tail(), &[]);
909         a = vec![11i, 12];
910         assert_eq!(a.tail(), &[12]);
911     }
912
913     #[test]
914     #[should_fail]
915     fn test_tail_empty() {
916         let a: Vec<int> = vec![];
917         a.tail();
918     }
919
920     #[test]
921     fn test_tailn() {
922         let mut a = vec![11i, 12, 13];
923         assert_eq!(a.tailn(0), &[11, 12, 13]);
924         a = vec![11i, 12, 13];
925         assert_eq!(a.tailn(2), &[13]);
926     }
927
928     #[test]
929     #[should_fail]
930     fn test_tailn_empty() {
931         let a: Vec<int> = vec![];
932         a.tailn(2);
933     }
934
935     #[test]
936     fn test_init() {
937         let mut a = vec![11i];
938         assert_eq!(a.init(), &[]);
939         a = vec![11i, 12];
940         assert_eq!(a.init(), &[11]);
941     }
942
943     #[test]
944     #[should_fail]
945     fn test_init_empty() {
946         let a: Vec<int> = vec![];
947         a.init();
948     }
949
950     #[test]
951     fn test_initn() {
952         let mut a = vec![11i, 12, 13];
953         assert_eq!(a.as_slice().initn(0), &[11, 12, 13]);
954         a = vec![11i, 12, 13];
955         assert_eq!(a.as_slice().initn(2), &[11]);
956     }
957
958     #[test]
959     #[should_fail]
960     fn test_initn_empty() {
961         let a: Vec<int> = vec![];
962         a.as_slice().initn(2);
963     }
964
965     #[test]
966     fn test_last() {
967         let mut a = vec![];
968         assert_eq!(a.as_slice().last(), None);
969         a = vec![11i];
970         assert_eq!(a.as_slice().last().unwrap(), &11);
971         a = vec![11i, 12];
972         assert_eq!(a.as_slice().last().unwrap(), &12);
973     }
974
975     #[test]
976     fn test_slice() {
977         // Test fixed length vector.
978         let vec_fixed = [1i, 2, 3, 4];
979         let v_a = vec_fixed.slice(1u, vec_fixed.len()).to_vec();
980         assert_eq!(v_a.len(), 3u);
981         let v_a = v_a.as_slice();
982         assert_eq!(v_a[0], 2);
983         assert_eq!(v_a[1], 3);
984         assert_eq!(v_a[2], 4);
985
986         // Test on stack.
987         let vec_stack = &[1i, 2, 3];
988         let v_b = vec_stack.slice(1u, 3u).to_vec();
989         assert_eq!(v_b.len(), 2u);
990         let v_b = v_b.as_slice();
991         assert_eq!(v_b[0], 2);
992         assert_eq!(v_b[1], 3);
993
994         // Test `Box<[T]>`
995         let vec_unique = vec![1i, 2, 3, 4, 5, 6];
996         let v_d = vec_unique.slice(1u, 6u).to_vec();
997         assert_eq!(v_d.len(), 5u);
998         let v_d = v_d.as_slice();
999         assert_eq!(v_d[0], 2);
1000         assert_eq!(v_d[1], 3);
1001         assert_eq!(v_d[2], 4);
1002         assert_eq!(v_d[3], 5);
1003         assert_eq!(v_d[4], 6);
1004     }
1005
1006     #[test]
1007     fn test_slice_from() {
1008         let vec = &[1i, 2, 3, 4];
1009         assert_eq!(vec.slice_from(0), vec);
1010         assert_eq!(vec.slice_from(2), &[3, 4]);
1011         assert_eq!(vec.slice_from(4), &[]);
1012     }
1013
1014     #[test]
1015     fn test_slice_to() {
1016         let vec = &[1i, 2, 3, 4];
1017         assert_eq!(vec.slice_to(4), vec);
1018         assert_eq!(vec.slice_to(2), &[1, 2]);
1019         assert_eq!(vec.slice_to(0), &[]);
1020     }
1021
1022
1023     #[test]
1024     fn test_pop() {
1025         let mut v = vec![5i];
1026         let e = v.pop();
1027         assert_eq!(v.len(), 0);
1028         assert_eq!(e, Some(5));
1029         let f = v.pop();
1030         assert_eq!(f, None);
1031         let g = v.pop();
1032         assert_eq!(g, None);
1033     }
1034
1035     #[test]
1036     fn test_swap_remove() {
1037         let mut v = vec![1i, 2, 3, 4, 5];
1038         let mut e = v.swap_remove(0);
1039         assert_eq!(e, Some(1));
1040         assert_eq!(v, vec![5i, 2, 3, 4]);
1041         e = v.swap_remove(3);
1042         assert_eq!(e, Some(4));
1043         assert_eq!(v, vec![5i, 2, 3]);
1044
1045         e = v.swap_remove(3);
1046         assert_eq!(e, None);
1047         assert_eq!(v, vec![5i, 2, 3]);
1048     }
1049
1050     #[test]
1051     fn test_swap_remove_noncopyable() {
1052         // Tests that we don't accidentally run destructors twice.
1053         let mut v = vec![rt::exclusive::Exclusive::new(()),
1054                          rt::exclusive::Exclusive::new(()),
1055                          rt::exclusive::Exclusive::new(())];
1056         let mut _e = v.swap_remove(0);
1057         assert_eq!(v.len(), 2);
1058         _e = v.swap_remove(1);
1059         assert_eq!(v.len(), 1);
1060         _e = v.swap_remove(0);
1061         assert_eq!(v.len(), 0);
1062     }
1063
1064     #[test]
1065     fn test_push() {
1066         // Test on-stack push().
1067         let mut v = vec![];
1068         v.push(1i);
1069         assert_eq!(v.len(), 1u);
1070         assert_eq!(v.as_slice()[0], 1);
1071
1072         // Test on-heap push().
1073         v.push(2i);
1074         assert_eq!(v.len(), 2u);
1075         assert_eq!(v.as_slice()[0], 1);
1076         assert_eq!(v.as_slice()[1], 2);
1077     }
1078
1079     #[test]
1080     fn test_grow() {
1081         // Test on-stack grow().
1082         let mut v = vec![];
1083         v.grow(2u, &1i);
1084         {
1085             let v = v.as_slice();
1086             assert_eq!(v.len(), 2u);
1087             assert_eq!(v[0], 1);
1088             assert_eq!(v[1], 1);
1089         }
1090
1091         // Test on-heap grow().
1092         v.grow(3u, &2i);
1093         {
1094             let v = v.as_slice();
1095             assert_eq!(v.len(), 5u);
1096             assert_eq!(v[0], 1);
1097             assert_eq!(v[1], 1);
1098             assert_eq!(v[2], 2);
1099             assert_eq!(v[3], 2);
1100             assert_eq!(v[4], 2);
1101         }
1102     }
1103
1104     #[test]
1105     fn test_grow_fn() {
1106         let mut v = vec![];
1107         v.grow_fn(3u, square);
1108         let v = v.as_slice();
1109         assert_eq!(v.len(), 3u);
1110         assert_eq!(v[0], 0u);
1111         assert_eq!(v[1], 1u);
1112         assert_eq!(v[2], 4u);
1113     }
1114
1115     #[test]
1116     fn test_grow_set() {
1117         let mut v = vec![1i, 2, 3];
1118         v.grow_set(4u, &4, 5);
1119         let v = v.as_slice();
1120         assert_eq!(v.len(), 5u);
1121         assert_eq!(v[0], 1);
1122         assert_eq!(v[1], 2);
1123         assert_eq!(v[2], 3);
1124         assert_eq!(v[3], 4);
1125         assert_eq!(v[4], 5);
1126     }
1127
1128     #[test]
1129     fn test_truncate() {
1130         let mut v = vec![box 6i,box 5,box 4];
1131         v.truncate(1);
1132         let v = v.as_slice();
1133         assert_eq!(v.len(), 1);
1134         assert_eq!(*(v[0]), 6);
1135         // If the unsafe block didn't drop things properly, we blow up here.
1136     }
1137
1138     #[test]
1139     fn test_clear() {
1140         let mut v = vec![box 6i,box 5,box 4];
1141         v.clear();
1142         assert_eq!(v.len(), 0);
1143         // If the unsafe block didn't drop things properly, we blow up here.
1144     }
1145
1146     #[test]
1147     fn test_dedup() {
1148         fn case(a: Vec<uint>, b: Vec<uint>) {
1149             let mut v = a;
1150             v.dedup();
1151             assert_eq!(v, b);
1152         }
1153         case(vec![], vec![]);
1154         case(vec![1u], vec![1]);
1155         case(vec![1u,1], vec![1]);
1156         case(vec![1u,2,3], vec![1,2,3]);
1157         case(vec![1u,1,2,3], vec![1,2,3]);
1158         case(vec![1u,2,2,3], vec![1,2,3]);
1159         case(vec![1u,2,3,3], vec![1,2,3]);
1160         case(vec![1u,1,2,2,2,3,3], vec![1,2,3]);
1161     }
1162
1163     #[test]
1164     fn test_dedup_unique() {
1165         let mut v0 = vec![box 1i, box 1, box 2, box 3];
1166         v0.dedup();
1167         let mut v1 = vec![box 1i, box 2, box 2, box 3];
1168         v1.dedup();
1169         let mut v2 = vec![box 1i, box 2, box 3, box 3];
1170         v2.dedup();
1171         /*
1172          * If the boxed pointers were leaked or otherwise misused, valgrind
1173          * and/or rustrt should raise errors.
1174          */
1175     }
1176
1177     #[test]
1178     fn test_dedup_shared() {
1179         let mut v0 = vec![box 1i, box 1, box 2, box 3];
1180         v0.dedup();
1181         let mut v1 = vec![box 1i, box 2, box 2, box 3];
1182         v1.dedup();
1183         let mut v2 = vec![box 1i, box 2, box 3, box 3];
1184         v2.dedup();
1185         /*
1186          * If the pointers were leaked or otherwise misused, valgrind and/or
1187          * rustrt should raise errors.
1188          */
1189     }
1190
1191     #[test]
1192     fn test_retain() {
1193         let mut v = vec![1u, 2, 3, 4, 5];
1194         v.retain(is_odd);
1195         assert_eq!(v, vec![1u, 3, 5]);
1196     }
1197
1198     #[test]
1199     fn test_element_swaps() {
1200         let mut v = [1i, 2, 3];
1201         for (i, (a, b)) in ElementSwaps::new(v.len()).enumerate() {
1202             v.swap(a, b);
1203             match i {
1204                 0 => assert!(v == [1, 3, 2]),
1205                 1 => assert!(v == [3, 1, 2]),
1206                 2 => assert!(v == [3, 2, 1]),
1207                 3 => assert!(v == [2, 3, 1]),
1208                 4 => assert!(v == [2, 1, 3]),
1209                 5 => assert!(v == [1, 2, 3]),
1210                 _ => fail!(),
1211             }
1212         }
1213     }
1214
1215     #[test]
1216     fn test_permutations() {
1217         {
1218             let v: [int, ..0] = [];
1219             let mut it = v.permutations();
1220             let (min_size, max_opt) = it.size_hint();
1221             assert_eq!(min_size, 1);
1222             assert_eq!(max_opt.unwrap(), 1);
1223             assert_eq!(it.next(), Some(v.as_slice().to_vec()));
1224             assert_eq!(it.next(), None);
1225         }
1226         {
1227             let v = ["Hello".to_string()];
1228             let mut it = v.permutations();
1229             let (min_size, max_opt) = it.size_hint();
1230             assert_eq!(min_size, 1);
1231             assert_eq!(max_opt.unwrap(), 1);
1232             assert_eq!(it.next(), Some(v.as_slice().to_vec()));
1233             assert_eq!(it.next(), None);
1234         }
1235         {
1236             let v = [1i, 2, 3];
1237             let mut it = v.permutations();
1238             let (min_size, max_opt) = it.size_hint();
1239             assert_eq!(min_size, 3*2);
1240             assert_eq!(max_opt.unwrap(), 3*2);
1241             assert_eq!(it.next(), Some(vec![1,2,3]));
1242             assert_eq!(it.next(), Some(vec![1,3,2]));
1243             assert_eq!(it.next(), Some(vec![3,1,2]));
1244             let (min_size, max_opt) = it.size_hint();
1245             assert_eq!(min_size, 3);
1246             assert_eq!(max_opt.unwrap(), 3);
1247             assert_eq!(it.next(), Some(vec![3,2,1]));
1248             assert_eq!(it.next(), Some(vec![2,3,1]));
1249             assert_eq!(it.next(), Some(vec![2,1,3]));
1250             assert_eq!(it.next(), None);
1251         }
1252         {
1253             // check that we have N! permutations
1254             let v = ['A', 'B', 'C', 'D', 'E', 'F'];
1255             let mut amt = 0;
1256             let mut it = v.permutations();
1257             let (min_size, max_opt) = it.size_hint();
1258             for _perm in it {
1259                 amt += 1;
1260             }
1261             assert_eq!(amt, it.swaps.swaps_made);
1262             assert_eq!(amt, min_size);
1263             assert_eq!(amt, 2 * 3 * 4 * 5 * 6);
1264             assert_eq!(amt, max_opt.unwrap());
1265         }
1266     }
1267
1268     #[test]
1269     fn test_lexicographic_permutations() {
1270         let v : &mut[int] = &mut[1i, 2, 3, 4, 5];
1271         assert!(v.prev_permutation() == false);
1272         assert!(v.next_permutation());
1273         assert_eq!(v, &mut[1, 2, 3, 5, 4]);
1274         assert!(v.prev_permutation());
1275         assert_eq!(v, &mut[1, 2, 3, 4, 5]);
1276         assert!(v.next_permutation());
1277         assert!(v.next_permutation());
1278         assert_eq!(v, &mut[1, 2, 4, 3, 5]);
1279         assert!(v.next_permutation());
1280         assert_eq!(v, &mut[1, 2, 4, 5, 3]);
1281
1282         let v : &mut[int] = &mut[1i, 0, 0, 0];
1283         assert!(v.next_permutation() == false);
1284         assert!(v.prev_permutation());
1285         assert_eq!(v, &mut[0, 1, 0, 0]);
1286         assert!(v.prev_permutation());
1287         assert_eq!(v, &mut[0, 0, 1, 0]);
1288         assert!(v.prev_permutation());
1289         assert_eq!(v, &mut[0, 0, 0, 1]);
1290         assert!(v.prev_permutation() == false);
1291     }
1292
1293     #[test]
1294     fn test_lexicographic_permutations_empty_and_short() {
1295         let empty : &mut[int] = &mut[];
1296         assert!(empty.next_permutation() == false);
1297         assert_eq!(empty, &mut[]);
1298         assert!(empty.prev_permutation() == false);
1299         assert_eq!(empty, &mut[]);
1300
1301         let one_elem : &mut[int] = &mut[4i];
1302         assert!(one_elem.prev_permutation() == false);
1303         assert_eq!(one_elem, &mut[4]);
1304         assert!(one_elem.next_permutation() == false);
1305         assert_eq!(one_elem, &mut[4]);
1306
1307         let two_elem : &mut[int] = &mut[1i, 2];
1308         assert!(two_elem.prev_permutation() == false);
1309         assert_eq!(two_elem, &mut[1, 2]);
1310         assert!(two_elem.next_permutation());
1311         assert_eq!(two_elem, &mut[2, 1]);
1312         assert!(two_elem.next_permutation() == false);
1313         assert_eq!(two_elem, &mut[2, 1]);
1314         assert!(two_elem.prev_permutation());
1315         assert_eq!(two_elem, &mut[1, 2]);
1316         assert!(two_elem.prev_permutation() == false);
1317         assert_eq!(two_elem, &mut[1, 2]);
1318     }
1319
1320     #[test]
1321     fn test_position_elem() {
1322         assert!([].position_elem(&1i).is_none());
1323
1324         let v1 = vec![1i, 2, 3, 3, 2, 5];
1325         assert_eq!(v1.as_slice().position_elem(&1), Some(0u));
1326         assert_eq!(v1.as_slice().position_elem(&2), Some(1u));
1327         assert_eq!(v1.as_slice().position_elem(&5), Some(5u));
1328         assert!(v1.as_slice().position_elem(&4).is_none());
1329     }
1330
1331     #[test]
1332     fn test_bsearch_elem() {
1333         assert_eq!([1i,2,3,4,5].bsearch_elem(&5), Some(4));
1334         assert_eq!([1i,2,3,4,5].bsearch_elem(&4), Some(3));
1335         assert_eq!([1i,2,3,4,5].bsearch_elem(&3), Some(2));
1336         assert_eq!([1i,2,3,4,5].bsearch_elem(&2), Some(1));
1337         assert_eq!([1i,2,3,4,5].bsearch_elem(&1), Some(0));
1338
1339         assert_eq!([2i,4,6,8,10].bsearch_elem(&1), None);
1340         assert_eq!([2i,4,6,8,10].bsearch_elem(&5), None);
1341         assert_eq!([2i,4,6,8,10].bsearch_elem(&4), Some(1));
1342         assert_eq!([2i,4,6,8,10].bsearch_elem(&10), Some(4));
1343
1344         assert_eq!([2i,4,6,8].bsearch_elem(&1), None);
1345         assert_eq!([2i,4,6,8].bsearch_elem(&5), None);
1346         assert_eq!([2i,4,6,8].bsearch_elem(&4), Some(1));
1347         assert_eq!([2i,4,6,8].bsearch_elem(&8), Some(3));
1348
1349         assert_eq!([2i,4,6].bsearch_elem(&1), None);
1350         assert_eq!([2i,4,6].bsearch_elem(&5), None);
1351         assert_eq!([2i,4,6].bsearch_elem(&4), Some(1));
1352         assert_eq!([2i,4,6].bsearch_elem(&6), Some(2));
1353
1354         assert_eq!([2i,4].bsearch_elem(&1), None);
1355         assert_eq!([2i,4].bsearch_elem(&5), None);
1356         assert_eq!([2i,4].bsearch_elem(&2), Some(0));
1357         assert_eq!([2i,4].bsearch_elem(&4), Some(1));
1358
1359         assert_eq!([2i].bsearch_elem(&1), None);
1360         assert_eq!([2i].bsearch_elem(&5), None);
1361         assert_eq!([2i].bsearch_elem(&2), Some(0));
1362
1363         assert_eq!([].bsearch_elem(&1i), None);
1364         assert_eq!([].bsearch_elem(&5i), None);
1365
1366         assert!([1i,1,1,1,1].bsearch_elem(&1) != None);
1367         assert!([1i,1,1,1,2].bsearch_elem(&1) != None);
1368         assert!([1i,1,1,2,2].bsearch_elem(&1) != None);
1369         assert!([1i,1,2,2,2].bsearch_elem(&1) != None);
1370         assert_eq!([1i,2,2,2,2].bsearch_elem(&1), Some(0));
1371
1372         assert_eq!([1i,2,3,4,5].bsearch_elem(&6), None);
1373         assert_eq!([1i,2,3,4,5].bsearch_elem(&0), None);
1374     }
1375
1376     #[test]
1377     fn test_reverse() {
1378         let mut v: Vec<int> = vec![10i, 20];
1379         assert_eq!(*v.get(0), 10);
1380         assert_eq!(*v.get(1), 20);
1381         v.reverse();
1382         assert_eq!(*v.get(0), 20);
1383         assert_eq!(*v.get(1), 10);
1384
1385         let mut v3: Vec<int> = vec![];
1386         v3.reverse();
1387         assert!(v3.is_empty());
1388     }
1389
1390     #[test]
1391     fn test_sort() {
1392         for len in range(4u, 25) {
1393             for _ in range(0i, 100) {
1394                 let mut v = task_rng().gen_iter::<uint>().take(len)
1395                                       .collect::<Vec<uint>>();
1396                 let mut v1 = v.clone();
1397
1398                 v.as_mut_slice().sort();
1399                 assert!(v.as_slice().windows(2).all(|w| w[0] <= w[1]));
1400
1401                 v1.as_mut_slice().sort_by(|a, b| a.cmp(b));
1402                 assert!(v1.as_slice().windows(2).all(|w| w[0] <= w[1]));
1403
1404                 v1.as_mut_slice().sort_by(|a, b| b.cmp(a));
1405                 assert!(v1.as_slice().windows(2).all(|w| w[0] >= w[1]));
1406             }
1407         }
1408
1409         // shouldn't fail/crash
1410         let mut v: [uint, .. 0] = [];
1411         v.sort();
1412
1413         let mut v = [0xDEADBEEFu];
1414         v.sort();
1415         assert!(v == [0xDEADBEEF]);
1416     }
1417
1418     #[test]
1419     fn test_sort_stability() {
1420         for len in range(4i, 25) {
1421             for _ in range(0u, 10) {
1422                 let mut counts = [0i, .. 10];
1423
1424                 // create a vector like [(6, 1), (5, 1), (6, 2), ...],
1425                 // where the first item of each tuple is random, but
1426                 // the second item represents which occurrence of that
1427                 // number this element is, i.e. the second elements
1428                 // will occur in sorted order.
1429                 let mut v = range(0, len).map(|_| {
1430                         let n = task_rng().gen::<uint>() % 10;
1431                         counts[n] += 1;
1432                         (n, counts[n])
1433                     }).collect::<Vec<(uint, int)>>();
1434
1435                 // only sort on the first element, so an unstable sort
1436                 // may mix up the counts.
1437                 v.sort_by(|&(a,_), &(b,_)| a.cmp(&b));
1438
1439                 // this comparison includes the count (the second item
1440                 // of the tuple), so elements with equal first items
1441                 // will need to be ordered with increasing
1442                 // counts... i.e. exactly asserting that this sort is
1443                 // stable.
1444                 assert!(v.as_slice().windows(2).all(|w| w[0] <= w[1]));
1445             }
1446         }
1447     }
1448
1449     #[test]
1450     fn test_partition() {
1451         assert_eq!((vec![]).partition(|x: &int| *x < 3), (vec![], vec![]));
1452         assert_eq!((vec![1i, 2, 3]).partition(|x: &int| *x < 4), (vec![1, 2, 3], vec![]));
1453         assert_eq!((vec![1i, 2, 3]).partition(|x: &int| *x < 2), (vec![1], vec![2, 3]));
1454         assert_eq!((vec![1i, 2, 3]).partition(|x: &int| *x < 0), (vec![], vec![1, 2, 3]));
1455     }
1456
1457     #[test]
1458     fn test_partitioned() {
1459         assert_eq!(([]).partitioned(|x: &int| *x < 3), (vec![], vec![]));
1460         assert_eq!(([1i, 2, 3]).partitioned(|x: &int| *x < 4), (vec![1, 2, 3], vec![]));
1461         assert_eq!(([1i, 2, 3]).partitioned(|x: &int| *x < 2), (vec![1], vec![2, 3]));
1462         assert_eq!(([1i, 2, 3]).partitioned(|x: &int| *x < 0), (vec![], vec![1, 2, 3]));
1463     }
1464
1465     #[test]
1466     fn test_concat() {
1467         let v: [Vec<int>, ..0] = [];
1468         assert_eq!(v.concat_vec(), vec![]);
1469         assert_eq!([vec![1i], vec![2i,3i]].concat_vec(), vec![1, 2, 3]);
1470
1471         assert_eq!([&[1i], &[2i,3i]].concat_vec(), vec![1, 2, 3]);
1472     }
1473
1474     #[test]
1475     fn test_connect() {
1476         let v: [Vec<int>, ..0] = [];
1477         assert_eq!(v.connect_vec(&0), vec![]);
1478         assert_eq!([vec![1i], vec![2i, 3]].connect_vec(&0), vec![1, 0, 2, 3]);
1479         assert_eq!([vec![1i], vec![2i], vec![3i]].connect_vec(&0), vec![1, 0, 2, 0, 3]);
1480
1481         assert_eq!([&[1i], &[2i, 3]].connect_vec(&0), vec![1, 0, 2, 3]);
1482         assert_eq!([&[1i], &[2i], &[3]].connect_vec(&0), vec![1, 0, 2, 0, 3]);
1483     }
1484
1485     #[test]
1486     fn test_shift() {
1487         let mut x = vec![1i, 2, 3];
1488         assert_eq!(x.shift(), Some(1));
1489         assert_eq!(&x, &vec![2i, 3]);
1490         assert_eq!(x.shift(), Some(2));
1491         assert_eq!(x.shift(), Some(3));
1492         assert_eq!(x.shift(), None);
1493         assert_eq!(x.len(), 0);
1494     }
1495
1496     #[test]
1497     fn test_unshift() {
1498         let mut x = vec![1i, 2, 3];
1499         x.unshift(0);
1500         assert_eq!(x, vec![0, 1, 2, 3]);
1501     }
1502
1503     #[test]
1504     fn test_insert() {
1505         let mut a = vec![1i, 2, 4];
1506         a.insert(2, 3);
1507         assert_eq!(a, vec![1, 2, 3, 4]);
1508
1509         let mut a = vec![1i, 2, 3];
1510         a.insert(0, 0);
1511         assert_eq!(a, vec![0, 1, 2, 3]);
1512
1513         let mut a = vec![1i, 2, 3];
1514         a.insert(3, 4);
1515         assert_eq!(a, vec![1, 2, 3, 4]);
1516
1517         let mut a = vec![];
1518         a.insert(0, 1i);
1519         assert_eq!(a, vec![1]);
1520     }
1521
1522     #[test]
1523     #[should_fail]
1524     fn test_insert_oob() {
1525         let mut a = vec![1i, 2, 3];
1526         a.insert(4, 5);
1527     }
1528
1529     #[test]
1530     fn test_remove() {
1531         let mut a = vec![1i,2,3,4];
1532
1533         assert_eq!(a.remove(2), Some(3));
1534         assert_eq!(a, vec![1i,2,4]);
1535
1536         assert_eq!(a.remove(2), Some(4));
1537         assert_eq!(a, vec![1i,2]);
1538
1539         assert_eq!(a.remove(2), None);
1540         assert_eq!(a, vec![1i,2]);
1541
1542         assert_eq!(a.remove(0), Some(1));
1543         assert_eq!(a, vec![2i]);
1544
1545         assert_eq!(a.remove(0), Some(2));
1546         assert_eq!(a, vec![]);
1547
1548         assert_eq!(a.remove(0), None);
1549         assert_eq!(a.remove(10), None);
1550     }
1551
1552     #[test]
1553     fn test_capacity() {
1554         let mut v = vec![0u64];
1555         v.reserve_exact(10u);
1556         assert_eq!(v.capacity(), 10u);
1557         let mut v = vec![0u32];
1558         v.reserve_exact(10u);
1559         assert_eq!(v.capacity(), 10u);
1560     }
1561
1562     #[test]
1563     fn test_slice_2() {
1564         let v = vec![1i, 2, 3, 4, 5];
1565         let v = v.slice(1u, 3u);
1566         assert_eq!(v.len(), 2u);
1567         assert_eq!(v[0], 2);
1568         assert_eq!(v[1], 3);
1569     }
1570
1571
1572     #[test]
1573     #[should_fail]
1574     fn test_from_fn_fail() {
1575         Vec::from_fn(100, |v| {
1576             if v == 50 { fail!() }
1577             box 0i
1578         });
1579     }
1580
1581     #[test]
1582     #[should_fail]
1583     fn test_from_elem_fail() {
1584
1585         struct S {
1586             f: Cell<int>,
1587             boxes: (Box<int>, Rc<int>)
1588         }
1589
1590         impl Clone for S {
1591             fn clone(&self) -> S {
1592                 self.f.set(self.f.get() + 1);
1593                 if self.f.get() == 10 { fail!() }
1594                 S { f: self.f, boxes: self.boxes.clone() }
1595             }
1596         }
1597
1598         let s = S { f: Cell::new(0), boxes: (box 0, Rc::new(0)) };
1599         let _ = Vec::from_elem(100, s);
1600     }
1601
1602     #[test]
1603     #[should_fail]
1604     fn test_grow_fn_fail() {
1605         let mut v = vec![];
1606         v.grow_fn(100, |i| {
1607             if i == 50 {
1608                 fail!()
1609             }
1610             (box 0i, Rc::new(0i))
1611         })
1612     }
1613
1614     #[test]
1615     #[should_fail]
1616     fn test_permute_fail() {
1617         let v = [(box 0i, Rc::new(0i)), (box 0i, Rc::new(0i)),
1618                  (box 0i, Rc::new(0i)), (box 0i, Rc::new(0i))];
1619         let mut i = 0u;
1620         for _ in v.permutations() {
1621             if i == 2 {
1622                 fail!()
1623             }
1624             i += 1;
1625         }
1626     }
1627
1628     #[test]
1629     #[should_fail]
1630     fn test_copy_memory_oob() {
1631         unsafe {
1632             let mut a = [1i, 2, 3, 4];
1633             let b = [1i, 2, 3, 4, 5];
1634             a.copy_memory(b);
1635         }
1636     }
1637
1638     #[test]
1639     fn test_total_ord() {
1640         [1i, 2, 3, 4].cmp(& &[1, 2, 3]) == Greater;
1641         [1i, 2, 3].cmp(& &[1, 2, 3, 4]) == Less;
1642         [1i, 2, 3, 4].cmp(& &[1, 2, 3, 4]) == Equal;
1643         [1i, 2, 3, 4, 5, 5, 5, 5].cmp(& &[1, 2, 3, 4, 5, 6]) == Less;
1644         [2i, 2].cmp(& &[1, 2, 3, 4]) == Greater;
1645     }
1646
1647     #[test]
1648     fn test_iterator() {
1649         let xs = [1i, 2, 5, 10, 11];
1650         let mut it = xs.iter();
1651         assert_eq!(it.size_hint(), (5, Some(5)));
1652         assert_eq!(it.next().unwrap(), &1);
1653         assert_eq!(it.size_hint(), (4, Some(4)));
1654         assert_eq!(it.next().unwrap(), &2);
1655         assert_eq!(it.size_hint(), (3, Some(3)));
1656         assert_eq!(it.next().unwrap(), &5);
1657         assert_eq!(it.size_hint(), (2, Some(2)));
1658         assert_eq!(it.next().unwrap(), &10);
1659         assert_eq!(it.size_hint(), (1, Some(1)));
1660         assert_eq!(it.next().unwrap(), &11);
1661         assert_eq!(it.size_hint(), (0, Some(0)));
1662         assert!(it.next().is_none());
1663     }
1664
1665     #[test]
1666     fn test_random_access_iterator() {
1667         let xs = [1i, 2, 5, 10, 11];
1668         let mut it = xs.iter();
1669
1670         assert_eq!(it.indexable(), 5);
1671         assert_eq!(it.idx(0).unwrap(), &1);
1672         assert_eq!(it.idx(2).unwrap(), &5);
1673         assert_eq!(it.idx(4).unwrap(), &11);
1674         assert!(it.idx(5).is_none());
1675
1676         assert_eq!(it.next().unwrap(), &1);
1677         assert_eq!(it.indexable(), 4);
1678         assert_eq!(it.idx(0).unwrap(), &2);
1679         assert_eq!(it.idx(3).unwrap(), &11);
1680         assert!(it.idx(4).is_none());
1681
1682         assert_eq!(it.next().unwrap(), &2);
1683         assert_eq!(it.indexable(), 3);
1684         assert_eq!(it.idx(1).unwrap(), &10);
1685         assert!(it.idx(3).is_none());
1686
1687         assert_eq!(it.next().unwrap(), &5);
1688         assert_eq!(it.indexable(), 2);
1689         assert_eq!(it.idx(1).unwrap(), &11);
1690
1691         assert_eq!(it.next().unwrap(), &10);
1692         assert_eq!(it.indexable(), 1);
1693         assert_eq!(it.idx(0).unwrap(), &11);
1694         assert!(it.idx(1).is_none());
1695
1696         assert_eq!(it.next().unwrap(), &11);
1697         assert_eq!(it.indexable(), 0);
1698         assert!(it.idx(0).is_none());
1699
1700         assert!(it.next().is_none());
1701     }
1702
1703     #[test]
1704     fn test_iter_size_hints() {
1705         let mut xs = [1i, 2, 5, 10, 11];
1706         assert_eq!(xs.iter().size_hint(), (5, Some(5)));
1707         assert_eq!(xs.mut_iter().size_hint(), (5, Some(5)));
1708     }
1709
1710     #[test]
1711     fn test_iter_clone() {
1712         let xs = [1i, 2, 5];
1713         let mut it = xs.iter();
1714         it.next();
1715         let mut jt = it.clone();
1716         assert_eq!(it.next(), jt.next());
1717         assert_eq!(it.next(), jt.next());
1718         assert_eq!(it.next(), jt.next());
1719     }
1720
1721     #[test]
1722     fn test_mut_iterator() {
1723         let mut xs = [1i, 2, 3, 4, 5];
1724         for x in xs.mut_iter() {
1725             *x += 1;
1726         }
1727         assert!(xs == [2, 3, 4, 5, 6])
1728     }
1729
1730     #[test]
1731     fn test_rev_iterator() {
1732
1733         let xs = [1i, 2, 5, 10, 11];
1734         let ys = [11, 10, 5, 2, 1];
1735         let mut i = 0;
1736         for &x in xs.iter().rev() {
1737             assert_eq!(x, ys[i]);
1738             i += 1;
1739         }
1740         assert_eq!(i, 5);
1741     }
1742
1743     #[test]
1744     fn test_mut_rev_iterator() {
1745         let mut xs = [1u, 2, 3, 4, 5];
1746         for (i,x) in xs.mut_iter().rev().enumerate() {
1747             *x += i;
1748         }
1749         assert!(xs == [5, 5, 5, 5, 5])
1750     }
1751
1752     #[test]
1753     fn test_move_iterator() {
1754         let xs = vec![1u,2,3,4,5];
1755         assert_eq!(xs.move_iter().fold(0, |a: uint, b: uint| 10*a + b), 12345);
1756     }
1757
1758     #[test]
1759     fn test_move_rev_iterator() {
1760         let xs = vec![1u,2,3,4,5];
1761         assert_eq!(xs.move_iter().rev().fold(0, |a: uint, b: uint| 10*a + b), 54321);
1762     }
1763
1764     #[test]
1765     fn test_splitator() {
1766         let xs = &[1i,2,3,4,5];
1767
1768         assert_eq!(xs.split(|x| *x % 2 == 0).collect::<Vec<&[int]>>().as_slice(),
1769                    &[&[1], &[3], &[5]]);
1770         assert_eq!(xs.split(|x| *x == 1).collect::<Vec<&[int]>>().as_slice(),
1771                    &[&[], &[2,3,4,5]]);
1772         assert_eq!(xs.split(|x| *x == 5).collect::<Vec<&[int]>>().as_slice(),
1773                    &[&[1,2,3,4], &[]]);
1774         assert_eq!(xs.split(|x| *x == 10).collect::<Vec<&[int]>>().as_slice(),
1775                    &[&[1,2,3,4,5]]);
1776         assert_eq!(xs.split(|_| true).collect::<Vec<&[int]>>().as_slice(),
1777                    &[&[], &[], &[], &[], &[], &[]]);
1778
1779         let xs: &[int] = &[];
1780         assert_eq!(xs.split(|x| *x == 5).collect::<Vec<&[int]>>().as_slice(), &[&[]]);
1781     }
1782
1783     #[test]
1784     fn test_splitnator() {
1785         let xs = &[1i,2,3,4,5];
1786
1787         assert_eq!(xs.splitn(0, |x| *x % 2 == 0).collect::<Vec<&[int]>>().as_slice(),
1788                    &[&[1,2,3,4,5]]);
1789         assert_eq!(xs.splitn(1, |x| *x % 2 == 0).collect::<Vec<&[int]>>().as_slice(),
1790                    &[&[1], &[3,4,5]]);
1791         assert_eq!(xs.splitn(3, |_| true).collect::<Vec<&[int]>>().as_slice(),
1792                    &[&[], &[], &[], &[4,5]]);
1793
1794         let xs: &[int] = &[];
1795         assert_eq!(xs.splitn(1, |x| *x == 5).collect::<Vec<&[int]>>().as_slice(), &[&[]]);
1796     }
1797
1798     #[test]
1799     fn test_rsplitator() {
1800         let xs = &[1i,2,3,4,5];
1801
1802         assert_eq!(xs.split(|x| *x % 2 == 0).rev().collect::<Vec<&[int]>>().as_slice(),
1803                    &[&[5], &[3], &[1]]);
1804         assert_eq!(xs.split(|x| *x == 1).rev().collect::<Vec<&[int]>>().as_slice(),
1805                    &[&[2,3,4,5], &[]]);
1806         assert_eq!(xs.split(|x| *x == 5).rev().collect::<Vec<&[int]>>().as_slice(),
1807                    &[&[], &[1,2,3,4]]);
1808         assert_eq!(xs.split(|x| *x == 10).rev().collect::<Vec<&[int]>>().as_slice(),
1809                    &[&[1,2,3,4,5]]);
1810
1811         let xs: &[int] = &[];
1812         assert_eq!(xs.split(|x| *x == 5).rev().collect::<Vec<&[int]>>().as_slice(), &[&[]]);
1813     }
1814
1815     #[test]
1816     fn test_rsplitnator() {
1817         let xs = &[1,2,3,4,5];
1818
1819         assert_eq!(xs.rsplitn(0, |x| *x % 2 == 0).collect::<Vec<&[int]>>().as_slice(),
1820                    &[&[1,2,3,4,5]]);
1821         assert_eq!(xs.rsplitn(1, |x| *x % 2 == 0).collect::<Vec<&[int]>>().as_slice(),
1822                    &[&[5], &[1,2,3]]);
1823         assert_eq!(xs.rsplitn(3, |_| true).collect::<Vec<&[int]>>().as_slice(),
1824                    &[&[], &[], &[], &[1,2]]);
1825
1826         let xs: &[int] = &[];
1827         assert_eq!(xs.rsplitn(1, |x| *x == 5).collect::<Vec<&[int]>>().as_slice(), &[&[]]);
1828     }
1829
1830     #[test]
1831     fn test_windowsator() {
1832         let v = &[1i,2,3,4];
1833
1834         assert_eq!(v.windows(2).collect::<Vec<&[int]>>().as_slice(), &[&[1,2], &[2,3], &[3,4]]);
1835         assert_eq!(v.windows(3).collect::<Vec<&[int]>>().as_slice(), &[&[1i,2,3], &[2,3,4]]);
1836         assert!(v.windows(6).next().is_none());
1837     }
1838
1839     #[test]
1840     #[should_fail]
1841     fn test_windowsator_0() {
1842         let v = &[1i,2,3,4];
1843         let _it = v.windows(0);
1844     }
1845
1846     #[test]
1847     fn test_chunksator() {
1848         let v = &[1i,2,3,4,5];
1849
1850         assert_eq!(v.chunks(2).collect::<Vec<&[int]>>().as_slice(), &[&[1i,2], &[3,4], &[5]]);
1851         assert_eq!(v.chunks(3).collect::<Vec<&[int]>>().as_slice(), &[&[1i,2,3], &[4,5]]);
1852         assert_eq!(v.chunks(6).collect::<Vec<&[int]>>().as_slice(), &[&[1i,2,3,4,5]]);
1853
1854         assert_eq!(v.chunks(2).rev().collect::<Vec<&[int]>>().as_slice(), &[&[5i], &[3,4], &[1,2]]);
1855         let mut it = v.chunks(2);
1856         assert_eq!(it.indexable(), 3);
1857         assert_eq!(it.idx(0).unwrap(), &[1,2]);
1858         assert_eq!(it.idx(1).unwrap(), &[3,4]);
1859         assert_eq!(it.idx(2).unwrap(), &[5]);
1860         assert_eq!(it.idx(3), None);
1861     }
1862
1863     #[test]
1864     #[should_fail]
1865     fn test_chunksator_0() {
1866         let v = &[1i,2,3,4];
1867         let _it = v.chunks(0);
1868     }
1869
1870     #[test]
1871     fn test_move_from() {
1872         let mut a = [1i,2,3,4,5];
1873         let b = vec![6i,7,8];
1874         assert_eq!(a.move_from(b, 0, 3), 3);
1875         assert!(a == [6i,7,8,4,5]);
1876         let mut a = [7i,2,8,1];
1877         let b = vec![3i,1,4,1,5,9];
1878         assert_eq!(a.move_from(b, 0, 6), 4);
1879         assert!(a == [3i,1,4,1]);
1880         let mut a = [1i,2,3,4];
1881         let b = vec![5i,6,7,8,9,0];
1882         assert_eq!(a.move_from(b, 2, 3), 1);
1883         assert!(a == [7i,2,3,4]);
1884         let mut a = [1i,2,3,4,5];
1885         let b = vec![5i,6,7,8,9,0];
1886         assert_eq!(a.mut_slice(2,4).move_from(b,1,6), 2);
1887         assert!(a == [1i,2,6,7,5]);
1888     }
1889
1890     #[test]
1891     fn test_copy_from() {
1892         let mut a = [1i,2,3,4,5];
1893         let b = [6i,7,8];
1894         assert_eq!(a.copy_from(b), 3);
1895         assert!(a == [6i,7,8,4,5]);
1896         let mut c = [7i,2,8,1];
1897         let d = [3i,1,4,1,5,9];
1898         assert_eq!(c.copy_from(d), 4);
1899         assert!(c == [3i,1,4,1]);
1900     }
1901
1902     #[test]
1903     fn test_reverse_part() {
1904         let mut values = [1i,2,3,4,5];
1905         values.mut_slice(1, 4).reverse();
1906         assert!(values == [1,4,3,2,5]);
1907     }
1908
1909     #[test]
1910     fn test_show() {
1911         macro_rules! test_show_vec(
1912             ($x:expr, $x_str:expr) => ({
1913                 let (x, x_str) = ($x, $x_str);
1914                 assert_eq!(format!("{}", x), x_str);
1915                 assert_eq!(format!("{}", x.as_slice()), x_str);
1916             })
1917         )
1918         let empty: Vec<int> = vec![];
1919         test_show_vec!(empty, "[]".to_string());
1920         test_show_vec!(vec![1i], "[1]".to_string());
1921         test_show_vec!(vec![1i, 2, 3], "[1, 2, 3]".to_string());
1922         test_show_vec!(vec![vec![], vec![1u], vec![1u, 1u]],
1923                        "[[], [1], [1, 1]]".to_string());
1924
1925         let empty_mut: &mut [int] = &mut[];
1926         test_show_vec!(empty_mut, "[]".to_string());
1927         test_show_vec!(&mut[1i], "[1]".to_string());
1928         test_show_vec!(&mut[1i, 2, 3], "[1, 2, 3]".to_string());
1929         test_show_vec!(&mut[&mut[], &mut[1u], &mut[1u, 1u]],
1930                        "[[], [1], [1, 1]]".to_string());
1931     }
1932
1933     #[test]
1934     fn test_vec_default() {
1935         macro_rules! t (
1936             ($ty:ty) => {{
1937                 let v: $ty = Default::default();
1938                 assert!(v.is_empty());
1939             }}
1940         );
1941
1942         t!(&[int]);
1943         t!(Vec<int>);
1944     }
1945
1946     #[test]
1947     fn test_bytes_set_memory() {
1948         use slice::bytes::MutableByteVector;
1949         let mut values = [1u8,2,3,4,5];
1950         values.mut_slice(0,5).set_memory(0xAB);
1951         assert!(values == [0xAB, 0xAB, 0xAB, 0xAB, 0xAB]);
1952         values.mut_slice(2,4).set_memory(0xFF);
1953         assert!(values == [0xAB, 0xAB, 0xFF, 0xFF, 0xAB]);
1954     }
1955
1956     #[test]
1957     #[should_fail]
1958     fn test_overflow_does_not_cause_segfault() {
1959         let mut v = vec![];
1960         v.reserve_exact(-1);
1961         v.push(1i);
1962         v.push(2);
1963     }
1964
1965     #[test]
1966     #[should_fail]
1967     fn test_overflow_does_not_cause_segfault_managed() {
1968         let mut v = vec![Rc::new(1i)];
1969         v.reserve_exact(-1);
1970         v.push(Rc::new(2i));
1971     }
1972
1973     #[test]
1974     fn test_mut_split_at() {
1975         let mut values = [1u8,2,3,4,5];
1976         {
1977             let (left, right) = values.mut_split_at(2);
1978             assert!(left.slice(0, left.len()) == [1, 2]);
1979             for p in left.mut_iter() {
1980                 *p += 1;
1981             }
1982
1983             assert!(right.slice(0, right.len()) == [3, 4, 5]);
1984             for p in right.mut_iter() {
1985                 *p += 2;
1986             }
1987         }
1988
1989         assert!(values == [2, 3, 5, 6, 7]);
1990     }
1991
1992     #[deriving(Clone, PartialEq)]
1993     struct Foo;
1994
1995     #[test]
1996     fn test_iter_zero_sized() {
1997         let mut v = vec![Foo, Foo, Foo];
1998         assert_eq!(v.len(), 3);
1999         let mut cnt = 0u;
2000
2001         for f in v.iter() {
2002             assert!(*f == Foo);
2003             cnt += 1;
2004         }
2005         assert_eq!(cnt, 3);
2006
2007         for f in v.slice(1, 3).iter() {
2008             assert!(*f == Foo);
2009             cnt += 1;
2010         }
2011         assert_eq!(cnt, 5);
2012
2013         for f in v.mut_iter() {
2014             assert!(*f == Foo);
2015             cnt += 1;
2016         }
2017         assert_eq!(cnt, 8);
2018
2019         for f in v.move_iter() {
2020             assert!(f == Foo);
2021             cnt += 1;
2022         }
2023         assert_eq!(cnt, 11);
2024
2025         let xs: [Foo, ..3] = [Foo, Foo, Foo];
2026         cnt = 0;
2027         for f in xs.iter() {
2028             assert!(*f == Foo);
2029             cnt += 1;
2030         }
2031         assert!(cnt == 3);
2032     }
2033
2034     #[test]
2035     fn test_shrink_to_fit() {
2036         let mut xs = vec![0, 1, 2, 3];
2037         for i in range(4i, 100) {
2038             xs.push(i)
2039         }
2040         assert_eq!(xs.capacity(), 128);
2041         xs.shrink_to_fit();
2042         assert_eq!(xs.capacity(), 100);
2043         assert_eq!(xs, range(0i, 100i).collect::<Vec<_>>());
2044     }
2045
2046     #[test]
2047     fn test_starts_with() {
2048         assert!(b"foobar".starts_with(b"foo"));
2049         assert!(!b"foobar".starts_with(b"oob"));
2050         assert!(!b"foobar".starts_with(b"bar"));
2051         assert!(!b"foo".starts_with(b"foobar"));
2052         assert!(!b"bar".starts_with(b"foobar"));
2053         assert!(b"foobar".starts_with(b"foobar"));
2054         let empty: &[u8] = [];
2055         assert!(empty.starts_with(empty));
2056         assert!(!empty.starts_with(b"foo"));
2057         assert!(b"foobar".starts_with(empty));
2058     }
2059
2060     #[test]
2061     fn test_ends_with() {
2062         assert!(b"foobar".ends_with(b"bar"));
2063         assert!(!b"foobar".ends_with(b"oba"));
2064         assert!(!b"foobar".ends_with(b"foo"));
2065         assert!(!b"foo".ends_with(b"foobar"));
2066         assert!(!b"bar".ends_with(b"foobar"));
2067         assert!(b"foobar".ends_with(b"foobar"));
2068         let empty: &[u8] = [];
2069         assert!(empty.ends_with(empty));
2070         assert!(!empty.ends_with(b"foo"));
2071         assert!(b"foobar".ends_with(empty));
2072     }
2073
2074     #[test]
2075     fn test_shift_ref() {
2076         let mut x: &[int] = [1, 2, 3, 4, 5];
2077         let h = x.shift_ref();
2078         assert_eq!(*h.unwrap(), 1);
2079         assert_eq!(x.len(), 4);
2080         assert_eq!(x[0], 2);
2081         assert_eq!(x[3], 5);
2082
2083         let mut y: &[int] = [];
2084         assert_eq!(y.shift_ref(), None);
2085     }
2086
2087     #[test]
2088     fn test_pop_ref() {
2089         let mut x: &[int] = [1, 2, 3, 4, 5];
2090         let h = x.pop_ref();
2091         assert_eq!(*h.unwrap(), 5);
2092         assert_eq!(x.len(), 4);
2093         assert_eq!(x[0], 1);
2094         assert_eq!(x[3], 4);
2095
2096         let mut y: &[int] = [];
2097         assert!(y.pop_ref().is_none());
2098     }
2099
2100     #[test]
2101     fn test_mut_splitator() {
2102         let mut xs = [0i,1,0,2,3,0,0,4,5,0];
2103         assert_eq!(xs.mut_split(|x| *x == 0).count(), 6);
2104         for slice in xs.mut_split(|x| *x == 0) {
2105             slice.reverse();
2106         }
2107         assert!(xs == [0,1,0,3,2,0,0,5,4,0]);
2108
2109         let mut xs = [0i,1,0,2,3,0,0,4,5,0,6,7];
2110         for slice in xs.mut_split(|x| *x == 0).take(5) {
2111             slice.reverse();
2112         }
2113         assert!(xs == [0,1,0,3,2,0,0,5,4,0,6,7]);
2114     }
2115
2116     #[test]
2117     fn test_mut_splitator_rev() {
2118         let mut xs = [1i,2,0,3,4,0,0,5,6,0];
2119         for slice in xs.mut_split(|x| *x == 0).rev().take(4) {
2120             slice.reverse();
2121         }
2122         assert!(xs == [1,2,0,4,3,0,0,6,5,0]);
2123     }
2124
2125     #[test]
2126     fn test_get_mut() {
2127         let mut v = [0i,1,2];
2128         assert_eq!(v.get_mut(3), None);
2129         v.get_mut(1).map(|e| *e = 7);
2130         assert_eq!(v[1], 7);
2131         let mut x = 2;
2132         assert_eq!(v.get_mut(2), Some(&mut x));
2133     }
2134
2135     #[test]
2136     fn test_mut_chunks() {
2137         let mut v = [0u8, 1, 2, 3, 4, 5, 6];
2138         for (i, chunk) in v.mut_chunks(3).enumerate() {
2139             for x in chunk.mut_iter() {
2140                 *x = i as u8;
2141             }
2142         }
2143         let result = [0u8, 0, 0, 1, 1, 1, 2];
2144         assert!(v == result);
2145     }
2146
2147     #[test]
2148     fn test_mut_chunks_rev() {
2149         let mut v = [0u8, 1, 2, 3, 4, 5, 6];
2150         for (i, chunk) in v.mut_chunks(3).rev().enumerate() {
2151             for x in chunk.mut_iter() {
2152                 *x = i as u8;
2153             }
2154         }
2155         let result = [2u8, 2, 2, 1, 1, 1, 0];
2156         assert!(v == result);
2157     }
2158
2159     #[test]
2160     #[should_fail]
2161     fn test_mut_chunks_0() {
2162         let mut v = [1i, 2, 3, 4];
2163         let _it = v.mut_chunks(0);
2164     }
2165
2166     #[test]
2167     fn test_mut_shift_ref() {
2168         let mut x: &mut [int] = [1, 2, 3, 4, 5];
2169         let h = x.mut_shift_ref();
2170         assert_eq!(*h.unwrap(), 1);
2171         assert_eq!(x.len(), 4);
2172         assert_eq!(x[0], 2);
2173         assert_eq!(x[3], 5);
2174
2175         let mut y: &mut [int] = [];
2176         assert!(y.mut_shift_ref().is_none());
2177     }
2178
2179     #[test]
2180     fn test_mut_pop_ref() {
2181         let mut x: &mut [int] = [1, 2, 3, 4, 5];
2182         let h = x.mut_pop_ref();
2183         assert_eq!(*h.unwrap(), 5);
2184         assert_eq!(x.len(), 4);
2185         assert_eq!(x[0], 1);
2186         assert_eq!(x[3], 4);
2187
2188         let mut y: &mut [int] = [];
2189         assert!(y.mut_pop_ref().is_none());
2190     }
2191
2192     #[test]
2193     fn test_mut_last() {
2194         let mut x = [1i, 2, 3, 4, 5];
2195         let h = x.mut_last();
2196         assert_eq!(*h.unwrap(), 5);
2197
2198         let y: &mut [int] = [];
2199         assert!(y.mut_last().is_none());
2200     }
2201 }
2202
2203 #[cfg(test)]
2204 mod bench {
2205     use std::prelude::*;
2206     use std::rand::{weak_rng, Rng};
2207     use std::mem;
2208     use std::ptr;
2209     use test::Bencher;
2210
2211     use vec::Vec;
2212     use MutableSeq;
2213
2214     #[bench]
2215     fn iterator(b: &mut Bencher) {
2216         // peculiar numbers to stop LLVM from optimising the summation
2217         // out.
2218         let v = Vec::from_fn(100, |i| i ^ (i << 1) ^ (i >> 1));
2219
2220         b.iter(|| {
2221             let mut sum = 0;
2222             for x in v.iter() {
2223                 sum += *x;
2224             }
2225             // sum == 11806, to stop dead code elimination.
2226             if sum == 0 {fail!()}
2227         })
2228     }
2229
2230     #[bench]
2231     fn mut_iterator(b: &mut Bencher) {
2232         let mut v = Vec::from_elem(100, 0i);
2233
2234         b.iter(|| {
2235             let mut i = 0i;
2236             for x in v.mut_iter() {
2237                 *x = i;
2238                 i += 1;
2239             }
2240         })
2241     }
2242
2243     #[bench]
2244     fn concat(b: &mut Bencher) {
2245         let xss: Vec<Vec<uint>> =
2246             Vec::from_fn(100, |i| range(0u, i).collect());
2247         b.iter(|| {
2248             xss.as_slice().concat_vec()
2249         });
2250     }
2251
2252     #[bench]
2253     fn connect(b: &mut Bencher) {
2254         let xss: Vec<Vec<uint>> =
2255             Vec::from_fn(100, |i| range(0u, i).collect());
2256         b.iter(|| {
2257             xss.as_slice().connect_vec(&0)
2258         });
2259     }
2260
2261     #[bench]
2262     fn push(b: &mut Bencher) {
2263         let mut vec: Vec<uint> = vec![];
2264         b.iter(|| {
2265             vec.push(0);
2266             &vec
2267         })
2268     }
2269
2270     #[bench]
2271     fn starts_with_same_vector(b: &mut Bencher) {
2272         let vec: Vec<uint> = Vec::from_fn(100, |i| i);
2273         b.iter(|| {
2274             vec.as_slice().starts_with(vec.as_slice())
2275         })
2276     }
2277
2278     #[bench]
2279     fn starts_with_single_element(b: &mut Bencher) {
2280         let vec: Vec<uint> = vec![0];
2281         b.iter(|| {
2282             vec.as_slice().starts_with(vec.as_slice())
2283         })
2284     }
2285
2286     #[bench]
2287     fn starts_with_diff_one_element_at_end(b: &mut Bencher) {
2288         let vec: Vec<uint> = Vec::from_fn(100, |i| i);
2289         let mut match_vec: Vec<uint> = Vec::from_fn(99, |i| i);
2290         match_vec.push(0);
2291         b.iter(|| {
2292             vec.as_slice().starts_with(match_vec.as_slice())
2293         })
2294     }
2295
2296     #[bench]
2297     fn ends_with_same_vector(b: &mut Bencher) {
2298         let vec: Vec<uint> = Vec::from_fn(100, |i| i);
2299         b.iter(|| {
2300             vec.as_slice().ends_with(vec.as_slice())
2301         })
2302     }
2303
2304     #[bench]
2305     fn ends_with_single_element(b: &mut Bencher) {
2306         let vec: Vec<uint> = vec![0];
2307         b.iter(|| {
2308             vec.as_slice().ends_with(vec.as_slice())
2309         })
2310     }
2311
2312     #[bench]
2313     fn ends_with_diff_one_element_at_beginning(b: &mut Bencher) {
2314         let vec: Vec<uint> = Vec::from_fn(100, |i| i);
2315         let mut match_vec: Vec<uint> = Vec::from_fn(100, |i| i);
2316         match_vec.as_mut_slice()[0] = 200;
2317         b.iter(|| {
2318             vec.as_slice().starts_with(match_vec.as_slice())
2319         })
2320     }
2321
2322     #[bench]
2323     fn contains_last_element(b: &mut Bencher) {
2324         let vec: Vec<uint> = Vec::from_fn(100, |i| i);
2325         b.iter(|| {
2326             vec.contains(&99u)
2327         })
2328     }
2329
2330     #[bench]
2331     fn zero_1kb_from_elem(b: &mut Bencher) {
2332         b.iter(|| {
2333             Vec::from_elem(1024, 0u8)
2334         });
2335     }
2336
2337     #[bench]
2338     fn zero_1kb_set_memory(b: &mut Bencher) {
2339         b.iter(|| {
2340             let mut v: Vec<uint> = Vec::with_capacity(1024);
2341             unsafe {
2342                 let vp = v.as_mut_ptr();
2343                 ptr::set_memory(vp, 0, 1024);
2344                 v.set_len(1024);
2345             }
2346             v
2347         });
2348     }
2349
2350     #[bench]
2351     fn zero_1kb_loop_set(b: &mut Bencher) {
2352         b.iter(|| {
2353             let mut v: Vec<uint> = Vec::with_capacity(1024);
2354             unsafe {
2355                 v.set_len(1024);
2356             }
2357             for i in range(0u, 1024) {
2358                 *v.get_mut(i) = 0;
2359             }
2360         });
2361     }
2362
2363     #[bench]
2364     fn zero_1kb_mut_iter(b: &mut Bencher) {
2365         b.iter(|| {
2366             let mut v = Vec::with_capacity(1024);
2367             unsafe {
2368                 v.set_len(1024);
2369             }
2370             for x in v.mut_iter() {
2371                 *x = 0i;
2372             }
2373             v
2374         });
2375     }
2376
2377     #[bench]
2378     fn random_inserts(b: &mut Bencher) {
2379         let mut rng = weak_rng();
2380         b.iter(|| {
2381                 let mut v = Vec::from_elem(30, (0u, 0u));
2382                 for _ in range(0u, 100) {
2383                     let l = v.len();
2384                     v.insert(rng.gen::<uint>() % (l + 1),
2385                              (1, 1));
2386                 }
2387             })
2388     }
2389     #[bench]
2390     fn random_removes(b: &mut Bencher) {
2391         let mut rng = weak_rng();
2392         b.iter(|| {
2393                 let mut v = Vec::from_elem(130, (0u, 0u));
2394                 for _ in range(0u, 100) {
2395                     let l = v.len();
2396                     v.remove(rng.gen::<uint>() % l);
2397                 }
2398             })
2399     }
2400
2401     #[bench]
2402     fn sort_random_small(b: &mut Bencher) {
2403         let mut rng = weak_rng();
2404         b.iter(|| {
2405             let mut v = rng.gen_iter::<u64>().take(5).collect::<Vec<u64>>();
2406             v.as_mut_slice().sort();
2407         });
2408         b.bytes = 5 * mem::size_of::<u64>() as u64;
2409     }
2410
2411     #[bench]
2412     fn sort_random_medium(b: &mut Bencher) {
2413         let mut rng = weak_rng();
2414         b.iter(|| {
2415             let mut v = rng.gen_iter::<u64>().take(100).collect::<Vec<u64>>();
2416             v.as_mut_slice().sort();
2417         });
2418         b.bytes = 100 * mem::size_of::<u64>() as u64;
2419     }
2420
2421     #[bench]
2422     fn sort_random_large(b: &mut Bencher) {
2423         let mut rng = weak_rng();
2424         b.iter(|| {
2425             let mut v = rng.gen_iter::<u64>().take(10000).collect::<Vec<u64>>();
2426             v.as_mut_slice().sort();
2427         });
2428         b.bytes = 10000 * mem::size_of::<u64>() as u64;
2429     }
2430
2431     #[bench]
2432     fn sort_sorted(b: &mut Bencher) {
2433         let mut v = Vec::from_fn(10000, |i| i);
2434         b.iter(|| {
2435             v.sort();
2436         });
2437         b.bytes = (v.len() * mem::size_of_val(v.get(0))) as u64;
2438     }
2439
2440     type BigSortable = (u64,u64,u64,u64);
2441
2442     #[bench]
2443     fn sort_big_random_small(b: &mut Bencher) {
2444         let mut rng = weak_rng();
2445         b.iter(|| {
2446             let mut v = rng.gen_iter::<BigSortable>().take(5)
2447                            .collect::<Vec<BigSortable>>();
2448             v.sort();
2449         });
2450         b.bytes = 5 * mem::size_of::<BigSortable>() as u64;
2451     }
2452
2453     #[bench]
2454     fn sort_big_random_medium(b: &mut Bencher) {
2455         let mut rng = weak_rng();
2456         b.iter(|| {
2457             let mut v = rng.gen_iter::<BigSortable>().take(100)
2458                            .collect::<Vec<BigSortable>>();
2459             v.sort();
2460         });
2461         b.bytes = 100 * mem::size_of::<BigSortable>() as u64;
2462     }
2463
2464     #[bench]
2465     fn sort_big_random_large(b: &mut Bencher) {
2466         let mut rng = weak_rng();
2467         b.iter(|| {
2468             let mut v = rng.gen_iter::<BigSortable>().take(10000)
2469                            .collect::<Vec<BigSortable>>();
2470             v.sort();
2471         });
2472         b.bytes = 10000 * mem::size_of::<BigSortable>() as u64;
2473     }
2474
2475     #[bench]
2476     fn sort_big_sorted(b: &mut Bencher) {
2477         let mut v = Vec::from_fn(10000u, |i| (i, i, i, i));
2478         b.iter(|| {
2479             v.sort();
2480         });
2481         b.bytes = (v.len() * mem::size_of_val(v.get(0))) as u64;
2482     }
2483 }