Struct radix_heap::RadixHeapMap

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

A montone priority queue implemented with a radix heap.

This will be a max-heap.

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.

Methods

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 minimum bound of the items being pushed to 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 more than the current top key.

pub fn constrain(&mut self)

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

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

Pops the largest element of the heap. This may increase the top value.

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.

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, V> Default for RadixHeapMap<K, V>

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

Returns the "default value" for a type.

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<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.

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.

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

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

Formats the value using the given formatter.