src/liballoc/collections/btree/map.rs

   1 use core::borrow::Borrow;
   2 use core::cmp::Ordering;
   3 use core::fmt::Debug;
   4 use core::hash::{Hash, Hasher};
   5 use core::iter::{FromIterator, FusedIterator, Peekable};
   6 use core::marker::PhantomData;
   7 use core::ops::Bound::{Excluded, Included, Unbounded};
   8 use core::ops::{Index, RangeBounds};
   9 use core::{fmt, mem, ptr};
  10
  11 use super::node::{self, marker, ForceResult::*, Handle, InsertResult::*, NodeRef};
  12 use super::search::{self, SearchResult::*};
  13 use super::unwrap_unchecked;
  14
  15 use Entry::*;
  16 use UnderflowResult::*;
  17
  18 /// A map based on a B-Tree.
  19 ///
  20 /// B-Trees represent a fundamental compromise between cache-efficiency and actually minimizing
  21 /// the amount of work performed in a search. In theory, a binary search tree (BST) is the optimal
  22 /// choice for a sorted map, as a perfectly balanced BST performs the theoretical minimum amount of
  23 /// comparisons necessary to find an element (log<sub>2</sub>n). However, in practice the way this
  24 /// is done is *very* inefficient for modern computer architectures. In particular, every element
  25 /// is stored in its own individually heap-allocated node. This means that every single insertion
  26 /// triggers a heap-allocation, and every single comparison should be a cache-miss. Since these
  27 /// are both notably expensive things to do in practice, we are forced to at very least reconsider
  28 /// the BST strategy.
  29 ///
  30 /// A B-Tree instead makes each node contain B-1 to 2B-1 elements in a contiguous array. By doing
  31 /// this, we reduce the number of allocations by a factor of B, and improve cache efficiency in
  32 /// searches. However, this does mean that searches will have to do *more* comparisons on average.
  33 /// The precise number of comparisons depends on the node search strategy used. For optimal cache
  34 /// efficiency, one could search the nodes linearly. For optimal comparisons, one could search
  35 /// the node using binary search. As a compromise, one could also perform a linear search
  36 /// that initially only checks every i<sup>th</sup> element for some choice of i.
  37 ///
  38 /// Currently, our implementation simply performs naive linear search. This provides excellent
  39 /// performance on *small* nodes of elements which are cheap to compare. However in the future we
  40 /// would like to further explore choosing the optimal search strategy based on the choice of B,
  41 /// and possibly other factors. Using linear search, searching for a random element is expected
  42 /// to take O(B log<sub>B</sub>n) comparisons, which is generally worse than a BST. In practice,
  43 /// however, performance is excellent.
  44 ///
  45 /// It is a logic error for a key to be modified in such a way that the key's ordering relative to
  46 /// any other key, as determined by the [`Ord`] trait, changes while it is in the map. This is
  47 /// normally only possible through [`Cell`], [`RefCell`], global state, I/O, or unsafe code.
  48 ///
  49 /// [`Ord`]: ../../std/cmp/trait.Ord.html
  50 /// [`Cell`]: ../../std/cell/struct.Cell.html
  51 /// [`RefCell`]: ../../std/cell/struct.RefCell.html
  52 ///
  53 /// # Examples
  54 ///
  55 /// ```
  56 /// use std::collections::BTreeMap;
  57 ///
  58 /// // type inference lets us omit an explicit type signature (which
  59 /// // would be `BTreeMap<&str, &str>` in this example).
  60 /// let mut movie_reviews = BTreeMap::new();
  61 ///
  62 /// // review some movies.
  63 /// movie_reviews.insert("Office Space",       "Deals with real issues in the workplace.");
  64 /// movie_reviews.insert("Pulp Fiction",       "Masterpiece.");
  65 /// movie_reviews.insert("The Godfather",      "Very enjoyable.");
  66 /// movie_reviews.insert("The Blues Brothers", "Eye lyked it a lot.");
  67 ///
  68 /// // check for a specific one.
  69 /// if !movie_reviews.contains_key("Les Misérables") {
  70 ///     println!("We've got {} reviews, but Les Misérables ain't one.",
  71 ///              movie_reviews.len());
  72 /// }
  73 ///
  74 /// // oops, this review has a lot of spelling mistakes, let's delete it.
  75 /// movie_reviews.remove("The Blues Brothers");
  76 ///
  77 /// // look up the values associated with some keys.
  78 /// let to_find = ["Up!", "Office Space"];
  79 /// for movie in &to_find {
  80 ///     match movie_reviews.get(movie) {
  81 ///        Some(review) => println!("{}: {}", movie, review),
  82 ///        None => println!("{} is unreviewed.", movie)
  83 ///     }
  84 /// }
  85 ///
  86 /// // Look up the value for a key (will panic if the key is not found).
  87 /// println!("Movie review: {}", movie_reviews["Office Space"]);
  88 ///
  89 /// // iterate over everything.
  90 /// for (movie, review) in &movie_reviews {
  91 ///     println!("{}: \"{}\"", movie, review);
  92 /// }
  93 /// ```
  94 ///
  95 /// `BTreeMap` also implements an [`Entry API`](#method.entry), which allows
  96 /// for more complex methods of getting, setting, updating and removing keys and
  97 /// their values:
  98 ///
  99 /// ```
 100 /// use std::collections::BTreeMap;
 101 ///
 102 /// // type inference lets us omit an explicit type signature (which
 103 /// // would be `BTreeMap<&str, u8>` in this example).
 104 /// let mut player_stats = BTreeMap::new();
 105 ///
 106 /// fn random_stat_buff() -> u8 {
 107 ///     // could actually return some random value here - let's just return
 108 ///     // some fixed value for now
 109 ///     42
 110 /// }
 111 ///
 112 /// // insert a key only if it doesn't already exist
 113 /// player_stats.entry("health").or_insert(100);
 114 ///
 115 /// // insert a key using a function that provides a new value only if it
 116 /// // doesn't already exist
 117 /// player_stats.entry("defence").or_insert_with(random_stat_buff);
 118 ///
 119 /// // update a key, guarding against the key possibly not being set
 120 /// let stat = player_stats.entry("attack").or_insert(100);
 121 /// *stat += random_stat_buff();
 122 /// ```
 123 #[stable(feature = "rust1", since = "1.0.0")]
 124 pub struct BTreeMap<K, V> {
 125     root: node::Root<K, V>,
 126     length: usize,
 127 }
 128
 129 #[stable(feature = "btree_drop", since = "1.7.0")]
 130 unsafe impl<#[may_dangle] K, #[may_dangle] V> Drop for BTreeMap<K, V> {
 131     fn drop(&mut self) {
 132         unsafe {
 133             drop(ptr::read(self).into_iter());
 134         }
 135     }
 136 }
 137
 138 #[stable(feature = "rust1", since = "1.0.0")]
 139 impl<K: Clone, V: Clone> Clone for BTreeMap<K, V> {
 140     fn clone(&self) -> BTreeMap<K, V> {
 141         fn clone_subtree<'a, K: Clone, V: Clone>(
 142             node: node::NodeRef<marker::Immut<'a>, K, V, marker::LeafOrInternal>,
 143         ) -> BTreeMap<K, V>
 144         where
 145             K: 'a,
 146             V: 'a,
 147         {
 148             match node.force() {
 149                 Leaf(leaf) => {
 150                     let mut out_tree = BTreeMap { root: node::Root::new_leaf(), length: 0 };
 151
 152                     {
 153                         let mut out_node = match out_tree.root.as_mut().force() {
 154                             Leaf(leaf) => leaf,
 155                             Internal(_) => unreachable!(),
 156                         };
 157
 158                         let mut in_edge = leaf.first_edge();
 159                         while let Ok(kv) = in_edge.right_kv() {
 160                             let (k, v) = kv.into_kv();
 161                             in_edge = kv.right_edge();
 162
 163                             out_node.push(k.clone(), v.clone());
 164                             out_tree.length += 1;
 165                         }
 166                     }
 167
 168                     out_tree
 169                 }
 170                 Internal(internal) => {
 171                     let mut out_tree = clone_subtree(internal.first_edge().descend());
 172
 173                     {
 174                         let mut out_node = out_tree.root.push_level();
 175                         let mut in_edge = internal.first_edge();
 176                         while let Ok(kv) = in_edge.right_kv() {
 177                             let (k, v) = kv.into_kv();
 178                             in_edge = kv.right_edge();
 179
 180                             let k = (*k).clone();
 181                             let v = (*v).clone();
 182                             let subtree = clone_subtree(in_edge.descend());
 183
 184                             // We can't destructure subtree directly
 185                             // because BTreeMap implements Drop
 186                             let (subroot, sublength) = unsafe {
 187                                 let root = ptr::read(&subtree.root);
 188                                 let length = subtree.length;
 189                                 mem::forget(subtree);
 190                                 (root, length)
 191                             };
 192
 193                             out_node.push(k, v, subroot);
 194                             out_tree.length += 1 + sublength;
 195                         }
 196                     }
 197
 198                     out_tree
 199                 }
 200             }
 201         }
 202
 203         if self.is_empty() {
 204             // Ideally we'd call `BTreeMap::new` here, but that has the `K:
 205             // Ord` constraint, which this method lacks.
 206             BTreeMap { root: node::Root::shared_empty_root(), length: 0 }
 207         } else {
 208             clone_subtree(self.root.as_ref())
 209         }
 210     }
 211
 212     fn clone_from(&mut self, other: &Self) {
 213         BTreeClone::clone_from(self, other);
 214     }
 215 }
 216
 217 trait BTreeClone {
 218     fn clone_from(&mut self, other: &Self);
 219 }
 220
 221 impl<K: Clone, V: Clone> BTreeClone for BTreeMap<K, V> {
 222     default fn clone_from(&mut self, other: &Self) {
 223         *self = other.clone();
 224     }
 225 }
 226
 227 impl<K: Clone + Ord, V: Clone> BTreeClone for BTreeMap<K, V> {
 228     fn clone_from(&mut self, other: &Self) {
 229         // This truncates `self` to `other.len()` by calling `split_off` on
 230         // the first key after `other.len()` elements if it exists
 231         let split_off_key = if self.len() > other.len() {
 232             let diff = self.len() - other.len();
 233             if diff <= other.len() {
 234                 self.iter().nth_back(diff - 1).map(|pair| (*pair.0).clone())
 235             } else {
 236                 self.iter().nth(other.len()).map(|pair| (*pair.0).clone())
 237             }
 238         } else {
 239             None
 240         };
 241         if let Some(key) = split_off_key {
 242             self.split_off(&key);
 243         }
 244
 245         let mut siter = self.range_mut(..);
 246         let mut oiter = other.iter();
 247         // After truncation, `self` is at most as long as `other` so this loop
 248         // replaces every key-value pair in `self`. Since `oiter` is in sorted
 249         // order and the structure of the `BTreeMap` stays the same,
 250         // the BTree invariants are maintained at the end of the loop
 251         while !siter.is_empty() {
 252             if let Some((ok, ov)) = oiter.next() {
 253                 // SAFETY: This is safe because the `siter.front != siter.back` check
 254                 // ensures that `siter` is nonempty
 255                 let (sk, sv) = unsafe { siter.next_unchecked() };
 256                 sk.clone_from(ok);
 257                 sv.clone_from(ov);
 258             } else {
 259                 break;
 260             }
 261         }
 262         // If `other` is longer than `self`, the remaining elements are inserted
 263         self.extend(oiter.map(|(k, v)| ((*k).clone(), (*v).clone())));
 264     }
 265 }
 266
 267 impl<K, Q: ?Sized> super::Recover<Q> for BTreeMap<K, ()>
 268 where
 269     K: Borrow<Q> + Ord,
 270     Q: Ord,
 271 {
 272     type Key = K;
 273
 274     fn get(&self, key: &Q) -> Option<&K> {
 275         match search::search_tree(self.root.as_ref(), key) {
 276             Found(handle) => Some(handle.into_kv().0),
 277             GoDown(_) => None,
 278         }
 279     }
 280
 281     fn take(&mut self, key: &Q) -> Option<K> {
 282         match search::search_tree(self.root.as_mut(), key) {
 283             Found(handle) => Some(
 284                 OccupiedEntry { handle, length: &mut self.length, _marker: PhantomData }
 285                     .remove_kv()
 286                     .0,
 287             ),
 288             GoDown(_) => None,
 289         }
 290     }
 291
 292     fn replace(&mut self, key: K) -> Option<K> {
 293         self.ensure_root_is_owned();
 294         match search::search_tree::<marker::Mut<'_>, K, (), K>(self.root.as_mut(), &key) {
 295             Found(handle) => Some(mem::replace(handle.into_kv_mut().0, key)),
 296             GoDown(handle) => {
 297                 VacantEntry { key, handle, length: &mut self.length, _marker: PhantomData }
 298                     .insert(());
 299                 None
 300             }
 301         }
 302     }
 303 }
 304
 305 /// An iterator over the entries of a `BTreeMap`.
 306 ///
 307 /// This `struct` is created by the [`iter`] method on [`BTreeMap`]. See its
 308 /// documentation for more.
 309 ///
 310 /// [`iter`]: struct.BTreeMap.html#method.iter
 311 /// [`BTreeMap`]: struct.BTreeMap.html
 312 #[stable(feature = "rust1", since = "1.0.0")]
 313 pub struct Iter<'a, K: 'a, V: 'a> {
 314     range: Range<'a, K, V>,
 315     length: usize,
 316 }
 317
 318 #[stable(feature = "collection_debug", since = "1.17.0")]
 319 impl<K: fmt::Debug, V: fmt::Debug> fmt::Debug for Iter<'_, K, V> {
 320     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 321         f.debug_list().entries(self.clone()).finish()
 322     }
 323 }
 324
 325 /// A mutable iterator over the entries of a `BTreeMap`.
 326 ///
 327 /// This `struct` is created by the [`iter_mut`] method on [`BTreeMap`]. See its
 328 /// documentation for more.
 329 ///
 330 /// [`iter_mut`]: struct.BTreeMap.html#method.iter_mut
 331 /// [`BTreeMap`]: struct.BTreeMap.html
 332 #[stable(feature = "rust1", since = "1.0.0")]
 333 #[derive(Debug)]
 334 pub struct IterMut<'a, K: 'a, V: 'a> {
 335     range: RangeMut<'a, K, V>,
 336     length: usize,
 337 }
 338
 339 /// An owning iterator over the entries of a `BTreeMap`.
 340 ///
 341 /// This `struct` is created by the [`into_iter`] method on [`BTreeMap`]
 342 /// (provided by the `IntoIterator` trait). See its documentation for more.
 343 ///
 344 /// [`into_iter`]: struct.BTreeMap.html#method.into_iter
 345 /// [`BTreeMap`]: struct.BTreeMap.html
 346 #[stable(feature = "rust1", since = "1.0.0")]
 347 pub struct IntoIter<K, V> {
 348     front: Handle<NodeRef<marker::Owned, K, V, marker::Leaf>, marker::Edge>,
 349     back: Handle<NodeRef<marker::Owned, K, V, marker::Leaf>, marker::Edge>,
 350     length: usize,
 351 }
 352
 353 #[stable(feature = "collection_debug", since = "1.17.0")]
 354 impl<K: fmt::Debug, V: fmt::Debug> fmt::Debug for IntoIter<K, V> {
 355     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 356         let range = Range { front: self.front.reborrow(), back: self.back.reborrow() };
 357         f.debug_list().entries(range).finish()
 358     }
 359 }
 360
 361 /// An iterator over the keys of a `BTreeMap`.
 362 ///
 363 /// This `struct` is created by the [`keys`] method on [`BTreeMap`]. See its
 364 /// documentation for more.
 365 ///
 366 /// [`keys`]: struct.BTreeMap.html#method.keys
 367 /// [`BTreeMap`]: struct.BTreeMap.html
 368 #[stable(feature = "rust1", since = "1.0.0")]
 369 pub struct Keys<'a, K: 'a, V: 'a> {
 370     inner: Iter<'a, K, V>,
 371 }
 372
 373 #[stable(feature = "collection_debug", since = "1.17.0")]
 374 impl<K: fmt::Debug, V> fmt::Debug for Keys<'_, K, V> {
 375     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 376         f.debug_list().entries(self.clone()).finish()
 377     }
 378 }
 379
 380 /// An iterator over the values of a `BTreeMap`.
 381 ///
 382 /// This `struct` is created by the [`values`] method on [`BTreeMap`]. See its
 383 /// documentation for more.
 384 ///
 385 /// [`values`]: struct.BTreeMap.html#method.values
 386 /// [`BTreeMap`]: struct.BTreeMap.html
 387 #[stable(feature = "rust1", since = "1.0.0")]
 388 pub struct Values<'a, K: 'a, V: 'a> {
 389     inner: Iter<'a, K, V>,
 390 }
 391
 392 #[stable(feature = "collection_debug", since = "1.17.0")]
 393 impl<K, V: fmt::Debug> fmt::Debug for Values<'_, K, V> {
 394     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 395         f.debug_list().entries(self.clone()).finish()
 396     }
 397 }
 398
 399 /// A mutable iterator over the values of a `BTreeMap`.
 400 ///
 401 /// This `struct` is created by the [`values_mut`] method on [`BTreeMap`]. See its
 402 /// documentation for more.
 403 ///
 404 /// [`values_mut`]: struct.BTreeMap.html#method.values_mut
 405 /// [`BTreeMap`]: struct.BTreeMap.html
 406 #[stable(feature = "map_values_mut", since = "1.10.0")]
 407 #[derive(Debug)]
 408 pub struct ValuesMut<'a, K: 'a, V: 'a> {
 409     inner: IterMut<'a, K, V>,
 410 }
 411
 412 /// An iterator over a sub-range of entries in a `BTreeMap`.
 413 ///
 414 /// This `struct` is created by the [`range`] method on [`BTreeMap`]. See its
 415 /// documentation for more.
 416 ///
 417 /// [`range`]: struct.BTreeMap.html#method.range
 418 /// [`BTreeMap`]: struct.BTreeMap.html
 419 #[stable(feature = "btree_range", since = "1.17.0")]
 420 pub struct Range<'a, K: 'a, V: 'a> {
 421     front: Handle<NodeRef<marker::Immut<'a>, K, V, marker::Leaf>, marker::Edge>,
 422     back: Handle<NodeRef<marker::Immut<'a>, K, V, marker::Leaf>, marker::Edge>,
 423 }
 424
 425 #[stable(feature = "collection_debug", since = "1.17.0")]
 426 impl<K: fmt::Debug, V: fmt::Debug> fmt::Debug for Range<'_, K, V> {
 427     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 428         f.debug_list().entries(self.clone()).finish()
 429     }
 430 }
 431
 432 /// A mutable iterator over a sub-range of entries in a `BTreeMap`.
 433 ///
 434 /// This `struct` is created by the [`range_mut`] method on [`BTreeMap`]. See its
 435 /// documentation for more.
 436 ///
 437 /// [`range_mut`]: struct.BTreeMap.html#method.range_mut
 438 /// [`BTreeMap`]: struct.BTreeMap.html
 439 #[stable(feature = "btree_range", since = "1.17.0")]
 440 pub struct RangeMut<'a, K: 'a, V: 'a> {
 441     front: Handle<NodeRef<marker::Mut<'a>, K, V, marker::Leaf>, marker::Edge>,
 442     back: Handle<NodeRef<marker::Mut<'a>, K, V, marker::Leaf>, marker::Edge>,
 443
 444     // Be invariant in `K` and `V`
 445     _marker: PhantomData<&'a mut (K, V)>,
 446 }
 447
 448 #[stable(feature = "collection_debug", since = "1.17.0")]
 449 impl<K: fmt::Debug, V: fmt::Debug> fmt::Debug for RangeMut<'_, K, V> {
 450     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 451         let range = Range { front: self.front.reborrow(), back: self.back.reborrow() };
 452         f.debug_list().entries(range).finish()
 453     }
 454 }
 455
 456 /// A view into a single entry in a map, which may either be vacant or occupied.
 457 ///
 458 /// This `enum` is constructed from the [`entry`] method on [`BTreeMap`].
 459 ///
 460 /// [`BTreeMap`]: struct.BTreeMap.html
 461 /// [`entry`]: struct.BTreeMap.html#method.entry
 462 #[stable(feature = "rust1", since = "1.0.0")]
 463 pub enum Entry<'a, K: 'a, V: 'a> {
 464     /// A vacant entry.
 465     #[stable(feature = "rust1", since = "1.0.0")]
 466     Vacant(#[stable(feature = "rust1", since = "1.0.0")] VacantEntry<'a, K, V>),
 467
 468     /// An occupied entry.
 469     #[stable(feature = "rust1", since = "1.0.0")]
 470     Occupied(#[stable(feature = "rust1", since = "1.0.0")] OccupiedEntry<'a, K, V>),
 471 }
 472
 473 #[stable(feature = "debug_btree_map", since = "1.12.0")]
 474 impl<K: Debug + Ord, V: Debug> Debug for Entry<'_, K, V> {
 475     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 476         match *self {
 477             Vacant(ref v) => f.debug_tuple("Entry").field(v).finish(),
 478             Occupied(ref o) => f.debug_tuple("Entry").field(o).finish(),
 479         }
 480     }
 481 }
 482
 483 /// A view into a vacant entry in a `BTreeMap`.
 484 /// It is part of the [`Entry`] enum.
 485 ///
 486 /// [`Entry`]: enum.Entry.html
 487 #[stable(feature = "rust1", since = "1.0.0")]
 488 pub struct VacantEntry<'a, K: 'a, V: 'a> {
 489     key: K,
 490     handle: Handle<NodeRef<marker::Mut<'a>, K, V, marker::Leaf>, marker::Edge>,
 491     length: &'a mut usize,
 492
 493     // Be invariant in `K` and `V`
 494     _marker: PhantomData<&'a mut (K, V)>,
 495 }
 496
 497 #[stable(feature = "debug_btree_map", since = "1.12.0")]
 498 impl<K: Debug + Ord, V> Debug for VacantEntry<'_, K, V> {
 499     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 500         f.debug_tuple("VacantEntry").field(self.key()).finish()
 501     }
 502 }
 503
 504 /// A view into an occupied entry in a `BTreeMap`.
 505 /// It is part of the [`Entry`] enum.
 506 ///
 507 /// [`Entry`]: enum.Entry.html
 508 #[stable(feature = "rust1", since = "1.0.0")]
 509 pub struct OccupiedEntry<'a, K: 'a, V: 'a> {
 510     handle: Handle<NodeRef<marker::Mut<'a>, K, V, marker::LeafOrInternal>, marker::KV>,
 511
 512     length: &'a mut usize,
 513
 514     // Be invariant in `K` and `V`
 515     _marker: PhantomData<&'a mut (K, V)>,
 516 }
 517
 518 #[stable(feature = "debug_btree_map", since = "1.12.0")]
 519 impl<K: Debug + Ord, V: Debug> Debug for OccupiedEntry<'_, K, V> {
 520     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 521         f.debug_struct("OccupiedEntry").field("key", self.key()).field("value", self.get()).finish()
 522     }
 523 }
 524
 525 // An iterator for merging two sorted sequences into one
 526 struct MergeIter<K, V, I: Iterator<Item = (K, V)>> {
 527     left: Peekable<I>,
 528     right: Peekable<I>,
 529 }
 530
 531 impl<K: Ord, V> BTreeMap<K, V> {
 532     /// Makes a new empty BTreeMap with a reasonable choice for B.
 533     ///
 534     /// # Examples
 535     ///
 536     /// Basic usage:
 537     ///
 538     /// ```
 539     /// use std::collections::BTreeMap;
 540     ///
 541     /// let mut map = BTreeMap::new();
 542     ///
 543     /// // entries can now be inserted into the empty map
 544     /// map.insert(1, "a");
 545     /// ```
 546     #[stable(feature = "rust1", since = "1.0.0")]
 547     pub fn new() -> BTreeMap<K, V> {
 548         BTreeMap { root: node::Root::shared_empty_root(), length: 0 }
 549     }
 550
 551     /// Clears the map, removing all elements.
 552     ///
 553     /// # Examples
 554     ///
 555     /// Basic usage:
 556     ///
 557     /// ```
 558     /// use std::collections::BTreeMap;
 559     ///
 560     /// let mut a = BTreeMap::new();
 561     /// a.insert(1, "a");
 562     /// a.clear();
 563     /// assert!(a.is_empty());
 564     /// ```
 565     #[stable(feature = "rust1", since = "1.0.0")]
 566     pub fn clear(&mut self) {
 567         *self = BTreeMap::new();
 568     }
 569
 570     /// Returns a reference to the value corresponding to the key.
 571     ///
 572     /// The key may be any borrowed form of the map's key type, but the ordering
 573     /// on the borrowed form *must* match the ordering on the key type.
 574     ///
 575     /// # Examples
 576     ///
 577     /// Basic usage:
 578     ///
 579     /// ```
 580     /// use std::collections::BTreeMap;
 581     ///
 582     /// let mut map = BTreeMap::new();
 583     /// map.insert(1, "a");
 584     /// assert_eq!(map.get(&1), Some(&"a"));
 585     /// assert_eq!(map.get(&2), None);
 586     /// ```
 587     #[stable(feature = "rust1", since = "1.0.0")]
 588     pub fn get<Q: ?Sized>(&self, key: &Q) -> Option<&V>
 589     where
 590         K: Borrow<Q>,
 591         Q: Ord,
 592     {
 593         match search::search_tree(self.root.as_ref(), key) {
 594             Found(handle) => Some(handle.into_kv().1),
 595             GoDown(_) => None,
 596         }
 597     }
 598
 599     /// Returns the key-value pair corresponding to the supplied key.
 600     ///
 601     /// The supplied key may be any borrowed form of the map's key type, but the ordering
 602     /// on the borrowed form *must* match the ordering on the key type.
 603     ///
 604     /// # Examples
 605     ///
 606     /// ```
 607     /// use std::collections::BTreeMap;
 608     ///
 609     /// let mut map = BTreeMap::new();
 610     /// map.insert(1, "a");
 611     /// assert_eq!(map.get_key_value(&1), Some((&1, &"a")));
 612     /// assert_eq!(map.get_key_value(&2), None);
 613     /// ```
 614     #[stable(feature = "map_get_key_value", since = "1.40.0")]
 615     pub fn get_key_value<Q: ?Sized>(&self, k: &Q) -> Option<(&K, &V)>
 616     where
 617         K: Borrow<Q>,
 618         Q: Ord,
 619     {
 620         match search::search_tree(self.root.as_ref(), k) {
 621             Found(handle) => Some(handle.into_kv()),
 622             GoDown(_) => None,
 623         }
 624     }
 625
 626     /// Returns the first key-value pair in the map.
 627     /// The key in this pair is the minimum key in the map.
 628     ///
 629     /// # Examples
 630     ///
 631     /// Basic usage:
 632     ///
 633     /// ```
 634     /// #![feature(map_first_last)]
 635     /// use std::collections::BTreeMap;
 636     ///
 637     /// let mut map = BTreeMap::new();
 638     /// assert_eq!(map.first_key_value(), None);
 639     /// map.insert(1, "b");
 640     /// map.insert(2, "a");
 641     /// assert_eq!(map.first_key_value(), Some((&1, &"b")));
 642     /// ```
 643     #[unstable(feature = "map_first_last", issue = "62924")]
 644     pub fn first_key_value<T: ?Sized>(&self) -> Option<(&K, &V)>
 645     where
 646         T: Ord,
 647         K: Borrow<T>,
 648     {
 649         let front = self.root.as_ref().first_leaf_edge();
 650         front.right_kv().ok().map(Handle::into_kv)
 651     }
 652
 653     /// Returns the first entry in the map for in-place manipulation.
 654     /// The key of this entry is the minimum key in the map.
 655     ///
 656     /// # Examples
 657     ///
 658     /// Contrived way to `clear` a map:
 659     ///
 660     /// ```
 661     /// #![feature(map_first_last)]
 662     /// use std::collections::BTreeMap;
 663     ///
 664     /// let mut map = BTreeMap::new();
 665     /// map.insert(1, "a");
 666     /// map.insert(2, "b");
 667     /// while let Some(entry) = map.first_entry() {
 668     ///     let (key, val) = entry.remove_entry();
 669     ///     assert!(!map.contains_key(&key));
 670     /// }
 671     /// ```
 672     #[unstable(feature = "map_first_last", issue = "62924")]
 673     pub fn first_entry<T: ?Sized>(&mut self) -> Option<OccupiedEntry<'_, K, V>>
 674     where
 675         T: Ord,
 676         K: Borrow<T>,
 677     {
 678         let front = self.root.as_mut().first_leaf_edge();
 679         if let Ok(kv) = front.right_kv() {
 680             Some(OccupiedEntry {
 681                 handle: kv.forget_node_type(),
 682                 length: &mut self.length,
 683                 _marker: PhantomData,
 684             })
 685         } else {
 686             None
 687         }
 688     }
 689
 690     /// Returns the last key-value pair in the map.
 691     /// The key in this pair is the maximum key in the map.
 692     ///
 693     /// # Examples
 694     ///
 695     /// Basic usage:
 696     ///
 697     /// ```
 698     /// #![feature(map_first_last)]
 699     /// use std::collections::BTreeMap;
 700     ///
 701     /// let mut map = BTreeMap::new();
 702     /// map.insert(1, "b");
 703     /// map.insert(2, "a");
 704     /// assert_eq!(map.last_key_value(), Some((&2, &"a")));
 705     /// ```
 706     #[unstable(feature = "map_first_last", issue = "62924")]
 707     pub fn last_key_value<T: ?Sized>(&self) -> Option<(&K, &V)>
 708     where
 709         T: Ord,
 710         K: Borrow<T>,
 711     {
 712         let back = self.root.as_ref().last_leaf_edge();
 713         back.left_kv().ok().map(Handle::into_kv)
 714     }
 715
 716     /// Returns the last entry in the map for in-place manipulation.
 717     /// The key of this entry is the maximum key in the map.
 718     ///
 719     /// # Examples
 720     ///
 721     /// Contrived way to `clear` a map:
 722     ///
 723     /// ```
 724     /// #![feature(map_first_last)]
 725     /// use std::collections::BTreeMap;
 726     ///
 727     /// let mut map = BTreeMap::new();
 728     /// map.insert(1, "a");
 729     /// map.insert(2, "b");
 730     /// while let Some(entry) = map.last_entry() {
 731     ///     let (key, val) = entry.remove_entry();
 732     ///     assert!(!map.contains_key(&key));
 733     /// }
 734     /// ```
 735     #[unstable(feature = "map_first_last", issue = "62924")]
 736     pub fn last_entry<T: ?Sized>(&mut self) -> Option<OccupiedEntry<'_, K, V>>
 737     where
 738         T: Ord,
 739         K: Borrow<T>,
 740     {
 741         let back = self.root.as_mut().last_leaf_edge();
 742         if let Ok(kv) = back.left_kv() {
 743             Some(OccupiedEntry {
 744                 handle: kv.forget_node_type(),
 745                 length: &mut self.length,
 746                 _marker: PhantomData,
 747             })
 748         } else {
 749             None
 750         }
 751     }
 752
 753     /// Returns `true` if the map contains a value for the specified key.
 754     ///
 755     /// The key may be any borrowed form of the map's key type, but the ordering
 756     /// on the borrowed form *must* match the ordering on the key type.
 757     ///
 758     /// # Examples
 759     ///
 760     /// Basic usage:
 761     ///
 762     /// ```
 763     /// use std::collections::BTreeMap;
 764     ///
 765     /// let mut map = BTreeMap::new();
 766     /// map.insert(1, "a");
 767     /// assert_eq!(map.contains_key(&1), true);
 768     /// assert_eq!(map.contains_key(&2), false);
 769     /// ```
 770     #[stable(feature = "rust1", since = "1.0.0")]
 771     pub fn contains_key<Q: ?Sized>(&self, key: &Q) -> bool
 772     where
 773         K: Borrow<Q>,
 774         Q: Ord,
 775     {
 776         self.get(key).is_some()
 777     }
 778
 779     /// Returns a mutable reference to the value corresponding to the key.
 780     ///
 781     /// The key may be any borrowed form of the map's key type, but the ordering
 782     /// on the borrowed form *must* match the ordering on the key type.
 783     ///
 784     /// # Examples
 785     ///
 786     /// Basic usage:
 787     ///
 788     /// ```
 789     /// use std::collections::BTreeMap;
 790     ///
 791     /// let mut map = BTreeMap::new();
 792     /// map.insert(1, "a");
 793     /// if let Some(x) = map.get_mut(&1) {
 794     ///     *x = "b";
 795     /// }
 796     /// assert_eq!(map[&1], "b");
 797     /// ```
 798     // See `get` for implementation notes, this is basically a copy-paste with mut's added
 799     #[stable(feature = "rust1", since = "1.0.0")]
 800     pub fn get_mut<Q: ?Sized>(&mut self, key: &Q) -> Option<&mut V>
 801     where
 802         K: Borrow<Q>,
 803         Q: Ord,
 804     {
 805         match search::search_tree(self.root.as_mut(), key) {
 806             Found(handle) => Some(handle.into_kv_mut().1),
 807             GoDown(_) => None,
 808         }
 809     }
 810
 811     /// Inserts a key-value pair into the map.
 812     ///
 813     /// If the map did not have this key present, `None` is returned.
 814     ///
 815     /// If the map did have this key present, the value is updated, and the old
 816     /// value is returned. The key is not updated, though; this matters for
 817     /// types that can be `==` without being identical. See the [module-level
 818     /// documentation] for more.
 819     ///
 820     /// [module-level documentation]: index.html#insert-and-complex-keys
 821     ///
 822     /// # Examples
 823     ///
 824     /// Basic usage:
 825     ///
 826     /// ```
 827     /// use std::collections::BTreeMap;
 828     ///
 829     /// let mut map = BTreeMap::new();
 830     /// assert_eq!(map.insert(37, "a"), None);
 831     /// assert_eq!(map.is_empty(), false);
 832     ///
 833     /// map.insert(37, "b");
 834     /// assert_eq!(map.insert(37, "c"), Some("b"));
 835     /// assert_eq!(map[&37], "c");
 836     /// ```
 837     #[stable(feature = "rust1", since = "1.0.0")]
 838     pub fn insert(&mut self, key: K, value: V) -> Option<V> {
 839         match self.entry(key) {
 840             Occupied(mut entry) => Some(entry.insert(value)),
 841             Vacant(entry) => {
 842                 entry.insert(value);
 843                 None
 844             }
 845         }
 846     }
 847
 848     /// Removes a key from the map, returning the value at the key if the key
 849     /// was previously in the map.
 850     ///
 851     /// The key may be any borrowed form of the map's key type, but the ordering
 852     /// on the borrowed form *must* match the ordering on the key type.
 853     ///
 854     /// # Examples
 855     ///
 856     /// Basic usage:
 857     ///
 858     /// ```
 859     /// use std::collections::BTreeMap;
 860     ///
 861     /// let mut map = BTreeMap::new();
 862     /// map.insert(1, "a");
 863     /// assert_eq!(map.remove(&1), Some("a"));
 864     /// assert_eq!(map.remove(&1), None);
 865     /// ```
 866     #[stable(feature = "rust1", since = "1.0.0")]
 867     pub fn remove<Q: ?Sized>(&mut self, key: &Q) -> Option<V>
 868     where
 869         K: Borrow<Q>,
 870         Q: Ord,
 871     {
 872         self.remove_entry(key).map(|(_, v)| v)
 873     }
 874
 875     /// Removes a key from the map, returning the stored key and value if the key
 876     /// was previously in the map.
 877     ///
 878     /// The key may be any borrowed form of the map's key type, but the ordering
 879     /// on the borrowed form *must* match the ordering on the key type.
 880     ///
 881     /// # Examples
 882     ///
 883     /// Basic usage:
 884     ///
 885     /// ```
 886     /// #![feature(btreemap_remove_entry)]
 887     /// use std::collections::BTreeMap;
 888     ///
 889     /// let mut map = BTreeMap::new();
 890     /// map.insert(1, "a");
 891     /// assert_eq!(map.remove_entry(&1), Some((1, "a")));
 892     /// assert_eq!(map.remove_entry(&1), None);
 893     /// ```
 894     #[unstable(feature = "btreemap_remove_entry", issue = "66714")]
 895     pub fn remove_entry<Q: ?Sized>(&mut self, key: &Q) -> Option<(K, V)>
 896     where
 897         K: Borrow<Q>,
 898         Q: Ord,
 899     {
 900         match search::search_tree(self.root.as_mut(), key) {
 901             Found(handle) => Some(
 902                 OccupiedEntry { handle, length: &mut self.length, _marker: PhantomData }
 903                     .remove_entry(),
 904             ),
 905             GoDown(_) => None,
 906         }
 907     }
 908
 909     /// Moves all elements from `other` into `Self`, leaving `other` empty.
 910     ///
 911     /// # Examples
 912     ///
 913     /// ```
 914     /// use std::collections::BTreeMap;
 915     ///
 916     /// let mut a = BTreeMap::new();
 917     /// a.insert(1, "a");
 918     /// a.insert(2, "b");
 919     /// a.insert(3, "c");
 920     ///
 921     /// let mut b = BTreeMap::new();
 922     /// b.insert(3, "d");
 923     /// b.insert(4, "e");
 924     /// b.insert(5, "f");
 925     ///
 926     /// a.append(&mut b);
 927     ///
 928     /// assert_eq!(a.len(), 5);
 929     /// assert_eq!(b.len(), 0);
 930     ///
 931     /// assert_eq!(a[&1], "a");
 932     /// assert_eq!(a[&2], "b");
 933     /// assert_eq!(a[&3], "d");
 934     /// assert_eq!(a[&4], "e");
 935     /// assert_eq!(a[&5], "f");
 936     /// ```
 937     #[stable(feature = "btree_append", since = "1.11.0")]
 938     pub fn append(&mut self, other: &mut Self) {
 939         // Do we have to append anything at all?
 940         if other.is_empty() {
 941             return;
 942         }
 943
 944         // We can just swap `self` and `other` if `self` is empty.
 945         if self.is_empty() {
 946             mem::swap(self, other);
 947             return;
 948         }
 949
 950         // First, we merge `self` and `other` into a sorted sequence in linear time.
 951         let self_iter = mem::take(self).into_iter();
 952         let other_iter = mem::take(other).into_iter();
 953         let iter = MergeIter { left: self_iter.peekable(), right: other_iter.peekable() };
 954
 955         // Second, we build a tree from the sorted sequence in linear time.
 956         self.from_sorted_iter(iter);
 957         self.fix_right_edge();
 958     }
 959
 960     /// Constructs a double-ended iterator over a sub-range of elements in the map.
 961     /// The simplest way is to use the range syntax `min..max`, thus `range(min..max)` will
 962     /// yield elements from min (inclusive) to max (exclusive).
 963     /// The range may also be entered as `(Bound<T>, Bound<T>)`, so for example
 964     /// `range((Excluded(4), Included(10)))` will yield a left-exclusive, right-inclusive
 965     /// range from 4 to 10.
 966     ///
 967     /// # Panics
 968     ///
 969     /// Panics if range `start > end`.
 970     /// Panics if range `start == end` and both bounds are `Excluded`.
 971     ///
 972     /// # Examples
 973     ///
 974     /// Basic usage:
 975     ///
 976     /// ```
 977     /// use std::collections::BTreeMap;
 978     /// use std::ops::Bound::Included;
 979     ///
 980     /// let mut map = BTreeMap::new();
 981     /// map.insert(3, "a");
 982     /// map.insert(5, "b");
 983     /// map.insert(8, "c");
 984     /// for (&key, &value) in map.range((Included(&4), Included(&8))) {
 985     ///     println!("{}: {}", key, value);
 986     /// }
 987     /// assert_eq!(Some((&5, &"b")), map.range(4..).next());
 988     /// ```
 989     #[stable(feature = "btree_range", since = "1.17.0")]
 990     pub fn range<T: ?Sized, R>(&self, range: R) -> Range<'_, K, V>
 991     where
 992         T: Ord,
 993         K: Borrow<T>,
 994         R: RangeBounds<T>,
 995     {
 996         let root1 = self.root.as_ref();
 997         let root2 = self.root.as_ref();
 998         let (f, b) = range_search(root1, root2, range);
 999
1000         Range { front: f, back: b }
1001     }
1002
1003     /// Constructs a mutable double-ended iterator over a sub-range of elements in the map.
1004     /// The simplest way is to use the range syntax `min..max`, thus `range(min..max)` will
1005     /// yield elements from min (inclusive) to max (exclusive).
1006     /// The range may also be entered as `(Bound<T>, Bound<T>)`, so for example
1007     /// `range((Excluded(4), Included(10)))` will yield a left-exclusive, right-inclusive
1008     /// range from 4 to 10.
1009     ///
1010     /// # Panics
1011     ///
1012     /// Panics if range `start > end`.
1013     /// Panics if range `start == end` and both bounds are `Excluded`.
1014     ///
1015     /// # Examples
1016     ///
1017     /// Basic usage:
1018     ///
1019     /// ```
1020     /// use std::collections::BTreeMap;
1021     ///
1022     /// let mut map: BTreeMap<&str, i32> = ["Alice", "Bob", "Carol", "Cheryl"]
1023     ///     .iter()
1024     ///     .map(|&s| (s, 0))
1025     ///     .collect();
1026     /// for (_, balance) in map.range_mut("B".."Cheryl") {
1027     ///     *balance += 100;
1028     /// }
1029     /// for (name, balance) in &map {
1030     ///     println!("{} => {}", name, balance);
1031     /// }
1032     /// ```
1033     #[stable(feature = "btree_range", since = "1.17.0")]
1034     pub fn range_mut<T: ?Sized, R>(&mut self, range: R) -> RangeMut<'_, K, V>
1035     where
1036         T: Ord,
1037         K: Borrow<T>,
1038         R: RangeBounds<T>,
1039     {
1040         let root1 = self.root.as_mut();
1041         let root2 = unsafe { ptr::read(&root1) };
1042         let (f, b) = range_search(root1, root2, range);
1043
1044         RangeMut { front: f, back: b, _marker: PhantomData }
1045     }
1046
1047     /// Gets the given key's corresponding entry in the map for in-place manipulation.
1048     ///
1049     /// # Examples
1050     ///
1051     /// Basic usage:
1052     ///
1053     /// ```
1054     /// use std::collections::BTreeMap;
1055     ///
1056     /// let mut count: BTreeMap<&str, usize> = BTreeMap::new();
1057     ///
1058     /// // count the number of occurrences of letters in the vec
1059     /// for x in vec!["a","b","a","c","a","b"] {
1060     ///     *count.entry(x).or_insert(0) += 1;
1061     /// }
1062     ///
1063     /// assert_eq!(count["a"], 3);
1064     /// ```
1065     #[stable(feature = "rust1", since = "1.0.0")]
1066     pub fn entry(&mut self, key: K) -> Entry<'_, K, V> {
1067         // FIXME(@porglezomp) Avoid allocating if we don't insert
1068         self.ensure_root_is_owned();
1069         match search::search_tree(self.root.as_mut(), &key) {
1070             Found(handle) => {
1071                 Occupied(OccupiedEntry { handle, length: &mut self.length, _marker: PhantomData })
1072             }
1073             GoDown(handle) => {
1074                 Vacant(VacantEntry { key, handle, length: &mut self.length, _marker: PhantomData })
1075             }
1076         }
1077     }
1078
1079     fn from_sorted_iter<I: Iterator<Item = (K, V)>>(&mut self, iter: I) {
1080         self.ensure_root_is_owned();
1081         let mut cur_node = self.root.as_mut().last_leaf_edge().into_node();
1082         // Iterate through all key-value pairs, pushing them into nodes at the right level.
1083         for (key, value) in iter {
1084             // Try to push key-value pair into the current leaf node.
1085             if cur_node.len() < node::CAPACITY {
1086                 cur_node.push(key, value);
1087             } else {
1088                 // No space left, go up and push there.
1089                 let mut open_node;
1090                 let mut test_node = cur_node.forget_type();
1091                 loop {
1092                     match test_node.ascend() {
1093                         Ok(parent) => {
1094                             let parent = parent.into_node();
1095                             if parent.len() < node::CAPACITY {
1096                                 // Found a node with space left, push here.
1097                                 open_node = parent;
1098                                 break;
1099                             } else {
1100                                 // Go up again.
1101                                 test_node = parent.forget_type();
1102                             }
1103                         }
1104                         Err(node) => {
1105                             // We are at the top, create a new root node and push there.
1106                             open_node = node.into_root_mut().push_level();
1107                             break;
1108                         }
1109                     }
1110                 }
1111
1112                 // Push key-value pair and new right subtree.
1113                 let tree_height = open_node.height() - 1;
1114                 let mut right_tree = node::Root::new_leaf();
1115                 for _ in 0..tree_height {
1116                     right_tree.push_level();
1117                 }
1118                 open_node.push(key, value, right_tree);
1119
1120                 // Go down to the right-most leaf again.
1121                 cur_node = open_node.forget_type().last_leaf_edge().into_node();
1122             }
1123
1124             self.length += 1;
1125         }
1126     }
1127
1128     fn fix_right_edge(&mut self) {
1129         // Handle underfull nodes, start from the top.
1130         let mut cur_node = self.root.as_mut();
1131         while let Internal(internal) = cur_node.force() {
1132             // Check if right-most child is underfull.
1133             let mut last_edge = internal.last_edge();
1134             let right_child_len = last_edge.reborrow().descend().len();
1135             if right_child_len < node::MIN_LEN {
1136                 // We need to steal.
1137                 let mut last_kv = match last_edge.left_kv() {
1138                     Ok(left) => left,
1139                     Err(_) => unreachable!(),
1140                 };
1141                 last_kv.bulk_steal_left(node::MIN_LEN - right_child_len);
1142                 last_edge = last_kv.right_edge();
1143             }
1144
1145             // Go further down.
1146             cur_node = last_edge.descend();
1147         }
1148     }
1149
1150     /// Splits the collection into two at the given key. Returns everything after the given key,
1151     /// including the key.
1152     ///
1153     /// # Examples
1154     ///
1155     /// Basic usage:
1156     ///
1157     /// ```
1158     /// use std::collections::BTreeMap;
1159     ///
1160     /// let mut a = BTreeMap::new();
1161     /// a.insert(1, "a");
1162     /// a.insert(2, "b");
1163     /// a.insert(3, "c");
1164     /// a.insert(17, "d");
1165     /// a.insert(41, "e");
1166     ///
1167     /// let b = a.split_off(&3);
1168     ///
1169     /// assert_eq!(a.len(), 2);
1170     /// assert_eq!(b.len(), 3);
1171     ///
1172     /// assert_eq!(a[&1], "a");
1173     /// assert_eq!(a[&2], "b");
1174     ///
1175     /// assert_eq!(b[&3], "c");
1176     /// assert_eq!(b[&17], "d");
1177     /// assert_eq!(b[&41], "e");
1178     /// ```
1179     #[stable(feature = "btree_split_off", since = "1.11.0")]
1180     pub fn split_off<Q: ?Sized + Ord>(&mut self, key: &Q) -> Self
1181     where
1182         K: Borrow<Q>,
1183     {
1184         if self.is_empty() {
1185             return Self::new();
1186         }
1187
1188         let total_num = self.len();
1189
1190         let mut right = Self::new();
1191         right.root = node::Root::new_leaf();
1192         for _ in 0..(self.root.as_ref().height()) {
1193             right.root.push_level();
1194         }
1195
1196         {
1197             let mut left_node = self.root.as_mut();
1198             let mut right_node = right.root.as_mut();
1199
1200             loop {
1201                 let mut split_edge = match search::search_node(left_node, key) {
1202                     // key is going to the right tree
1203                     Found(handle) => handle.left_edge(),
1204                     GoDown(handle) => handle,
1205                 };
1206
1207                 split_edge.move_suffix(&mut right_node);
1208
1209                 match (split_edge.force(), right_node.force()) {
1210                     (Internal(edge), Internal(node)) => {
1211                         left_node = edge.descend();
1212                         right_node = node.first_edge().descend();
1213                     }
1214                     (Leaf(_), Leaf(_)) => {
1215                         break;
1216                     }
1217                     _ => {
1218                         unreachable!();
1219                     }
1220                 }
1221             }
1222         }
1223
1224         self.fix_right_border();
1225         right.fix_left_border();
1226
1227         if self.root.as_ref().height() < right.root.as_ref().height() {
1228             self.recalc_length();
1229             right.length = total_num - self.len();
1230         } else {
1231             right.recalc_length();
1232             self.length = total_num - right.len();
1233         }
1234
1235         right
1236     }
1237
1238     /// Calculates the number of elements if it is incorrect.
1239     fn recalc_length(&mut self) {
1240         fn dfs<'a, K, V>(node: NodeRef<marker::Immut<'a>, K, V, marker::LeafOrInternal>) -> usize
1241         where
1242             K: 'a,
1243             V: 'a,
1244         {
1245             let mut res = node.len();
1246
1247             if let Internal(node) = node.force() {
1248                 let mut edge = node.first_edge();
1249                 loop {
1250                     res += dfs(edge.reborrow().descend());
1251                     match edge.right_kv() {
1252                         Ok(right_kv) => {
1253                             edge = right_kv.right_edge();
1254                         }
1255                         Err(_) => {
1256                             break;
1257                         }
1258                     }
1259                 }
1260             }
1261
1262             res
1263         }
1264
1265         self.length = dfs(self.root.as_ref());
1266     }
1267
1268     /// Removes empty levels on the top.
1269     fn fix_top(&mut self) {
1270         loop {
1271             {
1272                 let node = self.root.as_ref();
1273                 if node.height() == 0 || node.len() > 0 {
1274                     break;
1275                 }
1276             }
1277             self.root.pop_level();
1278         }
1279     }
1280
1281     fn fix_right_border(&mut self) {
1282         self.fix_top();
1283
1284         {
1285             let mut cur_node = self.root.as_mut();
1286
1287             while let Internal(node) = cur_node.force() {
1288                 let mut last_kv = node.last_kv();
1289
1290                 if last_kv.can_merge() {
1291                     cur_node = last_kv.merge().descend();
1292                 } else {
1293                     let right_len = last_kv.reborrow().right_edge().descend().len();
1294                     // `MINLEN + 1` to avoid readjust if merge happens on the next level.
1295                     if right_len < node::MIN_LEN + 1 {
1296                         last_kv.bulk_steal_left(node::MIN_LEN + 1 - right_len);
1297                     }
1298                     cur_node = last_kv.right_edge().descend();
1299                 }
1300             }
1301         }
1302
1303         self.fix_top();
1304     }
1305
1306     /// The symmetric clone of `fix_right_border`.
1307     fn fix_left_border(&mut self) {
1308         self.fix_top();
1309
1310         {
1311             let mut cur_node = self.root.as_mut();
1312
1313             while let Internal(node) = cur_node.force() {
1314                 let mut first_kv = node.first_kv();
1315
1316                 if first_kv.can_merge() {
1317                     cur_node = first_kv.merge().descend();
1318                 } else {
1319                     let left_len = first_kv.reborrow().left_edge().descend().len();
1320                     if left_len < node::MIN_LEN + 1 {
1321                         first_kv.bulk_steal_right(node::MIN_LEN + 1 - left_len);
1322                     }
1323                     cur_node = first_kv.left_edge().descend();
1324                 }
1325             }
1326         }
1327
1328         self.fix_top();
1329     }
1330
1331     /// If the root node is the shared root node, allocate our own node.
1332     fn ensure_root_is_owned(&mut self) {
1333         if self.root.is_shared_root() {
1334             self.root = node::Root::new_leaf();
1335         }
1336     }
1337 }
1338
1339 #[stable(feature = "rust1", since = "1.0.0")]
1340 impl<'a, K: 'a, V: 'a> IntoIterator for &'a BTreeMap<K, V> {
1341     type Item = (&'a K, &'a V);
1342     type IntoIter = Iter<'a, K, V>;
1343
1344     fn into_iter(self) -> Iter<'a, K, V> {
1345         self.iter()
1346     }
1347 }
1348
1349 #[stable(feature = "rust1", since = "1.0.0")]
1350 impl<'a, K: 'a, V: 'a> Iterator for Iter<'a, K, V> {
1351     type Item = (&'a K, &'a V);
1352
1353     fn next(&mut self) -> Option<(&'a K, &'a V)> {
1354         if self.length == 0 {
1355             None
1356         } else {
1357             self.length -= 1;
1358             unsafe { Some(self.range.next_unchecked()) }
1359         }
1360     }
1361
1362     fn size_hint(&self) -> (usize, Option<usize>) {
1363         (self.length, Some(self.length))
1364     }
1365
1366     fn last(mut self) -> Option<(&'a K, &'a V)> {
1367         self.next_back()
1368     }
1369 }
1370
1371 #[stable(feature = "fused", since = "1.26.0")]
1372 impl<K, V> FusedIterator for Iter<'_, K, V> {}
1373
1374 #[stable(feature = "rust1", since = "1.0.0")]
1375 impl<'a, K: 'a, V: 'a> DoubleEndedIterator for Iter<'a, K, V> {
1376     fn next_back(&mut self) -> Option<(&'a K, &'a V)> {
1377         if self.length == 0 {
1378             None
1379         } else {
1380             self.length -= 1;
1381             unsafe { Some(self.range.next_back_unchecked()) }
1382         }
1383     }
1384 }
1385
1386 #[stable(feature = "rust1", since = "1.0.0")]
1387 impl<K, V> ExactSizeIterator for Iter<'_, K, V> {
1388     fn len(&self) -> usize {
1389         self.length
1390     }
1391 }
1392
1393 #[stable(feature = "rust1", since = "1.0.0")]
1394 impl<K, V> Clone for Iter<'_, K, V> {
1395     fn clone(&self) -> Self {
1396         Iter { range: self.range.clone(), length: self.length }
1397     }
1398 }
1399
1400 #[stable(feature = "rust1", since = "1.0.0")]
1401 impl<'a, K: 'a, V: 'a> IntoIterator for &'a mut BTreeMap<K, V> {
1402     type Item = (&'a K, &'a mut V);
1403     type IntoIter = IterMut<'a, K, V>;
1404
1405     fn into_iter(self) -> IterMut<'a, K, V> {
1406         self.iter_mut()
1407     }
1408 }
1409
1410 #[stable(feature = "rust1", since = "1.0.0")]
1411 impl<'a, K: 'a, V: 'a> Iterator for IterMut<'a, K, V> {
1412     type Item = (&'a K, &'a mut V);
1413
1414     fn next(&mut self) -> Option<(&'a K, &'a mut V)> {
1415         if self.length == 0 {
1416             None
1417         } else {
1418             self.length -= 1;
1419             let (k, v) = unsafe { self.range.next_unchecked() };
1420             Some((k, v)) // coerce k from `&mut K` to `&K`
1421         }
1422     }
1423
1424     fn size_hint(&self) -> (usize, Option<usize>) {
1425         (self.length, Some(self.length))
1426     }
1427
1428     fn last(mut self) -> Option<(&'a K, &'a mut V)> {
1429         self.next_back()
1430     }
1431 }
1432
1433 #[stable(feature = "rust1", since = "1.0.0")]
1434 impl<'a, K: 'a, V: 'a> DoubleEndedIterator for IterMut<'a, K, V> {
1435     fn next_back(&mut self) -> Option<(&'a K, &'a mut V)> {
1436         if self.length == 0 {
1437             None
1438         } else {
1439             self.length -= 1;
1440             let (k, v) = unsafe { self.range.next_back_unchecked() };
1441             Some((k, v)) // coerce k from `&mut K` to `&K`
1442         }
1443     }
1444 }
1445
1446 #[stable(feature = "rust1", since = "1.0.0")]
1447 impl<K, V> ExactSizeIterator for IterMut<'_, K, V> {
1448     fn len(&self) -> usize {
1449         self.length
1450     }
1451 }
1452
1453 #[stable(feature = "fused", since = "1.26.0")]
1454 impl<K, V> FusedIterator for IterMut<'_, K, V> {}
1455
1456 #[stable(feature = "rust1", since = "1.0.0")]
1457 impl<K, V> IntoIterator for BTreeMap<K, V> {
1458     type Item = (K, V);
1459     type IntoIter = IntoIter<K, V>;
1460
1461     fn into_iter(self) -> IntoIter<K, V> {
1462         let root1 = unsafe { ptr::read(&self.root).into_ref() };
1463         let root2 = unsafe { ptr::read(&self.root).into_ref() };
1464         let len = self.length;
1465         mem::forget(self);
1466
1467         IntoIter { front: root1.first_leaf_edge(), back: root2.last_leaf_edge(), length: len }
1468     }
1469 }
1470
1471 #[stable(feature = "btree_drop", since = "1.7.0")]
1472 impl<K, V> Drop for IntoIter<K, V> {
1473     fn drop(&mut self) {
1474         self.for_each(drop);
1475         unsafe {
1476             let mut node = ptr::read(&self.front).into_node().forget_type();
1477             if node.is_shared_root() {
1478                 return;
1479             }
1480
1481             while let Some(parent) = node.deallocate_and_ascend() {
1482                 node = parent.into_node().forget_type();
1483             }
1484         }
1485     }
1486 }
1487
1488 #[stable(feature = "rust1", since = "1.0.0")]
1489 impl<K, V> Iterator for IntoIter<K, V> {
1490     type Item = (K, V);
1491
1492     fn next(&mut self) -> Option<(K, V)> {
1493         if self.length == 0 {
1494             None
1495         } else {
1496             self.length -= 1;
1497             Some(unsafe { self.front.next_unchecked() })
1498         }
1499     }
1500
1501     fn size_hint(&self) -> (usize, Option<usize>) {
1502         (self.length, Some(self.length))
1503     }
1504 }
1505
1506 #[stable(feature = "rust1", since = "1.0.0")]
1507 impl<K, V> DoubleEndedIterator for IntoIter<K, V> {
1508     fn next_back(&mut self) -> Option<(K, V)> {
1509         if self.length == 0 {
1510             None
1511         } else {
1512             self.length -= 1;
1513             Some(unsafe { self.back.next_back_unchecked() })
1514         }
1515     }
1516 }
1517
1518 #[stable(feature = "rust1", since = "1.0.0")]
1519 impl<K, V> ExactSizeIterator for IntoIter<K, V> {
1520     fn len(&self) -> usize {
1521         self.length
1522     }
1523 }
1524
1525 #[stable(feature = "fused", since = "1.26.0")]
1526 impl<K, V> FusedIterator for IntoIter<K, V> {}
1527
1528 #[stable(feature = "rust1", since = "1.0.0")]
1529 impl<'a, K, V> Iterator for Keys<'a, K, V> {
1530     type Item = &'a K;
1531
1532     fn next(&mut self) -> Option<&'a K> {
1533         self.inner.next().map(|(k, _)| k)
1534     }
1535
1536     fn size_hint(&self) -> (usize, Option<usize>) {
1537         self.inner.size_hint()
1538     }
1539
1540     fn last(mut self) -> Option<&'a K> {
1541         self.next_back()
1542     }
1543 }
1544
1545 #[stable(feature = "rust1", since = "1.0.0")]
1546 impl<'a, K, V> DoubleEndedIterator for Keys<'a, K, V> {
1547     fn next_back(&mut self) -> Option<&'a K> {
1548         self.inner.next_back().map(|(k, _)| k)
1549     }
1550 }
1551
1552 #[stable(feature = "rust1", since = "1.0.0")]
1553 impl<K, V> ExactSizeIterator for Keys<'_, K, V> {
1554     fn len(&self) -> usize {
1555         self.inner.len()
1556     }
1557 }
1558
1559 #[stable(feature = "fused", since = "1.26.0")]
1560 impl<K, V> FusedIterator for Keys<'_, K, V> {}
1561
1562 #[stable(feature = "rust1", since = "1.0.0")]
1563 impl<K, V> Clone for Keys<'_, K, V> {
1564     fn clone(&self) -> Self {
1565         Keys { inner: self.inner.clone() }
1566     }
1567 }
1568
1569 #[stable(feature = "rust1", since = "1.0.0")]
1570 impl<'a, K, V> Iterator for Values<'a, K, V> {
1571     type Item = &'a V;
1572
1573     fn next(&mut self) -> Option<&'a V> {
1574         self.inner.next().map(|(_, v)| v)
1575     }
1576
1577     fn size_hint(&self) -> (usize, Option<usize>) {
1578         self.inner.size_hint()
1579     }
1580
1581     fn last(mut self) -> Option<&'a V> {
1582         self.next_back()
1583     }
1584 }
1585
1586 #[stable(feature = "rust1", since = "1.0.0")]
1587 impl<'a, K, V> DoubleEndedIterator for Values<'a, K, V> {
1588     fn next_back(&mut self) -> Option<&'a V> {
1589         self.inner.next_back().map(|(_, v)| v)
1590     }
1591 }
1592
1593 #[stable(feature = "rust1", since = "1.0.0")]
1594 impl<K, V> ExactSizeIterator for Values<'_, K, V> {
1595     fn len(&self) -> usize {
1596         self.inner.len()
1597     }
1598 }
1599
1600 #[stable(feature = "fused", since = "1.26.0")]
1601 impl<K, V> FusedIterator for Values<'_, K, V> {}
1602
1603 #[stable(feature = "rust1", since = "1.0.0")]
1604 impl<K, V> Clone for Values<'_, K, V> {
1605     fn clone(&self) -> Self {
1606         Values { inner: self.inner.clone() }
1607     }
1608 }
1609
1610 #[stable(feature = "btree_range", since = "1.17.0")]
1611 impl<'a, K, V> Iterator for Range<'a, K, V> {
1612     type Item = (&'a K, &'a V);
1613
1614     fn next(&mut self) -> Option<(&'a K, &'a V)> {
1615         if self.is_empty() { None } else { unsafe { Some(self.next_unchecked()) } }
1616     }
1617
1618     fn last(mut self) -> Option<(&'a K, &'a V)> {
1619         self.next_back()
1620     }
1621 }
1622
1623 #[stable(feature = "map_values_mut", since = "1.10.0")]
1624 impl<'a, K, V> Iterator for ValuesMut<'a, K, V> {
1625     type Item = &'a mut V;
1626
1627     fn next(&mut self) -> Option<&'a mut V> {
1628         self.inner.next().map(|(_, v)| v)
1629     }
1630
1631     fn size_hint(&self) -> (usize, Option<usize>) {
1632         self.inner.size_hint()
1633     }
1634
1635     fn last(mut self) -> Option<&'a mut V> {
1636         self.next_back()
1637     }
1638 }
1639
1640 #[stable(feature = "map_values_mut", since = "1.10.0")]
1641 impl<'a, K, V> DoubleEndedIterator for ValuesMut<'a, K, V> {
1642     fn next_back(&mut self) -> Option<&'a mut V> {
1643         self.inner.next_back().map(|(_, v)| v)
1644     }
1645 }
1646
1647 #[stable(feature = "map_values_mut", since = "1.10.0")]
1648 impl<K, V> ExactSizeIterator for ValuesMut<'_, K, V> {
1649     fn len(&self) -> usize {
1650         self.inner.len()
1651     }
1652 }
1653
1654 #[stable(feature = "fused", since = "1.26.0")]
1655 impl<K, V> FusedIterator for ValuesMut<'_, K, V> {}
1656
1657 impl<'a, K, V> Range<'a, K, V> {
1658     fn is_empty(&self) -> bool {
1659         self.front == self.back
1660     }
1661
1662     unsafe fn next_unchecked(&mut self) -> (&'a K, &'a V) {
1663         self.front.next_unchecked()
1664     }
1665 }
1666
1667 #[stable(feature = "btree_range", since = "1.17.0")]
1668 impl<'a, K, V> DoubleEndedIterator for Range<'a, K, V> {
1669     fn next_back(&mut self) -> Option<(&'a K, &'a V)> {
1670         if self.is_empty() { None } else { Some(unsafe { self.next_back_unchecked() }) }
1671     }
1672 }
1673
1674 impl<'a, K, V> Range<'a, K, V> {
1675     unsafe fn next_back_unchecked(&mut self) -> (&'a K, &'a V) {
1676         self.back.next_back_unchecked()
1677     }
1678 }
1679
1680 #[stable(feature = "fused", since = "1.26.0")]
1681 impl<K, V> FusedIterator for Range<'_, K, V> {}
1682
1683 #[stable(feature = "btree_range", since = "1.17.0")]
1684 impl<K, V> Clone for Range<'_, K, V> {
1685     fn clone(&self) -> Self {
1686         Range { front: self.front, back: self.back }
1687     }
1688 }
1689
1690 #[stable(feature = "btree_range", since = "1.17.0")]
1691 impl<'a, K, V> Iterator for RangeMut<'a, K, V> {
1692     type Item = (&'a K, &'a mut V);
1693
1694     fn next(&mut self) -> Option<(&'a K, &'a mut V)> {
1695         if self.is_empty() {
1696             None
1697         } else {
1698             let (k, v) = unsafe { self.next_unchecked() };
1699             Some((k, v)) // coerce k from `&mut K` to `&K`
1700         }
1701     }
1702
1703     fn last(mut self) -> Option<(&'a K, &'a mut V)> {
1704         self.next_back()
1705     }
1706 }
1707
1708 impl<'a, K, V> RangeMut<'a, K, V> {
1709     fn is_empty(&self) -> bool {
1710         self.front == self.back
1711     }
1712
1713     unsafe fn next_unchecked(&mut self) -> (&'a mut K, &'a mut V) {
1714         self.front.next_unchecked()
1715     }
1716 }
1717
1718 #[stable(feature = "btree_range", since = "1.17.0")]
1719 impl<'a, K, V> DoubleEndedIterator for RangeMut<'a, K, V> {
1720     fn next_back(&mut self) -> Option<(&'a K, &'a mut V)> {
1721         if self.is_empty() {
1722             None
1723         } else {
1724             let (k, v) = unsafe { self.next_back_unchecked() };
1725             Some((k, v)) // coerce k from `&mut K` to `&K`
1726         }
1727     }
1728 }
1729
1730 #[stable(feature = "fused", since = "1.26.0")]
1731 impl<K, V> FusedIterator for RangeMut<'_, K, V> {}
1732
1733 impl<'a, K, V> RangeMut<'a, K, V> {
1734     unsafe fn next_back_unchecked(&mut self) -> (&'a mut K, &'a mut V) {
1735         self.back.next_back_unchecked()
1736     }
1737 }
1738
1739 #[stable(feature = "rust1", since = "1.0.0")]
1740 impl<K: Ord, V> FromIterator<(K, V)> for BTreeMap<K, V> {
1741     fn from_iter<T: IntoIterator<Item = (K, V)>>(iter: T) -> BTreeMap<K, V> {
1742         let mut map = BTreeMap::new();
1743         map.extend(iter);
1744         map
1745     }
1746 }
1747
1748 #[stable(feature = "rust1", since = "1.0.0")]
1749 impl<K: Ord, V> Extend<(K, V)> for BTreeMap<K, V> {
1750     #[inline]
1751     fn extend<T: IntoIterator<Item = (K, V)>>(&mut self, iter: T) {
1752         iter.into_iter().for_each(move |(k, v)| {
1753             self.insert(k, v);
1754         });
1755     }
1756 }
1757
1758 #[stable(feature = "extend_ref", since = "1.2.0")]
1759 impl<'a, K: Ord + Copy, V: Copy> Extend<(&'a K, &'a V)> for BTreeMap<K, V> {
1760     fn extend<I: IntoIterator<Item = (&'a K, &'a V)>>(&mut self, iter: I) {
1761         self.extend(iter.into_iter().map(|(&key, &value)| (key, value)));
1762     }
1763 }
1764
1765 #[stable(feature = "rust1", since = "1.0.0")]
1766 impl<K: Hash, V: Hash> Hash for BTreeMap<K, V> {
1767     fn hash<H: Hasher>(&self, state: &mut H) {
1768         for elt in self {
1769             elt.hash(state);
1770         }
1771     }
1772 }
1773
1774 #[stable(feature = "rust1", since = "1.0.0")]
1775 impl<K: Ord, V> Default for BTreeMap<K, V> {
1776     /// Creates an empty `BTreeMap<K, V>`.
1777     fn default() -> BTreeMap<K, V> {
1778         BTreeMap::new()
1779     }
1780 }
1781
1782 #[stable(feature = "rust1", since = "1.0.0")]
1783 impl<K: PartialEq, V: PartialEq> PartialEq for BTreeMap<K, V> {
1784     fn eq(&self, other: &BTreeMap<K, V>) -> bool {
1785         self.len() == other.len() && self.iter().zip(other).all(|(a, b)| a == b)
1786     }
1787 }
1788
1789 #[stable(feature = "rust1", since = "1.0.0")]
1790 impl<K: Eq, V: Eq> Eq for BTreeMap<K, V> {}
1791
1792 #[stable(feature = "rust1", since = "1.0.0")]
1793 impl<K: PartialOrd, V: PartialOrd> PartialOrd for BTreeMap<K, V> {
1794     #[inline]
1795     fn partial_cmp(&self, other: &BTreeMap<K, V>) -> Option<Ordering> {
1796         self.iter().partial_cmp(other.iter())
1797     }
1798 }
1799
1800 #[stable(feature = "rust1", since = "1.0.0")]
1801 impl<K: Ord, V: Ord> Ord for BTreeMap<K, V> {
1802     #[inline]
1803     fn cmp(&self, other: &BTreeMap<K, V>) -> Ordering {
1804         self.iter().cmp(other.iter())
1805     }
1806 }
1807
1808 #[stable(feature = "rust1", since = "1.0.0")]
1809 impl<K: Debug, V: Debug> Debug for BTreeMap<K, V> {
1810     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1811         f.debug_map().entries(self.iter()).finish()
1812     }
1813 }
1814
1815 #[stable(feature = "rust1", since = "1.0.0")]
1816 impl<K: Ord, Q: ?Sized, V> Index<&Q> for BTreeMap<K, V>
1817 where
1818     K: Borrow<Q>,
1819     Q: Ord,
1820 {
1821     type Output = V;
1822
1823     /// Returns a reference to the value corresponding to the supplied key.
1824     ///
1825     /// # Panics
1826     ///
1827     /// Panics if the key is not present in the `BTreeMap`.
1828     #[inline]
1829     fn index(&self, key: &Q) -> &V {
1830         self.get(key).expect("no entry found for key")
1831     }
1832 }
1833
1834 fn range_search<BorrowType, K, V, Q: ?Sized, R: RangeBounds<Q>>(
1835     root1: NodeRef<BorrowType, K, V, marker::LeafOrInternal>,
1836     root2: NodeRef<BorrowType, K, V, marker::LeafOrInternal>,
1837     range: R,
1838 ) -> (
1839     Handle<NodeRef<BorrowType, K, V, marker::Leaf>, marker::Edge>,
1840     Handle<NodeRef<BorrowType, K, V, marker::Leaf>, marker::Edge>,
1841 )
1842 where
1843     Q: Ord,
1844     K: Borrow<Q>,
1845 {
1846     match (range.start_bound(), range.end_bound()) {
1847         (Excluded(s), Excluded(e)) if s == e => {
1848             panic!("range start and end are equal and excluded in BTreeMap")
1849         }
1850         (Included(s), Included(e))
1851         | (Included(s), Excluded(e))
1852         | (Excluded(s), Included(e))
1853         | (Excluded(s), Excluded(e))
1854             if s > e =>
1855         {
1856             panic!("range start is greater than range end in BTreeMap")
1857         }
1858         _ => {}
1859     };
1860
1861     let mut min_node = root1;
1862     let mut max_node = root2;
1863     let mut min_found = false;
1864     let mut max_found = false;
1865     let mut diverged = false;
1866
1867     loop {
1868         let min_edge = match (min_found, range.start_bound()) {
1869             (false, Included(key)) => match search::search_linear(&min_node, key) {
1870                 (i, true) => {
1871                     min_found = true;
1872                     i
1873                 }
1874                 (i, false) => i,
1875             },
1876             (false, Excluded(key)) => match search::search_linear(&min_node, key) {
1877                 (i, true) => {
1878                     min_found = true;
1879                     i + 1
1880                 }
1881                 (i, false) => i,
1882             },
1883             (_, Unbounded) => 0,
1884             (true, Included(_)) => min_node.len(),
1885             (true, Excluded(_)) => 0,
1886         };
1887
1888         let max_edge = match (max_found, range.end_bound()) {
1889             (false, Included(key)) => match search::search_linear(&max_node, key) {
1890                 (i, true) => {
1891                     max_found = true;
1892                     i + 1
1893                 }
1894                 (i, false) => i,
1895             },
1896             (false, Excluded(key)) => match search::search_linear(&max_node, key) {
1897                 (i, true) => {
1898                     max_found = true;
1899                     i
1900                 }
1901                 (i, false) => i,
1902             },
1903             (_, Unbounded) => max_node.len(),
1904             (true, Included(_)) => 0,
1905             (true, Excluded(_)) => max_node.len(),
1906         };
1907
1908         if !diverged {
1909             if max_edge < min_edge {
1910                 panic!("Ord is ill-defined in BTreeMap range")
1911             }
1912             if min_edge != max_edge {
1913                 diverged = true;
1914             }
1915         }
1916
1917         // Safety guarantee: `min_edge` is always in range for `min_node`, because
1918         // `min_edge` is unconditionally calculated for each iteration's value of `min_node`,
1919         // either (if not found) as the edge index returned by `search_linear`,
1920         // or (if found) as the KV index returned by `search_linear`, possibly + 1.
1921         // Likewise for `max_node` versus `max_edge`.
1922         let front = unsafe { Handle::new_edge(min_node, min_edge) };
1923         let back = unsafe { Handle::new_edge(max_node, max_edge) };
1924         match (front.force(), back.force()) {
1925             (Leaf(f), Leaf(b)) => {
1926                 return (f, b);
1927             }
1928             (Internal(min_int), Internal(max_int)) => {
1929                 min_node = min_int.descend();
1930                 max_node = max_int.descend();
1931             }
1932             _ => unreachable!("BTreeMap has different depths"),
1933         };
1934     }
1935 }
1936
1937 impl<K, V> BTreeMap<K, V> {
1938     /// Gets an iterator over the entries of the map, sorted by key.
1939     ///
1940     /// # Examples
1941     ///
1942     /// Basic usage:
1943     ///
1944     /// ```
1945     /// use std::collections::BTreeMap;
1946     ///
1947     /// let mut map = BTreeMap::new();
1948     /// map.insert(3, "c");
1949     /// map.insert(2, "b");
1950     /// map.insert(1, "a");
1951     ///
1952     /// for (key, value) in map.iter() {
1953     ///     println!("{}: {}", key, value);
1954     /// }
1955     ///
1956     /// let (first_key, first_value) = map.iter().next().unwrap();
1957     /// assert_eq!((*first_key, *first_value), (1, "a"));
1958     /// ```
1959     #[stable(feature = "rust1", since = "1.0.0")]
1960     pub fn iter(&self) -> Iter<'_, K, V> {
1961         Iter {
1962             range: Range {
1963                 front: self.root.as_ref().first_leaf_edge(),
1964                 back: self.root.as_ref().last_leaf_edge(),
1965             },
1966             length: self.length,
1967         }
1968     }
1969
1970     /// Gets a mutable iterator over the entries of the map, sorted by key.
1971     ///
1972     /// # Examples
1973     ///
1974     /// Basic usage:
1975     ///
1976     /// ```
1977     /// use std::collections::BTreeMap;
1978     ///
1979     /// let mut map = BTreeMap::new();
1980     /// map.insert("a", 1);
1981     /// map.insert("b", 2);
1982     /// map.insert("c", 3);
1983     ///
1984     /// // add 10 to the value if the key isn't "a"
1985     /// for (key, value) in map.iter_mut() {
1986     ///     if key != &"a" {
1987     ///         *value += 10;
1988     ///     }
1989     /// }
1990     /// ```
1991     #[stable(feature = "rust1", since = "1.0.0")]
1992     pub fn iter_mut(&mut self) -> IterMut<'_, K, V> {
1993         let root1 = self.root.as_mut();
1994         let root2 = unsafe { ptr::read(&root1) };
1995         IterMut {
1996             range: RangeMut {
1997                 front: root1.first_leaf_edge(),
1998                 back: root2.last_leaf_edge(),
1999                 _marker: PhantomData,
2000             },
2001             length: self.length,
2002         }
2003     }
2004
2005     /// Gets an iterator over the keys of the map, in sorted order.
2006     ///
2007     /// # Examples
2008     ///
2009     /// Basic usage:
2010     ///
2011     /// ```
2012     /// use std::collections::BTreeMap;
2013     ///
2014     /// let mut a = BTreeMap::new();
2015     /// a.insert(2, "b");
2016     /// a.insert(1, "a");
2017     ///
2018     /// let keys: Vec<_> = a.keys().cloned().collect();
2019     /// assert_eq!(keys, [1, 2]);
2020     /// ```
2021     #[stable(feature = "rust1", since = "1.0.0")]
2022     pub fn keys(&self) -> Keys<'_, K, V> {
2023         Keys { inner: self.iter() }
2024     }
2025
2026     /// Gets an iterator over the values of the map, in order by key.
2027     ///
2028     /// # Examples
2029     ///
2030     /// Basic usage:
2031     ///
2032     /// ```
2033     /// use std::collections::BTreeMap;
2034     ///
2035     /// let mut a = BTreeMap::new();
2036     /// a.insert(1, "hello");
2037     /// a.insert(2, "goodbye");
2038     ///
2039     /// let values: Vec<&str> = a.values().cloned().collect();
2040     /// assert_eq!(values, ["hello", "goodbye"]);
2041     /// ```
2042     #[stable(feature = "rust1", since = "1.0.0")]
2043     pub fn values(&self) -> Values<'_, K, V> {
2044         Values { inner: self.iter() }
2045     }
2046
2047     /// Gets a mutable iterator over the values of the map, in order by key.
2048     ///
2049     /// # Examples
2050     ///
2051     /// Basic usage:
2052     ///
2053     /// ```
2054     /// use std::collections::BTreeMap;
2055     ///
2056     /// let mut a = BTreeMap::new();
2057     /// a.insert(1, String::from("hello"));
2058     /// a.insert(2, String::from("goodbye"));
2059     ///
2060     /// for value in a.values_mut() {
2061     ///     value.push_str("!");
2062     /// }
2063     ///
2064     /// let values: Vec<String> = a.values().cloned().collect();
2065     /// assert_eq!(values, [String::from("hello!"),
2066     ///                     String::from("goodbye!")]);
2067     /// ```
2068     #[stable(feature = "map_values_mut", since = "1.10.0")]
2069     pub fn values_mut(&mut self) -> ValuesMut<'_, K, V> {
2070         ValuesMut { inner: self.iter_mut() }
2071     }
2072
2073     /// Returns the number of elements in the map.
2074     ///
2075     /// # Examples
2076     ///
2077     /// Basic usage:
2078     ///
2079     /// ```
2080     /// use std::collections::BTreeMap;
2081     ///
2082     /// let mut a = BTreeMap::new();
2083     /// assert_eq!(a.len(), 0);
2084     /// a.insert(1, "a");
2085     /// assert_eq!(a.len(), 1);
2086     /// ```
2087     #[stable(feature = "rust1", since = "1.0.0")]
2088     pub fn len(&self) -> usize {
2089         self.length
2090     }
2091
2092     /// Returns `true` if the map contains no elements.
2093     ///
2094     /// # Examples
2095     ///
2096     /// Basic usage:
2097     ///
2098     /// ```
2099     /// use std::collections::BTreeMap;
2100     ///
2101     /// let mut a = BTreeMap::new();
2102     /// assert!(a.is_empty());
2103     /// a.insert(1, "a");
2104     /// assert!(!a.is_empty());
2105     /// ```
2106     #[stable(feature = "rust1", since = "1.0.0")]
2107     pub fn is_empty(&self) -> bool {
2108         self.len() == 0
2109     }
2110 }
2111
2112 impl<'a, K: Ord, V> Entry<'a, K, V> {
2113     /// Ensures a value is in the entry by inserting the default if empty, and returns
2114     /// a mutable reference to the value in the entry.
2115     ///
2116     /// # Examples
2117     ///
2118     /// ```
2119     /// use std::collections::BTreeMap;
2120     ///
2121     /// let mut map: BTreeMap<&str, usize> = BTreeMap::new();
2122     /// map.entry("poneyland").or_insert(12);
2123     ///
2124     /// assert_eq!(map["poneyland"], 12);
2125     /// ```
2126     #[stable(feature = "rust1", since = "1.0.0")]
2127     pub fn or_insert(self, default: V) -> &'a mut V {
2128         match self {
2129             Occupied(entry) => entry.into_mut(),
2130             Vacant(entry) => entry.insert(default),
2131         }
2132     }
2133
2134     /// Ensures a value is in the entry by inserting the result of the default function if empty,
2135     /// and returns a mutable reference to the value in the entry.
2136     ///
2137     /// # Examples
2138     ///
2139     /// ```
2140     /// use std::collections::BTreeMap;
2141     ///
2142     /// let mut map: BTreeMap<&str, String> = BTreeMap::new();
2143     /// let s = "hoho".to_string();
2144     ///
2145     /// map.entry("poneyland").or_insert_with(|| s);
2146     ///
2147     /// assert_eq!(map["poneyland"], "hoho".to_string());
2148     /// ```
2149     #[stable(feature = "rust1", since = "1.0.0")]
2150     pub fn or_insert_with<F: FnOnce() -> V>(self, default: F) -> &'a mut V {
2151         match self {
2152             Occupied(entry) => entry.into_mut(),
2153             Vacant(entry) => entry.insert(default()),
2154         }
2155     }
2156
2157     /// Returns a reference to this entry's key.
2158     ///
2159     /// # Examples
2160     ///
2161     /// ```
2162     /// use std::collections::BTreeMap;
2163     ///
2164     /// let mut map: BTreeMap<&str, usize> = BTreeMap::new();
2165     /// assert_eq!(map.entry("poneyland").key(), &"poneyland");
2166     /// ```
2167     #[stable(feature = "map_entry_keys", since = "1.10.0")]
2168     pub fn key(&self) -> &K {
2169         match *self {
2170             Occupied(ref entry) => entry.key(),
2171             Vacant(ref entry) => entry.key(),
2172         }
2173     }
2174
2175     /// Provides in-place mutable access to an occupied entry before any
2176     /// potential inserts into the map.
2177     ///
2178     /// # Examples
2179     ///
2180     /// ```
2181     /// use std::collections::BTreeMap;
2182     ///
2183     /// let mut map: BTreeMap<&str, usize> = BTreeMap::new();
2184     ///
2185     /// map.entry("poneyland")
2186     ///    .and_modify(|e| { *e += 1 })
2187     ///    .or_insert(42);
2188     /// assert_eq!(map["poneyland"], 42);
2189     ///
2190     /// map.entry("poneyland")
2191     ///    .and_modify(|e| { *e += 1 })
2192     ///    .or_insert(42);
2193     /// assert_eq!(map["poneyland"], 43);
2194     /// ```
2195     #[stable(feature = "entry_and_modify", since = "1.26.0")]
2196     pub fn and_modify<F>(self, f: F) -> Self
2197     where
2198         F: FnOnce(&mut V),
2199     {
2200         match self {
2201             Occupied(mut entry) => {
2202                 f(entry.get_mut());
2203                 Occupied(entry)
2204             }
2205             Vacant(entry) => Vacant(entry),
2206         }
2207     }
2208 }
2209
2210 impl<'a, K: Ord, V: Default> Entry<'a, K, V> {
2211     #[stable(feature = "entry_or_default", since = "1.28.0")]
2212     /// Ensures a value is in the entry by inserting the default value if empty,
2213     /// and returns a mutable reference to the value in the entry.
2214     ///
2215     /// # Examples
2216     ///
2217     /// ```
2218     /// use std::collections::BTreeMap;
2219     ///
2220     /// let mut map: BTreeMap<&str, Option<usize>> = BTreeMap::new();
2221     /// map.entry("poneyland").or_default();
2222     ///
2223     /// assert_eq!(map["poneyland"], None);
2224     /// ```
2225     pub fn or_default(self) -> &'a mut V {
2226         match self {
2227             Occupied(entry) => entry.into_mut(),
2228             Vacant(entry) => entry.insert(Default::default()),
2229         }
2230     }
2231 }
2232
2233 impl<'a, K: Ord, V> VacantEntry<'a, K, V> {
2234     /// Gets a reference to the key that would be used when inserting a value
2235     /// through the VacantEntry.
2236     ///
2237     /// # Examples
2238     ///
2239     /// ```
2240     /// use std::collections::BTreeMap;
2241     ///
2242     /// let mut map: BTreeMap<&str, usize> = BTreeMap::new();
2243     /// assert_eq!(map.entry("poneyland").key(), &"poneyland");
2244     /// ```
2245     #[stable(feature = "map_entry_keys", since = "1.10.0")]
2246     pub fn key(&self) -> &K {
2247         &self.key
2248     }
2249
2250     /// Take ownership of the key.
2251     ///
2252     /// # Examples
2253     ///
2254     /// ```
2255     /// use std::collections::BTreeMap;
2256     /// use std::collections::btree_map::Entry;
2257     ///
2258     /// let mut map: BTreeMap<&str, usize> = BTreeMap::new();
2259     ///
2260     /// if let Entry::Vacant(v) = map.entry("poneyland") {
2261     ///     v.into_key();
2262     /// }
2263     /// ```
2264     #[stable(feature = "map_entry_recover_keys2", since = "1.12.0")]
2265     pub fn into_key(self) -> K {
2266         self.key
2267     }
2268
2269     /// Sets the value of the entry with the `VacantEntry`'s key,
2270     /// and returns a mutable reference to it.
2271     ///
2272     /// # Examples
2273     ///
2274     /// ```
2275     /// use std::collections::BTreeMap;
2276     ///
2277     /// let mut count: BTreeMap<&str, usize> = BTreeMap::new();
2278     ///
2279     /// // count the number of occurrences of letters in the vec
2280     /// for x in vec!["a","b","a","c","a","b"] {
2281     ///     *count.entry(x).or_insert(0) += 1;
2282     /// }
2283     ///
2284     /// assert_eq!(count["a"], 3);
2285     /// ```
2286     #[stable(feature = "rust1", since = "1.0.0")]
2287     pub fn insert(self, value: V) -> &'a mut V {
2288         *self.length += 1;
2289
2290         let out_ptr;
2291
2292         let mut ins_k;
2293         let mut ins_v;
2294         let mut ins_edge;
2295
2296         let mut cur_parent = match self.handle.insert(self.key, value) {
2297             (Fit(handle), _) => return handle.into_kv_mut().1,
2298             (Split(left, k, v, right), ptr) => {
2299                 ins_k = k;
2300                 ins_v = v;
2301                 ins_edge = right;
2302                 out_ptr = ptr;
2303                 left.ascend().map_err(|n| n.into_root_mut())
2304             }
2305         };
2306
2307         loop {
2308             match cur_parent {
2309                 Ok(parent) => match parent.insert(ins_k, ins_v, ins_edge) {
2310                     Fit(_) => return unsafe { &mut *out_ptr },
2311                     Split(left, k, v, right) => {
2312                         ins_k = k;
2313                         ins_v = v;
2314                         ins_edge = right;
2315                         cur_parent = left.ascend().map_err(|n| n.into_root_mut());
2316                     }
2317                 },
2318                 Err(root) => {
2319                     root.push_level().push(ins_k, ins_v, ins_edge);
2320                     return unsafe { &mut *out_ptr };
2321                 }
2322             }
2323         }
2324     }
2325 }
2326
2327 impl<'a, K: Ord, V> OccupiedEntry<'a, K, V> {
2328     /// Gets a reference to the key in the entry.
2329     ///
2330     /// # Examples
2331     ///
2332     /// ```
2333     /// use std::collections::BTreeMap;
2334     ///
2335     /// let mut map: BTreeMap<&str, usize> = BTreeMap::new();
2336     /// map.entry("poneyland").or_insert(12);
2337     /// assert_eq!(map.entry("poneyland").key(), &"poneyland");
2338     /// ```
2339     #[stable(feature = "map_entry_keys", since = "1.10.0")]
2340     pub fn key(&self) -> &K {
2341         self.handle.reborrow().into_kv().0
2342     }
2343
2344     /// Take ownership of the key and value from the map.
2345     ///
2346     /// # Examples
2347     ///
2348     /// ```
2349     /// use std::collections::BTreeMap;
2350     /// use std::collections::btree_map::Entry;
2351     ///
2352     /// let mut map: BTreeMap<&str, usize> = BTreeMap::new();
2353     /// map.entry("poneyland").or_insert(12);
2354     ///
2355     /// if let Entry::Occupied(o) = map.entry("poneyland") {
2356     ///     // We delete the entry from the map.
2357     ///     o.remove_entry();
2358     /// }
2359     ///
2360     /// // If now try to get the value, it will panic:
2361     /// // println!("{}", map["poneyland"]);
2362     /// ```
2363     #[stable(feature = "map_entry_recover_keys2", since = "1.12.0")]
2364     pub fn remove_entry(self) -> (K, V) {
2365         self.remove_kv()
2366     }
2367
2368     /// Gets a reference to the value in the entry.
2369     ///
2370     /// # Examples
2371     ///
2372     /// ```
2373     /// use std::collections::BTreeMap;
2374     /// use std::collections::btree_map::Entry;
2375     ///
2376     /// let mut map: BTreeMap<&str, usize> = BTreeMap::new();
2377     /// map.entry("poneyland").or_insert(12);
2378     ///
2379     /// if let Entry::Occupied(o) = map.entry("poneyland") {
2380     ///     assert_eq!(o.get(), &12);
2381     /// }
2382     /// ```
2383     #[stable(feature = "rust1", since = "1.0.0")]
2384     pub fn get(&self) -> &V {
2385         self.handle.reborrow().into_kv().1
2386     }
2387
2388     /// Gets a mutable reference to the value in the entry.
2389     ///
2390     /// If you need a reference to the `OccupiedEntry` that may outlive the
2391     /// destruction of the `Entry` value, see [`into_mut`].
2392     ///
2393     /// [`into_mut`]: #method.into_mut
2394     ///
2395     /// # Examples
2396     ///
2397     /// ```
2398     /// use std::collections::BTreeMap;
2399     /// use std::collections::btree_map::Entry;
2400     ///
2401     /// let mut map: BTreeMap<&str, usize> = BTreeMap::new();
2402     /// map.entry("poneyland").or_insert(12);
2403     ///
2404     /// assert_eq!(map["poneyland"], 12);
2405     /// if let Entry::Occupied(mut o) = map.entry("poneyland") {
2406     ///     *o.get_mut() += 10;
2407     ///     assert_eq!(*o.get(), 22);
2408     ///
2409     ///     // We can use the same Entry multiple times.
2410     ///     *o.get_mut() += 2;
2411     /// }
2412     /// assert_eq!(map["poneyland"], 24);
2413     /// ```
2414     #[stable(feature = "rust1", since = "1.0.0")]
2415     pub fn get_mut(&mut self) -> &mut V {
2416         self.handle.kv_mut().1
2417     }
2418
2419     /// Converts the entry into a mutable reference to its value.
2420     ///
2421     /// If you need multiple references to the `OccupiedEntry`, see [`get_mut`].
2422     ///
2423     /// [`get_mut`]: #method.get_mut
2424     ///
2425     /// # Examples
2426     ///
2427     /// ```
2428     /// use std::collections::BTreeMap;
2429     /// use std::collections::btree_map::Entry;
2430     ///
2431     /// let mut map: BTreeMap<&str, usize> = BTreeMap::new();
2432     /// map.entry("poneyland").or_insert(12);
2433     ///
2434     /// assert_eq!(map["poneyland"], 12);
2435     /// if let Entry::Occupied(o) = map.entry("poneyland") {
2436     ///     *o.into_mut() += 10;
2437     /// }
2438     /// assert_eq!(map["poneyland"], 22);
2439     /// ```
2440     #[stable(feature = "rust1", since = "1.0.0")]
2441     pub fn into_mut(self) -> &'a mut V {
2442         self.handle.into_kv_mut().1
2443     }
2444
2445     /// Sets the value of the entry with the `OccupiedEntry`'s key,
2446     /// and returns the entry's old value.
2447     ///
2448     /// # Examples
2449     ///
2450     /// ```
2451     /// use std::collections::BTreeMap;
2452     /// use std::collections::btree_map::Entry;
2453     ///
2454     /// let mut map: BTreeMap<&str, usize> = BTreeMap::new();
2455     /// map.entry("poneyland").or_insert(12);
2456     ///
2457     /// if let Entry::Occupied(mut o) = map.entry("poneyland") {
2458     ///     assert_eq!(o.insert(15), 12);
2459     /// }
2460     /// assert_eq!(map["poneyland"], 15);
2461     /// ```
2462     #[stable(feature = "rust1", since = "1.0.0")]
2463     pub fn insert(&mut self, value: V) -> V {
2464         mem::replace(self.get_mut(), value)
2465     }
2466
2467     /// Takes the value of the entry out of the map, and returns it.
2468     ///
2469     /// # Examples
2470     ///
2471     /// ```
2472     /// use std::collections::BTreeMap;
2473     /// use std::collections::btree_map::Entry;
2474     ///
2475     /// let mut map: BTreeMap<&str, usize> = BTreeMap::new();
2476     /// map.entry("poneyland").or_insert(12);
2477     ///
2478     /// if let Entry::Occupied(o) = map.entry("poneyland") {
2479     ///     assert_eq!(o.remove(), 12);
2480     /// }
2481     /// // If we try to get "poneyland"'s value, it'll panic:
2482     /// // println!("{}", map["poneyland"]);
2483     /// ```
2484     #[stable(feature = "rust1", since = "1.0.0")]
2485     pub fn remove(self) -> V {
2486         self.remove_kv().1
2487     }
2488
2489     fn remove_kv(self) -> (K, V) {
2490         *self.length -= 1;
2491
2492         let (small_leaf, old_key, old_val) = match self.handle.force() {
2493             Leaf(leaf) => {
2494                 let (hole, old_key, old_val) = leaf.remove();
2495                 (hole.into_node(), old_key, old_val)
2496             }
2497             Internal(mut internal) => {
2498                 let key_loc = internal.kv_mut().0 as *mut K;
2499                 let val_loc = internal.kv_mut().1 as *mut V;
2500
2501                 let to_remove = internal.right_edge().descend().first_leaf_edge().right_kv().ok();
2502                 let to_remove = unsafe { unwrap_unchecked(to_remove) };
2503
2504                 let (hole, key, val) = to_remove.remove();
2505
2506                 let old_key = unsafe { mem::replace(&mut *key_loc, key) };
2507                 let old_val = unsafe { mem::replace(&mut *val_loc, val) };
2508
2509                 (hole.into_node(), old_key, old_val)
2510             }
2511         };
2512
2513         // Handle underflow
2514         let mut cur_node = small_leaf.forget_type();
2515         while cur_node.len() < node::MIN_LEN {
2516             match handle_underfull_node(cur_node) {
2517                 AtRoot => break,
2518                 EmptyParent(_) => unreachable!(),
2519                 Merged(parent) => {
2520                     if parent.len() == 0 {
2521                         // We must be at the root
2522                         parent.into_root_mut().pop_level();
2523                         break;
2524                     } else {
2525                         cur_node = parent.forget_type();
2526                     }
2527                 }
2528                 Stole(_) => break,
2529             }
2530         }
2531
2532         (old_key, old_val)
2533     }
2534 }
2535
2536 enum UnderflowResult<'a, K, V> {
2537     AtRoot,
2538     EmptyParent(NodeRef<marker::Mut<'a>, K, V, marker::Internal>),
2539     Merged(NodeRef<marker::Mut<'a>, K, V, marker::Internal>),
2540     Stole(NodeRef<marker::Mut<'a>, K, V, marker::Internal>),
2541 }
2542
2543 fn handle_underfull_node<K, V>(
2544     node: NodeRef<marker::Mut<'_>, K, V, marker::LeafOrInternal>,
2545 ) -> UnderflowResult<'_, K, V> {
2546     let parent = if let Ok(parent) = node.ascend() {
2547         parent
2548     } else {
2549         return AtRoot;
2550     };
2551
2552     let (is_left, mut handle) = match parent.left_kv() {
2553         Ok(left) => (true, left),
2554         Err(parent) => match parent.right_kv() {
2555             Ok(right) => (false, right),
2556             Err(parent) => {
2557                 return EmptyParent(parent.into_node());
2558             }
2559         },
2560     };
2561
2562     if handle.can_merge() {
2563         Merged(handle.merge().into_node())
2564     } else {
2565         if is_left {
2566             handle.steal_left();
2567         } else {
2568             handle.steal_right();
2569         }
2570         Stole(handle.into_node())
2571     }
2572 }
2573
2574 impl<K: Ord, V, I: Iterator<Item = (K, V)>> Iterator for MergeIter<K, V, I> {
2575     type Item = (K, V);
2576
2577     fn next(&mut self) -> Option<(K, V)> {
2578         let res = match (self.left.peek(), self.right.peek()) {
2579             (Some(&(ref left_key, _)), Some(&(ref right_key, _))) => left_key.cmp(right_key),
2580             (Some(_), None) => Ordering::Less,
2581             (None, Some(_)) => Ordering::Greater,
2582             (None, None) => return None,
2583         };
2584
2585         // Check which elements comes first and only advance the corresponding iterator.
2586         // If two keys are equal, take the value from `right`.
2587         match res {
2588             Ordering::Less => self.left.next(),
2589             Ordering::Greater => self.right.next(),
2590             Ordering::Equal => {
2591                 self.left.next();
2592                 self.right.next()
2593             }
2594         }
2595     }
2596 }