src/liballoc/collections/btree/set.rs

   1 // This is pretty much entirely stolen from TreeSet, since BTreeMap has an identical interface
   2 // to TreeMap
   3
   4 use core::borrow::Borrow;
   5 use core::cmp::Ordering::{Equal, Greater, Less};
   6 use core::cmp::{max, min};
   7 use core::fmt::{self, Debug};
   8 use core::iter::{FromIterator, FusedIterator, Peekable};
   9 use core::ops::{BitAnd, BitOr, BitXor, RangeBounds, Sub};
  10
  11 use super::map::{BTreeMap, Keys};
  12 use super::Recover;
  13
  14 // FIXME(conventions): implement bounded iterators
  15
  16 /// A set based on a B-Tree.
  17 ///
  18 /// See [`BTreeMap`]'s documentation for a detailed discussion of this collection's performance
  19 /// benefits and drawbacks.
  20 ///
  21 /// It is a logic error for an item to be modified in such a way that the item's ordering relative
  22 /// to any other item, as determined by the [`Ord`] trait, changes while it is in the set. This is
  23 /// normally only possible through [`Cell`], [`RefCell`], global state, I/O, or unsafe code.
  24 ///
  25 /// [`BTreeMap`]: struct.BTreeMap.html
  26 /// [`Ord`]: ../../std/cmp/trait.Ord.html
  27 /// [`Cell`]: ../../std/cell/struct.Cell.html
  28 /// [`RefCell`]: ../../std/cell/struct.RefCell.html
  29 ///
  30 /// # Examples
  31 ///
  32 /// ```
  33 /// use std::collections::BTreeSet;
  34 ///
  35 /// // Type inference lets us omit an explicit type signature (which
  36 /// // would be `BTreeSet<&str>` in this example).
  37 /// let mut books = BTreeSet::new();
  38 ///
  39 /// // Add some books.
  40 /// books.insert("A Dance With Dragons");
  41 /// books.insert("To Kill a Mockingbird");
  42 /// books.insert("The Odyssey");
  43 /// books.insert("The Great Gatsby");
  44 ///
  45 /// // Check for a specific one.
  46 /// if !books.contains("The Winds of Winter") {
  47 ///     println!("We have {} books, but The Winds of Winter ain't one.",
  48 ///              books.len());
  49 /// }
  50 ///
  51 /// // Remove a book.
  52 /// books.remove("The Odyssey");
  53 ///
  54 /// // Iterate over everything.
  55 /// for book in &books {
  56 ///     println!("{}", book);
  57 /// }
  58 /// ```
  59 #[derive(Hash, PartialEq, Eq, Ord, PartialOrd)]
  60 #[stable(feature = "rust1", since = "1.0.0")]
  61 pub struct BTreeSet<T> {
  62     map: BTreeMap<T, ()>,
  63 }
  64
  65 #[stable(feature = "rust1", since = "1.0.0")]
  66 impl<T: Clone> Clone for BTreeSet<T> {
  67     fn clone(&self) -> Self {
  68         BTreeSet { map: self.map.clone() }
  69     }
  70
  71     fn clone_from(&mut self, other: &Self) {
  72         self.map.clone_from(&other.map);
  73     }
  74 }
  75
  76 /// An iterator over the items of a `BTreeSet`.
  77 ///
  78 /// This `struct` is created by the [`iter`] method on [`BTreeSet`].
  79 /// See its documentation for more.
  80 ///
  81 /// [`BTreeSet`]: struct.BTreeSet.html
  82 /// [`iter`]: struct.BTreeSet.html#method.iter
  83 #[stable(feature = "rust1", since = "1.0.0")]
  84 pub struct Iter<'a, T: 'a> {
  85     iter: Keys<'a, T, ()>,
  86 }
  87
  88 #[stable(feature = "collection_debug", since = "1.17.0")]
  89 impl<T: fmt::Debug> fmt::Debug for Iter<'_, T> {
  90     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
  91         f.debug_tuple("Iter").field(&self.iter.clone()).finish()
  92     }
  93 }
  94
  95 /// An owning iterator over the items of a `BTreeSet`.
  96 ///
  97 /// This `struct` is created by the [`into_iter`] method on [`BTreeSet`]
  98 /// (provided by the `IntoIterator` trait). See its documentation for more.
  99 ///
 100 /// [`BTreeSet`]: struct.BTreeSet.html
 101 /// [`into_iter`]: struct.BTreeSet.html#method.into_iter
 102 #[stable(feature = "rust1", since = "1.0.0")]
 103 #[derive(Debug)]
 104 pub struct IntoIter<T> {
 105     iter: super::map::IntoIter<T, ()>,
 106 }
 107
 108 /// An iterator over a sub-range of items in a `BTreeSet`.
 109 ///
 110 /// This `struct` is created by the [`range`] method on [`BTreeSet`].
 111 /// See its documentation for more.
 112 ///
 113 /// [`BTreeSet`]: struct.BTreeSet.html
 114 /// [`range`]: struct.BTreeSet.html#method.range
 115 #[derive(Debug)]
 116 #[stable(feature = "btree_range", since = "1.17.0")]
 117 pub struct Range<'a, T: 'a> {
 118     iter: super::map::Range<'a, T, ()>,
 119 }
 120
 121 /// Core of SymmetricDifference and Union.
 122 /// More efficient than btree.map.MergeIter,
 123 /// and crucially for SymmetricDifference, nexts() reports on both sides.
 124 #[derive(Clone)]
 125 struct MergeIterInner<I>
 126 where
 127     I: Iterator,
 128     I::Item: Copy,
 129 {
 130     a: I,
 131     b: I,
 132     peeked: Option<MergeIterPeeked<I>>,
 133 }
 134
 135 #[derive(Copy, Clone, Debug)]
 136 enum MergeIterPeeked<I: Iterator> {
 137     A(I::Item),
 138     B(I::Item),
 139 }
 140
 141 impl<I> MergeIterInner<I>
 142 where
 143     I: ExactSizeIterator + FusedIterator,
 144     I::Item: Copy + Ord,
 145 {
 146     fn new(a: I, b: I) -> Self {
 147         MergeIterInner { a, b, peeked: None }
 148     }
 149
 150     fn nexts(&mut self) -> (Option<I::Item>, Option<I::Item>) {
 151         let mut a_next = match self.peeked {
 152             Some(MergeIterPeeked::A(next)) => Some(next),
 153             _ => self.a.next(),
 154         };
 155         let mut b_next = match self.peeked {
 156             Some(MergeIterPeeked::B(next)) => Some(next),
 157             _ => self.b.next(),
 158         };
 159         let ord = match (a_next, b_next) {
 160             (None, None) => Equal,
 161             (_, None) => Less,
 162             (None, _) => Greater,
 163             (Some(a1), Some(b1)) => a1.cmp(&b1),
 164         };
 165         self.peeked = match ord {
 166             Less => b_next.take().map(MergeIterPeeked::B),
 167             Equal => None,
 168             Greater => a_next.take().map(MergeIterPeeked::A),
 169         };
 170         (a_next, b_next)
 171     }
 172
 173     fn lens(&self) -> (usize, usize) {
 174         match self.peeked {
 175             Some(MergeIterPeeked::A(_)) => (1 + self.a.len(), self.b.len()),
 176             Some(MergeIterPeeked::B(_)) => (self.a.len(), 1 + self.b.len()),
 177             _ => (self.a.len(), self.b.len()),
 178         }
 179     }
 180 }
 181
 182 impl<I> Debug for MergeIterInner<I>
 183 where
 184     I: Iterator + Debug,
 185     I::Item: Copy + Debug,
 186 {
 187     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 188         f.debug_tuple("MergeIterInner").field(&self.a).field(&self.b).finish()
 189     }
 190 }
 191
 192 /// A lazy iterator producing elements in the difference of `BTreeSet`s.
 193 ///
 194 /// This `struct` is created by the [`difference`] method on [`BTreeSet`].
 195 /// See its documentation for more.
 196 ///
 197 /// [`BTreeSet`]: struct.BTreeSet.html
 198 /// [`difference`]: struct.BTreeSet.html#method.difference
 199 #[stable(feature = "rust1", since = "1.0.0")]
 200 pub struct Difference<'a, T: 'a> {
 201     inner: DifferenceInner<'a, T>,
 202 }
 203 #[derive(Debug)]
 204 enum DifferenceInner<'a, T: 'a> {
 205     Stitch {
 206         // iterate all of `self` and some of `other`, spotting matches along the way
 207         self_iter: Iter<'a, T>,
 208         other_iter: Peekable<Iter<'a, T>>,
 209     },
 210     Search {
 211         // iterate `self`, look up in `other`
 212         self_iter: Iter<'a, T>,
 213         other_set: &'a BTreeSet<T>,
 214     },
 215     Iterate(Iter<'a, T>), // simply produce all values in `self`
 216 }
 217
 218 #[stable(feature = "collection_debug", since = "1.17.0")]
 219 impl<T: fmt::Debug> fmt::Debug for Difference<'_, T> {
 220     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 221         f.debug_tuple("Difference").field(&self.inner).finish()
 222     }
 223 }
 224
 225 /// A lazy iterator producing elements in the symmetric difference of `BTreeSet`s.
 226 ///
 227 /// This `struct` is created by the [`symmetric_difference`] method on
 228 /// [`BTreeSet`]. See its documentation for more.
 229 ///
 230 /// [`BTreeSet`]: struct.BTreeSet.html
 231 /// [`symmetric_difference`]: struct.BTreeSet.html#method.symmetric_difference
 232 #[stable(feature = "rust1", since = "1.0.0")]
 233 pub struct SymmetricDifference<'a, T: 'a>(MergeIterInner<Iter<'a, T>>);
 234
 235 #[stable(feature = "collection_debug", since = "1.17.0")]
 236 impl<T: fmt::Debug> fmt::Debug for SymmetricDifference<'_, T> {
 237     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 238         f.debug_tuple("SymmetricDifference").field(&self.0).finish()
 239     }
 240 }
 241
 242 /// A lazy iterator producing elements in the intersection of `BTreeSet`s.
 243 ///
 244 /// This `struct` is created by the [`intersection`] method on [`BTreeSet`].
 245 /// See its documentation for more.
 246 ///
 247 /// [`BTreeSet`]: struct.BTreeSet.html
 248 /// [`intersection`]: struct.BTreeSet.html#method.intersection
 249 #[stable(feature = "rust1", since = "1.0.0")]
 250 pub struct Intersection<'a, T: 'a> {
 251     inner: IntersectionInner<'a, T>,
 252 }
 253 #[derive(Debug)]
 254 enum IntersectionInner<'a, T: 'a> {
 255     Stitch {
 256         // iterate similarly sized sets jointly, spotting matches along the way
 257         a: Iter<'a, T>,
 258         b: Iter<'a, T>,
 259     },
 260     Search {
 261         // iterate a small set, look up in the large set
 262         small_iter: Iter<'a, T>,
 263         large_set: &'a BTreeSet<T>,
 264     },
 265     Answer(Option<&'a T>), // return a specific value or emptiness
 266 }
 267
 268 #[stable(feature = "collection_debug", since = "1.17.0")]
 269 impl<T: fmt::Debug> fmt::Debug for Intersection<'_, T> {
 270     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 271         f.debug_tuple("Intersection").field(&self.inner).finish()
 272     }
 273 }
 274
 275 /// A lazy iterator producing elements in the union of `BTreeSet`s.
 276 ///
 277 /// This `struct` is created by the [`union`] method on [`BTreeSet`].
 278 /// See its documentation for more.
 279 ///
 280 /// [`BTreeSet`]: struct.BTreeSet.html
 281 /// [`union`]: struct.BTreeSet.html#method.union
 282 #[stable(feature = "rust1", since = "1.0.0")]
 283 pub struct Union<'a, T: 'a>(MergeIterInner<Iter<'a, T>>);
 284
 285 #[stable(feature = "collection_debug", since = "1.17.0")]
 286 impl<T: fmt::Debug> fmt::Debug for Union<'_, T> {
 287     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 288         f.debug_tuple("Union").field(&self.0).finish()
 289     }
 290 }
 291
 292 // This constant is used by functions that compare two sets.
 293 // It estimates the relative size at which searching performs better
 294 // than iterating, based on the benchmarks in
 295 // https://github.com/ssomers/rust_bench_btreeset_intersection;
 296 // It's used to divide rather than multiply sizes, to rule out overflow,
 297 // and it's a power of two to make that division cheap.
 298 const ITER_PERFORMANCE_TIPPING_SIZE_DIFF: usize = 16;
 299
 300 impl<T: Ord> BTreeSet<T> {
 301     /// Makes a new `BTreeSet` with a reasonable choice of B.
 302     ///
 303     /// # Examples
 304     ///
 305     /// ```
 306     /// # #![allow(unused_mut)]
 307     /// use std::collections::BTreeSet;
 308     ///
 309     /// let mut set: BTreeSet<i32> = BTreeSet::new();
 310     /// ```
 311     #[stable(feature = "rust1", since = "1.0.0")]
 312     #[rustc_const_unstable(feature = "const_btree_new", issue = "71835")]
 313     pub const fn new() -> BTreeSet<T> {
 314         BTreeSet { map: BTreeMap::new() }
 315     }
 316
 317     /// Constructs a double-ended iterator over a sub-range of elements in the set.
 318     /// The simplest way is to use the range syntax `min..max`, thus `range(min..max)` will
 319     /// yield elements from min (inclusive) to max (exclusive).
 320     /// The range may also be entered as `(Bound<T>, Bound<T>)`, so for example
 321     /// `range((Excluded(4), Included(10)))` will yield a left-exclusive, right-inclusive
 322     /// range from 4 to 10.
 323     ///
 324     /// # Examples
 325     ///
 326     /// ```
 327     /// use std::collections::BTreeSet;
 328     /// use std::ops::Bound::Included;
 329     ///
 330     /// let mut set = BTreeSet::new();
 331     /// set.insert(3);
 332     /// set.insert(5);
 333     /// set.insert(8);
 334     /// for &elem in set.range((Included(&4), Included(&8))) {
 335     ///     println!("{}", elem);
 336     /// }
 337     /// assert_eq!(Some(&5), set.range(4..).next());
 338     /// ```
 339     #[stable(feature = "btree_range", since = "1.17.0")]
 340     pub fn range<K: ?Sized, R>(&self, range: R) -> Range<'_, T>
 341     where
 342         K: Ord,
 343         T: Borrow<K>,
 344         R: RangeBounds<K>,
 345     {
 346         Range { iter: self.map.range(range) }
 347     }
 348
 349     /// Visits the values representing the difference,
 350     /// i.e., the values that are in `self` but not in `other`,
 351     /// in ascending order.
 352     ///
 353     /// # Examples
 354     ///
 355     /// ```
 356     /// use std::collections::BTreeSet;
 357     ///
 358     /// let mut a = BTreeSet::new();
 359     /// a.insert(1);
 360     /// a.insert(2);
 361     ///
 362     /// let mut b = BTreeSet::new();
 363     /// b.insert(2);
 364     /// b.insert(3);
 365     ///
 366     /// let diff: Vec<_> = a.difference(&b).cloned().collect();
 367     /// assert_eq!(diff, [1]);
 368     /// ```
 369     #[stable(feature = "rust1", since = "1.0.0")]
 370     pub fn difference<'a>(&'a self, other: &'a BTreeSet<T>) -> Difference<'a, T> {
 371         let (self_min, self_max) =
 372             if let (Some(self_min), Some(self_max)) = (self.first(), self.last()) {
 373                 (self_min, self_max)
 374             } else {
 375                 return Difference { inner: DifferenceInner::Iterate(self.iter()) };
 376             };
 377         let (other_min, other_max) =
 378             if let (Some(other_min), Some(other_max)) = (other.first(), other.last()) {
 379                 (other_min, other_max)
 380             } else {
 381                 return Difference { inner: DifferenceInner::Iterate(self.iter()) };
 382             };
 383         Difference {
 384             inner: match (self_min.cmp(other_max), self_max.cmp(other_min)) {
 385                 (Greater, _) | (_, Less) => DifferenceInner::Iterate(self.iter()),
 386                 (Equal, _) => {
 387                     let mut self_iter = self.iter();
 388                     self_iter.next();
 389                     DifferenceInner::Iterate(self_iter)
 390                 }
 391                 (_, Equal) => {
 392                     let mut self_iter = self.iter();
 393                     self_iter.next_back();
 394                     DifferenceInner::Iterate(self_iter)
 395                 }
 396                 _ if self.len() <= other.len() / ITER_PERFORMANCE_TIPPING_SIZE_DIFF => {
 397                     DifferenceInner::Search { self_iter: self.iter(), other_set: other }
 398                 }
 399                 _ => DifferenceInner::Stitch {
 400                     self_iter: self.iter(),
 401                     other_iter: other.iter().peekable(),
 402                 },
 403             },
 404         }
 405     }
 406
 407     /// Visits the values representing the symmetric difference,
 408     /// i.e., the values that are in `self` or in `other` but not in both,
 409     /// in ascending order.
 410     ///
 411     /// # Examples
 412     ///
 413     /// ```
 414     /// use std::collections::BTreeSet;
 415     ///
 416     /// let mut a = BTreeSet::new();
 417     /// a.insert(1);
 418     /// a.insert(2);
 419     ///
 420     /// let mut b = BTreeSet::new();
 421     /// b.insert(2);
 422     /// b.insert(3);
 423     ///
 424     /// let sym_diff: Vec<_> = a.symmetric_difference(&b).cloned().collect();
 425     /// assert_eq!(sym_diff, [1, 3]);
 426     /// ```
 427     #[stable(feature = "rust1", since = "1.0.0")]
 428     pub fn symmetric_difference<'a>(
 429         &'a self,
 430         other: &'a BTreeSet<T>,
 431     ) -> SymmetricDifference<'a, T> {
 432         SymmetricDifference(MergeIterInner::new(self.iter(), other.iter()))
 433     }
 434
 435     /// Visits the values representing the intersection,
 436     /// i.e., the values that are both in `self` and `other`,
 437     /// in ascending order.
 438     ///
 439     /// # Examples
 440     ///
 441     /// ```
 442     /// use std::collections::BTreeSet;
 443     ///
 444     /// let mut a = BTreeSet::new();
 445     /// a.insert(1);
 446     /// a.insert(2);
 447     ///
 448     /// let mut b = BTreeSet::new();
 449     /// b.insert(2);
 450     /// b.insert(3);
 451     ///
 452     /// let intersection: Vec<_> = a.intersection(&b).cloned().collect();
 453     /// assert_eq!(intersection, [2]);
 454     /// ```
 455     #[stable(feature = "rust1", since = "1.0.0")]
 456     pub fn intersection<'a>(&'a self, other: &'a BTreeSet<T>) -> Intersection<'a, T> {
 457         let (self_min, self_max) =
 458             if let (Some(self_min), Some(self_max)) = (self.first(), self.last()) {
 459                 (self_min, self_max)
 460             } else {
 461                 return Intersection { inner: IntersectionInner::Answer(None) };
 462             };
 463         let (other_min, other_max) =
 464             if let (Some(other_min), Some(other_max)) = (other.first(), other.last()) {
 465                 (other_min, other_max)
 466             } else {
 467                 return Intersection { inner: IntersectionInner::Answer(None) };
 468             };
 469         Intersection {
 470             inner: match (self_min.cmp(other_max), self_max.cmp(other_min)) {
 471                 (Greater, _) | (_, Less) => IntersectionInner::Answer(None),
 472                 (Equal, _) => IntersectionInner::Answer(Some(self_min)),
 473                 (_, Equal) => IntersectionInner::Answer(Some(self_max)),
 474                 _ if self.len() <= other.len() / ITER_PERFORMANCE_TIPPING_SIZE_DIFF => {
 475                     IntersectionInner::Search { small_iter: self.iter(), large_set: other }
 476                 }
 477                 _ if other.len() <= self.len() / ITER_PERFORMANCE_TIPPING_SIZE_DIFF => {
 478                     IntersectionInner::Search { small_iter: other.iter(), large_set: self }
 479                 }
 480                 _ => IntersectionInner::Stitch { a: self.iter(), b: other.iter() },
 481             },
 482         }
 483     }
 484
 485     /// Visits the values representing the union,
 486     /// i.e., all the values in `self` or `other`, without duplicates,
 487     /// in ascending order.
 488     ///
 489     /// # Examples
 490     ///
 491     /// ```
 492     /// use std::collections::BTreeSet;
 493     ///
 494     /// let mut a = BTreeSet::new();
 495     /// a.insert(1);
 496     ///
 497     /// let mut b = BTreeSet::new();
 498     /// b.insert(2);
 499     ///
 500     /// let union: Vec<_> = a.union(&b).cloned().collect();
 501     /// assert_eq!(union, [1, 2]);
 502     /// ```
 503     #[stable(feature = "rust1", since = "1.0.0")]
 504     pub fn union<'a>(&'a self, other: &'a BTreeSet<T>) -> Union<'a, T> {
 505         Union(MergeIterInner::new(self.iter(), other.iter()))
 506     }
 507
 508     /// Clears the set, removing all values.
 509     ///
 510     /// # Examples
 511     ///
 512     /// ```
 513     /// use std::collections::BTreeSet;
 514     ///
 515     /// let mut v = BTreeSet::new();
 516     /// v.insert(1);
 517     /// v.clear();
 518     /// assert!(v.is_empty());
 519     /// ```
 520     #[stable(feature = "rust1", since = "1.0.0")]
 521     pub fn clear(&mut self) {
 522         self.map.clear()
 523     }
 524
 525     /// Returns `true` if the set contains a value.
 526     ///
 527     /// The value may be any borrowed form of the set's value type,
 528     /// but the ordering on the borrowed form *must* match the
 529     /// ordering on the value type.
 530     ///
 531     /// # Examples
 532     ///
 533     /// ```
 534     /// use std::collections::BTreeSet;
 535     ///
 536     /// let set: BTreeSet<_> = [1, 2, 3].iter().cloned().collect();
 537     /// assert_eq!(set.contains(&1), true);
 538     /// assert_eq!(set.contains(&4), false);
 539     /// ```
 540     #[stable(feature = "rust1", since = "1.0.0")]
 541     pub fn contains<Q: ?Sized>(&self, value: &Q) -> bool
 542     where
 543         T: Borrow<Q>,
 544         Q: Ord,
 545     {
 546         self.map.contains_key(value)
 547     }
 548
 549     /// Returns a reference to the value in the set, if any, that is equal to the given value.
 550     ///
 551     /// The value may be any borrowed form of the set's value type,
 552     /// but the ordering on the borrowed form *must* match the
 553     /// ordering on the value type.
 554     ///
 555     /// # Examples
 556     ///
 557     /// ```
 558     /// use std::collections::BTreeSet;
 559     ///
 560     /// let set: BTreeSet<_> = [1, 2, 3].iter().cloned().collect();
 561     /// assert_eq!(set.get(&2), Some(&2));
 562     /// assert_eq!(set.get(&4), None);
 563     /// ```
 564     #[stable(feature = "set_recovery", since = "1.9.0")]
 565     pub fn get<Q: ?Sized>(&self, value: &Q) -> Option<&T>
 566     where
 567         T: Borrow<Q>,
 568         Q: Ord,
 569     {
 570         Recover::get(&self.map, value)
 571     }
 572
 573     /// Returns `true` if `self` has no elements in common with `other`.
 574     /// This is equivalent to checking for an empty intersection.
 575     ///
 576     /// # Examples
 577     ///
 578     /// ```
 579     /// use std::collections::BTreeSet;
 580     ///
 581     /// let a: BTreeSet<_> = [1, 2, 3].iter().cloned().collect();
 582     /// let mut b = BTreeSet::new();
 583     ///
 584     /// assert_eq!(a.is_disjoint(&b), true);
 585     /// b.insert(4);
 586     /// assert_eq!(a.is_disjoint(&b), true);
 587     /// b.insert(1);
 588     /// assert_eq!(a.is_disjoint(&b), false);
 589     /// ```
 590     #[stable(feature = "rust1", since = "1.0.0")]
 591     pub fn is_disjoint(&self, other: &BTreeSet<T>) -> bool {
 592         self.intersection(other).next().is_none()
 593     }
 594
 595     /// Returns `true` if the set is a subset of another,
 596     /// i.e., `other` contains at least all the values in `self`.
 597     ///
 598     /// # Examples
 599     ///
 600     /// ```
 601     /// use std::collections::BTreeSet;
 602     ///
 603     /// let sup: BTreeSet<_> = [1, 2, 3].iter().cloned().collect();
 604     /// let mut set = BTreeSet::new();
 605     ///
 606     /// assert_eq!(set.is_subset(&sup), true);
 607     /// set.insert(2);
 608     /// assert_eq!(set.is_subset(&sup), true);
 609     /// set.insert(4);
 610     /// assert_eq!(set.is_subset(&sup), false);
 611     /// ```
 612     #[stable(feature = "rust1", since = "1.0.0")]
 613     pub fn is_subset(&self, other: &BTreeSet<T>) -> bool {
 614         // Same result as self.difference(other).next().is_none()
 615         // but the code below is faster (hugely in some cases).
 616         if self.len() > other.len() {
 617             return false;
 618         }
 619         let (self_min, self_max) =
 620             if let (Some(self_min), Some(self_max)) = (self.first(), self.last()) {
 621                 (self_min, self_max)
 622             } else {
 623                 return true; // self is empty
 624             };
 625         let (other_min, other_max) =
 626             if let (Some(other_min), Some(other_max)) = (other.first(), other.last()) {
 627                 (other_min, other_max)
 628             } else {
 629                 return false; // other is empty
 630             };
 631         let mut self_iter = self.iter();
 632         match self_min.cmp(other_min) {
 633             Less => return false,
 634             Equal => {
 635                 self_iter.next();
 636             }
 637             Greater => (),
 638         }
 639         match self_max.cmp(other_max) {
 640             Greater => return false,
 641             Equal => {
 642                 self_iter.next_back();
 643             }
 644             Less => (),
 645         }
 646         if self_iter.len() <= other.len() / ITER_PERFORMANCE_TIPPING_SIZE_DIFF {
 647             for next in self_iter {
 648                 if !other.contains(next) {
 649                     return false;
 650                 }
 651             }
 652         } else {
 653             let mut other_iter = other.iter();
 654             other_iter.next();
 655             other_iter.next_back();
 656             let mut self_next = self_iter.next();
 657             while let Some(self1) = self_next {
 658                 match other_iter.next().map_or(Less, |other1| self1.cmp(other1)) {
 659                     Less => return false,
 660                     Equal => self_next = self_iter.next(),
 661                     Greater => (),
 662                 }
 663             }
 664         }
 665         true
 666     }
 667
 668     /// Returns `true` if the set is a superset of another,
 669     /// i.e., `self` contains at least all the values in `other`.
 670     ///
 671     /// # Examples
 672     ///
 673     /// ```
 674     /// use std::collections::BTreeSet;
 675     ///
 676     /// let sub: BTreeSet<_> = [1, 2].iter().cloned().collect();
 677     /// let mut set = BTreeSet::new();
 678     ///
 679     /// assert_eq!(set.is_superset(&sub), false);
 680     ///
 681     /// set.insert(0);
 682     /// set.insert(1);
 683     /// assert_eq!(set.is_superset(&sub), false);
 684     ///
 685     /// set.insert(2);
 686     /// assert_eq!(set.is_superset(&sub), true);
 687     /// ```
 688     #[stable(feature = "rust1", since = "1.0.0")]
 689     pub fn is_superset(&self, other: &BTreeSet<T>) -> bool {
 690         other.is_subset(self)
 691     }
 692
 693     /// Returns a reference to the first value in the set, if any.
 694     /// This value is always the minimum of all values in the set.
 695     ///
 696     /// # Examples
 697     ///
 698     /// Basic usage:
 699     ///
 700     /// ```
 701     /// #![feature(map_first_last)]
 702     /// use std::collections::BTreeSet;
 703     ///
 704     /// let mut map = BTreeSet::new();
 705     /// assert_eq!(map.first(), None);
 706     /// map.insert(1);
 707     /// assert_eq!(map.first(), Some(&1));
 708     /// map.insert(2);
 709     /// assert_eq!(map.first(), Some(&1));
 710     /// ```
 711     #[unstable(feature = "map_first_last", issue = "62924")]
 712     pub fn first(&self) -> Option<&T> {
 713         self.map.first_key_value().map(|(k, _)| k)
 714     }
 715
 716     /// Returns a reference to the last value in the set, if any.
 717     /// This value is always the maximum of all values in the set.
 718     ///
 719     /// # Examples
 720     ///
 721     /// Basic usage:
 722     ///
 723     /// ```
 724     /// #![feature(map_first_last)]
 725     /// use std::collections::BTreeSet;
 726     ///
 727     /// let mut map = BTreeSet::new();
 728     /// assert_eq!(map.first(), None);
 729     /// map.insert(1);
 730     /// assert_eq!(map.last(), Some(&1));
 731     /// map.insert(2);
 732     /// assert_eq!(map.last(), Some(&2));
 733     /// ```
 734     #[unstable(feature = "map_first_last", issue = "62924")]
 735     pub fn last(&self) -> Option<&T> {
 736         self.map.last_key_value().map(|(k, _)| k)
 737     }
 738
 739     /// Removes the first value from the set and returns it, if any.
 740     /// The first value is always the minimum value in the set.
 741     ///
 742     /// # Examples
 743     ///
 744     /// ```
 745     /// #![feature(map_first_last)]
 746     /// use std::collections::BTreeSet;
 747     ///
 748     /// let mut set = BTreeSet::new();
 749     ///
 750     /// set.insert(1);
 751     /// while let Some(n) = set.pop_first() {
 752     ///     assert_eq!(n, 1);
 753     /// }
 754     /// assert!(set.is_empty());
 755     /// ```
 756     #[unstable(feature = "map_first_last", issue = "62924")]
 757     pub fn pop_first(&mut self) -> Option<T> {
 758         self.map.first_entry().map(|entry| entry.remove_entry().0)
 759     }
 760
 761     /// Removes the last value from the set and returns it, if any.
 762     /// The last value is always the maximum value in the set.
 763     ///
 764     /// # Examples
 765     ///
 766     /// ```
 767     /// #![feature(map_first_last)]
 768     /// use std::collections::BTreeSet;
 769     ///
 770     /// let mut set = BTreeSet::new();
 771     ///
 772     /// set.insert(1);
 773     /// while let Some(n) = set.pop_last() {
 774     ///     assert_eq!(n, 1);
 775     /// }
 776     /// assert!(set.is_empty());
 777     /// ```
 778     #[unstable(feature = "map_first_last", issue = "62924")]
 779     pub fn pop_last(&mut self) -> Option<T> {
 780         self.map.last_entry().map(|entry| entry.remove_entry().0)
 781     }
 782
 783     /// Adds a value to the set.
 784     ///
 785     /// If the set did not have this value present, `true` is returned.
 786     ///
 787     /// If the set did have this value present, `false` is returned, and the
 788     /// entry is not updated. See the [module-level documentation] for more.
 789     ///
 790     /// [module-level documentation]: index.html#insert-and-complex-keys
 791     ///
 792     /// # Examples
 793     ///
 794     /// ```
 795     /// use std::collections::BTreeSet;
 796     ///
 797     /// let mut set = BTreeSet::new();
 798     ///
 799     /// assert_eq!(set.insert(2), true);
 800     /// assert_eq!(set.insert(2), false);
 801     /// assert_eq!(set.len(), 1);
 802     /// ```
 803     #[stable(feature = "rust1", since = "1.0.0")]
 804     pub fn insert(&mut self, value: T) -> bool {
 805         self.map.insert(value, ()).is_none()
 806     }
 807
 808     /// Adds a value to the set, replacing the existing value, if any, that is equal to the given
 809     /// one. Returns the replaced value.
 810     ///
 811     /// # Examples
 812     ///
 813     /// ```
 814     /// use std::collections::BTreeSet;
 815     ///
 816     /// let mut set = BTreeSet::new();
 817     /// set.insert(Vec::<i32>::new());
 818     ///
 819     /// assert_eq!(set.get(&[][..]).unwrap().capacity(), 0);
 820     /// set.replace(Vec::with_capacity(10));
 821     /// assert_eq!(set.get(&[][..]).unwrap().capacity(), 10);
 822     /// ```
 823     #[stable(feature = "set_recovery", since = "1.9.0")]
 824     pub fn replace(&mut self, value: T) -> Option<T> {
 825         Recover::replace(&mut self.map, value)
 826     }
 827
 828     /// Removes a value from the set. Returns whether the value was
 829     /// present in the set.
 830     ///
 831     /// The value may be any borrowed form of the set's value type,
 832     /// but the ordering on the borrowed form *must* match the
 833     /// ordering on the value type.
 834     ///
 835     /// # Examples
 836     ///
 837     /// ```
 838     /// use std::collections::BTreeSet;
 839     ///
 840     /// let mut set = BTreeSet::new();
 841     ///
 842     /// set.insert(2);
 843     /// assert_eq!(set.remove(&2), true);
 844     /// assert_eq!(set.remove(&2), false);
 845     /// ```
 846     #[stable(feature = "rust1", since = "1.0.0")]
 847     pub fn remove<Q: ?Sized>(&mut self, value: &Q) -> bool
 848     where
 849         T: Borrow<Q>,
 850         Q: Ord,
 851     {
 852         self.map.remove(value).is_some()
 853     }
 854
 855     /// Removes and returns the value in the set, if any, that is equal to the given one.
 856     ///
 857     /// The value may be any borrowed form of the set's value type,
 858     /// but the ordering on the borrowed form *must* match the
 859     /// ordering on the value type.
 860     ///
 861     /// # Examples
 862     ///
 863     /// ```
 864     /// use std::collections::BTreeSet;
 865     ///
 866     /// let mut set: BTreeSet<_> = [1, 2, 3].iter().cloned().collect();
 867     /// assert_eq!(set.take(&2), Some(2));
 868     /// assert_eq!(set.take(&2), None);
 869     /// ```
 870     #[stable(feature = "set_recovery", since = "1.9.0")]
 871     pub fn take<Q: ?Sized>(&mut self, value: &Q) -> Option<T>
 872     where
 873         T: Borrow<Q>,
 874         Q: Ord,
 875     {
 876         Recover::take(&mut self.map, value)
 877     }
 878
 879     /// Moves all elements from `other` into `Self`, leaving `other` empty.
 880     ///
 881     /// # Examples
 882     ///
 883     /// ```
 884     /// use std::collections::BTreeSet;
 885     ///
 886     /// let mut a = BTreeSet::new();
 887     /// a.insert(1);
 888     /// a.insert(2);
 889     /// a.insert(3);
 890     ///
 891     /// let mut b = BTreeSet::new();
 892     /// b.insert(3);
 893     /// b.insert(4);
 894     /// b.insert(5);
 895     ///
 896     /// a.append(&mut b);
 897     ///
 898     /// assert_eq!(a.len(), 5);
 899     /// assert_eq!(b.len(), 0);
 900     ///
 901     /// assert!(a.contains(&1));
 902     /// assert!(a.contains(&2));
 903     /// assert!(a.contains(&3));
 904     /// assert!(a.contains(&4));
 905     /// assert!(a.contains(&5));
 906     /// ```
 907     #[stable(feature = "btree_append", since = "1.11.0")]
 908     pub fn append(&mut self, other: &mut Self) {
 909         self.map.append(&mut other.map);
 910     }
 911
 912     /// Splits the collection into two at the given key. Returns everything after the given key,
 913     /// including the key.
 914     ///
 915     /// # Examples
 916     ///
 917     /// Basic usage:
 918     ///
 919     /// ```
 920     /// use std::collections::BTreeSet;
 921     ///
 922     /// let mut a = BTreeSet::new();
 923     /// a.insert(1);
 924     /// a.insert(2);
 925     /// a.insert(3);
 926     /// a.insert(17);
 927     /// a.insert(41);
 928     ///
 929     /// let b = a.split_off(&3);
 930     ///
 931     /// assert_eq!(a.len(), 2);
 932     /// assert_eq!(b.len(), 3);
 933     ///
 934     /// assert!(a.contains(&1));
 935     /// assert!(a.contains(&2));
 936     ///
 937     /// assert!(b.contains(&3));
 938     /// assert!(b.contains(&17));
 939     /// assert!(b.contains(&41));
 940     /// ```
 941     #[stable(feature = "btree_split_off", since = "1.11.0")]
 942     pub fn split_off<Q: ?Sized + Ord>(&mut self, key: &Q) -> Self
 943     where
 944         T: Borrow<Q>,
 945     {
 946         BTreeSet { map: self.map.split_off(key) }
 947     }
 948
 949     /// Creates an iterator which uses a closure to determine if a value should be removed.
 950     ///
 951     /// If the closure returns true, then the value is removed and yielded.
 952     /// If the closure returns false, the value will remain in the list and will not be yielded
 953     /// by the iterator.
 954     ///
 955     /// If the iterator is only partially consumed or not consumed at all, each of the remaining
 956     /// values will still be subjected to the closure and removed and dropped if it returns true.
 957     ///
 958     /// It is unspecified how many more values will be subjected to the closure
 959     /// if a panic occurs in the closure, or if a panic occurs while dropping a value, or if the
 960     /// `DrainFilter` itself is leaked.
 961     ///
 962     /// # Examples
 963     ///
 964     /// Splitting a set into even and odd values, reusing the original set:
 965     ///
 966     /// ```
 967     /// #![feature(btree_drain_filter)]
 968     /// use std::collections::BTreeSet;
 969     ///
 970     /// let mut set: BTreeSet<i32> = (0..8).collect();
 971     /// let evens: BTreeSet<_> = set.drain_filter(|v| v % 2 == 0).collect();
 972     /// let odds = set;
 973     /// assert_eq!(evens.into_iter().collect::<Vec<_>>(), vec![0, 2, 4, 6]);
 974     /// assert_eq!(odds.into_iter().collect::<Vec<_>>(), vec![1, 3, 5, 7]);
 975     /// ```
 976     #[unstable(feature = "btree_drain_filter", issue = "70530")]
 977     pub fn drain_filter<'a, F>(&'a mut self, pred: F) -> DrainFilter<'a, T, F>
 978     where
 979         F: 'a + FnMut(&T) -> bool,
 980     {
 981         DrainFilter { pred, inner: self.map.drain_filter_inner() }
 982     }
 983 }
 984
 985 impl<T> BTreeSet<T> {
 986     /// Gets an iterator that visits the values in the `BTreeSet` in ascending order.
 987     ///
 988     /// # Examples
 989     ///
 990     /// ```
 991     /// use std::collections::BTreeSet;
 992     ///
 993     /// let set: BTreeSet<usize> = [1, 2, 3].iter().cloned().collect();
 994     /// let mut set_iter = set.iter();
 995     /// assert_eq!(set_iter.next(), Some(&1));
 996     /// assert_eq!(set_iter.next(), Some(&2));
 997     /// assert_eq!(set_iter.next(), Some(&3));
 998     /// assert_eq!(set_iter.next(), None);
 999     /// ```
1000     ///
1001     /// Values returned by the iterator are returned in ascending order:
1002     ///
1003     /// ```
1004     /// use std::collections::BTreeSet;
1005     ///
1006     /// let set: BTreeSet<usize> = [3, 1, 2].iter().cloned().collect();
1007     /// let mut set_iter = set.iter();
1008     /// assert_eq!(set_iter.next(), Some(&1));
1009     /// assert_eq!(set_iter.next(), Some(&2));
1010     /// assert_eq!(set_iter.next(), Some(&3));
1011     /// assert_eq!(set_iter.next(), None);
1012     /// ```
1013     #[stable(feature = "rust1", since = "1.0.0")]
1014     pub fn iter(&self) -> Iter<'_, T> {
1015         Iter { iter: self.map.keys() }
1016     }
1017
1018     /// Returns the number of elements in the set.
1019     ///
1020     /// # Examples
1021     ///
1022     /// ```
1023     /// use std::collections::BTreeSet;
1024     ///
1025     /// let mut v = BTreeSet::new();
1026     /// assert_eq!(v.len(), 0);
1027     /// v.insert(1);
1028     /// assert_eq!(v.len(), 1);
1029     /// ```
1030     #[stable(feature = "rust1", since = "1.0.0")]
1031     pub fn len(&self) -> usize {
1032         self.map.len()
1033     }
1034
1035     /// Returns `true` if the set contains no elements.
1036     ///
1037     /// # Examples
1038     ///
1039     /// ```
1040     /// use std::collections::BTreeSet;
1041     ///
1042     /// let mut v = BTreeSet::new();
1043     /// assert!(v.is_empty());
1044     /// v.insert(1);
1045     /// assert!(!v.is_empty());
1046     /// ```
1047     #[stable(feature = "rust1", since = "1.0.0")]
1048     pub fn is_empty(&self) -> bool {
1049         self.len() == 0
1050     }
1051 }
1052
1053 #[stable(feature = "rust1", since = "1.0.0")]
1054 impl<T: Ord> FromIterator<T> for BTreeSet<T> {
1055     fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> BTreeSet<T> {
1056         let mut set = BTreeSet::new();
1057         set.extend(iter);
1058         set
1059     }
1060 }
1061
1062 #[stable(feature = "rust1", since = "1.0.0")]
1063 impl<T> IntoIterator for BTreeSet<T> {
1064     type Item = T;
1065     type IntoIter = IntoIter<T>;
1066
1067     /// Gets an iterator for moving out the `BTreeSet`'s contents.
1068     ///
1069     /// # Examples
1070     ///
1071     /// ```
1072     /// use std::collections::BTreeSet;
1073     ///
1074     /// let set: BTreeSet<usize> = [1, 2, 3, 4].iter().cloned().collect();
1075     ///
1076     /// let v: Vec<_> = set.into_iter().collect();
1077     /// assert_eq!(v, [1, 2, 3, 4]);
1078     /// ```
1079     fn into_iter(self) -> IntoIter<T> {
1080         IntoIter { iter: self.map.into_iter() }
1081     }
1082 }
1083
1084 #[stable(feature = "rust1", since = "1.0.0")]
1085 impl<'a, T> IntoIterator for &'a BTreeSet<T> {
1086     type Item = &'a T;
1087     type IntoIter = Iter<'a, T>;
1088
1089     fn into_iter(self) -> Iter<'a, T> {
1090         self.iter()
1091     }
1092 }
1093
1094 /// An iterator produced by calling `drain_filter` on BTreeSet.
1095 #[unstable(feature = "btree_drain_filter", issue = "70530")]
1096 pub struct DrainFilter<'a, T, F>
1097 where
1098     T: 'a,
1099     F: 'a + FnMut(&T) -> bool,
1100 {
1101     pred: F,
1102     inner: super::map::DrainFilterInner<'a, T, ()>,
1103 }
1104
1105 #[unstable(feature = "btree_drain_filter", issue = "70530")]
1106 impl<T, F> Drop for DrainFilter<'_, T, F>
1107 where
1108     F: FnMut(&T) -> bool,
1109 {
1110     fn drop(&mut self) {
1111         self.for_each(drop);
1112     }
1113 }
1114
1115 #[unstable(feature = "btree_drain_filter", issue = "70530")]
1116 impl<T, F> fmt::Debug for DrainFilter<'_, T, F>
1117 where
1118     T: fmt::Debug,
1119     F: FnMut(&T) -> bool,
1120 {
1121     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1122         f.debug_tuple("DrainFilter").field(&self.inner.peek().map(|(k, _)| k)).finish()
1123     }
1124 }
1125
1126 #[unstable(feature = "btree_drain_filter", issue = "70530")]
1127 impl<'a, T, F> Iterator for DrainFilter<'_, T, F>
1128 where
1129     F: 'a + FnMut(&T) -> bool,
1130 {
1131     type Item = T;
1132
1133     fn next(&mut self) -> Option<T> {
1134         let pred = &mut self.pred;
1135         let mut mapped_pred = |k: &T, _v: &mut ()| pred(k);
1136         self.inner.next(&mut mapped_pred).map(|(k, _)| k)
1137     }
1138
1139     fn size_hint(&self) -> (usize, Option<usize>) {
1140         self.inner.size_hint()
1141     }
1142 }
1143
1144 #[unstable(feature = "btree_drain_filter", issue = "70530")]
1145 impl<T, F> FusedIterator for DrainFilter<'_, T, F> where F: FnMut(&T) -> bool {}
1146
1147 #[stable(feature = "rust1", since = "1.0.0")]
1148 impl<T: Ord> Extend<T> for BTreeSet<T> {
1149     #[inline]
1150     fn extend<Iter: IntoIterator<Item = T>>(&mut self, iter: Iter) {
1151         iter.into_iter().for_each(move |elem| {
1152             self.insert(elem);
1153         });
1154     }
1155
1156     #[inline]
1157     fn extend_one(&mut self, elem: T) {
1158         self.insert(elem);
1159     }
1160 }
1161
1162 #[stable(feature = "extend_ref", since = "1.2.0")]
1163 impl<'a, T: 'a + Ord + Copy> Extend<&'a T> for BTreeSet<T> {
1164     fn extend<I: IntoIterator<Item = &'a T>>(&mut self, iter: I) {
1165         self.extend(iter.into_iter().cloned());
1166     }
1167
1168     #[inline]
1169     fn extend_one(&mut self, &elem: &'a T) {
1170         self.insert(elem);
1171     }
1172 }
1173
1174 #[stable(feature = "rust1", since = "1.0.0")]
1175 impl<T: Ord> Default for BTreeSet<T> {
1176     /// Makes an empty `BTreeSet<T>` with a reasonable choice of B.
1177     fn default() -> BTreeSet<T> {
1178         BTreeSet::new()
1179     }
1180 }
1181
1182 #[stable(feature = "rust1", since = "1.0.0")]
1183 impl<T: Ord + Clone> Sub<&BTreeSet<T>> for &BTreeSet<T> {
1184     type Output = BTreeSet<T>;
1185
1186     /// Returns the difference of `self` and `rhs` as a new `BTreeSet<T>`.
1187     ///
1188     /// # Examples
1189     ///
1190     /// ```
1191     /// use std::collections::BTreeSet;
1192     ///
1193     /// let a: BTreeSet<_> = vec![1, 2, 3].into_iter().collect();
1194     /// let b: BTreeSet<_> = vec![3, 4, 5].into_iter().collect();
1195     ///
1196     /// let result = &a - &b;
1197     /// let result_vec: Vec<_> = result.into_iter().collect();
1198     /// assert_eq!(result_vec, [1, 2]);
1199     /// ```
1200     fn sub(self, rhs: &BTreeSet<T>) -> BTreeSet<T> {
1201         self.difference(rhs).cloned().collect()
1202     }
1203 }
1204
1205 #[stable(feature = "rust1", since = "1.0.0")]
1206 impl<T: Ord + Clone> BitXor<&BTreeSet<T>> for &BTreeSet<T> {
1207     type Output = BTreeSet<T>;
1208
1209     /// Returns the symmetric difference of `self` and `rhs` as a new `BTreeSet<T>`.
1210     ///
1211     /// # Examples
1212     ///
1213     /// ```
1214     /// use std::collections::BTreeSet;
1215     ///
1216     /// let a: BTreeSet<_> = vec![1, 2, 3].into_iter().collect();
1217     /// let b: BTreeSet<_> = vec![2, 3, 4].into_iter().collect();
1218     ///
1219     /// let result = &a ^ &b;
1220     /// let result_vec: Vec<_> = result.into_iter().collect();
1221     /// assert_eq!(result_vec, [1, 4]);
1222     /// ```
1223     fn bitxor(self, rhs: &BTreeSet<T>) -> BTreeSet<T> {
1224         self.symmetric_difference(rhs).cloned().collect()
1225     }
1226 }
1227
1228 #[stable(feature = "rust1", since = "1.0.0")]
1229 impl<T: Ord + Clone> BitAnd<&BTreeSet<T>> for &BTreeSet<T> {
1230     type Output = BTreeSet<T>;
1231
1232     /// Returns the intersection of `self` and `rhs` as a new `BTreeSet<T>`.
1233     ///
1234     /// # Examples
1235     ///
1236     /// ```
1237     /// use std::collections::BTreeSet;
1238     ///
1239     /// let a: BTreeSet<_> = vec![1, 2, 3].into_iter().collect();
1240     /// let b: BTreeSet<_> = vec![2, 3, 4].into_iter().collect();
1241     ///
1242     /// let result = &a & &b;
1243     /// let result_vec: Vec<_> = result.into_iter().collect();
1244     /// assert_eq!(result_vec, [2, 3]);
1245     /// ```
1246     fn bitand(self, rhs: &BTreeSet<T>) -> BTreeSet<T> {
1247         self.intersection(rhs).cloned().collect()
1248     }
1249 }
1250
1251 #[stable(feature = "rust1", since = "1.0.0")]
1252 impl<T: Ord + Clone> BitOr<&BTreeSet<T>> for &BTreeSet<T> {
1253     type Output = BTreeSet<T>;
1254
1255     /// Returns the union of `self` and `rhs` as a new `BTreeSet<T>`.
1256     ///
1257     /// # Examples
1258     ///
1259     /// ```
1260     /// use std::collections::BTreeSet;
1261     ///
1262     /// let a: BTreeSet<_> = vec![1, 2, 3].into_iter().collect();
1263     /// let b: BTreeSet<_> = vec![3, 4, 5].into_iter().collect();
1264     ///
1265     /// let result = &a | &b;
1266     /// let result_vec: Vec<_> = result.into_iter().collect();
1267     /// assert_eq!(result_vec, [1, 2, 3, 4, 5]);
1268     /// ```
1269     fn bitor(self, rhs: &BTreeSet<T>) -> BTreeSet<T> {
1270         self.union(rhs).cloned().collect()
1271     }
1272 }
1273
1274 #[stable(feature = "rust1", since = "1.0.0")]
1275 impl<T: Debug> Debug for BTreeSet<T> {
1276     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1277         f.debug_set().entries(self.iter()).finish()
1278     }
1279 }
1280
1281 #[stable(feature = "rust1", since = "1.0.0")]
1282 impl<T> Clone for Iter<'_, T> {
1283     fn clone(&self) -> Self {
1284         Iter { iter: self.iter.clone() }
1285     }
1286 }
1287 #[stable(feature = "rust1", since = "1.0.0")]
1288 impl<'a, T> Iterator for Iter<'a, T> {
1289     type Item = &'a T;
1290
1291     fn next(&mut self) -> Option<&'a T> {
1292         self.iter.next()
1293     }
1294
1295     fn size_hint(&self) -> (usize, Option<usize>) {
1296         self.iter.size_hint()
1297     }
1298
1299     fn last(mut self) -> Option<&'a T> {
1300         self.next_back()
1301     }
1302
1303     fn min(mut self) -> Option<&'a T> {
1304         self.next()
1305     }
1306
1307     fn max(mut self) -> Option<&'a T> {
1308         self.next_back()
1309     }
1310 }
1311 #[stable(feature = "rust1", since = "1.0.0")]
1312 impl<'a, T> DoubleEndedIterator for Iter<'a, T> {
1313     fn next_back(&mut self) -> Option<&'a T> {
1314         self.iter.next_back()
1315     }
1316 }
1317 #[stable(feature = "rust1", since = "1.0.0")]
1318 impl<T> ExactSizeIterator for Iter<'_, T> {
1319     fn len(&self) -> usize {
1320         self.iter.len()
1321     }
1322 }
1323
1324 #[stable(feature = "fused", since = "1.26.0")]
1325 impl<T> FusedIterator for Iter<'_, T> {}
1326
1327 #[stable(feature = "rust1", since = "1.0.0")]
1328 impl<T> Iterator for IntoIter<T> {
1329     type Item = T;
1330
1331     fn next(&mut self) -> Option<T> {
1332         self.iter.next().map(|(k, _)| k)
1333     }
1334
1335     fn size_hint(&self) -> (usize, Option<usize>) {
1336         self.iter.size_hint()
1337     }
1338 }
1339 #[stable(feature = "rust1", since = "1.0.0")]
1340 impl<T> DoubleEndedIterator for IntoIter<T> {
1341     fn next_back(&mut self) -> Option<T> {
1342         self.iter.next_back().map(|(k, _)| k)
1343     }
1344 }
1345 #[stable(feature = "rust1", since = "1.0.0")]
1346 impl<T> ExactSizeIterator for IntoIter<T> {
1347     fn len(&self) -> usize {
1348         self.iter.len()
1349     }
1350 }
1351
1352 #[stable(feature = "fused", since = "1.26.0")]
1353 impl<T> FusedIterator for IntoIter<T> {}
1354
1355 #[stable(feature = "btree_range", since = "1.17.0")]
1356 impl<T> Clone for Range<'_, T> {
1357     fn clone(&self) -> Self {
1358         Range { iter: self.iter.clone() }
1359     }
1360 }
1361
1362 #[stable(feature = "btree_range", since = "1.17.0")]
1363 impl<'a, T> Iterator for Range<'a, T> {
1364     type Item = &'a T;
1365
1366     fn next(&mut self) -> Option<&'a T> {
1367         self.iter.next().map(|(k, _)| k)
1368     }
1369
1370     fn last(mut self) -> Option<&'a T> {
1371         self.next_back()
1372     }
1373
1374     fn min(mut self) -> Option<&'a T> {
1375         self.next()
1376     }
1377
1378     fn max(mut self) -> Option<&'a T> {
1379         self.next_back()
1380     }
1381 }
1382
1383 #[stable(feature = "btree_range", since = "1.17.0")]
1384 impl<'a, T> DoubleEndedIterator for Range<'a, T> {
1385     fn next_back(&mut self) -> Option<&'a T> {
1386         self.iter.next_back().map(|(k, _)| k)
1387     }
1388 }
1389
1390 #[stable(feature = "fused", since = "1.26.0")]
1391 impl<T> FusedIterator for Range<'_, T> {}
1392
1393 #[stable(feature = "rust1", since = "1.0.0")]
1394 impl<T> Clone for Difference<'_, T> {
1395     fn clone(&self) -> Self {
1396         Difference {
1397             inner: match &self.inner {
1398                 DifferenceInner::Stitch { self_iter, other_iter } => DifferenceInner::Stitch {
1399                     self_iter: self_iter.clone(),
1400                     other_iter: other_iter.clone(),
1401                 },
1402                 DifferenceInner::Search { self_iter, other_set } => {
1403                     DifferenceInner::Search { self_iter: self_iter.clone(), other_set }
1404                 }
1405                 DifferenceInner::Iterate(iter) => DifferenceInner::Iterate(iter.clone()),
1406             },
1407         }
1408     }
1409 }
1410 #[stable(feature = "rust1", since = "1.0.0")]
1411 impl<'a, T: Ord> Iterator for Difference<'a, T> {
1412     type Item = &'a T;
1413
1414     fn next(&mut self) -> Option<&'a T> {
1415         match &mut self.inner {
1416             DifferenceInner::Stitch { self_iter, other_iter } => {
1417                 let mut self_next = self_iter.next()?;
1418                 loop {
1419                     match other_iter.peek().map_or(Less, |other_next| self_next.cmp(other_next)) {
1420                         Less => return Some(self_next),
1421                         Equal => {
1422                             self_next = self_iter.next()?;
1423                             other_iter.next();
1424                         }
1425                         Greater => {
1426                             other_iter.next();
1427                         }
1428                     }
1429                 }
1430             }
1431             DifferenceInner::Search { self_iter, other_set } => loop {
1432                 let self_next = self_iter.next()?;
1433                 if !other_set.contains(&self_next) {
1434                     return Some(self_next);
1435                 }
1436             },
1437             DifferenceInner::Iterate(iter) => iter.next(),
1438         }
1439     }
1440
1441     fn size_hint(&self) -> (usize, Option<usize>) {
1442         let (self_len, other_len) = match &self.inner {
1443             DifferenceInner::Stitch { self_iter, other_iter } => {
1444                 (self_iter.len(), other_iter.len())
1445             }
1446             DifferenceInner::Search { self_iter, other_set } => (self_iter.len(), other_set.len()),
1447             DifferenceInner::Iterate(iter) => (iter.len(), 0),
1448         };
1449         (self_len.saturating_sub(other_len), Some(self_len))
1450     }
1451
1452     fn min(mut self) -> Option<&'a T> {
1453         self.next()
1454     }
1455 }
1456
1457 #[stable(feature = "fused", since = "1.26.0")]
1458 impl<T: Ord> FusedIterator for Difference<'_, T> {}
1459
1460 #[stable(feature = "rust1", since = "1.0.0")]
1461 impl<T> Clone for SymmetricDifference<'_, T> {
1462     fn clone(&self) -> Self {
1463         SymmetricDifference(self.0.clone())
1464     }
1465 }
1466 #[stable(feature = "rust1", since = "1.0.0")]
1467 impl<'a, T: Ord> Iterator for SymmetricDifference<'a, T> {
1468     type Item = &'a T;
1469
1470     fn next(&mut self) -> Option<&'a T> {
1471         loop {
1472             let (a_next, b_next) = self.0.nexts();
1473             if a_next.and(b_next).is_none() {
1474                 return a_next.or(b_next);
1475             }
1476         }
1477     }
1478
1479     fn size_hint(&self) -> (usize, Option<usize>) {
1480         let (a_len, b_len) = self.0.lens();
1481         // No checked_add, because even if a and b refer to the same set,
1482         // and T is an empty type, the storage overhead of sets limits
1483         // the number of elements to less than half the range of usize.
1484         (0, Some(a_len + b_len))
1485     }
1486
1487     fn min(mut self) -> Option<&'a T> {
1488         self.next()
1489     }
1490 }
1491
1492 #[stable(feature = "fused", since = "1.26.0")]
1493 impl<T: Ord> FusedIterator for SymmetricDifference<'_, T> {}
1494
1495 #[stable(feature = "rust1", since = "1.0.0")]
1496 impl<T> Clone for Intersection<'_, T> {
1497     fn clone(&self) -> Self {
1498         Intersection {
1499             inner: match &self.inner {
1500                 IntersectionInner::Stitch { a, b } => {
1501                     IntersectionInner::Stitch { a: a.clone(), b: b.clone() }
1502                 }
1503                 IntersectionInner::Search { small_iter, large_set } => {
1504                     IntersectionInner::Search { small_iter: small_iter.clone(), large_set }
1505                 }
1506                 IntersectionInner::Answer(answer) => IntersectionInner::Answer(*answer),
1507             },
1508         }
1509     }
1510 }
1511 #[stable(feature = "rust1", since = "1.0.0")]
1512 impl<'a, T: Ord> Iterator for Intersection<'a, T> {
1513     type Item = &'a T;
1514
1515     fn next(&mut self) -> Option<&'a T> {
1516         match &mut self.inner {
1517             IntersectionInner::Stitch { a, b } => {
1518                 let mut a_next = a.next()?;
1519                 let mut b_next = b.next()?;
1520                 loop {
1521                     match a_next.cmp(b_next) {
1522                         Less => a_next = a.next()?,
1523                         Greater => b_next = b.next()?,
1524                         Equal => return Some(a_next),
1525                     }
1526                 }
1527             }
1528             IntersectionInner::Search { small_iter, large_set } => loop {
1529                 let small_next = small_iter.next()?;
1530                 if large_set.contains(&small_next) {
1531                     return Some(small_next);
1532                 }
1533             },
1534             IntersectionInner::Answer(answer) => answer.take(),
1535         }
1536     }
1537
1538     fn size_hint(&self) -> (usize, Option<usize>) {
1539         match &self.inner {
1540             IntersectionInner::Stitch { a, b } => (0, Some(min(a.len(), b.len()))),
1541             IntersectionInner::Search { small_iter, .. } => (0, Some(small_iter.len())),
1542             IntersectionInner::Answer(None) => (0, Some(0)),
1543             IntersectionInner::Answer(Some(_)) => (1, Some(1)),
1544         }
1545     }
1546
1547     fn min(mut self) -> Option<&'a T> {
1548         self.next()
1549     }
1550 }
1551
1552 #[stable(feature = "fused", since = "1.26.0")]
1553 impl<T: Ord> FusedIterator for Intersection<'_, T> {}
1554
1555 #[stable(feature = "rust1", since = "1.0.0")]
1556 impl<T> Clone for Union<'_, T> {
1557     fn clone(&self) -> Self {
1558         Union(self.0.clone())
1559     }
1560 }
1561 #[stable(feature = "rust1", since = "1.0.0")]
1562 impl<'a, T: Ord> Iterator for Union<'a, T> {
1563     type Item = &'a T;
1564
1565     fn next(&mut self) -> Option<&'a T> {
1566         let (a_next, b_next) = self.0.nexts();
1567         a_next.or(b_next)
1568     }
1569
1570     fn size_hint(&self) -> (usize, Option<usize>) {
1571         let (a_len, b_len) = self.0.lens();
1572         // No checked_add - see SymmetricDifference::size_hint.
1573         (max(a_len, b_len), Some(a_len + b_len))
1574     }
1575
1576     fn min(mut self) -> Option<&'a T> {
1577         self.next()
1578     }
1579 }
1580
1581 #[stable(feature = "fused", since = "1.26.0")]
1582 impl<T: Ord> FusedIterator for Union<'_, T> {}