rust/src/libstd/treemap.rs

// Copyright 2013 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

//! An ordered map and set implemented as self-balancing binary search
//! trees. The only requirement for the types is that the key implements
//! `TotalOrd`.

use core::prelude::*;

// This is implemented as an AA tree, which is a simplified variation of
// a red-black tree where where red (horizontal) nodes can only be added
// as a right child. The time complexity is the same, and re-balancing
// operations are more frequent but also cheaper.

// Future improvements:

// range search - O(log n) retrieval of an iterator from some key

// (possibly) implement the overloads Python does for sets:
//   * intersection: &
//   * difference: -
//   * symmetric difference: ^
//   * union: |
// These would be convenient since the methods work like `each`

pub struct TreeMap<K, V> {
    priv root: Option<~TreeNode<K, V>>,
    priv length: uint
}

impl<K: Eq + TotalOrd, V: Eq> Eq for TreeMap<K, V> {
    pure fn eq(&self, other: &TreeMap<K, V>) -> bool {
        if self.len() != other.len() {
            false
        } else {
            let mut x = self.iter();
            let mut y = other.iter();
            for self.len().times {
                unsafe { // unsafe as a purity workaround
                    if map_next(&mut x).unwrap() !=
                       map_next(&mut y).unwrap() {
                        return false
                    }
                }
            }
            true
        }
    }
    pure fn ne(&self, other: &TreeMap<K, V>) -> bool { !self.eq(other) }
}

// Lexicographical comparison
pure fn lt<K: Ord + TotalOrd, V>(a: &TreeMap<K, V>,
                                 b: &TreeMap<K, V>) -> bool {
    let mut x = a.iter();
    let mut y = b.iter();

    let (a_len, b_len) = (a.len(), b.len());
    for uint::min(a_len, b_len).times {
        unsafe { // purity workaround
            let (key_a,_) = map_next(&mut x).unwrap();
            let (key_b,_) = map_next(&mut y).unwrap();
            if *key_a < *key_b { return true; }
            if *key_a > *key_b { return false; }
        }
    };

    return a_len < b_len;
}

impl<K: Ord + TotalOrd, V> Ord for TreeMap<K, V> {
    #[inline(always)]
    pure fn lt(&self, other: &TreeMap<K, V>) -> bool { lt(self, other) }
    #[inline(always)]
    pure fn le(&self, other: &TreeMap<K, V>) -> bool { !lt(other, self) }
    #[inline(always)]
    pure fn ge(&self, other: &TreeMap<K, V>) -> bool { !lt(self, other) }
    #[inline(always)]
    pure fn gt(&self, other: &TreeMap<K, V>) -> bool { lt(other, self) }
}

impl<'self, K: TotalOrd, V> BaseIter<(&'self K, &'self V)> for TreeMap<K, V> {
    /// Visit all key-value pairs in order
    pure fn each(&self, f: &fn(&(&self/K, &self/V)) -> bool) {
        each(&self.root, f)
    }
    pure fn size_hint(&self) -> Option<uint> { Some(self.len()) }
}

impl<'self, K: TotalOrd, V>
    ReverseIter<(&'self K, &'self V)>
    for TreeMap<K, V>
{
    /// Visit all key-value pairs in reverse order
    pure fn each_reverse(&self, f: &fn(&(&self/K, &self/V)) -> bool) {
        each_reverse(&self.root, f);
    }
}

impl<K: TotalOrd, V> Container for TreeMap<K, V> {
    /// Return the number of elements in the map
    pure fn len(&self) -> uint { self.length }

    /// Return true if the map contains no elements
    pure fn is_empty(&self) -> bool { self.root.is_none() }
}

impl<K: TotalOrd, V> Mutable for TreeMap<K, V> {
    /// Clear the map, removing all key-value pairs.
    fn clear(&mut self) {
        self.root = None;
        self.length = 0
    }
}

impl<K: TotalOrd, V> Map<K, V> for TreeMap<K, V> {
    /// Return true if the map contains a value for the specified key
    pure fn contains_key(&self, key: &K) -> bool {
        self.find(key).is_some()
    }

    /// Visit all keys in order
    pure fn each_key(&self, f: &fn(&K) -> bool) { self.each(|&(k, _)| f(k)) }

    /// Visit all values in order
    pure fn each_value(&self, f: &fn(&V) -> bool) {
        self.each(|&(_, v)| f(v))
    }

    /// Return the value corresponding to the key in the map
    pure fn find(&self, key: &K) -> Option<&self/V> {
        let mut current: &self/Option<~TreeNode<K, V>> = &self.root;
        loop {
            match *current {
              Some(ref r) => {
                match key.cmp(&r.key) {
                  Less => current = &r.left,
                  Greater => current = &r.right,
                  Equal => return Some(&r.value)
                }
              }
              None => return None
            }
        }
    }

