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