Trait orx_priority_queue::PriorityQueue
source · pub trait PriorityQueue<N, K>: Clonewhere
K: PartialOrd,{
// Required methods
fn len(&self) -> usize;
fn as_slice(&self) -> &[(N, K)];
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);
fn push_then_pop(&mut self, node: N, key: K) -> (N, K);
// Provided method
fn is_empty(&self) -> bool { ... }
}Expand description
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§
sourcefn as_slice(&self) -> &[(N, K)]
fn as_slice(&self) -> &[(N, K)]
Returns the nodes and keys currently in the queue as a slice; not necessarily sorted.
sourcefn peek(&self) -> Option<&(N, K)>
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.
sourcefn pop(&mut self) -> Option<(N, K)>
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.
sourcefn pop_node(&mut self) -> Option<N>
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.
sourcefn pop_key(&mut self) -> Option<K>
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.
sourcefn push_then_pop(&mut self, node: N, key: K) -> (N, K)
fn push_then_pop(&mut self, node: N, key: K) -> (N, K)
Performs the push with given (node, key) followed by the pop operation.
Since the queue cannot be empty after the push, the return type is not optional.
The reason of merging the calls is that handling two instructions at once is more efficient for certain implementations, such as for the binary heap.