Struct orx_priority_queue::DaryHeap
source · pub struct DaryHeap<N, K, const D: usize>where
N: Clone,
K: PartialOrd + Clone,{ /* private fields */ }
Expand description
A d-ary heap which implements PriorityQueue
and PriorityQueueDecKey
.
Examples
Heap as PriorityQueue
Usage of d-ary heap as a basic priority queue.
use orx_priority_queue::prelude::*;
fn test_priority_queue<P>(mut pq: P)
where
P: PriorityQueue<usize, f64>
{
pq.clear();
pq.push(0, 42.0);
assert_eq!(Some(&(0, 42.0)), pq.peek());
pq.push(1, 7.0);
assert_eq!(Some(&(1, 7.0)), pq.peek());
let popped = pq.pop();
assert_eq!(Some((1, 7.0)), popped);
let popped = pq.pop();
assert_eq!(Some((0, 42.0)), popped);
assert!(pq.is_empty());
}
// basic quaternary heap without any means to located existing nodes
test_priority_queue(DaryHeap::<_, _, 4>::default());
test_priority_queue(DaryHeap::<_, _, 4>::with_capacity(16));
// octonary heap using map to locate existing nodes (although decrease-key is not used here)
test_priority_queue(DaryHeapWithMap::<_, _, 8>::default());
test_priority_queue(DaryHeapWithMap::<_, _, 8>::with_capacity(64));
// binary heap using id's to locate existing nodes (although decrease-key is not used here)
test_priority_queue(DaryHeapOfIndices::<_, _, 2>::with_upper_limit(32));
Heap as PriorityQueueDecKey
Usage of a d-ary heap as a priority queue with decrease key operation and its variants.
use orx_priority_queue::prelude::*;
fn test_priority_queue_deckey<P>(mut pq: P)
where
P: PriorityQueueDecKey<usize, f64>
{
pq.clear();
pq.push(0, 42.0);
assert_eq!(Some(&(0, 42.0)), pq.peek());
pq.push(1, 17.0);
assert_eq!(Some(&(1, 17.0)), pq.peek());
pq.decrease_key(&0, &7.0);
assert_eq!(Some(&(0, 7.0)), pq.peek());
let is_key_decreased = pq.try_decrease_key(&1, &20.0);
assert!(!is_key_decreased);
let popped = pq.pop();
assert_eq!(Some((0, 7.0)), popped);
let popped = pq.pop();
assert_eq!(Some((1, 17.0)), popped);
assert!(pq.is_empty());
}
// octonary heap using map to locate existing nodes
test_priority_queue_deckey(DaryHeapWithMap::<_, _, 8>::default());
test_priority_queue_deckey(DaryHeapWithMap::<_, _, 8>::with_capacity(64));
// binary heap using id's to locate existing nodes
test_priority_queue_deckey(DaryHeapOfIndices::<_, _, 2>::with_upper_limit(32));
Implementations§
source§impl<N, K, const D: usize> DaryHeap<N, K, D>where
N: Clone,
K: PartialOrd + Clone,
impl<N, K, const D: usize> DaryHeap<N, K, D>where N: Clone, K: PartialOrd + Clone,
sourcepub fn with_capacity(capacity: usize) -> Self
pub fn with_capacity(capacity: usize) -> Self
Creates a new d-ary heap with the given initial capacity
on the number of nodes to simultaneously exist on the heap.
Trait Implementations§
source§impl<N, K, const D: usize> Clone for DaryHeap<N, K, D>where
N: Clone + Clone,
K: PartialOrd + Clone + Clone,
impl<N, K, const D: usize> Clone for DaryHeap<N, K, D>where N: Clone + Clone, K: PartialOrd + Clone + Clone,
source§impl<N, K, const D: usize> Debug for DaryHeap<N, K, D>where
N: Clone + Debug,
K: PartialOrd + Clone + Debug,
impl<N, K, const D: usize> Debug for DaryHeap<N, K, D>where N: Clone + Debug, K: PartialOrd + Clone + Debug,
source§impl<N, K, const D: usize> Default for DaryHeap<N, K, D>where
N: Clone,
K: PartialOrd + Clone,
impl<N, K, const D: usize> Default for DaryHeap<N, K, D>where N: Clone, K: PartialOrd + Clone,
source§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 DaryHeap<N, K, D>where N: Clone, K: PartialOrd + Clone,
source§fn 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.
source§fn 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.
source§fn 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.
source§fn 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.
source§fn 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.
source§fn push_then_pop(&mut self, node: N, key: K) -> (N, K)
fn push_then_pop(&mut self, node: N, key: K) -> (N, K)
Auto Trait Implementations§
impl<N, K, const D: usize> RefUnwindSafe for DaryHeap<N, K, D>where K: RefUnwindSafe, N: RefUnwindSafe,
impl<N, K, const D: usize> Send for DaryHeap<N, K, D>where K: Send, N: Send,
impl<N, K, const D: usize> Sync for DaryHeap<N, K, D>where K: Sync, N: Sync,
impl<N, K, const D: usize> Unpin for DaryHeap<N, K, D>where K: Unpin, N: Unpin,
impl<N, K, const D: usize> UnwindSafe for DaryHeap<N, K, D>where K: UnwindSafe, N: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more