Struct radix_heap::RadixHeapMap

pub struct RadixHeapMap<K, V> { /* private fields */ }

A montone priority queue implemented using a radix heap.

This will be a max-heap.

See the module documentation for more information.

It is a logic error for a key 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.

Implementations

impl<K: Radix + Ord + Copy, V> RadixHeapMap<K, V>

pub fn new() -> RadixHeapMap<K, V>

Create an empty RadixHeapMap

pub fn new_at(top: K) -> RadixHeapMap<K, V>

Create an empty RadixHeapMap with the top key set to a specific value.

This can be more efficient if you have a known minimum bound of the items being pushed to the heap.

pub fn clear(&mut self)

Drops all items form the RadixHeapMap and sets the top key to None.

pub fn clear_to(&mut self, top: K)

Drop all items from the RadixHeapMap and sets the top key to a specific value.

This can be more efficient if you have a known maximum bound of the items being pushed to the heap.

pub fn constrain(&mut self)

Sets the top value to the current maximum key value in the heap

pub fn push(&mut self, key: K, value: V)

Pushes a new key value pair onto the heap.

Panics

Panics if the key is larger than the current top key.

pub fn pop(&mut self) -> Option<(K, V)>

Remove the greatest element from the heap and returns it, or None if empty.

If there is a tie between multiple elements, the last inserted element will be popped first.

This will set the top key to the extracted key.

pub fn len(&self) -> usize

Returns the number of elements in the heap

pub fn is_empty(&self) -> bool

Returns true if there is no elements in the heap

pub fn top(&self) -> Option<K>

The current top value. All keys pushed onto the heap must be smaller than this value.

pub fn shrink_to_fit(&mut self)

Discards as much additional capacity as possible.

pub fn iter(&self) -> Iter<'_, K, V>

Returns an iterator of all key-value pairs in the RadixHeapMap in arbitrary order

pub fn keys(&self) -> Keys<'_, K, V>

Returns an iterator of all keys in the RadixHeapMap in arbitrary order

pub fn values(&self) -> Values<'_, K, V>

Returns an iterator of all values in the RadixHeapMap in arbitrary order

Trait Implementations

impl<K: Clone, V: Clone> Clone for RadixHeapMap<K, V>

fn clone(&self) -> RadixHeapMap<K, V>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<K: Radix + Ord + Copy + Debug, V: Debug> Debug for RadixHeapMap<K, V>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<K: Radix + Ord + Copy, V> Default for RadixHeapMap<K, V>

fn default() -> RadixHeapMap<K, V>

Returns the “default value” for a type.

impl<'a, K: Radix + Ord + Copy + 'a, V: Copy + 'a> Extend<&'a (K, V)> for RadixHeapMap<K, V>

fn extend<I>(&mut self, iter: I)

where I: IntoIterator<Item = &'a (K, V)>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<K: Radix + Ord + Copy, V> Extend<(K, V)> for RadixHeapMap<K, V>

fn extend<I>(&mut self, iter: I)

where I: IntoIterator<Item = (K, V)>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<K: Radix + Ord + Copy, V> FromIterator<(K, V)> for RadixHeapMap<K, V>

fn from_iter<I>(iter: I) -> RadixHeapMap<K, V>

where I: IntoIterator<Item = (K, V)>,

Creates a value from an iterator.

impl<'a, K: Radix + Ord + Copy, V> IntoIterator for &'a RadixHeapMap<K, V>

type Item = &'a (K, V)

The type of the elements being iterated over.

type IntoIter = Iter<'a, K, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<K: Radix + Ord + Copy, V> IntoIterator for RadixHeapMap<K, V>

type Item = (K, V)

The type of the elements being iterated over.

type IntoIter = IntoIter<K, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.