[−][src]Struct dary_heap::DaryHeap
A priority queue implemented with a d-ary heap.
This will be a max-heap.
It is a logic error for an item to be modified in such a way that the
item's ordering relative to any other item, as determined by the Ord
trait, changes while it is in the heap. This is normally only possible
through Cell
, RefCell
, global state, I/O, or unsafe code.
Usage
Rust type interference cannot infer the desired heap arity (value of d)
automatically. Therefore, it is generally more ergonomic to use one of the
type aliases instead of DaryHeap
directly. See the crate-level
documentation for more information.
Comparison to standard library
For a comparison with std::collections::BinaryHeap
, see the crate-level
documentation.
Examples
use dary_heap::BinaryHeap; // Type inference lets us omit an explicit type signature (which // would be `BinaryHeap<i32>` in this example). let mut heap = BinaryHeap::new(); // We can use peek to look at the next item in the heap. In this case, // there's no items in there yet so we get None. assert_eq!(heap.peek(), None); // Let's add some scores... heap.push(1); heap.push(5); heap.push(2); // Now peek shows the most important item in the heap. assert_eq!(heap.peek(), Some(&5)); // We can check the length of a heap. assert_eq!(heap.len(), 3); // We can iterate over the items in the heap, although they are returned in // a random order. for x in &heap { println!("{}", x); } // If we instead pop these scores, they should come back in order. assert_eq!(heap.pop(), Some(5)); assert_eq!(heap.pop(), Some(2)); assert_eq!(heap.pop(), Some(1)); assert_eq!(heap.pop(), None); // We can clear the heap of any remaining items. heap.clear(); // The heap should now be empty. assert!(heap.is_empty())
Min-heap
Either std::cmp::Reverse
or a custom Ord
implementation can be used to
make DaryHeap
a min-heap. This makes heap.pop()
return the smallest
value instead of the greatest one.
use dary_heap::TernaryHeap; use std::cmp::Reverse; let mut heap = TernaryHeap::new(); // Wrap values in `Reverse` heap.push(Reverse(1)); heap.push(Reverse(5)); heap.push(Reverse(2)); // If we pop these scores now, they should come back in the reverse order. assert_eq!(heap.pop(), Some(Reverse(1))); assert_eq!(heap.pop(), Some(Reverse(2))); assert_eq!(heap.pop(), Some(Reverse(5))); assert_eq!(heap.pop(), None);
Time complexity
push | pop | peek/peek_mut |
---|---|---|
O(1)~ | O(log(n)) | O(1) |
The value for push
is an expected cost; the method documentation gives a
more detailed analysis.
Implementations
impl<T: Ord, D: Arity> DaryHeap<T, D>
[src]
pub fn new() -> DaryHeap<T, D>
[src]
Creates an empty DaryHeap
as a max-heap.
Examples
Basic usage:
use dary_heap::QuaternaryHeap; let mut heap = QuaternaryHeap::new(); heap.push(4);
pub fn with_capacity(capacity: usize) -> DaryHeap<T, D>
[src]
Creates an empty DaryHeap
with a specific capacity.
This preallocates enough memory for capacity
elements,
so that the DaryHeap
does not have to be reallocated
until it contains at least that many values.
Examples
Basic usage:
use dary_heap::QuaternaryHeap; let mut heap = QuaternaryHeap::with_capacity(10); heap.push(4);
pub fn peek_mut(&mut self) -> Option<PeekMut<'_, T, D>>
[src]
Returns a mutable reference to the greatest item in the d-ary heap, or
None
if it is empty.
Note: If the PeekMut
value is leaked, the heap may be in an
inconsistent state.
Examples
Basic usage:
use dary_heap::TernaryHeap; let mut heap = TernaryHeap::new(); assert!(heap.peek_mut().is_none()); heap.push(1); heap.push(5); heap.push(2); { let mut val = heap.peek_mut().unwrap(); *val = 0; } assert_eq!(heap.peek(), Some(&2));
Time complexity
Cost is O(1) in the worst case.
pub fn pop(&mut self) -> Option<T>
[src]
Removes the greatest item from the d-ary heap and returns it, or None
if it
is empty.
Examples
Basic usage:
use dary_heap::BinaryHeap; let mut heap = BinaryHeap::from(vec![1, 3]); assert_eq!(heap.pop(), Some(3)); assert_eq!(heap.pop(), Some(1)); assert_eq!(heap.pop(), None);
Time complexity
The worst case cost of pop
on a heap containing n elements is O(log(n)).
pub fn push(&mut self, item: T)
[src]
Pushes an item onto the d-ary heap.
Examples
Basic usage:
use dary_heap::QuaternaryHeap; let mut heap = QuaternaryHeap::new(); heap.push(3); heap.push(5); heap.push(1); assert_eq!(heap.len(), 3); assert_eq!(heap.peek(), Some(&5));
Time complexity
The expected cost of push
, averaged over every possible ordering of
the elements being pushed, and over a sufficiently large number of
pushes, is O(1). This is the most meaningful cost metric when pushing
elements that are not already in any sorted pattern.
The time complexity degrades if elements are pushed in predominantly ascending order. In the worst case, elements are pushed in ascending sorted order and the amortized cost per push is O(log(n)) against a heap containing n elements.
The worst case cost of a single call to push
is O(n). The worst case
occurs when capacity is exhausted and needs a resize. The resize cost
has been amortized in the previous figures.
pub fn into_sorted_vec(self) -> Vec<T>
[src]
Consumes the DaryHeap
and returns a vector in sorted
(ascending) order.
Examples
Basic usage:
use dary_heap::OctonaryHeap; let mut heap = OctonaryHeap::from(vec![1, 2, 4, 5, 7]); heap.push(6); heap.push(3); let vec = heap.into_sorted_vec(); assert_eq!(vec, [1, 2, 3, 4, 5, 6, 7]);
pub fn append(&mut self, other: &mut Self)
[src]
Moves all the elements of other
into self
, leaving other
empty.
Examples
Basic usage:
use dary_heap::OctonaryHeap; let v = vec![-10, 1, 2, 3, 3]; let mut a = OctonaryHeap::from(v); let v = vec![-20, 5, 43]; let mut b = OctonaryHeap::from(v); a.append(&mut b); assert_eq!(a.into_sorted_vec(), [-20, -10, 1, 2, 3, 3, 5, 43]); assert!(b.is_empty());
pub fn drain_sorted(&mut self) -> DrainSorted<'_, T, D>ⓘNotable traits for DrainSorted<'_, T, D>
impl<T: Ord, D: Arity, '_> Iterator for DrainSorted<'_, T, D> type Item = T;
[src]
Notable traits for DrainSorted<'_, T, D>
impl<T: Ord, D: Arity, '_> Iterator for DrainSorted<'_, T, D> type Item = T;
unstable
only.Returns an iterator which retrieves elements in heap order. The retrieved elements are removed from the original heap. The remaining elements will be removed on drop in heap order.
Note:
.drain_sorted()
is O(n * log(n)); much slower than.drain()
. You should use the latter for most cases.
Examples
Basic usage:
use dary_heap::TernaryHeap; let mut heap = TernaryHeap::from(vec![1, 2, 3, 4, 5]); assert_eq!(heap.len(), 5); drop(heap.drain_sorted()); // removes all elements in heap order assert_eq!(heap.len(), 0);
pub fn retain<F>(&mut self, f: F) where
F: FnMut(&T) -> bool,
[src]
F: FnMut(&T) -> bool,
unstable
only.Retains only the elements specified by the predicate.
In other words, remove all elements e
such that f(&e)
returns
false
. The elements are visited in unsorted (and unspecified) order.
Examples
Basic usage:
use dary_heap::OctonaryHeap; let mut heap = OctonaryHeap::from(vec![-10, -5, 1, 2, 4, 13]); heap.retain(|x| x % 2 == 0); // only keep even numbers assert_eq!(heap.into_sorted_vec(), [-10, 2, 4])
impl<T, D: Arity> DaryHeap<T, D>
[src]
pub fn iter(&self) -> Iter<'_, T>ⓘ
[src]
Returns an iterator visiting all values in the underlying vector, in arbitrary order.
Examples
Basic usage:
use dary_heap::TernaryHeap; let heap = TernaryHeap::from(vec![1, 2, 3, 4]); // Print 1, 2, 3, 4 in arbitrary order for x in heap.iter() { println!("{}", x); }
pub fn into_iter_sorted(self) -> IntoIterSorted<T, D>ⓘNotable traits for IntoIterSorted<T, D>
impl<T: Ord, D: Arity> Iterator for IntoIterSorted<T, D> type Item = T;
[src]
Notable traits for IntoIterSorted<T, D>
impl<T: Ord, D: Arity> Iterator for IntoIterSorted<T, D> type Item = T;
unstable
only.Returns an iterator which retrieves elements in heap order. This method consumes the original heap.
Examples
Basic usage:
use dary_heap::QuaternaryHeap; let heap = QuaternaryHeap::from(vec![1, 2, 3, 4, 5]); assert_eq!(heap.into_iter_sorted().take(2).collect::<Vec<_>>(), vec![5, 4]);
pub fn peek(&self) -> Option<&T>
[src]
Returns the greatest item in the d-ary heap, or None
if it is empty.
Examples
Basic usage:
use dary_heap::BinaryHeap; let mut heap = BinaryHeap::new(); assert_eq!(heap.peek(), None); heap.push(1); heap.push(5); heap.push(2); assert_eq!(heap.peek(), Some(&5));
Time complexity
Cost is O(1) in the worst case.
pub fn capacity(&self) -> usize
[src]
Returns the number of elements the d-ary heap can hold without reallocating.
Examples
Basic usage:
use dary_heap::OctonaryHeap; let mut heap = OctonaryHeap::with_capacity(100); assert!(heap.capacity() >= 100); heap.push(4);
pub fn reserve_exact(&mut self, additional: usize)
[src]
Reserves the minimum capacity for exactly additional
more elements to be inserted in the
given DaryHeap
. Does nothing if the capacity is already sufficient.
Note that the allocator may give the collection more space than it requests. Therefore
capacity can not be relied upon to be precisely minimal. Prefer reserve
if future
insertions are expected.
Panics
Panics if the new capacity overflows usize
.
Examples
Basic usage:
use dary_heap::OctonaryHeap; let mut heap = OctonaryHeap::new(); heap.reserve_exact(100); assert!(heap.capacity() >= 100); heap.push(4);
pub fn reserve(&mut self, additional: usize)
[src]
Reserves capacity for at least additional
more elements to be inserted in the
DaryHeap
. The collection may reserve more space to avoid frequent reallocations.
Panics
Panics if the new capacity overflows usize
.
Examples
Basic usage:
use dary_heap::BinaryHeap; let mut heap = BinaryHeap::new(); heap.reserve(100); assert!(heap.capacity() >= 100); heap.push(4);
pub fn shrink_to_fit(&mut self)
[src]
Discards as much additional capacity as possible.
Examples
Basic usage:
use dary_heap::TernaryHeap; let mut heap: TernaryHeap<i32> = TernaryHeap::with_capacity(100); assert!(heap.capacity() >= 100); heap.shrink_to_fit(); assert!(heap.capacity() == 0);
pub fn shrink_to(&mut self, min_capacity: usize)
[src]
unstable_nightly
only.Discards capacity with a lower bound.
The capacity will remain at least as large as both the length and the supplied value.
Panics if the current capacity is smaller than the supplied minimum capacity.
Examples
#![feature(shrink_to)] use dary_heap::TernaryHeap; let mut heap: TernaryHeap<i32> = TernaryHeap::with_capacity(100); assert!(heap.capacity() >= 100); heap.shrink_to(10); assert!(heap.capacity() >= 10);
pub fn into_vec(self) -> Vec<T>
[src]
Consumes the DaryHeap
and returns the underlying vector
in arbitrary order.
Examples
Basic usage:
use dary_heap::QuaternaryHeap; let heap = QuaternaryHeap::from(vec![1, 2, 3, 4, 5, 6, 7]); let vec = heap.into_vec(); // Will print in some order for x in vec { println!("{}", x); }
pub fn len(&self) -> usize
[src]
Returns the length of the d-ary heap.
Examples
Basic usage:
use dary_heap::BinaryHeap; let heap = BinaryHeap::from(vec![1, 3]); assert_eq!(heap.len(), 2);
pub fn is_empty(&self) -> bool
[src]
Checks if the d-ary heap is empty.
Examples
Basic usage:
use dary_heap::BinaryHeap; let mut heap = BinaryHeap::new(); assert!(heap.is_empty()); heap.push(3); heap.push(5); heap.push(1); assert!(!heap.is_empty());
pub fn drain(&mut self) -> Drain<'_, T>ⓘ
[src]
Clears the d-ary heap, returning an iterator over the removed elements.
The elements are removed in arbitrary order.
Examples
Basic usage:
use dary_heap::QuaternaryHeap; let mut heap = QuaternaryHeap::from(vec![1, 3]); assert!(!heap.is_empty()); for x in heap.drain() { println!("{}", x); } assert!(heap.is_empty());
pub fn clear(&mut self)
[src]
Drops all items from the d-ary heap.
Examples
Basic usage:
use dary_heap::TernaryHeap; let mut heap = TernaryHeap::from(vec![1, 3]); assert!(!heap.is_empty()); heap.clear(); assert!(heap.is_empty());
Trait Implementations
impl<T: Clone, D: Arity> Clone for DaryHeap<T, D>
[src]
fn clone(&self) -> Self
[src]
fn clone_from(&mut self, source: &Self)
[src]
impl<T: Debug, D: Arity> Debug for DaryHeap<T, D>
[src]
impl<T: Ord, D: Arity> Default for DaryHeap<T, D>
[src]
impl<'de, T, D: Arity> Deserialize<'de> for DaryHeap<T, D> where
T: Deserialize<'de>,
[src]
T: Deserialize<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl<'a, T: 'a + Ord + Copy, D: Arity> Extend<&'a T> for DaryHeap<T, D>
[src]
fn extend<I: IntoIterator<Item = &'a T>>(&mut self, iter: I)
[src]
fn extend_one(&mut self, item: &'a T)
[src]
fn extend_reserve(&mut self, additional: usize)
[src]
impl<T: Ord, D: Arity> Extend<T> for DaryHeap<T, D>
[src]
fn extend<I: IntoIterator<Item = T>>(&mut self, iter: I)
[src]
fn extend_one(&mut self, item: T)
[src]
fn extend_reserve(&mut self, additional: usize)
[src]
impl<T, D: Arity> From<DaryHeap<T, D>> for Vec<T>
[src]
impl<T: Ord, D: Arity> From<Vec<T>> for DaryHeap<T, D>
[src]
fn from(vec: Vec<T>) -> DaryHeap<T, D>
[src]
Converts a Vec<T>
into a DaryHeap<T, D>
.
This conversion happens in-place, and has O(n) time complexity.
impl<T: Ord, D: Arity> FromIterator<T> for DaryHeap<T, D>
[src]
fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> DaryHeap<T, D>
[src]
impl<T, D: Arity> IntoIterator for DaryHeap<T, D>
[src]
type Item = T
The type of the elements being iterated over.
type IntoIter = IntoIter<T>
Which kind of iterator are we turning this into?
fn into_iter(self) -> IntoIter<T>ⓘ
[src]
Creates a consuming iterator, that is, one that moves each value out of the d-ary heap in arbitrary order. The d-ary heap cannot be used after calling this.
Examples
Basic usage:
use dary_heap::BinaryHeap; let heap = BinaryHeap::from(vec![1, 2, 3, 4]); // Print 1, 2, 3, 4 in arbitrary order for x in heap.into_iter() { // x has type i32, not &i32 println!("{}", x); }
impl<'a, T, D: Arity> IntoIterator for &'a DaryHeap<T, D>
[src]
type Item = &'a T
The type of the elements being iterated over.
type IntoIter = Iter<'a, T>
Which kind of iterator are we turning this into?
fn into_iter(self) -> Iter<'a, T>ⓘ
[src]
impl<T, D: Arity> Serialize for DaryHeap<T, D> where
T: Serialize,
[src]
T: Serialize,
Auto Trait Implementations
impl<T, D> RefUnwindSafe for DaryHeap<T, D> where
D: RefUnwindSafe,
T: RefUnwindSafe,
D: RefUnwindSafe,
T: RefUnwindSafe,
impl<T, D> Send for DaryHeap<T, D> where
D: Send,
T: Send,
D: Send,
T: Send,
impl<T, D> Sync for DaryHeap<T, D> where
D: Sync,
T: Sync,
D: Sync,
T: Sync,
impl<T, D> Unpin for DaryHeap<T, D> where
D: Unpin,
T: Unpin,
D: Unpin,
T: Unpin,
impl<T, D> UnwindSafe for DaryHeap<T, D> where
D: UnwindSafe,
T: UnwindSafe,
D: UnwindSafe,
T: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<I> IntoIterator for I where
I: Iterator,
[src]
I: Iterator,
type Item = <I as Iterator>::Item
The type of the elements being iterated over.
type IntoIter = I
Which kind of iterator are we turning this into?
fn into_iter(self) -> I
[src]
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,