    /// Insert a key-value pair into the map. An existing value for a
    /// key is replaced by the new value. Return true if the key did
    /// not already exist in the map.
    fn insert(&mut self, key: K, value: V) -> bool {
        let ret = insert(&mut self.root, key, value);
        if ret { self.length += 1 }
        ret
    }

    /// Remove a key-value pair from the map. Return true if the key
    /// was present in the map, otherwise false.
    fn remove(&mut self, key: &K) -> bool {
        let ret = remove(&mut self.root, key);
        if ret { self.length -= 1 }
        ret
    }
}

pub impl<K: TotalOrd, V> TreeMap<K, V> {
    /// Create an empty TreeMap
    static pure fn new() -> TreeMap<K, V> { TreeMap{root: None, length: 0} }

    /// Visit all keys in reverse order
    pure fn each_key_reverse(&self, f: &fn(&K) -> bool) {
        self.each_reverse(|&(k, _)| f(k))
    }

    /// Visit all values in reverse order
    pure fn each_value_reverse(&self, f: &fn(&V) -> bool) {
        self.each_reverse(|&(_, v)| f(v))
    }

    /// Get a lazy iterator over the key-value pairs in the map.
    /// Requires that it be frozen (immutable).
    pure fn iter(&self) -> TreeMapIterator/&self<K, V> {
        TreeMapIterator{stack: ~[], node: &self.root}
    }
}

/// Lazy forward iterator over a map
pub struct TreeMapIterator<K, V> {
    priv stack: ~[&self/~TreeNode<K, V>],
    priv node: &self/Option<~TreeNode<K, V>>
}

/// Advance the iterator to the next node (in order) and return a
/// tuple with a reference to the key and value. If there are no
/// more nodes, return `None`.
pub fn map_next<K, V>(iter: &mut TreeMapIterator/&r<K, V>)
                        -> Option<(&r/K, &r/V)> {
    while !iter.stack.is_empty() || iter.node.is_some() {
        match *iter.node {
          Some(ref x) => {
            iter.stack.push(x);
            iter.node = &x.left;
          }
          None => {
            let res = iter.stack.pop();
            iter.node = &res.right;
            return Some((&res.key, &res.value));
          }
        }
    }
    None
}

/// Advance the iterator through the map
pub fn map_advance<K, V>(iter: &mut TreeMapIterator/&r<K, V>,
                         f: &fn((&r/K, &r/V)) -> bool) {
    loop {
        match map_next(iter) {
          Some(x) => {
            if !f(x) { return }
          }
          None => return
        }
    }
}

pub struct TreeSet<T> {
    priv map: TreeMap<T, ()>
}

impl<T: TotalOrd> BaseIter<T> for TreeSet<T> {
    /// Visit all values in order
    #[inline(always)]
    pure fn each(&self, f: &fn(&T) -> bool) { self.map.each_key(f) }
    #[inline(always)]
    pure fn size_hint(&self) -> Option<uint> { Some(self.len()) }
}

impl<T: TotalOrd> ReverseIter<T> for TreeSet<T> {
    /// Visit all values in reverse order
    #[inline(always)]
    pure fn each_reverse(&self, f: &fn(&T) -> bool) {
        self.map.each_key_reverse(f)
    }
}

impl<T: Eq + TotalOrd> Eq for TreeSet<T> {
    #[inline(always)]
    pure fn eq(&self, other: &TreeSet<T>) -> bool { self.map == other.map }
    #[inline(always)]
    pure fn ne(&self, other: &TreeSet<T>) -> bool { self.map != other.map }
}

impl<T: Ord + TotalOrd> Ord for TreeSet<T> {
    #[inline(always)]
    pure fn lt(&self, other: &TreeSet<T>) -> bool { self.map < other.map }
    #[inline(always)]
    pure fn le(&self, other: &TreeSet<T>) -> bool { self.map <= other.map }
    #[inline(always)]
    pure fn ge(&self, other: &TreeSet<T>) -> bool { self.map >= other.map }
    #[inline(always)]
    pure fn gt(&self, other: &TreeSet<T>) -> bool { self.map > other.map }
}

impl<T: TotalOrd> Container for TreeSet<T> {
    /// Return the number of elements in the set
    #[inline(always)]
    pure fn len(&self) -> uint { self.map.len() }

    /// Return true if the set contains no elements
    #[inline(always)]
    pure fn is_empty(&self) -> bool { self.map.is_empty() }
}

