Trait orx_priority_queue::PriorityQueue

pub trait PriorityQueue<N, K>where
    K: PartialOrd,{
    // Required methods
    fn len(&self) -> usize;
    fn peek(&self) -> Option<&(N, K)>;
    fn clear(&mut self);
    fn pop(&mut self) -> Option<(N, K)>;
    fn pop_node(&mut self) -> Option<N>;
    fn pop_key(&mut self) -> Option<K>;
    fn push(&mut self, node: N, key: K);

    // Provided method
    fn is_empty(&self) -> bool { ... }
}

A priority queue which allows pushing ([N], [K])=(node, key) pairs to the collection, and popping the foremost element having the lowest key.

Required Methods

fn len(&self) -> usize

Number of elements in the queue.

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

Returns, without popping, a reference to the foremost element of the queue; returns None if the queue is empty.

fn clear(&mut self)

Clears the queue.

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

Removes and returns the (node, key) pair with the lowest key in the queue; returns None if the queue is empty.

fn pop_node(&mut self) -> Option<N>

Removes and returns the node with the lowest key in the queue; returns None if the queue is empty.

fn pop_key(&mut self) -> Option<K>

Removes and returns the key of the node with the lowest key in the queue; returns None if the queue is empty.

fn push(&mut self, node: N, key: K)

Pushes the given ([node], [key]) pair to the queue.

Provided Methods

fn is_empty(&self) -> bool

Returns whether he queue is empty or not.

Implementors

impl<N, K, const D: usize> PriorityQueue<N, K> for DaryHeap<N, K, D>where N: Clone, K: PartialOrd + Clone,

impl<N, K, const D: usize> PriorityQueue<N, K> for DaryHeapOfIndices<N, K, D>where N: HasIndex, K: PartialOrd + Clone,

impl<N, K, const D: usize> PriorityQueue<N, K> for DaryHeapWithMap<N, K, D>where N: Eq + Hash + Clone, K: PartialOrd + Clone,