Struct gix_revwalk::PriorityQueue

pub struct PriorityQueue<K: Ord, T>(/* private fields */);

A utility type implementing a queue which can be used to automatically sort data by its time in ascending order.

Note that the performance of this queue is very relevant to overall algorithm performance of many graph-walking algorithms, and as it stands our implementation is about 6% slower in practice, probably also depending on the size of the stored data.

Implementations

impl<K: Ord, T> PriorityQueue<K, T>

pub fn new() -> Self

Create a new instance.

pub fn insert(&mut self, key: K, value: T)

Insert value so that it is ordered according to key.

pub fn pop_value(&mut self) -> Option<T>

Pop the highest-priority item value off the queue.

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

Pop the highest-priority item key and value off the queue.

pub fn iter_unordered(&self) -> impl Iterator<Item = &T>

Iterate all items ordered from highest to lowest priority.

pub fn into_iter_unordered(self) -> impl Iterator<Item = (K, T)>

Turn this instance into an iterator over its keys and values in arbitrary order.

pub fn is_empty(&self) -> bool

Return true if the queue is empty.

pub fn len(&self) -> usize

Return true the amount of items on the queue.

pub fn peek(&self) -> Option<(&K, &T)>

Returns the greatest item (K, T) tuple, as ordered by K, if the queue is not empty, without removing it.

pub fn clear(&mut self)

Drop all items from the queue, without changing its capacity.

Trait Implementations

impl<K, T> Clone for PriorityQueue<K, T>

where K: Clone + Ord, T: Clone,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Ord + Debug, T: Debug> Debug for PriorityQueue<K, T>

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

Formats the value using the given formatter.

impl<K: Default + Ord, T: Default> Default for PriorityQueue<K, T>

fn default() -> PriorityQueue<K, T>

Returns the “default value” for a type.

impl<K: Ord, T> FromIterator<(K, T)> for PriorityQueue<K, T>

fn from_iter<I: IntoIterator<Item = (K, T)>>(iter: I) -> Self

Creates a value from an iterator.