impl<T: TotalOrd> Mutable for TreeSet<T> {
    /// Clear the set, removing all values.
    #[inline(always)]
    fn clear(&mut self) { self.map.clear() }
}

impl<T: TotalOrd> Set<T> for TreeSet<T> {
    /// Return true if the set contains a value
    #[inline(always)]
    pure fn contains(&self, value: &T) -> bool {
        self.map.contains_key(value)
    }

    /// Add a value to the set. Return true if the value was not already
    /// present in the set.
    #[inline(always)]
    fn insert(&mut self, value: T) -> bool { self.map.insert(value, ()) }

    /// Remove a value from the set. Return true if the value was
    /// present in the set.
    #[inline(always)]
    fn remove(&mut self, value: &T) -> bool { self.map.remove(value) }

    /// Return true if the set has no elements in common with `other`.
    /// This is equivalent to checking for an empty intersection.
    pure fn is_disjoint(&self, other: &TreeSet<T>) -> bool {
        let mut x = self.iter();
        let mut y = other.iter();
        unsafe { // purity workaround
            let mut a = set_next(&mut x);
            let mut b = set_next(&mut y);
            while a.is_some() && b.is_some() {
                let a1 = a.unwrap();
                let b1 = b.unwrap();
                match a1.cmp(b1) {
                  Less => a = set_next(&mut x),
                  Greater => b = set_next(&mut y),
                  Equal => return false
                }
            }
        }
        true
    }

    /// Return true if the set is a subset of another
    #[inline(always)]
    pure fn is_subset(&self, other: &TreeSet<T>) -> bool {
        other.is_superset(self)
    }

    /// Return true if the set is a superset of another
    pure fn is_superset(&self, other: &TreeSet<T>) -> bool {
        let mut x = self.iter();
        let mut y = other.iter();
        unsafe { // purity workaround
            let mut a = set_next(&mut x);
            let mut b = set_next(&mut y);
            while b.is_some() {
                if a.is_none() {
                    return false
                }

                let a1 = a.unwrap();
                let b1 = b.unwrap();

                match a1.cmp(b1) {
                  Less => (),
                  Greater => return false,
                  Equal => b = set_next(&mut y),
                }

                a = set_next(&mut x);
            }
        }
        true
    }

    /// Visit the values (in-order) representing the difference
    pure fn difference(&self, other: &TreeSet<T>, f: &fn(&T) -> bool) {
        let mut x = self.iter();
        let mut y = other.iter();

        unsafe { // purity workaround
            let mut a = set_next(&mut x);
            let mut b = set_next(&mut y);

            while a.is_some() {
                if b.is_none() {
                    return do a.while_some() |a1| {
                        if f(a1) { set_next(&mut x) } else { None }
                    }
                }

                let a1 = a.unwrap();
                let b1 = b.unwrap();

                let cmp = a1.cmp(b1);

                if cmp == Less {
                    if !f(a1) { return }
                    a = set_next(&mut x);
                } else {
                    if cmp == Equal { a = set_next(&mut x) }
                    b = set_next(&mut y);
                }
            }
        }
    }

    /// Visit the values (in-order) representing the symmetric difference
    pure fn symmetric_difference(&self, other: &TreeSet<T>,
                                 f: &fn(&T) -> bool) {
        let mut x = self.iter();
        let mut y = other.iter();

        unsafe { // purity workaround
            let mut a = set_next(&mut x);
            let mut b = set_next(&mut y);

            while a.is_some() {
                if b.is_none() {
                    return do a.while_some() |a1| {
                        if f(a1) { set_next(&mut x) } else { None }
                    }
                }

                let a1 = a.unwrap();
                let b1 = b.unwrap();

                let cmp = a1.cmp(b1);

                if cmp == Less {
                    if !f(a1) { return }
                    a = set_next(&mut x);
                } else {
                    if cmp == Greater {
                        if !f(b1) { return }
                    } else {
                        a = set_next(&mut x);
                    }
                    b = set_next(&mut y);
                }
            }
            do b.while_some |b1| {
                if f(b1) { set_next(&mut y) } else { None }
            }
        }
    }

    /// Visit the values (in-order) representing the intersection
    pure fn intersection(&self, other: &TreeSet<T>, f: &fn(&T) -> bool) {
        let mut x = self.iter();
        let mut y = other.iter();

        unsafe { // purity workaround
            let mut a = set_next(&mut x);
            let mut b = set_next(&mut y);

            while a.is_some() && b.is_some() {
                let a1 = a.unwrap();
                let b1 = b.unwrap();

                let cmp = a1.cmp(b1);

                if cmp == Less {
                    a = set_next(&mut x);
                } else {
                    if cmp == Equal {
                        if !f(a1) { return }
                    }
                    b = set_next(&mut y);
                }
            }
        }
    }

