OpenE2K/rust
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Auto merge of #27998 - birkenfeld:patch-1, r=alexcrichton

Browse Source 
These have been removed and should not be documented here.

Should the replacement crates on crates.io be linked to, or is that not wanted in the core docs?
This commit is contained in:
bors 2015-08-26 15:50:52 +00:00
commit 685332c8d3
1 changed files with 6 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
src/libstd/collections/mod.rs
View File

@ -25,9 +25,9 @@
//! //!
//! Rust's collections can be grouped into four major categories: //! Rust's collections can be grouped into four major categories:
//! //!
//! * Sequences: `Vec`, `VecDeque`, `LinkedList`, `BitVec` //! * Sequences: `Vec`, `VecDeque`, `LinkedList`
//! * Maps: `HashMap`, `BTreeMap`, `VecMap` //! * Maps: `HashMap`, `BTreeMap`
//! * Sets: `HashSet`, `BTreeSet`, `BitSet` //! * Sets: `HashSet`, `BTreeSet`
//! * Misc: `BinaryHeap` //! * Misc: `BinaryHeap`
//! //!
//! # When Should You Use Which Collection? //! # When Should You Use Which Collection?
@ -70,22 +70,11 @@
//! * You want to be able to get all of the entries in order on-demand. //! * You want to be able to get all of the entries in order on-demand.
//! * You want a sorted map. //! * You want a sorted map.
//! //!
//! ### Use a `VecMap` when:
//! * You want a `HashMap` but with known to be small `usize` keys.
//! * You want a `BTreeMap`, but with known to be small `usize` keys.
//!
//! ### Use the `Set` variant of any of these `Map`s when: //! ### Use the `Set` variant of any of these `Map`s when:
//! * You just want to remember which keys you've seen. //! * You just want to remember which keys you've seen.
//! * There is no meaningful value to associate with your keys. //! * There is no meaningful value to associate with your keys.
//! * You just want a set. //! * You just want a set.
//! //!
//! ### Use a `BitVec` when:
//! * You want to store an unbounded number of booleans in a small space.
//! * You want a bit vector.
//!
//! ### Use a `BitSet` when:
//! * You want a `BitVec`, but want `Set` properties
//!
//! ### Use a `BinaryHeap` when: //! ### Use a `BinaryHeap` when:
//! //!
//! * You want to store a bunch of elements, but only ever want to process the //! * You want to store a bunch of elements, but only ever want to process the
@ -123,31 +112,20 @@
//! | Vec | O(1) | O(n-i)* | O(n-i) | O(m)* | O(n-i) | //! | Vec | O(1) | O(n-i)* | O(n-i) | O(m)* | O(n-i) |
//! | VecDeque | O(1) | O(min(i, n-i))* | O(min(i, n-i)) | O(m)* | O(min(i, n-i)) | //! | VecDeque | O(1) | O(min(i, n-i))* | O(min(i, n-i)) | O(m)* | O(min(i, n-i)) |
//! | LinkedList | O(min(i, n-i)) | O(min(i, n-i)) | O(min(i, n-i)) | O(1) | O(min(i, n-i)) | //! | LinkedList | O(min(i, n-i)) | O(min(i, n-i)) | O(min(i, n-i)) | O(1) | O(min(i, n-i)) |
//! | BitVec | O(1) | O(n-i)* | O(n-i) | O(m)* | O(n-i) |
//! //!
//! Note that where ties occur, Vec is generally going to be faster than VecDeque, and VecDeque //! Note that where ties occur, Vec is generally going to be faster than VecDeque, and VecDeque
//! is generally going to be faster than LinkedList. BitVec is not a general purpose collection, and //! is generally going to be faster than LinkedList.
//! therefore cannot reasonably be compared.
//! //!
//! ## Maps //! ## Maps
//! //!
//! For Sets, all operations have the cost of the equivalent Map operation. For //! For Sets, all operations have the cost of the equivalent Map operation.
//! BitSet,
//! refer to VecMap.
//! //!
//! | | get | insert | remove | predecessor | //! | | get | insert | remove | predecessor |
//! |----------|-----------|----------|----------|-------------| //! |----------|-----------|----------|----------|-------------|
//! | HashMap | O(1)~ | O(1)~* | O(1)~ | N/A | //! | HashMap | O(1)~ | O(1)~* | O(1)~ | N/A |
//! | BTreeMap | O(log n) | O(log n) | O(log n) | O(log n) | //! | BTreeMap | O(log n) | O(log n) | O(log n) | O(log n) |
//! | VecMap | O(1) | O(1)? | O(1) | O(n) |
//! //!
//! Note that VecMap is *incredibly* inefficient in terms of space. The O(1) //! Note that BTreeMap's precise performance depends on the value of B.
//! insertion time assumes space for the element is already allocated.
//! Otherwise, a large key may require a massive reallocation, with no direct
//! relation to the number of elements in the collection. VecMap should only be
//! seriously considered for small keys.
//!
//! Note also that BTreeMap's precise performance depends on the value of B.
//! //!
//! # Correct and Efficient Usage of Collections //! # Correct and Efficient Usage of Collections
//! //!