Skip to content

Dlist examples #21126

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 16, 2015
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
172 changes: 166 additions & 6 deletions src/libcollections/dlist.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
// Copyright 2012-2015 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
Expand Down Expand Up @@ -230,7 +230,7 @@ impl<T> DList<T> {
///
/// # Examples
///
/// ```rust
/// ```
/// use std::collections::DList;
///
/// let mut a = DList::new();
Expand Down Expand Up @@ -304,6 +304,18 @@ impl<T> DList<T> {
/// Returns `true` if the `DList` is empty.
///
/// This operation should compute in O(1) time.
///
/// # Examples
///
/// ```
/// use std::collections::DList;
///
/// let mut dl = DList::new();
/// assert!(dl.is_empty());
///
/// dl.push_front("foo");
/// assert!(!dl.is_empty());
/// ```
#[inline]
#[stable]
pub fn is_empty(&self) -> bool {
Expand All @@ -313,6 +325,24 @@ impl<T> DList<T> {
/// Returns the length of the `DList`.
///
/// This operation should compute in O(1) time.
///
/// # Examples
///
/// ```
/// use std::collections::DList;
///
/// let mut dl = DList::new();
///
/// dl.push_front(2is);
/// assert_eq!(dl.len(), 1);
///
/// dl.push_front(1);
/// assert_eq!(dl.len(), 2);
///
/// dl.push_back(3);
/// assert_eq!(dl.len(), 3);
///
/// ```
#[inline]
#[stable]
pub fn len(&self) -> uint {
Expand All @@ -322,6 +352,24 @@ impl<T> DList<T> {
/// Removes all elements from the `DList`.
///
/// This operation should compute in O(n) time.
///
/// # Examples
///
/// ```
/// use std::collections::DList;
///
/// let mut dl = DList::new();
///
/// dl.push_front(2is);
/// dl.push_front(1);
/// assert_eq!(dl.len(), 2);
/// assert_eq!(dl.front(), Some(&1is));
///
/// dl.clear();
/// assert_eq!(dl.len(), 0);
/// assert_eq!(dl.front(), None);
///
/// ```
#[inline]
#[stable]
pub fn clear(&mut self) {
Expand All @@ -330,6 +378,19 @@ impl<T> DList<T> {

/// Provides a reference to the front element, or `None` if the list is
/// empty.
///
/// # Examples
///
/// ```
/// use std::collections::DList;
///
/// let mut dl = DList::new();
/// assert_eq!(dl.front(), None);
///
/// dl.push_front(1);
/// assert_eq!(dl.front(), Some(&1is));
///
/// ```
#[inline]
#[stable]
pub fn front(&self) -> Option<&T> {
Expand All @@ -338,6 +399,25 @@ impl<T> DList<T> {

/// Provides a mutable reference to the front element, or `None` if the list
/// is empty.
///
/// # Examples
///
/// ```
/// use std::collections::DList;
///
/// let mut dl = DList::new();
/// assert_eq!(dl.front(), None);
///
/// dl.push_front(1);
/// assert_eq!(dl.front(), Some(&1is));
///
/// match dl.front_mut() {
/// None => {},
/// Some(x) => *x = 5is,
/// }
/// assert_eq!(dl.front(), Some(&5is));
///
/// ```
#[inline]
#[stable]
pub fn front_mut(&mut self) -> Option<&mut T> {
Expand All @@ -346,6 +426,19 @@ impl<T> DList<T> {

/// Provides a reference to the back element, or `None` if the list is
/// empty.
///
/// # Examples
///
/// ```
/// use std::collections::DList;
///
/// let mut dl = DList::new();
/// assert_eq!(dl.back(), None);
///
/// dl.push_back(1);
/// assert_eq!(dl.back(), Some(&1is));
///
/// ```
#[inline]
#[stable]
pub fn back(&self) -> Option<&T> {
Expand All @@ -354,6 +447,25 @@ impl<T> DList<T> {

/// Provides a mutable reference to the back element, or `None` if the list
/// is empty.
///
/// # Examples
///
/// ```
/// use std::collections::DList;
///
/// let mut dl = DList::new();
/// assert_eq!(dl.back(), None);
///
/// dl.push_back(1);
/// assert_eq!(dl.back(), Some(&1is));
///
/// match dl.back_mut() {
/// None => {},
/// Some(x) => *x = 5is,
/// }
/// assert_eq!(dl.back(), Some(&5is));
///
/// ```
#[inline]
#[stable]
pub fn back_mut(&mut self) -> Option<&mut T> {
Expand All @@ -363,6 +475,21 @@ impl<T> DList<T> {
/// Adds an element first in the list.
///
/// This operation should compute in O(1) time.
///
/// # Examples
///
/// ```
/// use std::collections::DList;
///
/// let mut dl = DList::new();
///
/// dl.push_front(2is);
/// assert_eq!(dl.front().unwrap(), &2is);
///
/// dl.push_front(1);
/// assert_eq!(dl.front().unwrap(), &1);
///
/// ```
#[stable]
pub fn push_front(&mut self, elt: T) {
self.push_front_node(box Node::new(elt))
Expand All @@ -372,6 +499,23 @@ impl<T> DList<T> {
/// empty.
///
/// This operation should compute in O(1) time.
///
/// # Examples
///
/// ```
/// use std::collections::DList;
///
/// let mut d = DList::new();
/// assert_eq!(d.pop_front(), None);
///
/// d.push_front(1is);
/// d.push_front(3);
/// assert_eq!(d.pop_front(), Some(3));
/// assert_eq!(d.pop_front(), Some(1));
/// assert_eq!(d.pop_front(), None);
///
/// ```
///
#[stable]
pub fn pop_front(&mut self) -> Option<T> {
self.pop_front_node().map(|box Node{value, ..}| value)
Expand All @@ -381,7 +525,7 @@ impl<T> DList<T> {
///
/// # Examples
///
/// ```rust
/// ```
/// use std::collections::DList;
///
/// let mut d = DList::new();
Expand All @@ -399,7 +543,7 @@ impl<T> DList<T> {
///
/// # Examples
///
/// ```rust
/// ```
/// use std::collections::DList;
///
/// let mut d = DList::new();
Expand All @@ -417,6 +561,22 @@ impl<T> DList<T> {
/// including the index.
///
/// This operation should compute in O(n) time.
/// # Examples
///
/// ```
/// use std::collections::DList;
///
/// let mut d = DList::new();
///
/// d.push_front(1is);
/// d.push_front(2);
/// d.push_front(3);
///
/// let mut splitted = d.split_off(2);
///
/// assert_eq!(splitted.pop_front(), Some(1));
/// assert_eq!(splitted.pop_front(), None);
/// ```
#[stable]
pub fn split_off(&mut self, at: uint) -> DList<T> {
let len = self.len();
Expand Down Expand Up @@ -593,7 +753,7 @@ impl<'a, A> IterMut<'a, A> {
///
/// # Examples
///
/// ```rust
/// ```
/// use std::collections::DList;
///
/// let mut list: DList<int> = vec![1, 3, 4].into_iter().collect();
Expand All @@ -619,7 +779,7 @@ impl<'a, A> IterMut<'a, A> {
///
/// # Examples
///
/// ```rust
/// ```
/// use std::collections::DList;
///
/// let mut list: DList<int> = vec![1, 2, 3].into_iter().collect();
Expand Down