    /// Visit the values (in-order) representing the union
    pure fn union(&self, other: &TreeSet<T>, f: &fn(&T) -> bool) {
        let mut x = self.iter();
        let mut y = other.iter();

        unsafe { // purity workaround
            let mut a = set_next(&mut x);
            let mut b = set_next(&mut y);

            while a.is_some() {
                if b.is_none() {
                    return do a.while_some() |a1| {
                        if f(a1) { set_next(&mut x) } else { None }
                    }
                }

                let a1 = a.unwrap();
                let b1 = b.unwrap();

                let cmp = a1.cmp(b1);

                if cmp == Greater {
                    if !f(b1) { return }
                    b = set_next(&mut y);
                } else {
                    if !f(a1) { return }
                    if cmp == Equal {
                        b = set_next(&mut y);
                    }
                    a = set_next(&mut x);
                }
            }
            do b.while_some |b1| {
                if f(b1) { set_next(&mut y) } else { None }
            }
        }
    }
}

pub impl <T: TotalOrd> TreeSet<T> {
    /// Create an empty TreeSet
    #[inline(always)]
    static pure fn new() -> TreeSet<T> { TreeSet{map: TreeMap::new()} }

    /// Get a lazy iterator over the values in the set.
    /// Requires that it be frozen (immutable).
    #[inline(always)]
    pure fn iter(&self) -> TreeSetIterator/&self<T> {
        TreeSetIterator{iter: self.map.iter()}
    }
}

/// Lazy forward iterator over a set
pub struct TreeSetIterator<T> {
    priv iter: TreeMapIterator/&self<T, ()>
}

/// Advance the iterator to the next node (in order). If this iterator is
/// finished, does nothing.
#[inline(always)]
pub fn set_next<T>(iter: &mut TreeSetIterator/&r<T>) -> Option<&r/T> {
    do map_next(&mut iter.iter).map |&(value, _)| { value }
}

/// Advance the iterator through the set
#[inline(always)]
pub fn set_advance<T>(iter: &mut TreeSetIterator/&r<T>,
                      f: &fn(&r/T) -> bool) {
    do map_advance(&mut iter.iter) |(k, _)| { f(k) }
}

// Nodes keep track of their level in the tree, starting at 1 in the
// leaves and with a red child sharing the level of the parent.
struct TreeNode<K, V> {
    key: K,
    value: V,
    left: Option<~TreeNode<K, V>>,
    right: Option<~TreeNode<K, V>>,
    level: uint
}

pub impl<K: TotalOrd, V> TreeNode<K, V> {
    #[inline(always)]
    static pure fn new(key: K, value: V) -> TreeNode<K, V> {
        TreeNode{key: key, value: value, left: None, right: None, level: 1}
    }
}

pure fn each<K: TotalOrd, V>(node: &r/Option<~TreeNode<K, V>>,
                             f: &fn(&(&r/K, &r/V)) -> bool) {
    for node.each |x| {
        each(&x.left, f);
        if f(&(&x.key, &x.value)) { each(&x.right, f) }
    }
}

pure fn each_reverse<K: TotalOrd, V>(node: &r/Option<~TreeNode<K, V>>,
                                     f: &fn(&(&r/K, &r/V)) -> bool) {
    for node.each |x| {
        each_reverse(&x.right, f);
        if f(&(&x.key, &x.value)) { each_reverse(&x.left, f) }
    }
}

// Remove left horizontal link by rotating right
fn skew<K: TotalOrd, V>(node: &mut ~TreeNode<K, V>) {
    if node.left.map_default(false, |x| x.level == node.level) {
        let mut save = node.left.swap_unwrap();
        node.left <-> save.right; // save.right now None
        *node <-> save;
        node.right = Some(save);
    }
}

// Remove dual horizontal link by rotating left and increasing level of
// the parent
fn split<K: TotalOrd, V>(node: &mut ~TreeNode<K, V>) {
    if node.right.map_default(false,
      |x| x.right.map_default(false, |y| y.level == node.level)) {
        let mut save = node.right.swap_unwrap();
        node.right <-> save.left; // save.left now None
        save.level += 1;
        *node <-> save;
        node.left = Some(save);
    }
}

