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

Add some doc comments to SortedMap.

Browse Source
This commit is contained in:
Michael Woerister 2018-05-21 19:17:00 +02:00
parent 4bedc31459
commit 95fac99a20
1 changed files with 20 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
src/librustc_data_structures/sorted_map.rs
View File

@ -14,7 +14,15 @@ use std::convert::From;
use std::mem; use std::mem;
use std::ops::{RangeBounds, Bound, Index, IndexMut}; use std::ops::{RangeBounds, Bound, Index, IndexMut};
#[derive(Clone, PartialEq, Eq, Hash, Debug, RustcEncodable, RustcDecodable)] /// `SortedMap` is a data structure with similar characteristics as BTreeMap but
/// slightly different trade-offs: lookup, inseration, and removal are O(log(N))
/// and elements can be iterated in order cheaply.
///
/// `SortedMap` can be faster than a `BTreeMap` for small sizes (<50) since it
/// stores data in a more compact way. It also supports accessing contiguous
/// ranges of elements as a slice, and slices of already sorted elements can be
/// inserted efficiently.
#[derive(Clone, PartialEq, Eq, Hash, Default, Debug, RustcEncodable, RustcDecodable)]
pub struct SortedMap<K: Ord, V> { pub struct SortedMap<K: Ord, V> {
data: Vec<(K,V)> data: Vec<(K,V)>
} }
@ -28,8 +36,11 @@ impl<K: Ord, V> SortedMap<K, V> {
} }
} }
// It is up to the caller to make sure that the elements are sorted by key /// Construct a `SortedMap` from a presorted set of elements. This is faster
// and that there are no duplicates. /// than creating an empty map and then inserting the elements individually.
///
/// It is up to the caller to make sure that the elements are sorted by key
/// and that there are no duplicates.
#[inline] #[inline]
pub fn from_presorted_elements(elements: Vec<(K, V)>) -> SortedMap<K, V> pub fn from_presorted_elements(elements: Vec<(K, V)>) -> SortedMap<K, V>
{ {
@ -150,8 +161,12 @@ impl<K: Ord, V> SortedMap<K, V> {
self.data.iter_mut().map(|&mut (ref mut k, _)| k).for_each(f); self.data.iter_mut().map(|&mut (ref mut k, _)| k).for_each(f);
} }
// It is up to the caller to make sure that the elements are sorted by key /// Inserts a presorted range of elements into the map. If the range can be
// and that there are no duplicates. /// inserted as a whole in between to existing elements of the map, this
/// will be faster than inserting the elements individually.
///
/// It is up to the caller to make sure that the elements are sorted by key
/// and that there are no duplicates.
#[inline] #[inline]
pub fn insert_presorted(&mut self, mut elements: Vec<(K, V)>) { pub fn insert_presorted(&mut self, mut elements: Vec<(K, V)>) {
if elements.is_empty() { if elements.is_empty() {