bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Clarify explicitly that BTree{Map,Set} are ordered.

Browse source
This commit is contained in:
Brennan Vincent 2022-01-09 17:58:52 -05:00
parent 092e1c9d23
commit 9057a6d66a
3 changed files with 10 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

5
library/alloc/src/collections/btree/map.rs
View file

@ -31,7 +31,7 @@ pub(super) const MIN_LEN: usize = node::MIN_LEN_AFTER_SPLIT;
// An empty map is represented either by the absence of a root node or by a
// root node that is an empty leaf.
/// A map based on a [B-Tree].
/// An ordered map based on a [B-Tree].
///
/// B-Trees represent a fundamental compromise between cache-efficiency and actually minimizing
/// the amount of work performed in a search. In theory, a binary search tree (BST) is the optimal
@ -65,6 +65,9 @@ pub(super) const MIN_LEN: usize = node::MIN_LEN_AFTER_SPLIT;
/// incorrect results, aborts, memory leaks, or non-termination) but will not be undefined
/// behavior.
///
/// Entries in a `BTreeMap` are stored in ascending order according to the [`Ord`] implementation on the key.
/// Thus, iteration methods are guaranteed to produce iterators that yield items in that order.
///
/// [B-Tree]: https://en.wikipedia.org/wiki/B-tree
/// [`Cell`]: core::cell::Cell
/// [`RefCell`]: core::cell::RefCell

5
library/alloc/src/collections/btree/set.rs
View file

@ -15,7 +15,7 @@ use super::Recover;
// FIXME(conventions): implement bounded iterators
/// A set based on a B-Tree.
/// An ordered set based on a B-Tree.
///
/// See [`BTreeMap`]'s documentation for a detailed discussion of this collection's performance
/// benefits and drawbacks.
@ -27,6 +27,9 @@ use super::Recover;
/// incorrect results, aborts, memory leaks, or non-termination) but will not be undefined
/// behavior.
///
/// Entries in a `BTreeSet` are stored in ascending order according to the [`Ord`] implementation on the key.
/// Thus, iteration methods are guaranteed to produce iterators that yield items in that order.
///
/// [`Ord`]: core::cmp::Ord
/// [`Cell`]: core::cell::Cell
/// [`RefCell`]: core::cell::RefCell

4
library/alloc/src/collections/mod.rs
View file

@ -14,7 +14,7 @@ pub mod vec_deque;
#[cfg(not(no_global_oom_handling))]
#[stable(feature = "rust1", since = "1.0.0")]
pub mod btree_map {
//! A map based on a B-Tree.
//! An ordered map based on a B-Tree.
#[stable(feature = "rust1", since = "1.0.0")]
pub use super::btree::map::*;
}
@ -22,7 +22,7 @@ pub mod btree_map {
#[cfg(not(no_global_oom_handling))]
#[stable(feature = "rust1", since = "1.0.0")]
pub mod btree_set {
//! A set based on a B-Tree.
//! An ordered set based on a B-Tree.
#[stable(feature = "rust1", since = "1.0.0")]
pub use super::btree::set::*;
}