fn insert<K: TotalOrd, V>(node: &mut Option<~TreeNode<K, V>>, key: K,
                          value: V) -> bool {
    match *node {
      Some(ref mut save) => {
        match key.cmp(&save.key) {
          Less => {
            let inserted = insert(&mut save.left, key, value);
            skew(save);
            split(save);
            inserted
          }
          Greater => {
            let inserted = insert(&mut save.right, key, value);
            skew(save);
            split(save);
            inserted
          }
          Equal => {
            save.key = key;
            save.value = value;
            false
          }
        }
      }
      None => {
       *node = Some(~TreeNode::new(key, value));
        true
      }
    }
}

fn remove<K: TotalOrd, V>(node: &mut Option<~TreeNode<K, V>>,
                          key: &K) -> bool {
    fn heir_swap<K: TotalOrd, V>(node: &mut ~TreeNode<K, V>,
                            child: &mut Option<~TreeNode<K, V>>) {
        // *could* be done without recursion, but it won't borrow check
        do child.mutate |mut child| {
            if child.right.is_some() {
                heir_swap(node, &mut child.right);
            } else {
                node.key <-> child.key;
                node.value <-> child.value;
            }
            child
        }
    }

    match *node {
      None => {
        return false // bottom of tree
      }
      Some(ref mut save) => {
        let (removed, this) = match key.cmp(&save.key) {
          Less => (remove(&mut save.left, key), false),
          Greater => (remove(&mut save.right, key), false),
          Equal => {
            if save.left.is_some() {
                if save.right.is_some() {
                    let mut left = save.left.swap_unwrap();
                    if left.right.is_some() {
                        heir_swap(save, &mut left.right);
                    } else {
                        save.key <-> left.key;
                        save.value <-> left.value;
                    }
                    save.left = Some(left);
                    remove(&mut save.left, key);
                } else {
                    *save = save.left.swap_unwrap();
                }
                (true, false)
            } else if save.right.is_some() {
                *save = save.right.swap_unwrap();
                (true, false)
            } else {
                (true, true)
            }
          }
        };

        if !this {
            let left_level = save.left.map_default(0, |x| x.level);
            let right_level = save.right.map_default(0, |x| x.level);

            // re-balance, if necessary
            if left_level < save.level - 1 || right_level < save.level - 1 {
                save.level -= 1;

                if right_level > save.level {
                    do save.right.mutate |mut x| { x.level = save.level; x }
                }

                skew(save);

                match save.right {
                  Some(ref mut right) => {
                    skew(right);
                    match right.right {
                      Some(ref mut x) => { skew(x) },
                      None => ()
                    }
                  }
                  None => ()
                }

                split(save);
                match save.right {
                  Some(ref mut x) => { split(x) },
                  None => ()
                }
            }

            return removed;
        }
      }
    }

    *node = None;
    return true;
}

#[cfg(test)]
mod test_treemap {
    use core::prelude::*;
    use super::*;
    use core::rand;

    #[test]
    fn find_empty() {
        let m = TreeMap::new::<int, int>(); fail_unless!(m.find(&5) == None);
    }

    #[test]
    fn find_not_found() {
        let mut m = TreeMap::new();
        fail_unless!(m.insert(1, 2));
        fail_unless!(m.insert(5, 3));
        fail_unless!(m.insert(9, 3));
        fail_unless!(m.find(&2) == None);
    }

    #[test]
    fn insert_replace() {
        let mut m = TreeMap::new();
        fail_unless!(m.insert(5, 2));
        fail_unless!(m.insert(2, 9));
        fail_unless!(!m.insert(2, 11));
        fail_unless!(m.find(&2).unwrap() == &11);
    }

    #[test]
    fn test_clear() {
        let mut m = TreeMap::new();
        m.clear();
        fail_unless!(m.insert(5, 11));
        fail_unless!(m.insert(12, -3));
        fail_unless!(m.insert(19, 2));
        m.clear();
        fail_unless!(m.find(&5).is_none());
        fail_unless!(m.find(&12).is_none());
        fail_unless!(m.find(&19).is_none());
        fail_unless!(m.is_empty());
    }

    #[test]
    fn u8_map() {
        let mut m = TreeMap::new();

        let k1 = str::to_bytes(~"foo");
        let k2 = str::to_bytes(~"bar");
        let v1 = str::to_bytes(~"baz");
        let v2 = str::to_bytes(~"foobar");

        m.insert(copy k1, copy v1);
        m.insert(copy k2, copy v2);

        fail_unless!(m.find(&k2) == Some(&v2));
        fail_unless!(m.find(&k1) == Some(&v1));
    }

