]> git.lizzy.rs Git - rust.git/blob - src/libcollections/dlist.rs
c6c8a6e4a1ecf2b00c6c99a25ea46b7c7b34dff9
[rust.git] / src / libcollections / dlist.rs
1 // Copyright 2012-2015 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
4 //
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
10
11 //! A doubly-linked list with owned nodes.
12 //!
13 //! The `DList` allows pushing and popping elements at either end and is thus
14 //! efficiently usable as a double-ended queue.
15
16 // DList is constructed like a singly-linked list over the field `next`.
17 // including the last link being None; each Node owns its `next` field.
18 //
19 // Backlinks over DList::prev are raw pointers that form a full chain in
20 // the reverse direction.
21
22 #![stable(feature = "rust1", since = "1.0.0")]
23
24 use core::prelude::*;
25
26 use alloc::boxed::Box;
27 use core::cmp::Ordering;
28 use core::default::Default;
29 use core::fmt;
30 use core::hash::{Writer, Hasher, Hash};
31 use core::iter::{self, FromIterator, IntoIterator};
32 use core::mem;
33 use core::ptr;
34
35 /// A doubly-linked list.
36 #[stable(feature = "rust1", since = "1.0.0")]
37 pub struct DList<T> {
38     length: uint,
39     list_head: Link<T>,
40     list_tail: Rawlink<Node<T>>,
41 }
42
43 type Link<T> = Option<Box<Node<T>>>;
44
45 struct Rawlink<T> {
46     p: *mut T,
47 }
48
49 impl<T> Copy for Rawlink<T> {}
50 unsafe impl<T:'static+Send> Send for Rawlink<T> {}
51 unsafe impl<T:Send+Sync> Sync for Rawlink<T> {}
52
53 struct Node<T> {
54     next: Link<T>,
55     prev: Rawlink<Node<T>>,
56     value: T,
57 }
58
59 /// An iterator over references to the items of a `DList`.
60 #[stable(feature = "rust1", since = "1.0.0")]
61 pub struct Iter<'a, T:'a> {
62     head: &'a Link<T>,
63     tail: Rawlink<Node<T>>,
64     nelem: uint,
65 }
66
67 // FIXME #19839: deriving is too aggressive on the bounds (T doesn't need to be Clone).
68 #[stable(feature = "rust1", since = "1.0.0")]
69 impl<'a, T> Clone for Iter<'a, T> {
70     fn clone(&self) -> Iter<'a, T> {
71         Iter {
72             head: self.head.clone(),
73             tail: self.tail,
74             nelem: self.nelem,
75         }
76     }
77 }
78
79 /// An iterator over mutable references to the items of a `DList`.
80 #[stable(feature = "rust1", since = "1.0.0")]
81 pub struct IterMut<'a, T:'a> {
82     list: &'a mut DList<T>,
83     head: Rawlink<Node<T>>,
84     tail: Rawlink<Node<T>>,
85     nelem: uint,
86 }
87
88 /// An iterator over mutable references to the items of a `DList`.
89 #[derive(Clone)]
90 #[stable(feature = "rust1", since = "1.0.0")]
91 pub struct IntoIter<T> {
92     list: DList<T>
93 }
94
95 /// Rawlink is a type like Option<T> but for holding a raw pointer
96 impl<T> Rawlink<T> {
97     /// Like Option::None for Rawlink
98     fn none() -> Rawlink<T> {
99         Rawlink{p: ptr::null_mut()}
100     }
101
102     /// Like Option::Some for Rawlink
103     fn some(n: &mut T) -> Rawlink<T> {
104         Rawlink{p: n}
105     }
106
107     /// Convert the `Rawlink` into an Option value
108     fn resolve_immut<'a>(&self) -> Option<&'a T> {
109         unsafe {
110             mem::transmute(self.p.as_ref())
111         }
112     }
113
114     /// Convert the `Rawlink` into an Option value
115     fn resolve<'a>(&mut self) -> Option<&'a mut T> {
116         if self.p.is_null() {
117             None
118         } else {
119             Some(unsafe { mem::transmute(self.p) })
120         }
121     }
122
123     /// Return the `Rawlink` and replace with `Rawlink::none()`
124     fn take(&mut self) -> Rawlink<T> {
125         mem::replace(self, Rawlink::none())
126     }
127 }
128
129 impl<T> Clone for Rawlink<T> {
130     #[inline]
131     fn clone(&self) -> Rawlink<T> {
132         Rawlink{p: self.p}
133     }
134 }
135
136 impl<T> Node<T> {
137     fn new(v: T) -> Node<T> {
138         Node{value: v, next: None, prev: Rawlink::none()}
139     }
140 }
141
142 /// Set the .prev field on `next`, then return `Some(next)`
143 fn link_with_prev<T>(mut next: Box<Node<T>>, prev: Rawlink<Node<T>>)
144                   -> Link<T> {
145     next.prev = prev;
146     Some(next)
147 }
148
149 // private methods
150 impl<T> DList<T> {
151     /// Add a Node first in the list
152     #[inline]
153     fn push_front_node(&mut self, mut new_head: Box<Node<T>>) {
154         match self.list_head {
155             None => {
156                 self.list_tail = Rawlink::some(&mut *new_head);
157                 self.list_head = link_with_prev(new_head, Rawlink::none());
158             }
159             Some(ref mut head) => {
160                 new_head.prev = Rawlink::none();
161                 head.prev = Rawlink::some(&mut *new_head);
162                 mem::swap(head, &mut new_head);
163                 head.next = Some(new_head);
164             }
165         }
166         self.length += 1;
167     }
168
169     /// Remove the first Node and return it, or None if the list is empty
170     #[inline]
171     fn pop_front_node(&mut self) -> Option<Box<Node<T>>> {
172         self.list_head.take().map(|mut front_node| {
173             self.length -= 1;
174             match front_node.next.take() {
175                 Some(node) => self.list_head = link_with_prev(node, Rawlink::none()),
176                 None => self.list_tail = Rawlink::none()
177             }
178             front_node
179         })
180     }
181
182     /// Add a Node last in the list
183     #[inline]
184     fn push_back_node(&mut self, mut new_tail: Box<Node<T>>) {
185         match self.list_tail.resolve() {
186             None => return self.push_front_node(new_tail),
187             Some(tail) => {
188                 self.list_tail = Rawlink::some(&mut *new_tail);
189                 tail.next = link_with_prev(new_tail, Rawlink::some(tail));
190             }
191         }
192         self.length += 1;
193     }
194
195     /// Remove the last Node and return it, or None if the list is empty
196     #[inline]
197     fn pop_back_node(&mut self) -> Option<Box<Node<T>>> {
198         self.list_tail.resolve().map_or(None, |tail| {
199             self.length -= 1;
200             self.list_tail = tail.prev;
201             match tail.prev.resolve() {
202                 None => self.list_head.take(),
203                 Some(tail_prev) => tail_prev.next.take()
204             }
205         })
206     }
207 }
208
209 #[stable(feature = "rust1", since = "1.0.0")]
210 impl<T> Default for DList<T> {
211     #[inline]
212     #[stable(feature = "rust1", since = "1.0.0")]
213     fn default() -> DList<T> { DList::new() }
214 }
215
216 impl<T> DList<T> {
217     /// Creates an empty `DList`.
218     #[inline]
219     #[stable(feature = "rust1", since = "1.0.0")]
220     pub fn new() -> DList<T> {
221         DList{list_head: None, list_tail: Rawlink::none(), length: 0}
222     }
223
224     /// Moves all elements from `other` to the end of the list.
225     ///
226     /// This reuses all the nodes from `other` and moves them into `self`. After
227     /// this operation, `other` becomes empty.
228     ///
229     /// This operation should compute in O(1) time and O(1) memory.
230     ///
231     /// # Examples
232     ///
233     /// ```
234     /// use std::collections::DList;
235     ///
236     /// let mut a = DList::new();
237     /// let mut b = DList::new();
238     /// a.push_back(1);
239     /// a.push_back(2);
240     /// b.push_back(3);
241     /// b.push_back(4);
242     ///
243     /// a.append(&mut b);
244     ///
245     /// for e in a.iter() {
246     ///     println!("{}", e); // prints 1, then 2, then 3, then 4
247     /// }
248     /// println!("{}", b.len()); // prints 0
249     /// ```
250     pub fn append(&mut self, other: &mut DList<T>) {
251         match self.list_tail.resolve() {
252             None => {
253                 self.length = other.length;
254                 self.list_head = other.list_head.take();
255                 self.list_tail = other.list_tail.take();
256             },
257             Some(tail) => {
258                 // Carefully empty `other`.
259                 let o_tail = other.list_tail.take();
260                 let o_length = other.length;
261                 match other.list_head.take() {
262                     None => return,
263                     Some(node) => {
264                         tail.next = link_with_prev(node, self.list_tail);
265                         self.list_tail = o_tail;
266                         self.length += o_length;
267                     }
268                 }
269             }
270         }
271         other.length = 0;
272     }
273
274     /// Provides a forward iterator.
275     #[inline]
276     #[stable(feature = "rust1", since = "1.0.0")]
277     pub fn iter(&self) -> Iter<T> {
278         Iter{nelem: self.len(), head: &self.list_head, tail: self.list_tail}
279     }
280
281     /// Provides a forward iterator with mutable references.
282     #[inline]
283     #[stable(feature = "rust1", since = "1.0.0")]
284     pub fn iter_mut(&mut self) -> IterMut<T> {
285         let head_raw = match self.list_head {
286             Some(ref mut h) => Rawlink::some(&mut **h),
287             None => Rawlink::none(),
288         };
289         IterMut{
290             nelem: self.len(),
291             head: head_raw,
292             tail: self.list_tail,
293             list: self
294         }
295     }
296
297     /// Consumes the list into an iterator yielding elements by value.
298     #[inline]
299     #[stable(feature = "rust1", since = "1.0.0")]
300     pub fn into_iter(self) -> IntoIter<T> {
301         IntoIter{list: self}
302     }
303
304     /// Returns `true` if the `DList` is empty.
305     ///
306     /// This operation should compute in O(1) time.
307     ///
308     /// # Examples
309     ///
310     /// ```
311     /// use std::collections::DList;
312     ///
313     /// let mut dl = DList::new();
314     /// assert!(dl.is_empty());
315     ///
316     /// dl.push_front("foo");
317     /// assert!(!dl.is_empty());
318     /// ```
319     #[inline]
320     #[stable(feature = "rust1", since = "1.0.0")]
321     pub fn is_empty(&self) -> bool {
322         self.list_head.is_none()
323     }
324
325     /// Returns the length of the `DList`.
326     ///
327     /// This operation should compute in O(1) time.
328     ///
329     /// # Examples
330     ///
331     /// ```
332     /// use std::collections::DList;
333     ///
334     /// let mut dl = DList::new();
335     ///
336     /// dl.push_front(2);
337     /// assert_eq!(dl.len(), 1);
338     ///
339     /// dl.push_front(1);
340     /// assert_eq!(dl.len(), 2);
341     ///
342     /// dl.push_back(3);
343     /// assert_eq!(dl.len(), 3);
344     ///
345     /// ```
346     #[inline]
347     #[stable(feature = "rust1", since = "1.0.0")]
348     pub fn len(&self) -> uint {
349         self.length
350     }
351
352     /// Removes all elements from the `DList`.
353     ///
354     /// This operation should compute in O(n) time.
355     ///
356     /// # Examples
357     ///
358     /// ```
359     /// use std::collections::DList;
360     ///
361     /// let mut dl = DList::new();
362     ///
363     /// dl.push_front(2);
364     /// dl.push_front(1);
365     /// assert_eq!(dl.len(), 2);
366     /// assert_eq!(dl.front(), Some(&1));
367     ///
368     /// dl.clear();
369     /// assert_eq!(dl.len(), 0);
370     /// assert_eq!(dl.front(), None);
371     ///
372     /// ```
373     #[inline]
374     #[stable(feature = "rust1", since = "1.0.0")]
375     pub fn clear(&mut self) {
376         *self = DList::new()
377     }
378
379     /// Provides a reference to the front element, or `None` if the list is
380     /// empty.
381     ///
382     /// # Examples
383     ///
384     /// ```
385     /// use std::collections::DList;
386     ///
387     /// let mut dl = DList::new();
388     /// assert_eq!(dl.front(), None);
389     ///
390     /// dl.push_front(1);
391     /// assert_eq!(dl.front(), Some(&1));
392     ///
393     /// ```
394     #[inline]
395     #[stable(feature = "rust1", since = "1.0.0")]
396     pub fn front(&self) -> Option<&T> {
397         self.list_head.as_ref().map(|head| &head.value)
398     }
399
400     /// Provides a mutable reference to the front element, or `None` if the list
401     /// is empty.
402     ///
403     /// # Examples
404     ///
405     /// ```
406     /// use std::collections::DList;
407     ///
408     /// let mut dl = DList::new();
409     /// assert_eq!(dl.front(), None);
410     ///
411     /// dl.push_front(1);
412     /// assert_eq!(dl.front(), Some(&1));
413     ///
414     /// match dl.front_mut() {
415     ///     None => {},
416     ///     Some(x) => *x = 5,
417     /// }
418     /// assert_eq!(dl.front(), Some(&5));
419     ///
420     /// ```
421     #[inline]
422     #[stable(feature = "rust1", since = "1.0.0")]
423     pub fn front_mut(&mut self) -> Option<&mut T> {
424         self.list_head.as_mut().map(|head| &mut head.value)
425     }
426
427     /// Provides a reference to the back element, or `None` if the list is
428     /// empty.
429     ///
430     /// # Examples
431     ///
432     /// ```
433     /// use std::collections::DList;
434     ///
435     /// let mut dl = DList::new();
436     /// assert_eq!(dl.back(), None);
437     ///
438     /// dl.push_back(1);
439     /// assert_eq!(dl.back(), Some(&1));
440     ///
441     /// ```
442     #[inline]
443     #[stable(feature = "rust1", since = "1.0.0")]
444     pub fn back(&self) -> Option<&T> {
445         self.list_tail.resolve_immut().as_ref().map(|tail| &tail.value)
446     }
447
448     /// Provides a mutable reference to the back element, or `None` if the list
449     /// is empty.
450     ///
451     /// # Examples
452     ///
453     /// ```
454     /// use std::collections::DList;
455     ///
456     /// let mut dl = DList::new();
457     /// assert_eq!(dl.back(), None);
458     ///
459     /// dl.push_back(1);
460     /// assert_eq!(dl.back(), Some(&1));
461     ///
462     /// match dl.back_mut() {
463     ///     None => {},
464     ///     Some(x) => *x = 5,
465     /// }
466     /// assert_eq!(dl.back(), Some(&5));
467     ///
468     /// ```
469     #[inline]
470     #[stable(feature = "rust1", since = "1.0.0")]
471     pub fn back_mut(&mut self) -> Option<&mut T> {
472         self.list_tail.resolve().map(|tail| &mut tail.value)
473     }
474
475     /// Adds an element first in the list.
476     ///
477     /// This operation should compute in O(1) time.
478     ///
479     /// # Examples
480     ///
481     /// ```
482     /// use std::collections::DList;
483     ///
484     /// let mut dl = DList::new();
485     ///
486     /// dl.push_front(2);
487     /// assert_eq!(dl.front().unwrap(), &2);
488     ///
489     /// dl.push_front(1);
490     /// assert_eq!(dl.front().unwrap(), &1);
491     ///
492     /// ```
493     #[stable(feature = "rust1", since = "1.0.0")]
494     pub fn push_front(&mut self, elt: T) {
495         self.push_front_node(box Node::new(elt))
496     }
497
498     /// Removes the first element and returns it, or `None` if the list is
499     /// empty.
500     ///
501     /// This operation should compute in O(1) time.
502     ///
503     /// # Examples
504     ///
505     /// ```
506     /// use std::collections::DList;
507     ///
508     /// let mut d = DList::new();
509     /// assert_eq!(d.pop_front(), None);
510     ///
511     /// d.push_front(1);
512     /// d.push_front(3);
513     /// assert_eq!(d.pop_front(), Some(3));
514     /// assert_eq!(d.pop_front(), Some(1));
515     /// assert_eq!(d.pop_front(), None);
516     ///
517     /// ```
518     ///
519     #[stable(feature = "rust1", since = "1.0.0")]
520     pub fn pop_front(&mut self) -> Option<T> {
521         self.pop_front_node().map(|box Node{value, ..}| value)
522     }
523
524     /// Appends an element to the back of a list
525     ///
526     /// # Examples
527     ///
528     /// ```
529     /// use std::collections::DList;
530     ///
531     /// let mut d = DList::new();
532     /// d.push_back(1);
533     /// d.push_back(3);
534     /// assert_eq!(3, *d.back().unwrap());
535     /// ```
536     #[stable(feature = "rust1", since = "1.0.0")]
537     pub fn push_back(&mut self, elt: T) {
538         self.push_back_node(box Node::new(elt))
539     }
540
541     /// Removes the last element from a list and returns it, or `None` if
542     /// it is empty.
543     ///
544     /// # Examples
545     ///
546     /// ```
547     /// use std::collections::DList;
548     ///
549     /// let mut d = DList::new();
550     /// assert_eq!(d.pop_back(), None);
551     /// d.push_back(1);
552     /// d.push_back(3);
553     /// assert_eq!(d.pop_back(), Some(3));
554     /// ```
555     #[stable(feature = "rust1", since = "1.0.0")]
556     pub fn pop_back(&mut self) -> Option<T> {
557         self.pop_back_node().map(|box Node{value, ..}| value)
558     }
559
560     /// Splits the list into two at the given index. Returns everything after the given index,
561     /// including the index.
562     ///
563     /// This operation should compute in O(n) time.
564     /// # Examples
565     ///
566     /// ```
567     /// use std::collections::DList;
568     ///
569     /// let mut d = DList::new();
570     ///
571     /// d.push_front(1);
572     /// d.push_front(2);
573     /// d.push_front(3);
574     ///
575     /// let mut splitted = d.split_off(2);
576     ///
577     /// assert_eq!(splitted.pop_front(), Some(1));
578     /// assert_eq!(splitted.pop_front(), None);
579     /// ```
580     #[stable(feature = "rust1", since = "1.0.0")]
581     pub fn split_off(&mut self, at: uint) -> DList<T> {
582         let len = self.len();
583         assert!(at < len, "Cannot split off at a nonexistent index");
584         if at == 0 {
585             return mem::replace(self, DList::new());
586         }
587
588         // Below, we iterate towards the `i-1`th node, either from the start or the end,
589         // depending on which would be faster.
590         let mut split_node = if at - 1 <= len - 1 - (at - 1) {
591             let mut iter = self.iter_mut();
592             // instead of skipping using .skip() (which creates a new struct),
593             // we skip manually so we can access the head field without
594             // depending on implementation details of Skip
595             for _ in 0..at - 1 {
596                 iter.next();
597             }
598             iter.head
599         }  else {
600             // better off starting from the end
601             let mut iter = self.iter_mut();
602             for _ in 0..len - 1 - (at - 1) {
603                 iter.next_back();
604             }
605             iter.tail
606         };
607
608         let mut splitted_list = DList {
609             list_head: None,
610             list_tail: self.list_tail,
611             length: len - at
612         };
613
614         mem::swap(&mut split_node.resolve().unwrap().next, &mut splitted_list.list_head);
615         self.list_tail = split_node;
616         self.length = at;
617
618         splitted_list
619     }
620 }
621
622 #[unsafe_destructor]
623 #[stable(feature = "rust1", since = "1.0.0")]
624 impl<T> Drop for DList<T> {
625     fn drop(&mut self) {
626         // Dissolve the dlist in backwards direction
627         // Just dropping the list_head can lead to stack exhaustion
628         // when length is >> 1_000_000
629         let mut tail = self.list_tail;
630         loop {
631             match tail.resolve() {
632                 None => break,
633                 Some(prev) => {
634                     prev.next.take(); // release Box<Node<T>>
635                     tail = prev.prev;
636                 }
637             }
638         }
639         self.length = 0;
640         self.list_head = None;
641         self.list_tail = Rawlink::none();
642     }
643 }
644
645 #[stable(feature = "rust1", since = "1.0.0")]
646 impl<'a, A> Iterator for Iter<'a, A> {
647     type Item = &'a A;
648
649     #[inline]
650     fn next(&mut self) -> Option<&'a A> {
651         if self.nelem == 0 {
652             return None;
653         }
654         self.head.as_ref().map(|head| {
655             self.nelem -= 1;
656             self.head = &head.next;
657             &head.value
658         })
659     }
660
661     #[inline]
662     fn size_hint(&self) -> (uint, Option<uint>) {
663         (self.nelem, Some(self.nelem))
664     }
665 }
666
667 #[stable(feature = "rust1", since = "1.0.0")]
668 impl<'a, A> DoubleEndedIterator for Iter<'a, A> {
669     #[inline]
670     fn next_back(&mut self) -> Option<&'a A> {
671         if self.nelem == 0 {
672             return None;
673         }
674         self.tail.resolve_immut().as_ref().map(|prev| {
675             self.nelem -= 1;
676             self.tail = prev.prev;
677             &prev.value
678         })
679     }
680 }
681
682 #[stable(feature = "rust1", since = "1.0.0")]
683 impl<'a, A> ExactSizeIterator for Iter<'a, A> {}
684
685 #[stable(feature = "rust1", since = "1.0.0")]
686 impl<'a, A> Iterator for IterMut<'a, A> {
687     type Item = &'a mut A;
688     #[inline]
689     fn next(&mut self) -> Option<&'a mut A> {
690         if self.nelem == 0 {
691             return None;
692         }
693         self.head.resolve().map(|next| {
694             self.nelem -= 1;
695             self.head = match next.next {
696                 Some(ref mut node) => Rawlink::some(&mut **node),
697                 None => Rawlink::none(),
698             };
699             &mut next.value
700         })
701     }
702
703     #[inline]
704     fn size_hint(&self) -> (uint, Option<uint>) {
705         (self.nelem, Some(self.nelem))
706     }
707 }
708
709 #[stable(feature = "rust1", since = "1.0.0")]
710 impl<'a, A> DoubleEndedIterator for IterMut<'a, A> {
711     #[inline]
712     fn next_back(&mut self) -> Option<&'a mut A> {
713         if self.nelem == 0 {
714             return None;
715         }
716         self.tail.resolve().map(|prev| {
717             self.nelem -= 1;
718             self.tail = prev.prev;
719             &mut prev.value
720         })
721     }
722 }
723
724 #[stable(feature = "rust1", since = "1.0.0")]
725 impl<'a, A> ExactSizeIterator for IterMut<'a, A> {}
726
727 // private methods for IterMut
728 impl<'a, A> IterMut<'a, A> {
729     fn insert_next_node(&mut self, mut ins_node: Box<Node<A>>) {
730         // Insert before `self.head` so that it is between the
731         // previously yielded element and self.head.
732         //
733         // The inserted node will not appear in further iteration.
734         match self.head.resolve() {
735             None => { self.list.push_back_node(ins_node); }
736             Some(node) => {
737                 let prev_node = match node.prev.resolve() {
738                     None => return self.list.push_front_node(ins_node),
739                     Some(prev) => prev,
740                 };
741                 let node_own = prev_node.next.take().unwrap();
742                 ins_node.next = link_with_prev(node_own, Rawlink::some(&mut *ins_node));
743                 prev_node.next = link_with_prev(ins_node, Rawlink::some(prev_node));
744                 self.list.length += 1;
745             }
746         }
747     }
748 }
749
750 impl<'a, A> IterMut<'a, A> {
751     /// Inserts `elt` just after the element most recently returned by `.next()`.
752     /// The inserted element does not appear in the iteration.
753     ///
754     /// # Examples
755     ///
756     /// ```
757     /// use std::collections::DList;
758     ///
759     /// let mut list: DList<int> = vec![1, 3, 4].into_iter().collect();
760     ///
761     /// {
762     ///     let mut it = list.iter_mut();
763     ///     assert_eq!(it.next().unwrap(), &1);
764     ///     // insert `2` after `1`
765     ///     it.insert_next(2);
766     /// }
767     /// {
768     ///     let vec: Vec<int> = list.into_iter().collect();
769     ///     assert_eq!(vec, vec![1, 2, 3, 4]);
770     /// }
771     /// ```
772     #[inline]
773     #[unstable(feature = "collections",
774                reason = "this is probably better handled by a cursor type -- we'll see")]
775     pub fn insert_next(&mut self, elt: A) {
776         self.insert_next_node(box Node::new(elt))
777     }
778
779     /// Provides a reference to the next element, without changing the iterator.
780     ///
781     /// # Examples
782     ///
783     /// ```
784     /// use std::collections::DList;
785     ///
786     /// let mut list: DList<int> = vec![1, 2, 3].into_iter().collect();
787     ///
788     /// let mut it = list.iter_mut();
789     /// assert_eq!(it.next().unwrap(), &1);
790     /// assert_eq!(it.peek_next().unwrap(), &2);
791     /// // We just peeked at 2, so it was not consumed from the iterator.
792     /// assert_eq!(it.next().unwrap(), &2);
793     /// ```
794     #[inline]
795     #[unstable(feature = "collections",
796                reason = "this is probably better handled by a cursor type -- we'll see")]
797     pub fn peek_next(&mut self) -> Option<&mut A> {
798         if self.nelem == 0 {
799             return None
800         }
801         self.head.resolve().map(|head| &mut head.value)
802     }
803 }
804
805 #[stable(feature = "rust1", since = "1.0.0")]
806 impl<A> Iterator for IntoIter<A> {
807     type Item = A;
808
809     #[inline]
810     fn next(&mut self) -> Option<A> { self.list.pop_front() }
811
812     #[inline]
813     fn size_hint(&self) -> (uint, Option<uint>) {
814         (self.list.length, Some(self.list.length))
815     }
816 }
817
818 #[stable(feature = "rust1", since = "1.0.0")]
819 impl<A> DoubleEndedIterator for IntoIter<A> {
820     #[inline]
821     fn next_back(&mut self) -> Option<A> { self.list.pop_back() }
822 }
823
824 #[stable(feature = "rust1", since = "1.0.0")]
825 impl<A> FromIterator<A> for DList<A> {
826     fn from_iter<T: Iterator<Item=A>>(iterator: T) -> DList<A> {
827         let mut ret = DList::new();
828         ret.extend(iterator);
829         ret
830     }
831 }
832
833 impl<T> IntoIterator for DList<T> {
834     type Iter = IntoIter<T>;
835
836     fn into_iter(self) -> IntoIter<T> {
837         self.into_iter()
838     }
839 }
840
841 impl<'a, T> IntoIterator for &'a DList<T> {
842     type Iter = Iter<'a, T>;
843
844     fn into_iter(self) -> Iter<'a, T> {
845         self.iter()
846     }
847 }
848
849 impl<'a, T> IntoIterator for &'a mut DList<T> {
850     type Iter = IterMut<'a, T>;
851
852     fn into_iter(mut self) -> IterMut<'a, T> {
853         self.iter_mut()
854     }
855 }
856
857 #[stable(feature = "rust1", since = "1.0.0")]
858 impl<A> Extend<A> for DList<A> {
859     fn extend<T: Iterator<Item=A>>(&mut self, mut iterator: T) {
860         for elt in iterator { self.push_back(elt); }
861     }
862 }
863
864 #[stable(feature = "rust1", since = "1.0.0")]
865 impl<A: PartialEq> PartialEq for DList<A> {
866     fn eq(&self, other: &DList<A>) -> bool {
867         self.len() == other.len() &&
868             iter::order::eq(self.iter(), other.iter())
869     }
870
871     fn ne(&self, other: &DList<A>) -> bool {
872         self.len() != other.len() ||
873             iter::order::ne(self.iter(), other.iter())
874     }
875 }
876
877 #[stable(feature = "rust1", since = "1.0.0")]
878 impl<A: Eq> Eq for DList<A> {}
879
880 #[stable(feature = "rust1", since = "1.0.0")]
881 impl<A: PartialOrd> PartialOrd for DList<A> {
882     fn partial_cmp(&self, other: &DList<A>) -> Option<Ordering> {
883         iter::order::partial_cmp(self.iter(), other.iter())
884     }
885 }
886
887 #[stable(feature = "rust1", since = "1.0.0")]
888 impl<A: Ord> Ord for DList<A> {
889     #[inline]
890     fn cmp(&self, other: &DList<A>) -> Ordering {
891         iter::order::cmp(self.iter(), other.iter())
892     }
893 }
894
895 #[stable(feature = "rust1", since = "1.0.0")]
896 impl<A: Clone> Clone for DList<A> {
897     fn clone(&self) -> DList<A> {
898         self.iter().map(|x| x.clone()).collect()
899     }
900 }
901
902 #[stable(feature = "rust1", since = "1.0.0")]
903 impl<A: fmt::Debug> fmt::Debug for DList<A> {
904     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
905         try!(write!(f, "DList ["));
906
907         for (i, e) in self.iter().enumerate() {
908             if i != 0 { try!(write!(f, ", ")); }
909             try!(write!(f, "{:?}", *e));
910         }
911
912         write!(f, "]")
913     }
914 }
915
916 #[stable(feature = "rust1", since = "1.0.0")]
917 impl<S: Writer + Hasher, A: Hash<S>> Hash<S> for DList<A> {
918     fn hash(&self, state: &mut S) {
919         self.len().hash(state);
920         for elt in self {
921             elt.hash(state);
922         }
923     }
924 }
925
926 #[cfg(test)]
927 mod tests {
928     use prelude::*;
929     use std::rand;
930     use std::hash::{self, SipHasher};
931     use std::thread::Thread;
932     use test::Bencher;
933     use test;
934
935     use super::{DList, Node};
936
937     pub fn check_links<T>(list: &DList<T>) {
938         let mut len = 0u;
939         let mut last_ptr: Option<&Node<T>> = None;
940         let mut node_ptr: &Node<T>;
941         match list.list_head {
942             None => { assert_eq!(0u, list.length); return }
943             Some(ref node) => node_ptr = &**node,
944         }
945         loop {
946             match (last_ptr, node_ptr.prev.resolve_immut()) {
947                 (None   , None      ) => {}
948                 (None   , _         ) => panic!("prev link for list_head"),
949                 (Some(p), Some(pptr)) => {
950                     assert_eq!(p as *const Node<T>, pptr as *const Node<T>);
951                 }
952                 _ => panic!("prev link is none, not good"),
953             }
954             match node_ptr.next {
955                 Some(ref next) => {
956                     last_ptr = Some(node_ptr);
957                     node_ptr = &**next;
958                     len += 1;
959                 }
960                 None => {
961                     len += 1;
962                     break;
963                 }
964             }
965         }
966         assert_eq!(len, list.length);
967     }
968
969     #[test]
970     fn test_basic() {
971         let mut m: DList<Box<int>> = DList::new();
972         assert_eq!(m.pop_front(), None);
973         assert_eq!(m.pop_back(), None);
974         assert_eq!(m.pop_front(), None);
975         m.push_front(box 1);
976         assert_eq!(m.pop_front(), Some(box 1));
977         m.push_back(box 2);
978         m.push_back(box 3);
979         assert_eq!(m.len(), 2);
980         assert_eq!(m.pop_front(), Some(box 2));
981         assert_eq!(m.pop_front(), Some(box 3));
982         assert_eq!(m.len(), 0);
983         assert_eq!(m.pop_front(), None);
984         m.push_back(box 1);
985         m.push_back(box 3);
986         m.push_back(box 5);
987         m.push_back(box 7);
988         assert_eq!(m.pop_front(), Some(box 1));
989
990         let mut n = DList::new();
991         n.push_front(2);
992         n.push_front(3);
993         {
994             assert_eq!(n.front().unwrap(), &3);
995             let x = n.front_mut().unwrap();
996             assert_eq!(*x, 3);
997             *x = 0;
998         }
999         {
1000             assert_eq!(n.back().unwrap(), &2);
1001             let y = n.back_mut().unwrap();
1002             assert_eq!(*y, 2);
1003             *y = 1;
1004         }
1005         assert_eq!(n.pop_front(), Some(0));
1006         assert_eq!(n.pop_front(), Some(1));
1007     }
1008
1009     #[cfg(test)]
1010     fn generate_test() -> DList<int> {
1011         list_from(&[0,1,2,3,4,5,6])
1012     }
1013
1014     #[cfg(test)]
1015     fn list_from<T: Clone>(v: &[T]) -> DList<T> {
1016         v.iter().map(|x| (*x).clone()).collect()
1017     }
1018
1019     #[test]
1020     fn test_append() {
1021         // Empty to empty
1022         {
1023             let mut m: DList<int> = DList::new();
1024             let mut n = DList::new();
1025             m.append(&mut n);
1026             check_links(&m);
1027             assert_eq!(m.len(), 0);
1028             assert_eq!(n.len(), 0);
1029         }
1030         // Non-empty to empty
1031         {
1032             let mut m = DList::new();
1033             let mut n = DList::new();
1034             n.push_back(2);
1035             m.append(&mut n);
1036             check_links(&m);
1037             assert_eq!(m.len(), 1);
1038             assert_eq!(m.pop_back(), Some(2));
1039             assert_eq!(n.len(), 0);
1040             check_links(&m);
1041         }
1042         // Empty to non-empty
1043         {
1044             let mut m = DList::new();
1045             let mut n = DList::new();
1046             m.push_back(2);
1047             m.append(&mut n);
1048             check_links(&m);
1049             assert_eq!(m.len(), 1);
1050             assert_eq!(m.pop_back(), Some(2));
1051             check_links(&m);
1052         }
1053
1054         // Non-empty to non-empty
1055         let v = vec![1,2,3,4,5];
1056         let u = vec![9,8,1,2,3,4,5];
1057         let mut m = list_from(v.as_slice());
1058         let mut n = list_from(u.as_slice());
1059         m.append(&mut n);
1060         check_links(&m);
1061         let mut sum = v;
1062         sum.push_all(u.as_slice());
1063         assert_eq!(sum.len(), m.len());
1064         for elt in sum {
1065             assert_eq!(m.pop_front(), Some(elt))
1066         }
1067         assert_eq!(n.len(), 0);
1068         // let's make sure it's working properly, since we
1069         // did some direct changes to private members
1070         n.push_back(3);
1071         assert_eq!(n.len(), 1);
1072         assert_eq!(n.pop_front(), Some(3));
1073         check_links(&n);
1074     }
1075
1076     #[test]
1077     fn test_split_off() {
1078         // singleton
1079         {
1080             let mut m = DList::new();
1081             m.push_back(1);
1082
1083             let p = m.split_off(0);
1084             assert_eq!(m.len(), 0);
1085             assert_eq!(p.len(), 1);
1086             assert_eq!(p.back(), Some(&1));
1087             assert_eq!(p.front(), Some(&1));
1088         }
1089
1090         // not singleton, forwards
1091         {
1092             let u = vec![1,2,3,4,5];
1093             let mut m = list_from(u.as_slice());
1094             let mut n = m.split_off(2);
1095             assert_eq!(m.len(), 2);
1096             assert_eq!(n.len(), 3);
1097             for elt in 1..3 {
1098                 assert_eq!(m.pop_front(), Some(elt));
1099             }
1100             for elt in 3..6 {
1101                 assert_eq!(n.pop_front(), Some(elt));
1102             }
1103         }
1104         // not singleton, backwards
1105         {
1106             let u = vec![1,2,3,4,5];
1107             let mut m = list_from(u.as_slice());
1108             let mut n = m.split_off(4);
1109             assert_eq!(m.len(), 4);
1110             assert_eq!(n.len(), 1);
1111             for elt in 1..5 {
1112                 assert_eq!(m.pop_front(), Some(elt));
1113             }
1114             for elt in 5..6 {
1115                 assert_eq!(n.pop_front(), Some(elt));
1116             }
1117         }
1118
1119     }
1120
1121     #[test]
1122     fn test_iterator() {
1123         let m = generate_test();
1124         for (i, elt) in m.iter().enumerate() {
1125             assert_eq!(i as int, *elt);
1126         }
1127         let mut n = DList::new();
1128         assert_eq!(n.iter().next(), None);
1129         n.push_front(4);
1130         let mut it = n.iter();
1131         assert_eq!(it.size_hint(), (1, Some(1)));
1132         assert_eq!(it.next().unwrap(), &4);
1133         assert_eq!(it.size_hint(), (0, Some(0)));
1134         assert_eq!(it.next(), None);
1135     }
1136
1137     #[test]
1138     fn test_iterator_clone() {
1139         let mut n = DList::new();
1140         n.push_back(2);
1141         n.push_back(3);
1142         n.push_back(4);
1143         let mut it = n.iter();
1144         it.next();
1145         let mut jt = it.clone();
1146         assert_eq!(it.next(), jt.next());
1147         assert_eq!(it.next_back(), jt.next_back());
1148         assert_eq!(it.next(), jt.next());
1149     }
1150
1151     #[test]
1152     fn test_iterator_double_end() {
1153         let mut n = DList::new();
1154         assert_eq!(n.iter().next(), None);
1155         n.push_front(4);
1156         n.push_front(5);
1157         n.push_front(6);
1158         let mut it = n.iter();
1159         assert_eq!(it.size_hint(), (3, Some(3)));
1160         assert_eq!(it.next().unwrap(), &6);
1161         assert_eq!(it.size_hint(), (2, Some(2)));
1162         assert_eq!(it.next_back().unwrap(), &4);
1163         assert_eq!(it.size_hint(), (1, Some(1)));
1164         assert_eq!(it.next_back().unwrap(), &5);
1165         assert_eq!(it.next_back(), None);
1166         assert_eq!(it.next(), None);
1167     }
1168
1169     #[test]
1170     fn test_rev_iter() {
1171         let m = generate_test();
1172         for (i, elt) in m.iter().rev().enumerate() {
1173             assert_eq!((6 - i) as int, *elt);
1174         }
1175         let mut n = DList::new();
1176         assert_eq!(n.iter().rev().next(), None);
1177         n.push_front(4);
1178         let mut it = n.iter().rev();
1179         assert_eq!(it.size_hint(), (1, Some(1)));
1180         assert_eq!(it.next().unwrap(), &4);
1181         assert_eq!(it.size_hint(), (0, Some(0)));
1182         assert_eq!(it.next(), None);
1183     }
1184
1185     #[test]
1186     fn test_mut_iter() {
1187         let mut m = generate_test();
1188         let mut len = m.len();
1189         for (i, elt) in m.iter_mut().enumerate() {
1190             assert_eq!(i as int, *elt);
1191             len -= 1;
1192         }
1193         assert_eq!(len, 0);
1194         let mut n = DList::new();
1195         assert!(n.iter_mut().next().is_none());
1196         n.push_front(4);
1197         n.push_back(5);
1198         let mut it = n.iter_mut();
1199         assert_eq!(it.size_hint(), (2, Some(2)));
1200         assert!(it.next().is_some());
1201         assert!(it.next().is_some());
1202         assert_eq!(it.size_hint(), (0, Some(0)));
1203         assert!(it.next().is_none());
1204     }
1205
1206     #[test]
1207     fn test_iterator_mut_double_end() {
1208         let mut n = DList::new();
1209         assert!(n.iter_mut().next_back().is_none());
1210         n.push_front(4);
1211         n.push_front(5);
1212         n.push_front(6);
1213         let mut it = n.iter_mut();
1214         assert_eq!(it.size_hint(), (3, Some(3)));
1215         assert_eq!(*it.next().unwrap(), 6);
1216         assert_eq!(it.size_hint(), (2, Some(2)));
1217         assert_eq!(*it.next_back().unwrap(), 4);
1218         assert_eq!(it.size_hint(), (1, Some(1)));
1219         assert_eq!(*it.next_back().unwrap(), 5);
1220         assert!(it.next_back().is_none());
1221         assert!(it.next().is_none());
1222     }
1223
1224     #[test]
1225     fn test_insert_prev() {
1226         let mut m = list_from(&[0,2,4,6,8]);
1227         let len = m.len();
1228         {
1229             let mut it = m.iter_mut();
1230             it.insert_next(-2);
1231             loop {
1232                 match it.next() {
1233                     None => break,
1234                     Some(elt) => {
1235                         it.insert_next(*elt + 1);
1236                         match it.peek_next() {
1237                             Some(x) => assert_eq!(*x, *elt + 2),
1238                             None => assert_eq!(8, *elt),
1239                         }
1240                     }
1241                 }
1242             }
1243             it.insert_next(0);
1244             it.insert_next(1);
1245         }
1246         check_links(&m);
1247         assert_eq!(m.len(), 3 + len * 2);
1248         assert_eq!(m.into_iter().collect::<Vec<int>>(), vec![-2,0,1,2,3,4,5,6,7,8,9,0,1]);
1249     }
1250
1251     #[test]
1252     fn test_mut_rev_iter() {
1253         let mut m = generate_test();
1254         for (i, elt) in m.iter_mut().rev().enumerate() {
1255             assert_eq!((6-i) as int, *elt);
1256         }
1257         let mut n = DList::new();
1258         assert!(n.iter_mut().rev().next().is_none());
1259         n.push_front(4);
1260         let mut it = n.iter_mut().rev();
1261         assert!(it.next().is_some());
1262         assert!(it.next().is_none());
1263     }
1264
1265     #[test]
1266     fn test_send() {
1267         let n = list_from(&[1,2,3]);
1268         Thread::scoped(move || {
1269             check_links(&n);
1270             let a: &[_] = &[&1,&2,&3];
1271             assert_eq!(a, n.iter().collect::<Vec<&int>>());
1272         }).join().ok().unwrap();
1273     }
1274
1275     #[test]
1276     fn test_eq() {
1277         let mut n: DList<u8> = list_from(&[]);
1278         let mut m = list_from(&[]);
1279         assert!(n == m);
1280         n.push_front(1);
1281         assert!(n != m);
1282         m.push_back(1);
1283         assert!(n == m);
1284
1285         let n = list_from(&[2,3,4]);
1286         let m = list_from(&[1,2,3]);
1287         assert!(n != m);
1288     }
1289
1290     #[test]
1291     fn test_hash() {
1292       let mut x = DList::new();
1293       let mut y = DList::new();
1294
1295       assert!(hash::hash::<_, SipHasher>(&x) == hash::hash::<_, SipHasher>(&y));
1296
1297       x.push_back(1);
1298       x.push_back(2);
1299       x.push_back(3);
1300
1301       y.push_front(3);
1302       y.push_front(2);
1303       y.push_front(1);
1304
1305       assert!(hash::hash::<_, SipHasher>(&x) == hash::hash::<_, SipHasher>(&y));
1306     }
1307
1308     #[test]
1309     fn test_ord() {
1310         let n: DList<int> = list_from(&[]);
1311         let m = list_from(&[1,2,3]);
1312         assert!(n < m);
1313         assert!(m > n);
1314         assert!(n <= n);
1315         assert!(n >= n);
1316     }
1317
1318     #[test]
1319     fn test_ord_nan() {
1320         let nan = 0.0f64/0.0;
1321         let n = list_from(&[nan]);
1322         let m = list_from(&[nan]);
1323         assert!(!(n < m));
1324         assert!(!(n > m));
1325         assert!(!(n <= m));
1326         assert!(!(n >= m));
1327
1328         let n = list_from(&[nan]);
1329         let one = list_from(&[1.0f64]);
1330         assert!(!(n < one));
1331         assert!(!(n > one));
1332         assert!(!(n <= one));
1333         assert!(!(n >= one));
1334
1335         let u = list_from(&[1.0f64,2.0,nan]);
1336         let v = list_from(&[1.0f64,2.0,3.0]);
1337         assert!(!(u < v));
1338         assert!(!(u > v));
1339         assert!(!(u <= v));
1340         assert!(!(u >= v));
1341
1342         let s = list_from(&[1.0f64,2.0,4.0,2.0]);
1343         let t = list_from(&[1.0f64,2.0,3.0,2.0]);
1344         assert!(!(s < t));
1345         assert!(s > one);
1346         assert!(!(s <= one));
1347         assert!(s >= one);
1348     }
1349
1350     #[test]
1351     fn test_fuzz() {
1352         for _ in 0u..25 {
1353             fuzz_test(3);
1354             fuzz_test(16);
1355             fuzz_test(189);
1356         }
1357     }
1358
1359     #[test]
1360     fn test_show() {
1361         let list: DList<i32> = (0..10).collect();
1362         assert_eq!(format!("{:?}", list), "DList [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]");
1363
1364         let list: DList<&str> = vec!["just", "one", "test", "more"].iter()
1365                                                                    .map(|&s| s)
1366                                                                    .collect();
1367         assert_eq!(format!("{:?}", list), "DList [\"just\", \"one\", \"test\", \"more\"]");
1368     }
1369
1370     #[cfg(test)]
1371     fn fuzz_test(sz: int) {
1372         let mut m: DList<int> = DList::new();
1373         let mut v = vec![];
1374         for i in 0..sz {
1375             check_links(&m);
1376             let r: u8 = rand::random();
1377             match r % 6 {
1378                 0 => {
1379                     m.pop_back();
1380                     v.pop();
1381                 }
1382                 1 => {
1383                     if !v.is_empty() {
1384                         m.pop_front();
1385                         v.remove(0);
1386                     }
1387                 }
1388                 2 | 4 =>  {
1389                     m.push_front(-i);
1390                     v.insert(0, -i);
1391                 }
1392                 3 | 5 | _ => {
1393                     m.push_back(i);
1394                     v.push(i);
1395                 }
1396             }
1397         }
1398
1399         check_links(&m);
1400
1401         let mut i = 0u;
1402         for (a, &b) in m.into_iter().zip(v.iter()) {
1403             i += 1;
1404             assert_eq!(a, b);
1405         }
1406         assert_eq!(i, v.len());
1407     }
1408
1409     #[bench]
1410     fn bench_collect_into(b: &mut test::Bencher) {
1411         let v = &[0; 64];
1412         b.iter(|| {
1413             let _: DList<int> = v.iter().map(|x| *x).collect();
1414         })
1415     }
1416
1417     #[bench]
1418     fn bench_push_front(b: &mut test::Bencher) {
1419         let mut m: DList<int> = DList::new();
1420         b.iter(|| {
1421             m.push_front(0);
1422         })
1423     }
1424
1425     #[bench]
1426     fn bench_push_back(b: &mut test::Bencher) {
1427         let mut m: DList<int> = DList::new();
1428         b.iter(|| {
1429             m.push_back(0);
1430         })
1431     }
1432
1433     #[bench]
1434     fn bench_push_back_pop_back(b: &mut test::Bencher) {
1435         let mut m: DList<int> = DList::new();
1436         b.iter(|| {
1437             m.push_back(0);
1438             m.pop_back();
1439         })
1440     }
1441
1442     #[bench]
1443     fn bench_push_front_pop_front(b: &mut test::Bencher) {
1444         let mut m: DList<int> = DList::new();
1445         b.iter(|| {
1446             m.push_front(0);
1447             m.pop_front();
1448         })
1449     }
1450
1451     #[bench]
1452     fn bench_iter(b: &mut test::Bencher) {
1453         let v = &[0; 128];
1454         let m: DList<int> = v.iter().map(|&x|x).collect();
1455         b.iter(|| {
1456             assert!(m.iter().count() == 128);
1457         })
1458     }
1459     #[bench]
1460     fn bench_iter_mut(b: &mut test::Bencher) {
1461         let v = &[0; 128];
1462         let mut m: DList<int> = v.iter().map(|&x|x).collect();
1463         b.iter(|| {
1464             assert!(m.iter_mut().count() == 128);
1465         })
1466     }
1467     #[bench]
1468     fn bench_iter_rev(b: &mut test::Bencher) {
1469         let v = &[0; 128];
1470         let m: DList<int> = v.iter().map(|&x|x).collect();
1471         b.iter(|| {
1472             assert!(m.iter().rev().count() == 128);
1473         })
1474     }
1475     #[bench]
1476     fn bench_iter_mut_rev(b: &mut test::Bencher) {
1477         let v = &[0; 128];
1478         let mut m: DList<int> = v.iter().map(|&x|x).collect();
1479         b.iter(|| {
1480             assert!(m.iter_mut().rev().count() == 128);
1481         })
1482     }
1483 }