diff options
Diffstat (limited to 'src/weak_hash_set.rs')
| -rw-r--r-- | src/weak_hash_set.rs | 56 |
1 files changed, 51 insertions, 5 deletions
diff --git a/src/weak_hash_set.rs b/src/weak_hash_set.rs index a3bc151..bbff3b8 100644 --- a/src/weak_hash_set.rs +++ b/src/weak_hash_set.rs @@ -1,10 +1,6 @@ //! A hash set where the elements are held by weak pointers and compared by value. -use std::borrow::Borrow; -use std::collections::hash_map::RandomState; -use std::fmt::{self, Debug}; -use std::hash::{BuildHasher, Hash}; -use std::iter::FromIterator; +use crate::compat::*; use super::traits::*; use super::weak_key_hash_map as base; @@ -13,11 +9,15 @@ pub use super::WeakHashSet; impl <T: WeakKey> WeakHashSet<T, RandomState> { /// Creates an empty `WeakHashSet`. + /// + /// *O*(1) time pub fn new() -> Self { WeakHashSet(base::WeakKeyHashMap::new()) } /// Creates an empty `WeakHashSet` with the given capacity. + /// + /// *O*(*n*) time pub fn with_capacity(capacity: usize) -> Self { WeakHashSet(base::WeakKeyHashMap::with_capacity(capacity)) } @@ -25,41 +25,57 @@ impl <T: WeakKey> WeakHashSet<T, RandomState> { impl <T: WeakKey, S: BuildHasher> WeakHashSet<T, S> { /// Creates an empty `WeakHashSet` with the given capacity and hasher. + /// + /// *O*(*n*) time pub fn with_hasher(hash_builder: S) -> Self { WeakHashSet(base::WeakKeyHashMap::with_hasher(hash_builder)) } /// Creates an empty `WeakHashSet` with the given capacity and hasher. + /// + /// *O*(*n*) time pub fn with_capacity_and_hasher(capacity: usize, hash_builder: S) -> Self { WeakHashSet(base::WeakKeyHashMap::with_capacity_and_hasher(capacity, hash_builder)) } /// Returns a reference to the map's `BuildHasher`. + /// + /// *O*(1) time pub fn hasher(&self) -> &S { self.0.hasher() } /// Returns the number of elements the map can hold without reallocating. + /// + /// *O*(1) time pub fn capacity(&self) -> usize { self.0.capacity() } /// Removes all mappings whose keys have expired. + /// + /// *O*(*n*) time pub fn remove_expired(&mut self) { self.0.remove_expired() } /// Reserves room for additional elements. + /// + /// *O*(*n*) time pub fn reserve(&mut self, additional_capacity: usize) { self.0.reserve(additional_capacity) } /// Shrinks the capacity to the minimum allowed to hold the current number of elements. + /// + /// *O*(*n*) time pub fn shrink_to_fit(&mut self) { self.0.shrink_to_fit() } /// Returns an over-approximation of the number of elements. + /// + /// *O*(1) time pub fn len(&self) -> usize { self.0.len() } @@ -68,6 +84,8 @@ impl <T: WeakKey, S: BuildHasher> WeakHashSet<T, S> { /// /// Note that this may return false even if all keys in the set have /// expired, if they haven't been collected yet. + /// + /// *O*(1) time pub fn is_empty(&self) -> bool { self.0.is_empty() } @@ -75,11 +93,15 @@ impl <T: WeakKey, S: BuildHasher> WeakHashSet<T, S> { /// The proportion of buckets that are used. /// /// This is an over-approximation because of expired elements. + /// + /// *O*(1) time pub fn load_factor(&self) -> f32 { self.0.load_factor() } /// Removes all associations from the map. + /// + /// *O*(*n*) time pub fn clear(&mut self) { self.0.clear() } @@ -87,6 +109,8 @@ impl <T: WeakKey, S: BuildHasher> WeakHashSet<T, S> { // Non-ptr WeakHashSet should probably have `get` method. /// Returns true if the map contains the specified key. + /// + /// expected *O*(1) time; worst-case *O*(*p*) time pub fn contains<Q>(&self, key: &Q) -> bool where Q: ?Sized + Eq + Hash, T::Key: Borrow<Q> @@ -112,6 +136,8 @@ impl <T: WeakKey, S: BuildHasher> WeakHashSet<T, S> { /// /// assert!(Rc::ptr_eq( &a, &also_a )); /// ``` + /// + /// expected *O*(1) time; worst-case *O*(*p*) time pub fn get<Q>(&self, key: &Q) -> Option<T::Strong> where Q: ?Sized + Eq + Hash, T::Key: Borrow<Q> @@ -121,11 +147,15 @@ impl <T: WeakKey, S: BuildHasher> WeakHashSet<T, S> { /// Unconditionally inserts the value, returning the old value if already present. Does not /// replace the key. + /// + /// expected *O*(1) time; worst-case *O*(*p*) time pub fn insert(&mut self, key: T::Strong) -> bool { self.0.insert(key, ()).is_some() } /// Removes the entry with the given key, if it exists, and returns the value. + /// + /// expected *O*(1) time; worst-case *O*(*p*) time pub fn remove<Q>(&mut self, key: &Q) -> bool where Q: ?Sized + Eq + Hash, T::Key: Borrow<Q> @@ -136,6 +166,8 @@ impl <T: WeakKey, S: BuildHasher> WeakHashSet<T, S> { /// Removes all mappings not satisfying the given predicate. /// /// Also removes any expired mappings. + /// + /// *O*(*n*) time pub fn retain<F>(&mut self, mut f: F) where F: FnMut(T::Strong) -> bool { @@ -143,6 +175,10 @@ impl <T: WeakKey, S: BuildHasher> WeakHashSet<T, S> { } /// Is self a subset of other? + /// + /// expected *O*(*n*) time; worst-case *O*(*nq*) time (where *n* is + /// `self.capacity()` and *q* is the length of the probe sequences + /// in `other`) pub fn is_subset<S1>(&self, other: &WeakHashSet<T, S1>) -> bool where S1: BuildHasher { @@ -197,11 +233,15 @@ impl<'a, T: WeakElement> Iterator for Drain<'a, T> { impl<T: WeakKey, S> WeakHashSet<T, S> { /// Gets an iterator over the keys and values. + /// + /// *O*(1) time pub fn iter(&self) -> Iter<T> { Iter(self.0.keys()) } /// Gets a draining iterator, which removes all the values but retains the storage. + /// + /// *O*(1) time (and *O*(*n*) time to dispose of the result) pub fn drain(&mut self) -> Drain<T> { Drain(self.0.drain()) } @@ -255,6 +295,9 @@ impl<T: WeakKey, S> IntoIterator for WeakHashSet<T, S> { type Item = T::Strong; type IntoIter = IntoIter<T>; + /// Creates an owning iterator from `self`. + /// + /// *O*(1) time (and *O*(*n*) time to dispose of the result) fn into_iter(self) -> Self::IntoIter { IntoIter(self.0.into_iter()) } @@ -264,6 +307,9 @@ impl<'a, T: WeakKey, S> IntoIterator for &'a WeakHashSet<T, S> { type Item = T::Strong; type IntoIter = Iter<'a, T>; + /// Creates a borrowing iterator from `self`. + /// + /// *O*(1) time fn into_iter(self) -> Self::IntoIter { Iter(self.0.keys()) } |