    fn check_equal<K: Eq + TotalOrd, V: Eq>(ctrl: &[(K, V)],
                                            map: &TreeMap<K, V>) {
        fail_unless!(ctrl.is_empty() == map.is_empty());
        for ctrl.each |x| {
            let &(k, v) = x;
            fail_unless!(map.find(&k).unwrap() == &v)
        }
        for map.each |&(map_k, map_v)| {
            let mut found = false;
            for ctrl.each |x| {
                let &(ctrl_k, ctrl_v) = x;
                if *map_k == ctrl_k {
                    fail_unless!(*map_v == ctrl_v);
                    found = true;
                    break;
                }
            }
            fail_unless!(found);
        }
    }

    fn check_left<K: TotalOrd, V>(node: &Option<~TreeNode<K, V>>,
                                  parent: &~TreeNode<K, V>) {
        match *node {
          Some(ref r) => {
            fail_unless!(r.key.cmp(&parent.key) == Less);
            fail_unless!(r.level == parent.level - 1); // left is black
            check_left(&r.left, r);
            check_right(&r.right, r, false);
          }
          None => fail_unless!(parent.level == 1) // parent is leaf
        }
    }

    fn check_right<K: TotalOrd, V>(node: &Option<~TreeNode<K, V>>,
                                   parent: &~TreeNode<K, V>,
                                   parent_red: bool) {
        match *node {
          Some(ref r) => {
            fail_unless!(r.key.cmp(&parent.key) == Greater);
            let red = r.level == parent.level;
            if parent_red { fail_unless!(!red) } // no dual horizontal links
            // Right red or black
            fail_unless!(red || r.level == parent.level - 1);
            check_left(&r.left, r);
            check_right(&r.right, r, red);
          }
          None => fail_unless!(parent.level == 1) // parent is leaf
        }
    }

    fn check_structure<K: TotalOrd, V>(map: &TreeMap<K, V>) {
        match map.root {
          Some(ref r) => {
            check_left(&r.left, r);
            check_right(&r.right, r, false);
          }
          None => ()
        }
    }

    #[test]
    fn test_rand_int() {
        let mut map = TreeMap::new::<int, int>();
        let mut ctrl = ~[];

        check_equal(ctrl, &map);
        fail_unless!(map.find(&5).is_none());

        let rng = rand::seeded_rng(&[42]);

        for 3.times {
            for 90.times {
                let k = rng.gen_int();
                let v = rng.gen_int();
                if !ctrl.contains(&(k, v)) {
                    fail_unless!(map.insert(k, v));
                    ctrl.push((k, v));
                    check_structure(&map);
                    check_equal(ctrl, &map);
                }
            }

            for 30.times {
                let r = rng.gen_uint_range(0, ctrl.len());
                let (key, _) = vec::remove(&mut ctrl, r);
                fail_unless!(map.remove(&key));
                check_structure(&map);
                check_equal(ctrl, &map);
            }
        }
    }

    #[test]
    fn test_len() {
        let mut m = TreeMap::new();
        fail_unless!(m.insert(3, 6));
        fail_unless!(m.len() == 1);
        fail_unless!(m.insert(0, 0));
        fail_unless!(m.len() == 2);
        fail_unless!(m.insert(4, 8));
        fail_unless!(m.len() == 3);
        fail_unless!(m.remove(&3));
        fail_unless!(m.len() == 2);
        fail_unless!(!m.remove(&5));
        fail_unless!(m.len() == 2);
        fail_unless!(m.insert(2, 4));
        fail_unless!(m.len() == 3);
        fail_unless!(m.insert(1, 2));
        fail_unless!(m.len() == 4);
    }

    #[test]
    fn test_each() {
        let mut m = TreeMap::new();

        fail_unless!(m.insert(3, 6));
        fail_unless!(m.insert(0, 0));
        fail_unless!(m.insert(4, 8));
        fail_unless!(m.insert(2, 4));
        fail_unless!(m.insert(1, 2));

        let mut n = 0;
        for m.each |&(k, v)| {
            fail_unless!(*k == n);
            fail_unless!(*v == n * 2);
            n += 1;
        }
    }

    #[test]
    fn test_each_reverse() {
        let mut m = TreeMap::new();

        fail_unless!(m.insert(3, 6));
        fail_unless!(m.insert(0, 0));
        fail_unless!(m.insert(4, 8));
        fail_unless!(m.insert(2, 4));
        fail_unless!(m.insert(1, 2));

        let mut n = 4;
        for m.each_reverse |&(k, v)| {
            fail_unless!(*k == n);
            fail_unless!(*v == n * 2);
            n -= 1;
        }
    }

