src/libextra/treemap.rs

   1 // Copyright 2013 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 //! An ordered map and set implemented as self-balancing binary search
  12 //! trees. The only requirement for the types is that the key implements
  13 //! `TotalOrd`.
  14
  15
  16 use std::num;
  17 use std::util::{swap, replace};
  18 use std::iterator::{FromIterator, Extendable};
  19
  20 // This is implemented as an AA tree, which is a simplified variation of
  21 // a red-black tree where red (horizontal) nodes can only be added
  22 // as a right child. The time complexity is the same, and re-balancing
  23 // operations are more frequent but also cheaper.
  24
  25 // Future improvements:
  26
  27 // range search - O(log n) retrieval of an iterator from some key
  28
  29 // (possibly) implement the overloads Python does for sets:
  30 //   * intersection: &
  31 //   * difference: -
  32 //   * symmetric difference: ^
  33 //   * union: |
  34 // These would be convenient since the methods work like `each`
  35
  36 #[allow(missing_doc)]
  37 #[deriving(Clone)]
  38 pub struct TreeMap<K, V> {
  39     priv root: Option<~TreeNode<K, V>>,
  40     priv length: uint
  41 }
  42
  43 impl<K: Eq + TotalOrd, V: Eq> Eq for TreeMap<K, V> {
  44     fn eq(&self, other: &TreeMap<K, V>) -> bool {
  45         self.len() == other.len() &&
  46             self.iter().zip(other.iter()).all(|(a, b)| a == b)
  47     }
  48 }
  49
  50 // Lexicographical comparison
  51 fn lt<K: Ord + TotalOrd, V: Ord>(a: &TreeMap<K, V>,
  52                                  b: &TreeMap<K, V>) -> bool {
  53     // the Zip iterator is as long as the shortest of a and b.
  54     for ((key_a, value_a), (key_b, value_b)) in a.iter().zip(b.iter()) {
  55         if *key_a < *key_b { return true; }
  56         if *key_a > *key_b { return false; }
  57         if *value_a < *value_b { return true; }
  58         if *value_a > *value_b { return false; }
  59     }
  60
  61     a.len() < b.len()
  62 }
  63
  64 impl<K: Ord + TotalOrd, V: Ord> Ord for TreeMap<K, V> {
  65     #[inline]
  66     fn lt(&self, other: &TreeMap<K, V>) -> bool { lt(self, other) }
  67     #[inline]
  68     fn le(&self, other: &TreeMap<K, V>) -> bool { !lt(other, self) }
  69     #[inline]
  70     fn ge(&self, other: &TreeMap<K, V>) -> bool { !lt(self, other) }
  71     #[inline]
  72     fn gt(&self, other: &TreeMap<K, V>) -> bool { lt(other, self) }
  73 }
  74
  75 impl<K: TotalOrd, V> Container for TreeMap<K, V> {
  76     /// Return the number of elements in the map
  77     fn len(&self) -> uint { self.length }
  78
  79     /// Return true if the map contains no elements
  80     fn is_empty(&self) -> bool { self.root.is_none() }
  81 }
  82
  83 impl<K: TotalOrd, V> Mutable for TreeMap<K, V> {
  84     /// Clear the map, removing all key-value pairs.
  85     fn clear(&mut self) {
  86         self.root = None;
  87         self.length = 0
  88     }
  89 }
  90
  91 impl<K: TotalOrd, V> Map<K, V> for TreeMap<K, V> {
  92     /// Return a reference to the value corresponding to the key
  93     fn find<'a>(&'a self, key: &K) -> Option<&'a V> {
  94         let mut current: &'a Option<~TreeNode<K, V>> = &self.root;
  95         loop {
  96             match *current {
  97               Some(ref r) => {
  98                 match key.cmp(&r.key) {
  99                   Less => current = &r.left,
 100                   Greater => current = &r.right,
 101                   Equal => return Some(&r.value)
 102                 }
 103               }
 104               None => return None
 105             }
 106         }
 107     }
 108 }
 109
 110 impl<K: TotalOrd, V> MutableMap<K, V> for TreeMap<K, V> {
 111     /// Return a mutable reference to the value corresponding to the key
 112     #[inline]
 113     fn find_mut<'a>(&'a mut self, key: &K) -> Option<&'a mut V> {
 114         find_mut(&mut self.root, key)
 115     }
 116
 117     /// Insert a key-value pair from the map. If the key already had a value
 118     /// present in the map, that value is returned. Otherwise None is returned.
 119     fn swap(&mut self, key: K, value: V) -> Option<V> {
 120         let ret = insert(&mut self.root, key, value);
 121         if ret.is_none() { self.length += 1 }
 122         ret
 123     }
 124
 125     /// Removes a key from the map, returning the value at the key if the key
 126     /// was previously in the map.
 127     fn pop(&mut self, key: &K) -> Option<V> {
 128         let ret = remove(&mut self.root, key);
 129         if ret.is_some() { self.length -= 1 }
 130         ret
 131     }
 132 }
 133
 134 impl<K: TotalOrd, V> TreeMap<K, V> {
 135     /// Create an empty TreeMap
 136     pub fn new() -> TreeMap<K, V> { TreeMap{root: None, length: 0} }
 137
 138     /// Visit all keys in order
 139     pub fn each_key(&self, f: &fn(&K) -> bool) -> bool {
 140         self.iter().advance(|(k, _)| f(k))
 141     }
 142
 143     /// Visit all values in order
 144     pub fn each_value<'a>(&'a self, f: &fn(&'a V) -> bool) -> bool {
 145         self.iter().advance(|(_, v)| f(v))
 146     }
 147
 148     /// Iterate over the map and mutate the contained values
 149     pub fn mutate_values(&mut self, f: &fn(&K, &mut V) -> bool) -> bool {
 150         mutate_values(&mut self.root, f)
 151     }
 152
 153     /// Visit all key-value pairs in reverse order
 154     pub fn each_reverse<'a>(&'a self, f: &fn(&'a K, &'a V) -> bool) -> bool {
 155         each_reverse(&self.root, f)
 156     }
 157
 158     /// Visit all keys in reverse order
 159     pub fn each_key_reverse(&self, f: &fn(&K) -> bool) -> bool {
 160         self.each_reverse(|k, _| f(k))
 161     }
 162
 163     /// Visit all values in reverse order
 164     pub fn each_value_reverse(&self, f: &fn(&V) -> bool) -> bool {
 165         self.each_reverse(|_, v| f(v))
 166     }
 167
 168     /// Get a lazy iterator over the key-value pairs in the map.
 169     /// Requires that it be frozen (immutable).
 170     pub fn iter<'a>(&'a self) -> TreeMapIterator<'a, K, V> {
 171         TreeMapIterator {
 172             stack: ~[],
 173             node: &self.root,
 174             remaining_min: self.length,
 175             remaining_max: self.length
 176         }
 177     }
 178
 179     /// Get a lazy iterator that should be initialized using
 180     /// `iter_traverse_left`/`iter_traverse_right`/`iter_traverse_complete`.
 181     fn iter_for_traversal<'a>(&'a self) -> TreeMapIterator<'a, K, V> {
 182         TreeMapIterator {
 183             stack: ~[],
 184             node: &self.root,
 185             remaining_min: 0,
 186             remaining_max: self.length
 187         }
 188     }
 189
 190     /// Return a lazy iterator to the first key-value pair whose key is not less than `k`
 191     /// If all keys in map are less than `k` an empty iterator is returned.
 192     pub fn lower_bound_iter<'a>(&'a self, k: &K) -> TreeMapIterator<'a, K, V> {
 193         let mut iter: TreeMapIterator<'a, K, V> = self.iter_for_traversal();
 194         loop {
 195             match *iter.node {
 196               Some(ref r) => {
 197                 match k.cmp(&r.key) {
 198                   Less => iter_traverse_left(&mut iter),
 199                   Greater => iter_traverse_right(&mut iter),
 200                   Equal => {
 201                     iter_traverse_complete(&mut iter);
 202                     return iter;
 203                   }
 204                 }
 205               }
 206               None => {
 207                 iter_traverse_complete(&mut iter);
 208                 return iter;
 209               }
 210             }
 211         }
 212     }
 213
 214     /// Return a lazy iterator to the first key-value pair whose key is greater than `k`
 215     /// If all keys in map are not greater than `k` an empty iterator is returned.
 216     pub fn upper_bound_iter<'a>(&'a self, k: &K) -> TreeMapIterator<'a, K, V> {
 217         let mut iter: TreeMapIterator<'a, K, V> = self.iter_for_traversal();
 218         loop {
 219             match *iter.node {
 220               Some(ref r) => {
 221                 match k.cmp(&r.key) {
 222                   Less => iter_traverse_left(&mut iter),
 223                   Greater => iter_traverse_right(&mut iter),
 224                   Equal => iter_traverse_right(&mut iter)
 225                 }
 226               }
 227               None => {
 228                 iter_traverse_complete(&mut iter);
 229                 return iter;
 230               }
 231             }
 232         }
 233     }
 234
 235     /// Get a lazy iterator that consumes the treemap.
 236     pub fn consume_iter(self) -> TreeMapConsumeIterator<K, V> {
 237         let TreeMap { root: root, length: length } = self;
 238         let stk = match root {
 239             None => ~[],
 240             Some(~tn) => ~[tn]
 241         };
 242         TreeMapConsumeIterator {
 243             stack: stk,
 244             remaining: length
 245         }
 246     }
 247 }
 248
 249 /// Lazy forward iterator over a map
 250 pub struct TreeMapIterator<'self, K, V> {
 251     priv stack: ~[&'self ~TreeNode<K, V>],
 252     priv node: &'self Option<~TreeNode<K, V>>,
 253     priv remaining_min: uint,
 254     priv remaining_max: uint
 255 }
 256
 257 impl<'self, K, V> Iterator<(&'self K, &'self V)> for TreeMapIterator<'self, K, V> {
 258     /// Advance the iterator to the next node (in order) and return a
 259     /// tuple with a reference to the key and value. If there are no
 260     /// more nodes, return `None`.
 261     fn next(&mut self) -> Option<(&'self K, &'self V)> {
 262         while !self.stack.is_empty() || self.node.is_some() {
 263             match *self.node {
 264               Some(ref x) => {
 265                 self.stack.push(x);
 266                 self.node = &x.left;
 267               }
 268               None => {
 269                 let res = self.stack.pop();
 270                 self.node = &res.right;
 271                 self.remaining_max -= 1;
 272                 if self.remaining_min > 0 {
 273                     self.remaining_min -= 1;
 274                 }
 275                 return Some((&res.key, &res.value));
 276               }
 277             }
 278         }
 279         None
 280     }
 281
 282     #[inline]
 283     fn size_hint(&self) -> (uint, Option<uint>) {
 284         (self.remaining_min, Some(self.remaining_max))
 285     }
 286 }
 287
 288 /// iter_traverse_left, iter_traverse_right and iter_traverse_complete are used to
 289 /// initialize TreeMapIterator pointing to element inside tree structure.
 290 ///
 291 /// They should be used in following manner:
 292 ///   - create iterator using TreeMap::iter_for_traversal
 293 ///   - find required node using `iter_traverse_left`/`iter_traverse_right`
 294 ///     (current node is `TreeMapIterator::node` field)
 295 ///   - complete initialization with `iter_traverse_complete`
 296 #[inline]
 297 fn iter_traverse_left<'a, K, V>(it: &mut TreeMapIterator<'a, K, V>) {
 298     let node = it.node.get_ref();
 299     it.stack.push(node);
 300     it.node = &node.left;
 301 }
 302
 303 #[inline]
 304 fn iter_traverse_right<'a, K, V>(it: &mut TreeMapIterator<'a, K, V>) {
 305     it.node = &(it.node.get_ref().right);
 306 }
 307
 308 /// iter_traverse_left, iter_traverse_right and iter_traverse_complete are used to
 309 /// initialize TreeMapIterator pointing to element inside tree structure.
 310 ///
 311 /// Completes traversal. Should be called before using iterator.
 312 /// Iteration will start from `self.node`.
 313 /// If `self.node` is None iteration will start from last node from which we
 314 /// traversed left.
 315 #[inline]
 316 fn iter_traverse_complete<'a, K, V>(it: &mut TreeMapIterator<'a, K, V>) {
 317     static none: Option<~TreeNode<K, V>> = None;
 318     match *it.node {
 319         Some(ref n) => {
 320             it.stack.push(n);
 321             it.node = &none;
 322         }
 323         None => ()
 324     }
 325 }
 326
 327 /// Lazy forward iterator over a map that consumes the map while iterating
 328 pub struct TreeMapConsumeIterator<K, V> {
 329     priv stack: ~[TreeNode<K, V>],
 330     priv remaining: uint
 331 }
 332
 333 impl<K, V> Iterator<(K, V)> for TreeMapConsumeIterator<K,V> {
 334     #[inline]
 335     fn next(&mut self) -> Option<(K, V)> {
 336         while !self.stack.is_empty() {
 337             let TreeNode {
 338                 key: key,
 339                 value: value,
 340                 left: left,
 341                 right: right,
 342                 level: level
 343             } = self.stack.pop();
 344
 345             match left {
 346                 Some(~left) => {
 347                     let n = TreeNode {
 348                         key: key,
 349                         value: value,
 350                         left: None,
 351                         right: right,
 352                         level: level
 353                     };
 354                     self.stack.push(n);
 355                     self.stack.push(left);
 356                 }
 357                 None => {
 358                     match right {
 359                         Some(~right) => self.stack.push(right),
 360                         None => ()
 361                     }
 362                     self.remaining -= 1;
 363                     return Some((key, value))
 364                 }
 365             }
 366         }
 367         None
 368     }
 369
 370     #[inline]
 371     fn size_hint(&self) -> (uint, Option<uint>) {
 372         (self.remaining, Some(self.remaining))
 373     }
 374
 375 }
 376
 377 impl<'self, T> Iterator<&'self T> for TreeSetIterator<'self, T> {
 378     /// Advance the iterator to the next node (in order). If there are no more nodes, return `None`.
 379     #[inline]
 380     fn next(&mut self) -> Option<&'self T> {
 381         do self.iter.next().map_move |(value, _)| { value }
 382     }
 383 }
 384
 385 /// A implementation of the `Set` trait on top of the `TreeMap` container. The
 386 /// only requirement is that the type of the elements contained ascribes to the
 387 /// `TotalOrd` trait.
 388 pub struct TreeSet<T> {
 389     priv map: TreeMap<T, ()>
 390 }
 391
 392 impl<T: Eq + TotalOrd> Eq for TreeSet<T> {
 393     #[inline]
 394     fn eq(&self, other: &TreeSet<T>) -> bool { self.map == other.map }
 395     #[inline]
 396     fn ne(&self, other: &TreeSet<T>) -> bool { self.map != other.map }
 397 }
 398
 399 impl<T: Ord + TotalOrd> Ord for TreeSet<T> {
 400     #[inline]
 401     fn lt(&self, other: &TreeSet<T>) -> bool { self.map < other.map }
 402     #[inline]
 403     fn le(&self, other: &TreeSet<T>) -> bool { self.map <= other.map }
 404     #[inline]
 405     fn ge(&self, other: &TreeSet<T>) -> bool { self.map >= other.map }
 406     #[inline]
 407     fn gt(&self, other: &TreeSet<T>) -> bool { self.map > other.map }
 408 }
 409
 410 impl<T: TotalOrd> Container for TreeSet<T> {
 411     /// Return the number of elements in the set
 412     #[inline]
 413     fn len(&self) -> uint { self.map.len() }
 414
 415     /// Return true if the set contains no elements
 416     #[inline]
 417     fn is_empty(&self) -> bool { self.map.is_empty() }
 418 }
 419
 420 impl<T: TotalOrd> Mutable for TreeSet<T> {
 421     /// Clear the set, removing all values.
 422     #[inline]
 423     fn clear(&mut self) { self.map.clear() }
 424 }
 425
 426 impl<T: TotalOrd> Set<T> for TreeSet<T> {
 427     /// Return true if the set contains a value
 428     #[inline]
 429     fn contains(&self, value: &T) -> bool {
 430         self.map.contains_key(value)
 431     }
 432
 433     /// Return true if the set has no elements in common with `other`.
 434     /// This is equivalent to checking for an empty intersection.
 435     fn is_disjoint(&self, other: &TreeSet<T>) -> bool {
 436         let mut x = self.iter();
 437         let mut y = other.iter();
 438         let mut a = x.next();
 439         let mut b = y.next();
 440         while a.is_some() && b.is_some() {
 441             let a1 = a.unwrap();
 442             let b1 = b.unwrap();
 443             match a1.cmp(b1) {
 444               Less => a = x.next(),
 445               Greater => b = y.next(),
 446               Equal => return false
 447             }
 448         }
 449         true
 450     }
 451
 452     /// Return true if the set is a subset of another
 453     #[inline]
 454     fn is_subset(&self, other: &TreeSet<T>) -> bool {
 455         other.is_superset(self)
 456     }
 457
 458     /// Return true if the set is a superset of another
 459     fn is_superset(&self, other: &TreeSet<T>) -> bool {
 460         let mut x = self.iter();
 461         let mut y = other.iter();
 462         let mut a = x.next();
 463         let mut b = y.next();
 464         while b.is_some() {
 465             if a.is_none() {
 466                 return false
 467             }
 468
 469             let a1 = a.unwrap();
 470             let b1 = b.unwrap();
 471
 472             match a1.cmp(b1) {
 473               Less => (),
 474               Greater => return false,
 475               Equal => b = y.next(),
 476             }
 477
 478             a = x.next();
 479         }
 480         true
 481     }
 482 }
 483
 484 impl<T: TotalOrd> MutableSet<T> for TreeSet<T> {
 485     /// Add a value to the set. Return true if the value was not already
 486     /// present in the set.
 487     #[inline]
 488     fn insert(&mut self, value: T) -> bool { self.map.insert(value, ()) }
 489
 490     /// Remove a value from the set. Return true if the value was
 491     /// present in the set.
 492     #[inline]
 493     fn remove(&mut self, value: &T) -> bool { self.map.remove(value) }
 494 }
 495
 496 impl<T: TotalOrd> TreeSet<T> {
 497     /// Create an empty TreeSet
 498     #[inline]
 499     pub fn new() -> TreeSet<T> { TreeSet{map: TreeMap::new()} }
 500
 501     /// Get a lazy iterator over the values in the set.
 502     /// Requires that it be frozen (immutable).
 503     #[inline]
 504     pub fn iter<'a>(&'a self) -> TreeSetIterator<'a, T> {
 505         TreeSetIterator{iter: self.map.iter()}
 506     }
 507
 508     /// Get a lazy iterator pointing to the first value not less than `v` (greater or equal).
 509     /// If all elements in the set are less than `v` empty iterator is returned.
 510     #[inline]
 511     pub fn lower_bound_iter<'a>(&'a self, v: &T) -> TreeSetIterator<'a, T> {
 512         TreeSetIterator{iter: self.map.lower_bound_iter(v)}
 513     }
 514
 515     /// Get a lazy iterator pointing to the first value greater than `v`.
 516     /// If all elements in the set are not greater than `v` empty iterator is returned.
 517     #[inline]
 518     pub fn upper_bound_iter<'a>(&'a self, v: &T) -> TreeSetIterator<'a, T> {
 519         TreeSetIterator{iter: self.map.upper_bound_iter(v)}
 520     }
 521
 522     /// Visit all values in reverse order
 523     #[inline]
 524     pub fn each_reverse(&self, f: &fn(&T) -> bool) -> bool {
 525         self.map.each_key_reverse(f)
 526     }
 527
 528     /// Visit the values (in-order) representing the difference
 529     pub fn difference(&self, other: &TreeSet<T>, f: &fn(&T) -> bool) -> bool {
 530         let mut x = self.iter();
 531         let mut y = other.iter();
 532
 533         let mut a = x.next();
 534         let mut b = y.next();
 535
 536         while a.is_some() {
 537             if b.is_none() {
 538                 return f(a.unwrap()) && x.advance(f);
 539             }
 540
 541             let a1 = a.unwrap();
 542             let b1 = b.unwrap();
 543
 544             let cmp = a1.cmp(b1);
 545
 546             if cmp == Less {
 547                 if !f(a1) { return false; }
 548                 a = x.next();
 549             } else {
 550                 if cmp == Equal { a = x.next() }
 551                 b = y.next();
 552             }
 553         }
 554         return true;
 555     }
 556
 557     /// Visit the values (in-order) representing the symmetric difference
 558     pub fn symmetric_difference(&self, other: &TreeSet<T>,
 559                             f: &fn(&T) -> bool) -> bool {
 560         let mut x = self.iter();
 561         let mut y = other.iter();
 562
 563         let mut a = x.next();
 564         let mut b = y.next();
 565
 566         while a.is_some() {
 567             if b.is_none() {
 568                 return f(a.unwrap()) && x.advance(f);
 569             }
 570
 571             let a1 = a.unwrap();
 572             let b1 = b.unwrap();
 573
 574             let cmp = a1.cmp(b1);
 575
 576             if cmp == Less {
 577                 if !f(a1) { return false; }
 578                 a = x.next();
 579             } else {
 580                 if cmp == Greater {
 581                     if !f(b1) { return false; }
 582                 } else {
 583                     a = x.next();
 584                 }
 585                 b = y.next();
 586             }
 587         }
 588         b.iter().advance(|&x| f(x)) && y.advance(f)
 589     }
 590
 591     /// Visit the values (in-order) representing the intersection
 592     pub fn intersection(&self, other: &TreeSet<T>, f: &fn(&T) -> bool) -> bool {
 593         let mut x = self.iter();
 594         let mut y = other.iter();
 595
 596         let mut a = x.next();
 597         let mut b = y.next();
 598
 599         while a.is_some() && b.is_some() {
 600             let a1 = a.unwrap();
 601             let b1 = b.unwrap();
 602
 603             let cmp = a1.cmp(b1);
 604
 605             if cmp == Less {
 606                 a = x.next();
 607             } else {
 608                 if cmp == Equal {
 609                     if !f(a1) { return false }
 610                 }
 611                 b = y.next();
 612             }
 613         }
 614         return true;
 615     }
 616
 617     /// Visit the values (in-order) representing the union
 618     pub fn union(&self, other: &TreeSet<T>, f: &fn(&T) -> bool) -> bool {
 619         let mut x = self.iter();
 620         let mut y = other.iter();
 621
 622         let mut a = x.next();
 623         let mut b = y.next();
 624
 625         while a.is_some() {
 626             if b.is_none() {
 627                 return f(a.unwrap()) && x.advance(f);
 628             }
 629
 630             let a1 = a.unwrap();
 631             let b1 = b.unwrap();
 632
 633             let cmp = a1.cmp(b1);
 634
 635             if cmp == Greater {
 636                 if !f(b1) { return false; }
 637                 b = y.next();
 638             } else {
 639                 if !f(a1) { return false; }
 640                 if cmp == Equal {
 641                     b = y.next();
 642                 }
 643                 a = x.next();
 644             }
 645         }
 646         b.iter().advance(|&x| f(x)) && y.advance(f)
 647     }
 648 }
 649
 650 /// Lazy forward iterator over a set
 651 pub struct TreeSetIterator<'self, T> {
 652     priv iter: TreeMapIterator<'self, T, ()>
 653 }
 654
 655 // Nodes keep track of their level in the tree, starting at 1 in the
 656 // leaves and with a red child sharing the level of the parent.
 657 #[deriving(Clone)]
 658 struct TreeNode<K, V> {
 659     key: K,
 660     value: V,
 661     left: Option<~TreeNode<K, V>>,
 662     right: Option<~TreeNode<K, V>>,
 663     level: uint
 664 }
 665
 666 impl<K: TotalOrd, V> TreeNode<K, V> {
 667     /// Creates a new tree node.
 668     #[inline]
 669     pub fn new(key: K, value: V) -> TreeNode<K, V> {
 670         TreeNode{key: key, value: value, left: None, right: None, level: 1}
 671     }
 672 }
 673
 674 fn each<'r, K: TotalOrd, V>(node: &'r Option<~TreeNode<K, V>>,
 675                             f: &fn(&'r K, &'r V) -> bool) -> bool {
 676     node.iter().advance(|x| each(&x.left,  |k,v| f(k,v)) && f(&x.key, &x.value) &&
 677                             each(&x.right, |k,v| f(k,v)))
 678 }
 679
 680 fn each_reverse<'r, K: TotalOrd, V>(node: &'r Option<~TreeNode<K, V>>,
 681                                     f: &fn(&'r K, &'r V) -> bool) -> bool {
 682     node.iter().advance(|x| each_reverse(&x.right, |k,v| f(k,v)) && f(&x.key, &x.value) &&
 683                             each_reverse(&x.left,  |k,v| f(k,v)))
 684 }
 685
 686 fn mutate_values<'r, K: TotalOrd, V>(node: &'r mut Option<~TreeNode<K, V>>,
 687                                      f: &fn(&'r K, &'r mut V) -> bool)
 688                                   -> bool {
 689     match *node {
 690       Some(~TreeNode{key: ref key, value: ref mut value, left: ref mut left,
 691                      right: ref mut right, _}) => {
 692         if !mutate_values(left,  |k,v| f(k,v)) { return false }
 693         if !f(key, value) { return false }
 694         if !mutate_values(right, |k,v| f(k,v)) { return false }
 695       }
 696       None => return false
 697     }
 698     true
 699 }
 700
 701 // Remove left horizontal link by rotating right
 702 fn skew<K: TotalOrd, V>(node: &mut ~TreeNode<K, V>) {
 703     if node.left.map_default(false, |x| x.level == node.level) {
 704         let mut save = node.left.take_unwrap();
 705         swap(&mut node.left, &mut save.right); // save.right now None
 706         swap(node, &mut save);
 707         node.right = Some(save);
 708     }
 709 }
 710
 711 // Remove dual horizontal link by rotating left and increasing level of
 712 // the parent
 713 fn split<K: TotalOrd, V>(node: &mut ~TreeNode<K, V>) {
 714     if node.right.map_default(false,
 715       |x| x.right.map_default(false, |y| y.level == node.level)) {
 716         let mut save = node.right.take_unwrap();
 717         swap(&mut node.right, &mut save.left); // save.left now None
 718         save.level += 1;
 719         swap(node, &mut save);
 720         node.left = Some(save);
 721     }
 722 }
 723
 724 fn find_mut<'r, K: TotalOrd, V>(node: &'r mut Option<~TreeNode<K, V>>,
 725                                 key: &K)
 726                              -> Option<&'r mut V> {
 727     match *node {
 728       Some(ref mut x) => {
 729         match key.cmp(&x.key) {
 730           Less => find_mut(&mut x.left, key),
 731           Greater => find_mut(&mut x.right, key),
 732           Equal => Some(&mut x.value),
 733         }
 734       }
 735       None => None
 736     }
 737 }
 738
 739 fn insert<K: TotalOrd, V>(node: &mut Option<~TreeNode<K, V>>,
 740                           key: K, value: V) -> Option<V> {
 741     match *node {
 742       Some(ref mut save) => {
 743         match key.cmp(&save.key) {
 744           Less => {
 745             let inserted = insert(&mut save.left, key, value);
 746             skew(save);
 747             split(save);
 748             inserted
 749           }
 750           Greater => {
 751             let inserted = insert(&mut save.right, key, value);
 752             skew(save);
 753             split(save);
 754             inserted
 755           }
 756           Equal => {
 757             save.key = key;
 758             Some(replace(&mut save.value, value))
 759           }
 760         }
 761       }
 762       None => {
 763        *node = Some(~TreeNode::new(key, value));
 764         None
 765       }
 766     }
 767 }
 768
 769 fn remove<K: TotalOrd, V>(node: &mut Option<~TreeNode<K, V>>,
 770                           key: &K) -> Option<V> {
 771     fn heir_swap<K: TotalOrd, V>(node: &mut ~TreeNode<K, V>,
 772                                  child: &mut Option<~TreeNode<K, V>>) {
 773         // *could* be done without recursion, but it won't borrow check
 774         for x in child.mut_iter() {
 775             if x.right.is_some() {
 776                 heir_swap(node, &mut x.right);
 777             } else {
 778                 swap(&mut node.key, &mut x.key);
 779                 swap(&mut node.value, &mut x.value);
 780             }
 781         }
 782     }
 783
 784     match *node {
 785       None => {
 786         return None; // bottom of tree
 787       }
 788       Some(ref mut save) => {
 789         let (ret, rebalance) = match key.cmp(&save.key) {
 790           Less => (remove(&mut save.left, key), true),
 791           Greater => (remove(&mut save.right, key), true),
 792           Equal => {
 793             if save.left.is_some() {
 794                 if save.right.is_some() {
 795                     let mut left = save.left.take_unwrap();
 796                     if left.right.is_some() {
 797                         heir_swap(save, &mut left.right);
 798                     } else {
 799                         swap(&mut save.key, &mut left.key);
 800                         swap(&mut save.value, &mut left.value);
 801                     }
 802                     save.left = Some(left);
 803                     (remove(&mut save.left, key), true)
 804                 } else {
 805                     let new = save.left.take_unwrap();
 806                     let ~TreeNode{value, _} = replace(save, new);
 807                     *save = save.left.take_unwrap();
 808                     (Some(value), true)
 809                 }
 810             } else if save.right.is_some() {
 811                 let new = save.right.take_unwrap();
 812                 let ~TreeNode{value, _} = replace(save, new);
 813                 (Some(value), true)
 814             } else {
 815                 (None, false)
 816             }
 817           }
 818         };
 819
 820         if rebalance {
 821             let left_level = save.left.map_default(0, |x| x.level);
 822             let right_level = save.right.map_default(0, |x| x.level);
 823
 824             // re-balance, if necessary
 825             if left_level < save.level - 1 || right_level < save.level - 1 {
 826                 save.level -= 1;
 827
 828                 if right_level > save.level {
 829                     for x in save.right.mut_iter() { x.level = save.level }
 830                 }
 831
 832                 skew(save);
 833
 834                 for right in save.right.mut_iter() {
 835                     skew(right);
 836                     for x in right.right.mut_iter() { skew(x) }
 837                 }
 838
 839                 split(save);
 840                 for x in save.right.mut_iter() { split(x) }
 841             }
 842
 843             return ret;
 844         }
 845       }
 846     }
 847     return match node.take() {
 848         Some(~TreeNode{value, _}) => Some(value), None => fail!()
 849     };
 850 }
 851
 852 impl<K: TotalOrd, V, T: Iterator<(K, V)>> FromIterator<(K, V), T> for TreeMap<K, V> {
 853     fn from_iterator(iter: &mut T) -> TreeMap<K, V> {
 854         let mut map = TreeMap::new();
 855         map.extend(iter);
 856         map
 857     }
 858 }
 859
 860 impl<K: TotalOrd, V, T: Iterator<(K, V)>> Extendable<(K, V), T> for TreeMap<K, V> {
 861     #[inline]
 862     fn extend(&mut self, iter: &mut T) {
 863         for (k, v) in *iter {
 864             self.insert(k, v);
 865         }
 866     }
 867 }
 868
 869 impl<T: TotalOrd, Iter: Iterator<T>> FromIterator<T, Iter> for TreeSet<T> {
 870     pub fn from_iterator(iter: &mut Iter) -> TreeSet<T> {
 871         let mut set = TreeSet::new();
 872         set.extend(iter);
 873         set
 874     }
 875 }
 876
 877 impl<T: TotalOrd, Iter: Iterator<T>> Extendable<T, Iter> for TreeSet<T> {
 878     #[inline]
 879     fn extend(&mut self, iter: &mut Iter) {
 880         for elem in *iter {
 881             self.insert(elem);
 882         }
 883     }
 884 }
 885
 886 #[cfg(test)]
 887 mod test_treemap {
 888
 889     use super::*;
 890
 891     use std::rand::RngUtil;
 892     use std::rand;
 893
 894     #[test]
 895     fn find_empty() {
 896         let m = TreeMap::new::<int, int>(); assert!(m.find(&5) == None);
 897     }
 898
 899     #[test]
 900     fn find_not_found() {
 901         let mut m = TreeMap::new();
 902         assert!(m.insert(1, 2));
 903         assert!(m.insert(5, 3));
 904         assert!(m.insert(9, 3));
 905         assert_eq!(m.find(&2), None);
 906     }
 907
 908     #[test]
 909     fn test_find_mut() {
 910         let mut m = TreeMap::new();
 911         assert!(m.insert(1, 12));
 912         assert!(m.insert(2, 8));
 913         assert!(m.insert(5, 14));
 914         let new = 100;
 915         match m.find_mut(&5) {
 916           None => fail!(), Some(x) => *x = new
 917         }
 918         assert_eq!(m.find(&5), Some(&new));
 919     }
 920
 921     #[test]
 922     fn insert_replace() {
 923         let mut m = TreeMap::new();
 924         assert!(m.insert(5, 2));
 925         assert!(m.insert(2, 9));
 926         assert!(!m.insert(2, 11));
 927         assert_eq!(m.find(&2).unwrap(), &11);
 928     }
 929
 930     #[test]
 931     fn test_clear() {
 932         let mut m = TreeMap::new();
 933         m.clear();
 934         assert!(m.insert(5, 11));
 935         assert!(m.insert(12, -3));
 936         assert!(m.insert(19, 2));
 937         m.clear();
 938         assert!(m.find(&5).is_none());
 939         assert!(m.find(&12).is_none());
 940         assert!(m.find(&19).is_none());
 941         assert!(m.is_empty());
 942     }
 943
 944     #[test]
 945     fn u8_map() {
 946         let mut m = TreeMap::new();
 947
 948         let k1 = "foo".as_bytes();
 949         let k2 = "bar".as_bytes();
 950         let v1 = "baz".as_bytes();
 951         let v2 = "foobar".as_bytes();
 952
 953         m.insert(k1.clone(), v1.clone());
 954         m.insert(k2.clone(), v2.clone());
 955
 956         assert_eq!(m.find(&k2), Some(&v2));
 957         assert_eq!(m.find(&k1), Some(&v1));
 958     }
 959
 960     fn check_equal<K: Eq + TotalOrd, V: Eq>(ctrl: &[(K, V)],
 961                                             map: &TreeMap<K, V>) {
 962         assert_eq!(ctrl.is_empty(), map.is_empty());
 963         for x in ctrl.iter() {
 964             let &(ref k, ref v) = x;
 965             assert!(map.find(k).unwrap() == v)
 966         }
 967         for (map_k, map_v) in map.iter() {
 968             let mut found = false;
 969             for x in ctrl.iter() {
 970                 let &(ref ctrl_k, ref ctrl_v) = x;
 971                 if *map_k == *ctrl_k {
 972                     assert!(*map_v == *ctrl_v);
 973                     found = true;
 974                     break;
 975                 }
 976             }
 977             assert!(found);
 978         }
 979     }
 980
 981     fn check_left<K: TotalOrd, V>(node: &Option<~TreeNode<K, V>>,
 982                                   parent: &~TreeNode<K, V>) {
 983         match *node {
 984           Some(ref r) => {
 985             assert_eq!(r.key.cmp(&parent.key), Less);
 986             assert!(r.level == parent.level - 1); // left is black
 987             check_left(&r.left, r);
 988             check_right(&r.right, r, false);
 989           }
 990           None => assert!(parent.level == 1) // parent is leaf
 991         }
 992     }
 993
 994     fn check_right<K: TotalOrd, V>(node: &Option<~TreeNode<K, V>>,
 995                                    parent: &~TreeNode<K, V>,
 996                                    parent_red: bool) {
 997         match *node {
 998           Some(ref r) => {
 999             assert_eq!(r.key.cmp(&parent.key), Greater);
1000             let red = r.level == parent.level;
1001             if parent_red { assert!(!red) } // no dual horizontal links
1002             // Right red or black
1003             assert!(red || r.level == parent.level - 1);
1004             check_left(&r.left, r);
1005             check_right(&r.right, r, red);
1006           }
1007           None => assert!(parent.level == 1) // parent is leaf
1008         }
1009     }
1010
1011     fn check_structure<K: TotalOrd, V>(map: &TreeMap<K, V>) {
1012         match map.root {
1013           Some(ref r) => {
1014             check_left(&r.left, r);
1015             check_right(&r.right, r, false);
1016           }
1017           None => ()
1018         }
1019     }
1020
1021     #[test]
1022     fn test_rand_int() {
1023         let mut map = TreeMap::new::<int, int>();
1024         let mut ctrl = ~[];
1025
1026         check_equal(ctrl, &map);
1027         assert!(map.find(&5).is_none());
1028
1029         let mut rng = rand::IsaacRng::new_seeded(&[42]);
1030
1031         do 3.times {
1032             do 90.times {
1033                 let k = rng.gen();
1034                 let v = rng.gen();
1035                 if !ctrl.iter().any(|x| x == &(k, v)) {
1036                     assert!(map.insert(k, v));
1037                     ctrl.push((k, v));
1038                     check_structure(&map);
1039                     check_equal(ctrl, &map);
1040                 }
1041             }
1042
1043             do 30.times {
1044                 let r = rng.gen_uint_range(0, ctrl.len());
1045                 let (key, _) = ctrl.remove(r);
1046                 assert!(map.remove(&key));
1047                 check_structure(&map);
1048                 check_equal(ctrl, &map);
1049             }
1050         }
1051     }
1052
1053     #[test]
1054     fn test_len() {
1055         let mut m = TreeMap::new();
1056         assert!(m.insert(3, 6));
1057         assert_eq!(m.len(), 1);
1058         assert!(m.insert(0, 0));
1059         assert_eq!(m.len(), 2);
1060         assert!(m.insert(4, 8));
1061         assert_eq!(m.len(), 3);
1062         assert!(m.remove(&3));
1063         assert_eq!(m.len(), 2);
1064         assert!(!m.remove(&5));
1065         assert_eq!(m.len(), 2);
1066         assert!(m.insert(2, 4));
1067         assert_eq!(m.len(), 3);
1068         assert!(m.insert(1, 2));
1069         assert_eq!(m.len(), 4);
1070     }
1071
1072     #[test]
1073     fn test_iterator() {
1074         let mut m = TreeMap::new();
1075
1076         assert!(m.insert(3, 6));
1077         assert!(m.insert(0, 0));
1078         assert!(m.insert(4, 8));
1079         assert!(m.insert(2, 4));
1080         assert!(m.insert(1, 2));
1081
1082         let mut n = 0;
1083         for (k, v) in m.iter() {
1084             assert_eq!(*k, n);
1085             assert_eq!(*v, n * 2);
1086             n += 1;
1087         }
1088         assert_eq!(n, 5);
1089     }
1090
1091     #[test]
1092     fn test_interval_iteration() {
1093         let mut m = TreeMap::new();
1094         for i in range(1, 100) {
1095             assert!(m.insert(i * 2, i * 4));
1096         }
1097
1098         for i in range(1, 198) {
1099             let mut lb_it = m.lower_bound_iter(&i);
1100             let (&k, &v) = lb_it.next().unwrap();
1101             let lb = i + i % 2;
1102             assert_eq!(lb, k);
1103             assert_eq!(lb * 2, v);
1104
1105             let mut ub_it = m.upper_bound_iter(&i);
1106             let (&k, &v) = ub_it.next().unwrap();
1107             let ub = i + 2 - i % 2;
1108             assert_eq!(ub, k);
1109             assert_eq!(ub * 2, v);
1110         }
1111         let mut end_it = m.lower_bound_iter(&199);
1112         assert_eq!(end_it.next(), None);
1113     }
1114
1115     #[test]
1116     fn test_each_reverse() {
1117         let mut m = TreeMap::new();
1118
1119         assert!(m.insert(3, 6));
1120         assert!(m.insert(0, 0));
1121         assert!(m.insert(4, 8));
1122         assert!(m.insert(2, 4));
1123         assert!(m.insert(1, 2));
1124
1125         let mut n = 4;
1126         do m.each_reverse |k, v| {
1127             assert_eq!(*k, n);
1128             assert_eq!(*v, n * 2);
1129             n -= 1;
1130             true
1131         };
1132     }
1133
1134     #[test]
1135     fn test_eq() {
1136         let mut a = TreeMap::new();
1137         let mut b = TreeMap::new();
1138
1139         assert!(a == b);
1140         assert!(a.insert(0, 5));
1141         assert!(a != b);
1142         assert!(b.insert(0, 4));
1143         assert!(a != b);
1144         assert!(a.insert(5, 19));
1145         assert!(a != b);
1146         assert!(!b.insert(0, 5));
1147         assert!(a != b);
1148         assert!(b.insert(5, 19));
1149         assert!(a == b);
1150     }
1151
1152     #[test]
1153     fn test_lt() {
1154         let mut a = TreeMap::new();
1155         let mut b = TreeMap::new();
1156
1157         assert!(!(a < b) && !(b < a));
1158         assert!(b.insert(0, 5));
1159         assert!(a < b);
1160         assert!(a.insert(0, 7));
1161         assert!(!(a < b) && b < a);
1162         assert!(b.insert(-2, 0));
1163         assert!(b < a);
1164         assert!(a.insert(-5, 2));
1165         assert!(a < b);
1166         assert!(a.insert(6, 2));
1167         assert!(a < b && !(b < a));
1168     }
1169
1170     #[test]
1171     fn test_ord() {
1172         let mut a = TreeMap::new();
1173         let mut b = TreeMap::new();
1174
1175         assert!(a <= b && a >= b);
1176         assert!(a.insert(1, 1));
1177         assert!(a > b && a >= b);
1178         assert!(b < a && b <= a);
1179         assert!(b.insert(2, 2));
1180         assert!(b > a && b >= a);
1181         assert!(a < b && a <= b);
1182     }
1183
1184     #[test]
1185     fn test_lazy_iterator() {
1186         let mut m = TreeMap::new();
1187         let (x1, y1) = (2, 5);
1188         let (x2, y2) = (9, 12);
1189         let (x3, y3) = (20, -3);
1190         let (x4, y4) = (29, 5);
1191         let (x5, y5) = (103, 3);
1192
1193         assert!(m.insert(x1, y1));
1194         assert!(m.insert(x2, y2));
1195         assert!(m.insert(x3, y3));
1196         assert!(m.insert(x4, y4));
1197         assert!(m.insert(x5, y5));
1198
1199         let m = m;
1200         let mut a = m.iter();
1201
1202         assert_eq!(a.next().unwrap(), (&x1, &y1));
1203         assert_eq!(a.next().unwrap(), (&x2, &y2));
1204         assert_eq!(a.next().unwrap(), (&x3, &y3));
1205         assert_eq!(a.next().unwrap(), (&x4, &y4));
1206         assert_eq!(a.next().unwrap(), (&x5, &y5));
1207
1208         assert!(a.next().is_none());
1209
1210         let mut b = m.iter();
1211
1212         let expected = [(&x1, &y1), (&x2, &y2), (&x3, &y3), (&x4, &y4),
1213                         (&x5, &y5)];
1214         let mut i = 0;
1215
1216         for x in b {
1217             assert_eq!(expected[i], x);
1218             i += 1;
1219
1220             if i == 2 {
1221                 break
1222             }
1223         }
1224
1225         for x in b {
1226             assert_eq!(expected[i], x);
1227             i += 1;
1228         }
1229     }
1230
1231     #[test]
1232     fn test_from_iter() {
1233         let xs = ~[(1, 1), (2, 2), (3, 3), (4, 4), (5, 5), (6, 6)];
1234
1235         let map: TreeMap<int, int> = xs.iter().transform(|&x| x).collect();
1236
1237         for &(k, v) in xs.iter() {
1238             assert_eq!(map.find(&k), Some(&v));
1239         }
1240     }
1241
1242 }
1243
1244 #[cfg(test)]
1245 mod bench {
1246
1247     use super::*;
1248     use test::BenchHarness;
1249     use container::bench::*;
1250
1251     // Find seq
1252     #[bench]
1253     pub fn insert_rand_100(bh: &mut BenchHarness) {
1254         let mut m : TreeMap<uint,uint> = TreeMap::new();
1255         insert_rand_n(100, &mut m, bh);
1256     }
1257
1258     #[bench]
1259     pub fn insert_rand_10_000(bh: &mut BenchHarness) {
1260         let mut m : TreeMap<uint,uint> = TreeMap::new();
1261         insert_rand_n(10_000, &mut m, bh);
1262     }
1263
1264     // Insert seq
1265     #[bench]
1266     pub fn insert_seq_100(bh: &mut BenchHarness) {
1267         let mut m : TreeMap<uint,uint> = TreeMap::new();
1268         insert_seq_n(100, &mut m, bh);
1269     }
1270
1271     #[bench]
1272     pub fn insert_seq_10_000(bh: &mut BenchHarness) {
1273         let mut m : TreeMap<uint,uint> = TreeMap::new();
1274         insert_seq_n(10_000, &mut m, bh);
1275     }
1276
1277     // Find rand
1278     #[bench]
1279     pub fn find_rand_100(bh: &mut BenchHarness) {
1280         let mut m : TreeMap<uint,uint> = TreeMap::new();
1281         find_rand_n(100, &mut m, bh);
1282     }
1283
1284     #[bench]
1285     pub fn find_rand_10_000(bh: &mut BenchHarness) {
1286         let mut m : TreeMap<uint,uint> = TreeMap::new();
1287         find_rand_n(10_000, &mut m, bh);
1288     }
1289
1290     // Find seq
1291     #[bench]
1292     pub fn find_seq_100(bh: &mut BenchHarness) {
1293         let mut m : TreeMap<uint,uint> = TreeMap::new();
1294         find_seq_n(100, &mut m, bh);
1295     }
1296
1297     #[bench]
1298     pub fn find_seq_10_000(bh: &mut BenchHarness) {
1299         let mut m : TreeMap<uint,uint> = TreeMap::new();
1300         find_seq_n(10_000, &mut m, bh);
1301     }
1302 }
1303
1304 #[cfg(test)]
1305 mod test_set {
1306
1307     use super::*;
1308
1309     #[test]
1310     fn test_clear() {
1311         let mut s = TreeSet::new();
1312         s.clear();
1313         assert!(s.insert(5));
1314         assert!(s.insert(12));
1315         assert!(s.insert(19));
1316         s.clear();
1317         assert!(!s.contains(&5));
1318         assert!(!s.contains(&12));
1319         assert!(!s.contains(&19));
1320         assert!(s.is_empty());
1321     }
1322
1323     #[test]
1324     fn test_disjoint() {
1325         let mut xs = TreeSet::new();
1326         let mut ys = TreeSet::new();
1327         assert!(xs.is_disjoint(&ys));
1328         assert!(ys.is_disjoint(&xs));
1329         assert!(xs.insert(5));
1330         assert!(ys.insert(11));
1331         assert!(xs.is_disjoint(&ys));
1332         assert!(ys.is_disjoint(&xs));
1333         assert!(xs.insert(7));
1334         assert!(xs.insert(19));
1335         assert!(xs.insert(4));
1336         assert!(ys.insert(2));
1337         assert!(ys.insert(-11));
1338         assert!(xs.is_disjoint(&ys));
1339         assert!(ys.is_disjoint(&xs));
1340         assert!(ys.insert(7));
1341         assert!(!xs.is_disjoint(&ys));
1342         assert!(!ys.is_disjoint(&xs));
1343     }
1344
1345     #[test]
1346     fn test_subset_and_superset() {
1347         let mut a = TreeSet::new();
1348         assert!(a.insert(0));
1349         assert!(a.insert(5));
1350         assert!(a.insert(11));
1351         assert!(a.insert(7));
1352
1353         let mut b = TreeSet::new();
1354         assert!(b.insert(0));
1355         assert!(b.insert(7));
1356         assert!(b.insert(19));
1357         assert!(b.insert(250));
1358         assert!(b.insert(11));
1359         assert!(b.insert(200));
1360
1361         assert!(!a.is_subset(&b));
1362         assert!(!a.is_superset(&b));
1363         assert!(!b.is_subset(&a));
1364         assert!(!b.is_superset(&a));
1365
1366         assert!(b.insert(5));
1367
1368         assert!(a.is_subset(&b));
1369         assert!(!a.is_superset(&b));
1370         assert!(!b.is_subset(&a));
1371         assert!(b.is_superset(&a));
1372     }
1373
1374     #[test]
1375     fn test_iterator() {
1376         let mut m = TreeSet::new();
1377
1378         assert!(m.insert(3));
1379         assert!(m.insert(0));
1380         assert!(m.insert(4));
1381         assert!(m.insert(2));
1382         assert!(m.insert(1));
1383
1384         let mut n = 0;
1385         for x in m.iter() {
1386             assert_eq!(*x, n);
1387             n += 1
1388         }
1389     }
1390
1391     #[test]
1392     fn test_each_reverse() {
1393         let mut m = TreeSet::new();
1394
1395         assert!(m.insert(3));
1396         assert!(m.insert(0));
1397         assert!(m.insert(4));
1398         assert!(m.insert(2));
1399         assert!(m.insert(1));
1400
1401         let mut n = 4;
1402         do m.each_reverse |x| {
1403             assert_eq!(*x, n);
1404             n -= 1;
1405             true
1406         };
1407     }
1408
1409     fn check(a: &[int], b: &[int], expected: &[int],
1410              f: &fn(&TreeSet<int>, &TreeSet<int>, f: &fn(&int) -> bool) -> bool) {
1411         let mut set_a = TreeSet::new();
1412         let mut set_b = TreeSet::new();
1413
1414         for x in a.iter() { assert!(set_a.insert(*x)) }
1415         for y in b.iter() { assert!(set_b.insert(*y)) }
1416
1417         let mut i = 0;
1418         do f(&set_a, &set_b) |x| {
1419             assert_eq!(*x, expected[i]);
1420             i += 1;
1421             true
1422         };
1423         assert_eq!(i, expected.len());
1424     }
1425
1426     #[test]
1427     fn test_intersection() {
1428         fn check_intersection(a: &[int], b: &[int], expected: &[int]) {
1429             check(a, b, expected, |x, y, z| x.intersection(y, z))
1430         }
1431
1432         check_intersection([], [], []);
1433         check_intersection([1, 2, 3], [], []);
1434         check_intersection([], [1, 2, 3], []);
1435         check_intersection([2], [1, 2, 3], [2]);
1436         check_intersection([1, 2, 3], [2], [2]);
1437         check_intersection([11, 1, 3, 77, 103, 5, -5],
1438                            [2, 11, 77, -9, -42, 5, 3],
1439                            [3, 5, 11, 77]);
1440     }
1441
1442     #[test]
1443     fn test_difference() {
1444         fn check_difference(a: &[int], b: &[int], expected: &[int]) {
1445             check(a, b, expected, |x, y, z| x.difference(y, z))
1446         }
1447
1448         check_difference([], [], []);
1449         check_difference([1, 12], [], [1, 12]);
1450         check_difference([], [1, 2, 3, 9], []);
1451         check_difference([1, 3, 5, 9, 11],
1452                          [3, 9],
1453                          [1, 5, 11]);
1454         check_difference([-5, 11, 22, 33, 40, 42],
1455                          [-12, -5, 14, 23, 34, 38, 39, 50],
1456                          [11, 22, 33, 40, 42]);
1457     }
1458
1459     #[test]
1460     fn test_symmetric_difference() {
1461         fn check_symmetric_difference(a: &[int], b: &[int],
1462                                       expected: &[int]) {
1463             check(a, b, expected, |x, y, z| x.symmetric_difference(y, z))
1464         }
1465
1466         check_symmetric_difference([], [], []);
1467         check_symmetric_difference([1, 2, 3], [2], [1, 3]);
1468         check_symmetric_difference([2], [1, 2, 3], [1, 3]);
1469         check_symmetric_difference([1, 3, 5, 9, 11],
1470                                    [-2, 3, 9, 14, 22],
1471                                    [-2, 1, 5, 11, 14, 22]);
1472     }
1473
1474     #[test]
1475     fn test_union() {
1476         fn check_union(a: &[int], b: &[int],
1477                                       expected: &[int]) {
1478             check(a, b, expected, |x, y, z| x.union(y, z))
1479         }
1480
1481         check_union([], [], []);
1482         check_union([1, 2, 3], [2], [1, 2, 3]);
1483         check_union([2], [1, 2, 3], [1, 2, 3]);
1484         check_union([1, 3, 5, 9, 11, 16, 19, 24],
1485                     [-2, 1, 5, 9, 13, 19],
1486                     [-2, 1, 3, 5, 9, 11, 13, 16, 19, 24]);
1487     }
1488
1489     #[test]
1490     fn test_zip() {
1491         let mut x = TreeSet::new();
1492         x.insert(5u);
1493         x.insert(12u);
1494         x.insert(11u);
1495
1496         let mut y = TreeSet::new();
1497         y.insert("foo");
1498         y.insert("bar");
1499
1500         let x = x;
1501         let y = y;
1502         let mut z = x.iter().zip(y.iter());
1503
1504         // FIXME: #5801: this needs a type hint to compile...
1505         let result: Option<(&uint, & &'static str)> = z.next();
1506         assert_eq!(result.unwrap(), (&5u, & &"bar"));
1507
1508         let result: Option<(&uint, & &'static str)> = z.next();
1509         assert_eq!(result.unwrap(), (&11u, & &"foo"));
1510
1511         let result: Option<(&uint, & &'static str)> = z.next();
1512         assert!(result.is_none());
1513     }
1514
1515     #[test]
1516     fn test_swap() {
1517         let mut m = TreeMap::new();
1518         assert_eq!(m.swap(1, 2), None);
1519         assert_eq!(m.swap(1, 3), Some(2));
1520         assert_eq!(m.swap(1, 4), Some(3));
1521     }
1522
1523     #[test]
1524     fn test_pop() {
1525         let mut m = TreeMap::new();
1526         m.insert(1, 2);
1527         assert_eq!(m.pop(&1), Some(2));
1528         assert_eq!(m.pop(&1), None);
1529     }
1530
1531     #[test]
1532     fn test_from_iter() {
1533         let xs = ~[1, 2, 3, 4, 5, 6, 7, 8, 9];
1534
1535         let set: TreeSet<int> = xs.iter().transform(|&x| x).collect();
1536
1537         for x in xs.iter() {
1538             assert!(set.contains(x));
1539         }
1540     }
1541 }