Struct gix_revision::PriorityQueue

pub struct PriorityQueue<K: Ord, T>(_);

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 insert(&mut self, key: K, value: T)

Insert value so that it is ordered according to key.

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

Pop the highest-priority item off the queue.

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

Iterate all items ordered from highest to lowest priority.

pub fn is_empty(&self) -> bool

Return true if the queue is empty.

Trait Implementations

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.