    #[test]
    fn test_eq() {
        let mut a = TreeMap::new();
        let mut b = TreeMap::new();

        fail_unless!(a == b);
        fail_unless!(a.insert(0, 5));
        fail_unless!(a != b);
        fail_unless!(b.insert(0, 4));
        fail_unless!(a != b);
        fail_unless!(a.insert(5, 19));
        fail_unless!(a != b);
        fail_unless!(!b.insert(0, 5));
        fail_unless!(a != b);
        fail_unless!(b.insert(5, 19));
        fail_unless!(a == b);
    }

    #[test]
    fn test_lt() {
        let mut a = TreeMap::new();
        let mut b = TreeMap::new();

        fail_unless!(!(a < b) && !(b < a));
        fail_unless!(b.insert(0, 5));
        fail_unless!(a < b);
        fail_unless!(a.insert(0, 7));
        fail_unless!(!(a < b) && !(b < a));
        fail_unless!(b.insert(-2, 0));
        fail_unless!(b < a);
        fail_unless!(a.insert(-5, 2));
        fail_unless!(a < b);
        fail_unless!(a.insert(6, 2));
        fail_unless!(a < b && !(b < a));
    }

    #[test]
    fn test_ord() {
        let mut a = TreeMap::new();
        let mut b = TreeMap::new();

        fail_unless!(a <= b && a >= b);
        fail_unless!(a.insert(1, 1));
        fail_unless!(a > b && a >= b);
        fail_unless!(b < a && b <= a);
        fail_unless!(b.insert(2, 2));
        fail_unless!(b > a && b >= a);
        fail_unless!(a < b && a <= b);
    }

    #[test]
    fn test_lazy_iterator() {
        let mut m = TreeMap::new();
        let (x1, y1) = (2, 5);
        let (x2, y2) = (9, 12);
        let (x3, y3) = (20, -3);
        let (x4, y4) = (29, 5);
        let (x5, y5) = (103, 3);

        fail_unless!(m.insert(x1, y1));
        fail_unless!(m.insert(x2, y2));
        fail_unless!(m.insert(x3, y3));
        fail_unless!(m.insert(x4, y4));
        fail_unless!(m.insert(x5, y5));

        let m = m;
        let mut a = m.iter();

        // FIXME: #4492 (ICE): iter.get() == Some((&x1, &y1))

        fail_unless!(map_next(&mut a).unwrap() == (&x1, &y1));
        fail_unless!(map_next(&mut a).unwrap() == (&x2, &y2));
        fail_unless!(map_next(&mut a).unwrap() == (&x3, &y3));
        fail_unless!(map_next(&mut a).unwrap() == (&x4, &y4));
        fail_unless!(map_next(&mut a).unwrap() == (&x5, &y5));

        fail_unless!(map_next(&mut a).is_none());

        let mut b = m.iter();

        let expected = [(&x1, &y1), (&x2, &y2), (&x3, &y3), (&x4, &y4),
                        (&x5, &y5)];
        let mut i = 0;

        for map_advance(&mut b) |x| {
            fail_unless!(expected[i] == x);
            i += 1;

            if i == 2 {
                break
            }
        }

        for map_advance(&mut b) |x| {
            fail_unless!(expected[i] == x);
            i += 1;
        }
    }
}

#[cfg(test)]
mod test_set {
    use super::*;

    #[test]
    fn test_clear() {
        let mut s = TreeSet::new();
        s.clear();
        fail_unless!(s.insert(5));
        fail_unless!(s.insert(12));
        fail_unless!(s.insert(19));
        s.clear();
        fail_unless!(!s.contains(&5));
        fail_unless!(!s.contains(&12));
        fail_unless!(!s.contains(&19));
        fail_unless!(s.is_empty());
    }

    #[test]
    fn test_disjoint() {
        let mut xs = TreeSet::new();
        let mut ys = TreeSet::new();
        fail_unless!(xs.is_disjoint(&ys));
        fail_unless!(ys.is_disjoint(&xs));
        fail_unless!(xs.insert(5));
        fail_unless!(ys.insert(11));
        fail_unless!(xs.is_disjoint(&ys));
        fail_unless!(ys.is_disjoint(&xs));
        fail_unless!(xs.insert(7));
        fail_unless!(xs.insert(19));
        fail_unless!(xs.insert(4));
        fail_unless!(ys.insert(2));
        fail_unless!(ys.insert(-11));
        fail_unless!(xs.is_disjoint(&ys));
        fail_unless!(ys.is_disjoint(&xs));
        fail_unless!(ys.insert(7));
        fail_unless!(!xs.is_disjoint(&ys));
        fail_unless!(!ys.is_disjoint(&xs));
    }

