src/lib.rs

   1 // Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 /// An implementation of a set using a bit vector as an underlying
  12 /// representation for holding unsigned numerical elements.
  13 ///
  14 /// It should also be noted that the amount of storage necessary for holding a
  15 /// set of objects is proportional to the maximum of the objects when viewed
  16 /// as a `usize`.
  17 ///
  18 /// # Examples
  19 ///
  20 /// ```
  21 /// use bit_set::BitSet;
  22 ///
  23 /// // It's a regular set
  24 /// let mut s = BitSet::new();
  25 /// s.insert(0);
  26 /// s.insert(3);
  27 /// s.insert(7);
  28 ///
  29 /// s.remove(&7);
  30 ///
  31 /// if !s.contains(&7) {
  32 ///     println!("There is no 7");
  33 /// }
  34 ///
  35 /// // Can initialize from a `BitVec`
  36 /// let other = BitSet::from_bytes(&[0b11010000]);
  37 ///
  38 /// s.union_with(&other);
  39 ///
  40 /// // Print 0, 1, 3 in some order
  41 /// for x in s.iter() {
  42 ///     println!("{}", x);
  43 /// }
  44 ///
  45 /// // Can convert back to a `BitVec`
  46 /// let bv = s.into_bit_vec();
  47 /// assert!(bv[3]);
  48 /// ```
  49
  50
  51
  52 extern crate bit_vec;
  53
  54 use bit_vec::{BitVec, Blocks, BitBlock};
  55 use std::cmp::Ordering;
  56 use std::cmp;
  57 use std::fmt;
  58 use std::hash;
  59 use std::iter::{Chain, Enumerate, Repeat, Skip, Take, repeat};
  60 use std::iter::{self, FromIterator};
  61
  62 type MatchWords<'a, B> = Chain<Enumerate<Blocks<'a, B>>, Skip<Take<Enumerate<Repeat<B>>>>>;
  63
  64 /// Computes how many blocks are needed to store that many bits
  65 fn blocks_for_bits<B: BitBlock>(bits: usize) -> usize {
  66     // If we want 17 bits, dividing by 32 will produce 0. So we add 1 to make sure we
  67     // reserve enough. But if we want exactly a multiple of 32, this will actually allocate
  68     // one too many. So we need to check if that's the case. We can do that by computing if
  69     // bitwise AND by `32 - 1` is 0. But LLVM should be able to optimize the semantically
  70     // superior modulo operator on a power of two to this.
  71     //
  72     // Note that we can technically avoid this branch with the expression
  73     // `(nbits + u32::BITS - 1) / 32::BITS`, but if nbits is almost usize::MAX this will overflow.
  74     if bits % B::bits() == 0 {
  75         bits / B::bits()
  76     } else {
  77         bits / B::bits() + 1
  78     }
  79 }
  80
  81 // Take two BitVec's, and return iterators of their words, where the shorter one
  82 // has been padded with 0's
  83 fn match_words<'a,'b, B: BitBlock>(a: &'a BitVec<B>, b: &'b BitVec<B>)
  84                 -> (MatchWords<'a, B>, MatchWords<'b, B>) {
  85     let a_len = a.storage().len();
  86     let b_len = b.storage().len();
  87
  88     // have to uselessly pretend to pad the longer one for type matching
  89     if a_len < b_len {
  90         (a.blocks().enumerate().chain(iter::repeat(B::zero()).enumerate().take(b_len).skip(a_len)),
  91          b.blocks().enumerate().chain(iter::repeat(B::zero()).enumerate().take(0).skip(0)))
  92     } else {
  93         (a.blocks().enumerate().chain(iter::repeat(B::zero()).enumerate().take(0).skip(0)),
  94          b.blocks().enumerate().chain(iter::repeat(B::zero()).enumerate().take(a_len).skip(b_len)))
  95     }
  96 }
  97
  98 pub struct BitSet<B=u32> {
  99     bit_vec: BitVec<B>,
 100 }
 101
 102 impl<B: BitBlock> Clone for BitSet<B> {
 103         fn clone(&self) -> Self {
 104                 BitSet {
 105                         bit_vec: self.bit_vec.clone(),
 106                 }
 107         }
 108 }
 109
 110 impl<B: BitBlock> Default for BitSet<B> {
 111     #[inline]
 112     fn default() -> Self { BitSet { bit_vec: Default::default() } }
 113 }
 114
 115 impl<B: BitBlock> FromIterator<usize> for BitSet<B> {
 116     fn from_iter<I: IntoIterator<Item=usize>>(iter: I) -> Self {
 117         let mut ret: Self = Default::default();
 118         ret.extend(iter);
 119         ret
 120     }
 121 }
 122
 123 impl<B: BitBlock> Extend<usize> for BitSet<B> {
 124     #[inline]
 125     fn extend<I: IntoIterator<Item=usize>>(&mut self, iter: I) {
 126         for i in iter {
 127             self.insert(i);
 128         }
 129     }
 130 }
 131
 132 impl<B: BitBlock> PartialOrd for BitSet<B> {
 133     #[inline]
 134     fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
 135         Some(self.cmp(other))
 136     }
 137 }
 138
 139 impl<B: BitBlock> Ord for BitSet<B> {
 140     #[inline]
 141     fn cmp(&self, other: &Self) -> Ordering {
 142         let mut a = self.iter();
 143         let mut b = other.iter();
 144         loop {
 145             match (a.next(), b.next()) {
 146                 (Some(x), Some(y)) => match x.cmp(&y) {
 147                     Ordering::Equal => {}
 148                     otherwise => return otherwise,
 149                 },
 150                 (None, None) => return Ordering::Equal,
 151                 (None, _) => return Ordering::Less,
 152                 (_, None) => return Ordering::Greater,
 153             }
 154         }
 155     }
 156 }
 157
 158 impl<B: BitBlock> cmp::PartialEq for BitSet<B> {
 159     #[inline]
 160     fn eq(&self, other: &Self) -> bool {
 161         self.cmp(other) == Ordering::Equal
 162     }
 163 }
 164
 165 impl<B: BitBlock> cmp::Eq for BitSet<B> {}
 166
 167 impl BitSet<u32> {
 168     /// Creates a new empty `BitSet`.
 169     ///
 170     /// # Examples
 171     ///
 172     /// ```
 173     /// use bit_set::BitSet;
 174     ///
 175     /// let mut s = BitSet::new();
 176     /// ```
 177     #[inline]
 178     pub fn new() -> Self {
 179         Default::default()
 180     }
 181
 182     /// Creates a new `BitSet` with initially no contents, able to
 183     /// hold `nbits` elements without resizing.
 184     ///
 185     /// # Examples
 186     ///
 187     /// ```
 188     /// use bit_set::BitSet;
 189     ///
 190     /// let mut s = BitSet::with_capacity(100);
 191     /// assert!(s.capacity() >= 100);
 192     /// ```
 193     #[inline]
 194     pub fn with_capacity(nbits: usize) -> Self {
 195         let bit_vec = BitVec::from_elem(nbits, false);
 196         BitSet::from_bit_vec(bit_vec)
 197     }
 198
 199     /// Creates a new `BitSet` from the given bit vector.
 200     ///
 201     /// # Examples
 202     ///
 203     /// ```
 204     /// extern crate bit_vec;
 205     /// extern crate bit_set;
 206     ///
 207     /// fn main() {
 208     ///     use bit_vec::BitVec;
 209     ///     use bit_set::BitSet;
 210     ///
 211     ///     let bv = BitVec::from_bytes(&[0b01100000]);
 212     ///     let s = BitSet::from_bit_vec(bv);
 213     ///
 214     ///     // Print 1, 2 in arbitrary order
 215     ///     for x in s.iter() {
 216     ///         println!("{}", x);
 217     ///     }
 218     /// }
 219     /// ```
 220     #[inline]
 221     pub fn from_bit_vec(bit_vec: BitVec) -> Self {
 222         BitSet { bit_vec: bit_vec }
 223     }
 224
 225     pub fn from_bytes(bytes: &[u8]) -> Self {
 226         BitSet { bit_vec: BitVec::from_bytes(bytes) }
 227     }
 228 }
 229
 230 impl<B: BitBlock> BitSet<B> {
 231
 232     /// Returns the capacity in bits for this bit vector. Inserting any
 233     /// element less than this amount will not trigger a resizing.
 234     ///
 235     /// # Examples
 236     ///
 237     /// ```
 238     /// use bit_set::BitSet;
 239     ///
 240     /// let mut s = BitSet::with_capacity(100);
 241     /// assert!(s.capacity() >= 100);
 242     /// ```
 243     #[inline]
 244     pub fn capacity(&self) -> usize {
 245         self.bit_vec.capacity()
 246     }
 247
 248     /// Reserves capacity for the given `BitSet` to contain `len` distinct elements. In the case
 249     /// of `BitSet` this means reallocations will not occur as long as all inserted elements
 250     /// are less than `len`.
 251     ///
 252     /// The collection may reserve more space to avoid frequent reallocations.
 253     ///
 254     ///
 255     /// # Examples
 256     ///
 257     /// ```
 258     /// use bit_set::BitSet;
 259     ///
 260     /// let mut s = BitSet::new();
 261     /// s.reserve_len(10);
 262     /// assert!(s.capacity() >= 10);
 263     /// ```
 264     pub fn reserve_len(&mut self, len: usize) {
 265         let cur_len = self.bit_vec.len();
 266         if len >= cur_len {
 267             self.bit_vec.reserve(len - cur_len);
 268         }
 269     }
 270
 271     /// Reserves the minimum capacity for the given `BitSet` to contain `len` distinct elements.
 272     /// In the case of `BitSet` this means reallocations will not occur as long as all inserted
 273     /// elements are less than `len`.
 274     ///
 275     /// Note that the allocator may give the collection more space than it requests. Therefore
 276     /// capacity can not be relied upon to be precisely minimal. Prefer `reserve_len` if future
 277     /// insertions are expected.
 278     ///
 279     ///
 280     /// # Examples
 281     ///
 282     /// ```
 283     /// use bit_set::BitSet;
 284     ///
 285     /// let mut s = BitSet::new();
 286     /// s.reserve_len_exact(10);
 287     /// assert!(s.capacity() >= 10);
 288     /// ```
 289     pub fn reserve_len_exact(&mut self, len: usize) {
 290         let cur_len = self.bit_vec.len();
 291         if len >= cur_len {
 292             self.bit_vec.reserve_exact(len - cur_len);
 293         }
 294     }
 295
 296
 297     /// Consumes this set to return the underlying bit vector.
 298     ///
 299     /// # Examples
 300     ///
 301     /// ```
 302     /// use bit_set::BitSet;
 303     ///
 304     /// let mut s = BitSet::new();
 305     /// s.insert(0);
 306     /// s.insert(3);
 307     ///
 308     /// let bv = s.into_bit_vec();
 309     /// assert!(bv[0]);
 310     /// assert!(bv[3]);
 311     /// ```
 312     #[inline]
 313     pub fn into_bit_vec(self) -> BitVec<B> {
 314         self.bit_vec
 315     }
 316
 317     /// Returns a reference to the underlying bit vector.
 318     ///
 319     /// # Examples
 320     ///
 321     /// ```
 322     /// use bit_set::BitSet;
 323     ///
 324     /// let mut s = BitSet::new();
 325     /// s.insert(0);
 326     ///
 327     /// let bv = s.get_ref();
 328     /// assert_eq!(bv[0], true);
 329     /// ```
 330     #[inline]
 331     pub fn get_ref(&self) -> &BitVec<B> {
 332         &self.bit_vec
 333     }
 334
 335     #[inline]
 336     fn other_op<F>(&mut self, other: &Self, mut f: F) where F: FnMut(B, B) -> B {
 337         // Unwrap BitVecs
 338         let self_bit_vec = &mut self.bit_vec;
 339         let other_bit_vec = &other.bit_vec;
 340
 341         let self_len = self_bit_vec.len();
 342         let other_len = other_bit_vec.len();
 343
 344         // Expand the vector if necessary
 345         if self_len < other_len {
 346             self_bit_vec.grow(other_len - self_len, false);
 347         }
 348
 349         // virtually pad other with 0's for equal lengths
 350         let other_words = {
 351             let (_, result) = match_words(self_bit_vec, other_bit_vec);
 352             result
 353         };
 354
 355         // Apply values found in other
 356         for (i, w) in other_words {
 357             let old = self_bit_vec.storage()[i];
 358             let new = f(old, w);
 359             unsafe {
 360                 self_bit_vec.storage_mut()[i] = new;
 361             }
 362         }
 363     }
 364
 365     /// Truncates the underlying vector to the least length required.
 366     ///
 367     /// # Examples
 368     ///
 369     /// ```
 370     /// use bit_set::BitSet;
 371     ///
 372     /// let mut s = BitSet::new();
 373     /// s.insert(32183231);
 374     /// s.remove(&32183231);
 375     ///
 376     /// // Internal storage will probably be bigger than necessary
 377     /// println!("old capacity: {}", s.capacity());
 378     ///
 379     /// // Now should be smaller
 380     /// s.shrink_to_fit();
 381     /// println!("new capacity: {}", s.capacity());
 382     /// ```
 383     #[inline]
 384     pub fn shrink_to_fit(&mut self) {
 385         let bit_vec = &mut self.bit_vec;
 386         // Obtain original length
 387         let old_len = bit_vec.storage().len();
 388         // Obtain coarse trailing zero length
 389         let n = bit_vec.storage().iter().rev().take_while(|&&n| n == B::zero()).count();
 390         // Truncate
 391         let trunc_len = cmp::max(old_len - n, 1);
 392         unsafe {
 393                 bit_vec.storage_mut().truncate(trunc_len);
 394                 bit_vec.set_len(trunc_len * B::bits());
 395         }
 396     }
 397
 398     /// Iterator over each usize stored in the `BitSet`.
 399     ///
 400     /// # Examples
 401     ///
 402     /// ```
 403     /// use bit_set::BitSet;
 404     ///
 405     /// let s = BitSet::from_bytes(&[0b01001010]);
 406     ///
 407     /// // Print 1, 4, 6 in arbitrary order
 408     /// for x in s.iter() {
 409     ///     println!("{}", x);
 410     /// }
 411     /// ```
 412     #[inline]
 413     pub fn iter(&self) -> Iter<B> {
 414         Iter(BlockIter::from_blocks(self.bit_vec.blocks()))
 415     }
 416
 417     /// Iterator over each usize stored in `self` union `other`.
 418     /// See [union_with](#method.union_with) for an efficient in-place version.
 419     ///
 420     /// # Examples
 421     ///
 422     /// ```
 423     /// use bit_set::BitSet;
 424     ///
 425     /// let a = BitSet::from_bytes(&[0b01101000]);
 426     /// let b = BitSet::from_bytes(&[0b10100000]);
 427     ///
 428     /// // Print 0, 1, 2, 4 in arbitrary order
 429     /// for x in a.union(&b) {
 430     ///     println!("{}", x);
 431     /// }
 432     /// ```
 433     #[inline]
 434     pub fn union<'a>(&'a self, other: &'a Self) -> Union<'a, B> {
 435         fn or<B: BitBlock>(w1: B, w2: B) -> B { w1 | w2 }
 436
 437         Union(BlockIter::from_blocks(TwoBitPositions {
 438             set: self.bit_vec.blocks(),
 439             other: other.bit_vec.blocks(),
 440             merge: or,
 441         }))
 442     }
 443
 444     /// Iterator over each usize stored in `self` intersect `other`.
 445     /// See [intersect_with](#method.intersect_with) for an efficient in-place version.
 446     ///
 447     /// # Examples
 448     ///
 449     /// ```
 450     /// use bit_set::BitSet;
 451     ///
 452     /// let a = BitSet::from_bytes(&[0b01101000]);
 453     /// let b = BitSet::from_bytes(&[0b10100000]);
 454     ///
 455     /// // Print 2
 456     /// for x in a.intersection(&b) {
 457     ///     println!("{}", x);
 458     /// }
 459     /// ```
 460     #[inline]
 461     pub fn intersection<'a>(&'a self, other: &'a Self) -> Intersection<'a, B> {
 462         fn bitand<B: BitBlock>(w1: B, w2: B) -> B { w1 & w2 }
 463         let min = cmp::min(self.bit_vec.len(), other.bit_vec.len());
 464
 465         Intersection(BlockIter::from_blocks(TwoBitPositions {
 466             set: self.bit_vec.blocks(),
 467             other: other.bit_vec.blocks(),
 468             merge: bitand,
 469         }).take(min))
 470     }
 471
 472     /// Iterator over each usize stored in the `self` setminus `other`.
 473     /// See [difference_with](#method.difference_with) for an efficient in-place version.
 474     ///
 475     /// # Examples
 476     ///
 477     /// ```
 478     /// use bit_set::BitSet;
 479     ///
 480     /// let a = BitSet::from_bytes(&[0b01101000]);
 481     /// let b = BitSet::from_bytes(&[0b10100000]);
 482     ///
 483     /// // Print 1, 4 in arbitrary order
 484     /// for x in a.difference(&b) {
 485     ///     println!("{}", x);
 486     /// }
 487     ///
 488     /// // Note that difference is not symmetric,
 489     /// // and `b - a` means something else.
 490     /// // This prints 0
 491     /// for x in b.difference(&a) {
 492     ///     println!("{}", x);
 493     /// }
 494     /// ```
 495     #[inline]
 496     pub fn difference<'a>(&'a self, other: &'a Self) -> Difference<'a, B> {
 497         fn diff<B: BitBlock>(w1: B, w2: B) -> B { w1 & !w2 }
 498
 499         Difference(BlockIter::from_blocks(TwoBitPositions {
 500             set: self.bit_vec.blocks(),
 501             other: other.bit_vec.blocks(),
 502             merge: diff,
 503         }))
 504     }
 505
 506     /// Iterator over each usize stored in the symmetric difference of `self` and `other`.
 507     /// See [symmetric_difference_with](#method.symmetric_difference_with) for
 508     /// an efficient in-place version.
 509     ///
 510     /// # Examples
 511     ///
 512     /// ```
 513     /// use bit_set::BitSet;
 514     ///
 515     /// let a = BitSet::from_bytes(&[0b01101000]);
 516     /// let b = BitSet::from_bytes(&[0b10100000]);
 517     ///
 518     /// // Print 0, 1, 4 in arbitrary order
 519     /// for x in a.symmetric_difference(&b) {
 520     ///     println!("{}", x);
 521     /// }
 522     /// ```
 523     #[inline]
 524     pub fn symmetric_difference<'a>(&'a self, other: &'a Self) -> SymmetricDifference<'a, B> {
 525         fn bitxor<B: BitBlock>(w1: B, w2: B) -> B { w1 ^ w2 }
 526
 527         SymmetricDifference(BlockIter::from_blocks(TwoBitPositions {
 528             set: self.bit_vec.blocks(),
 529             other: other.bit_vec.blocks(),
 530             merge: bitxor,
 531         }))
 532     }
 533
 534     /// Unions in-place with the specified other bit vector.
 535     ///
 536     /// # Examples
 537     ///
 538     /// ```
 539     /// use bit_set::BitSet;
 540     ///
 541     /// let a   = 0b01101000;
 542     /// let b   = 0b10100000;
 543     /// let res = 0b11101000;
 544     ///
 545     /// let mut a = BitSet::from_bytes(&[a]);
 546     /// let b = BitSet::from_bytes(&[b]);
 547     /// let res = BitSet::from_bytes(&[res]);
 548     ///
 549     /// a.union_with(&b);
 550     /// assert_eq!(a, res);
 551     /// ```
 552     #[inline]
 553     pub fn union_with(&mut self, other: &Self) {
 554         self.other_op(other, |w1, w2| w1 | w2);
 555     }
 556
 557     /// Intersects in-place with the specified other bit vector.
 558     ///
 559     /// # Examples
 560     ///
 561     /// ```
 562     /// use bit_set::BitSet;
 563     ///
 564     /// let a   = 0b01101000;
 565     /// let b   = 0b10100000;
 566     /// let res = 0b00100000;
 567     ///
 568     /// let mut a = BitSet::from_bytes(&[a]);
 569     /// let b = BitSet::from_bytes(&[b]);
 570     /// let res = BitSet::from_bytes(&[res]);
 571     ///
 572     /// a.intersect_with(&b);
 573     /// assert_eq!(a, res);
 574     /// ```
 575     #[inline]
 576     pub fn intersect_with(&mut self, other: &Self) {
 577         self.other_op(other, |w1, w2| w1 & w2);
 578     }
 579
 580     /// Makes this bit vector the difference with the specified other bit vector
 581     /// in-place.
 582     ///
 583     /// # Examples
 584     ///
 585     /// ```
 586     /// use bit_set::BitSet;
 587     ///
 588     /// let a   = 0b01101000;
 589     /// let b   = 0b10100000;
 590     /// let a_b = 0b01001000; // a - b
 591     /// let b_a = 0b10000000; // b - a
 592     ///
 593     /// let mut bva = BitSet::from_bytes(&[a]);
 594     /// let bvb = BitSet::from_bytes(&[b]);
 595     /// let bva_b = BitSet::from_bytes(&[a_b]);
 596     /// let bvb_a = BitSet::from_bytes(&[b_a]);
 597     ///
 598     /// bva.difference_with(&bvb);
 599     /// assert_eq!(bva, bva_b);
 600     ///
 601     /// let bva = BitSet::from_bytes(&[a]);
 602     /// let mut bvb = BitSet::from_bytes(&[b]);
 603     ///
 604     /// bvb.difference_with(&bva);
 605     /// assert_eq!(bvb, bvb_a);
 606     /// ```
 607     #[inline]
 608     pub fn difference_with(&mut self, other: &Self) {
 609         self.other_op(other, |w1, w2| w1 & !w2);
 610     }
 611
 612     /// Makes this bit vector the symmetric difference with the specified other
 613     /// bit vector in-place.
 614     ///
 615     /// # Examples
 616     ///
 617     /// ```
 618     /// use bit_set::BitSet;
 619     ///
 620     /// let a   = 0b01101000;
 621     /// let b   = 0b10100000;
 622     /// let res = 0b11001000;
 623     ///
 624     /// let mut a = BitSet::from_bytes(&[a]);
 625     /// let b = BitSet::from_bytes(&[b]);
 626     /// let res = BitSet::from_bytes(&[res]);
 627     ///
 628     /// a.symmetric_difference_with(&b);
 629     /// assert_eq!(a, res);
 630     /// ```
 631     #[inline]
 632     pub fn symmetric_difference_with(&mut self, other: &Self) {
 633         self.other_op(other, |w1, w2| w1 ^ w2);
 634     }
 635
 636 /*
 637     /// Moves all elements from `other` into `Self`, leaving `other` empty.
 638     ///
 639     /// # Examples
 640     ///
 641     /// ```
 642     /// use bit_set::BitSet;
 643     ///
 644     /// let mut a = BitSet::new();
 645     /// a.insert(2);
 646     /// a.insert(6);
 647     ///
 648     /// let mut b = BitSet::new();
 649     /// b.insert(1);
 650     /// b.insert(3);
 651     /// b.insert(6);
 652     ///
 653     /// a.append(&mut b);
 654     ///
 655     /// assert_eq!(a.len(), 4);
 656     /// assert_eq!(b.len(), 0);
 657     /// assert_eq!(a, BitSet::from_bytes(&[0b01110010]));
 658     /// ```
 659     pub fn append(&mut self, other: &mut Self) {
 660         self.union_with(other);
 661         other.clear();
 662     }
 663
 664     /// Splits the `BitSet` into two at the given key including the key.
 665     /// Retains the first part in-place while returning the second part.
 666     ///
 667     /// # Examples
 668     ///
 669     /// ```
 670     /// use bit_set::BitSet;
 671     ///
 672     /// let mut a = BitSet::new();
 673     /// a.insert(2);
 674     /// a.insert(6);
 675     /// a.insert(1);
 676     /// a.insert(3);
 677     ///
 678     /// let b = a.split_off(3);
 679     ///
 680     /// assert_eq!(a.len(), 2);
 681     /// assert_eq!(b.len(), 2);
 682     /// assert_eq!(a, BitSet::from_bytes(&[0b01100000]));
 683     /// assert_eq!(b, BitSet::from_bytes(&[0b00010010]));
 684     /// ```
 685     pub fn split_off(&mut self, at: usize) -> Self {
 686         let mut other = BitSet::new();
 687
 688         if at == 0 {
 689             swap(self, &mut other);
 690             return other;
 691         } else if at >= self.bit_vec.len() {
 692             return other;
 693         }
 694
 695         // Calculate block and bit at which to split
 696         let w = at / u32::BITS;
 697         let b = at % u32::BITS;
 698
 699         // Pad `other` with `w` zero blocks,
 700         // append `self`'s blocks in the range from `w` to the end to `other`
 701         other.bit_vec.storage_mut().extend(repeat(0u32).take(w)
 702                                      .chain(self.bit_vec.storage()[w..].iter().cloned()));
 703         other.bit_vec.nbits = self.bit_vec.nbits;
 704
 705         if b > 0 {
 706             other.bit_vec.storage_mut()[w] &= !0 << b;
 707         }
 708
 709         // Sets `bit_vec.len()` and fixes the last block as well
 710         self.bit_vec.truncate(at);
 711
 712         other
 713     }
 714 */
 715
 716     /// Returns the number of set bits in this set.
 717     #[inline]
 718     pub fn len(&self) -> usize  {
 719         self.bit_vec.blocks().fold(0, |acc, n| acc + n.count_ones() as usize)
 720     }
 721
 722     /// Returns whether there are no bits set in this set
 723     #[inline]
 724     pub fn is_empty(&self) -> bool {
 725         self.bit_vec.none()
 726     }
 727
 728     /// Clears all bits in this set
 729     #[inline]
 730     pub fn clear(&mut self) {
 731         self.bit_vec.clear();
 732     }
 733
 734     /// Returns `true` if this set contains the specified integer.
 735     #[inline]
 736     pub fn contains(&self, value: &usize) -> bool {
 737         let bit_vec = &self.bit_vec;
 738         *value < bit_vec.len() && bit_vec[*value]
 739     }
 740
 741     /// Returns `true` if the set has no elements in common with `other`.
 742     /// This is equivalent to checking for an empty intersection.
 743     #[inline]
 744     pub fn is_disjoint(&self, other: &Self) -> bool {
 745         self.intersection(other).next().is_none()
 746     }
 747
 748     /// Returns `true` if the set is a subset of another.
 749     #[inline]
 750     pub fn is_subset(&self, other: &Self) -> bool {
 751         let self_bit_vec = &self.bit_vec;
 752         let other_bit_vec = &other.bit_vec;
 753         let other_blocks = blocks_for_bits::<B>(other_bit_vec.len());
 754
 755         // Check that `self` intersect `other` is self
 756         self_bit_vec.blocks().zip(other_bit_vec.blocks()).all(|(w1, w2)| w1 & w2 == w1) &&
 757         // Make sure if `self` has any more blocks than `other`, they're all 0
 758         self_bit_vec.blocks().skip(other_blocks).all(|w| w == B::zero())
 759     }
 760
 761     /// Returns `true` if the set is a superset of another.
 762     #[inline]
 763     pub fn is_superset(&self, other: &Self) -> bool {
 764         other.is_subset(self)
 765     }
 766
 767     /// Adds a value to the set. Returns `true` if the value was not already
 768     /// present in the set.
 769     pub fn insert(&mut self, value: usize) -> bool {
 770         if self.contains(&value) {
 771             return false;
 772         }
 773
 774         // Ensure we have enough space to hold the new element
 775         let len = self.bit_vec.len();
 776         if value >= len {
 777             self.bit_vec.grow(value - len + 1, false)
 778         }
 779
 780         self.bit_vec.set(value, true);
 781         return true;
 782     }
 783
 784     /// Removes a value from the set. Returns `true` if the value was
 785     /// present in the set.
 786     pub fn remove(&mut self, value: &usize) -> bool {
 787         if !self.contains(value) {
 788             return false;
 789         }
 790
 791         self.bit_vec.set(*value, false);
 792
 793         return true;
 794     }
 795 }
 796
 797 impl<B: BitBlock> fmt::Debug for BitSet<B> {
 798     fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
 799         try!(write!(fmt, "{{"));
 800         let mut first = true;
 801         for n in self {
 802             if !first {
 803                 try!(write!(fmt, ", "));
 804             }
 805             try!(write!(fmt, "{:?}", n));
 806             first = false;
 807         }
 808         write!(fmt, "}}")
 809     }
 810 }
 811
 812 impl<B: BitBlock> hash::Hash for BitSet<B> {
 813     fn hash<H: hash::Hasher>(&self, state: &mut H) {
 814         for pos in self {
 815             pos.hash(state);
 816         }
 817     }
 818 }
 819
 820 #[derive(Clone)]
 821 struct BlockIter<T, B> {
 822     head: B,
 823     head_offset: usize,
 824     tail: T,
 825 }
 826
 827 impl<T, B: BitBlock> BlockIter<T, B> where T: Iterator<Item=B> {
 828     fn from_blocks(mut blocks: T) -> BlockIter<T, B> {
 829         let h = blocks.next().unwrap_or(B::zero());
 830         BlockIter {tail: blocks, head: h, head_offset: 0}
 831     }
 832 }
 833
 834 /// An iterator combining two `BitSet` iterators.
 835 #[derive(Clone)]
 836 struct TwoBitPositions<'a, B: 'a> {
 837     set: Blocks<'a, B>,
 838     other: Blocks<'a, B>,
 839     merge: fn(B, B) -> B,
 840 }
 841
 842 /// An iterator for `BitSet`.
 843 #[derive(Clone)]
 844 pub struct Iter<'a, B: 'a>(BlockIter<Blocks<'a, B>, B>);
 845 #[derive(Clone)]
 846 pub struct Union<'a, B: 'a>(BlockIter<TwoBitPositions<'a, B>, B>);
 847 #[derive(Clone)]
 848 pub struct Intersection<'a, B: 'a>(Take<BlockIter<TwoBitPositions<'a, B>, B>>);
 849 #[derive(Clone)]
 850 pub struct Difference<'a, B: 'a>(BlockIter<TwoBitPositions<'a, B>, B>);
 851 #[derive(Clone)]
 852 pub struct SymmetricDifference<'a, B: 'a>(BlockIter<TwoBitPositions<'a, B>, B>);
 853
 854 impl<'a, T, B: BitBlock> Iterator for BlockIter<T, B> where T: Iterator<Item=B> {
 855     type Item = usize;
 856
 857     fn next(&mut self) -> Option<usize> {
 858         while self.head == B::zero() {
 859             match self.tail.next() {
 860                 Some(w) => self.head = w,
 861                 None => return None
 862             }
 863             self.head_offset += B::bits();
 864         }
 865
 866         // from the current block, isolate the
 867         // LSB and subtract 1, producing k:
 868         // a block with a number of set bits
 869         // equal to the index of the LSB
 870         let k = (self.head & (!self.head + B::one())) - B::one();
 871         // update block, removing the LSB
 872         self.head = self.head & (self.head - B::one());
 873         // return offset + (index of LSB)
 874         Some(self.head_offset + (B::count_ones(k) as usize))
 875     }
 876
 877     #[inline]
 878     fn size_hint(&self) -> (usize, Option<usize>) {
 879         match self.tail.size_hint() {
 880             (_, Some(h)) => (0, Some(1 + h * B::bits())),
 881             _ => (0, None)
 882         }
 883     }
 884 }
 885
 886 impl<'a, B: BitBlock> Iterator for TwoBitPositions<'a, B> {
 887     type Item = B;
 888
 889     fn next(&mut self) -> Option<B> {
 890         match (self.set.next(), self.other.next()) {
 891             (Some(a), Some(b)) => Some((self.merge)(a, b)),
 892             (Some(a), None) => Some((self.merge)(a, B::zero())),
 893             (None, Some(b)) => Some((self.merge)(B::zero(), b)),
 894             _ => return None
 895         }
 896     }
 897
 898     #[inline]
 899     fn size_hint(&self) -> (usize, Option<usize>) {
 900         let (a, au) = self.set.size_hint();
 901         let (b, bu) = self.other.size_hint();
 902
 903         let upper = match (au, bu) {
 904             (Some(au), Some(bu)) => Some(cmp::max(au, bu)),
 905             _ => None
 906         };
 907
 908         (cmp::max(a, b), upper)
 909     }
 910 }
 911
 912 impl<'a, B: BitBlock> Iterator for Iter<'a, B> {
 913     type Item = usize;
 914
 915     #[inline] fn next(&mut self) -> Option<usize> { self.0.next() }
 916     #[inline] fn size_hint(&self) -> (usize, Option<usize>) { self.0.size_hint() }
 917 }
 918
 919 impl<'a, B: BitBlock> Iterator for Union<'a, B> {
 920     type Item = usize;
 921
 922     #[inline] fn next(&mut self) -> Option<usize> { self.0.next() }
 923     #[inline] fn size_hint(&self) -> (usize, Option<usize>) { self.0.size_hint() }
 924 }
 925
 926 impl<'a, B: BitBlock> Iterator for Intersection<'a, B> {
 927     type Item = usize;
 928
 929     #[inline] fn next(&mut self) -> Option<usize> { self.0.next() }
 930     #[inline] fn size_hint(&self) -> (usize, Option<usize>) { self.0.size_hint() }
 931 }
 932
 933 impl<'a, B: BitBlock> Iterator for Difference<'a, B> {
 934     type Item = usize;
 935
 936     #[inline] fn next(&mut self) -> Option<usize> { self.0.next() }
 937     #[inline] fn size_hint(&self) -> (usize, Option<usize>) { self.0.size_hint() }
 938 }
 939
 940 impl<'a, B: BitBlock> Iterator for SymmetricDifference<'a, B> {
 941     type Item = usize;
 942
 943     #[inline] fn next(&mut self) -> Option<usize> { self.0.next() }
 944     #[inline] fn size_hint(&self) -> (usize, Option<usize>) { self.0.size_hint() }
 945 }
 946
 947 impl<'a, B: BitBlock> IntoIterator for &'a BitSet<B> {
 948     type Item = usize;
 949     type IntoIter = Iter<'a, B>;
 950
 951     fn into_iter(self) -> Iter<'a, B> {
 952         self.iter()
 953     }
 954 }