    #[test]
    fn test_subset_and_superset() {
        let mut a = TreeSet::new();
        fail_unless!(a.insert(0));
        fail_unless!(a.insert(5));
        fail_unless!(a.insert(11));
        fail_unless!(a.insert(7));

        let mut b = TreeSet::new();
        fail_unless!(b.insert(0));
        fail_unless!(b.insert(7));
        fail_unless!(b.insert(19));
        fail_unless!(b.insert(250));
        fail_unless!(b.insert(11));
        fail_unless!(b.insert(200));

        fail_unless!(!a.is_subset(&b));
        fail_unless!(!a.is_superset(&b));
        fail_unless!(!b.is_subset(&a));
        fail_unless!(!b.is_superset(&a));

        fail_unless!(b.insert(5));

        fail_unless!(a.is_subset(&b));
        fail_unless!(!a.is_superset(&b));
        fail_unless!(!b.is_subset(&a));
        fail_unless!(b.is_superset(&a));
    }

    #[test]
    fn test_each() {
        let mut m = TreeSet::new();

        fail_unless!(m.insert(3));
        fail_unless!(m.insert(0));
        fail_unless!(m.insert(4));
        fail_unless!(m.insert(2));
        fail_unless!(m.insert(1));

        let mut n = 0;
        for m.each |x| {
            fail_unless!(*x == n);
            n += 1
        }
    }

    #[test]
    fn test_each_reverse() {
        let mut m = TreeSet::new();

        fail_unless!(m.insert(3));
        fail_unless!(m.insert(0));
        fail_unless!(m.insert(4));
        fail_unless!(m.insert(2));
        fail_unless!(m.insert(1));

        let mut n = 4;
        for m.each_reverse |x| {
            fail_unless!(*x == n);
            n -= 1
        }
    }

    fn check(a: &[int], b: &[int], expected: &[int],
             f: &fn(&TreeSet<int>, &TreeSet<int>, f: &fn(&int) -> bool)) {
        let mut set_a = TreeSet::new();
        let mut set_b = TreeSet::new();

        for a.each |x| { fail_unless!(set_a.insert(*x)) }
        for b.each |y| { fail_unless!(set_b.insert(*y)) }

        let mut i = 0;
        for f(&set_a, &set_b) |x| {
            fail_unless!(*x == expected[i]);
            i += 1;
        }
        fail_unless!(i == expected.len());
    }

    #[test]
    fn test_intersection() {
        fn check_intersection(a: &[int], b: &[int], expected: &[int]) {
            check(a, b, expected, |x, y, z| x.intersection(y, z))
        }

        check_intersection([], [], []);
        check_intersection([1, 2, 3], [], []);
        check_intersection([], [1, 2, 3], []);
        check_intersection([2], [1, 2, 3], [2]);
        check_intersection([1, 2, 3], [2], [2]);
        check_intersection([11, 1, 3, 77, 103, 5, -5],
                           [2, 11, 77, -9, -42, 5, 3],
                           [3, 5, 11, 77]);
    }

    #[test]
    fn test_difference() {
        fn check_difference(a: &[int], b: &[int], expected: &[int]) {
            check(a, b, expected, |x, y, z| x.difference(y, z))
        }

        check_difference([], [], []);
        check_difference([1, 12], [], [1, 12]);
        check_difference([], [1, 2, 3, 9], []);
        check_difference([1, 3, 5, 9, 11],
                         [3, 9],
                         [1, 5, 11]);
        check_difference([-5, 11, 22, 33, 40, 42],
                         [-12, -5, 14, 23, 34, 38, 39, 50],
                         [11, 22, 33, 40, 42]);
    }

    #[test]
    fn test_symmetric_difference() {
        fn check_symmetric_difference(a: &[int], b: &[int],
                                      expected: &[int]) {
            check(a, b, expected, |x, y, z| x.symmetric_difference(y, z))
        }

        check_symmetric_difference([], [], []);
        check_symmetric_difference([1, 2, 3], [2], [1, 3]);
        check_symmetric_difference([2], [1, 2, 3], [1, 3]);
        check_symmetric_difference([1, 3, 5, 9, 11],
                                   [-2, 3, 9, 14, 22],
                                   [-2, 1, 5, 11, 14, 22]);
    }

    #[test]
    fn test_union() {
        fn check_union(a: &[int], b: &[int],
                                      expected: &[int]) {
            check(a, b, expected, |x, y, z| x.union(y, z))
        }

        check_union([], [], []);
        check_union([1, 2, 3], [2], [1, 2, 3]);
        check_union([2], [1, 2, 3], [1, 2, 3]);
        check_union([1, 3, 5, 9, 11, 16, 19, 24],
                    [-2, 1, 5, 9, 13, 19],
                    [-2, 1, 3, 5, 9, 11, 13, 16, 19, 24]);
    }
}