orx-priority-queue 1.8.0

Priority queue traits and high performance d-ary heap implementations.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

use crate::{
    priority_queue::PriorityQueue, PriorityQueueDecKey, ResTryDecreaseKeyOrPush, ResUpdateKey,
};
use std::hash::Hash;

impl<N, K> PriorityQueue<N, K> for priority_queue::PriorityQueue<N, K>
where
    K: PartialOrd + Ord,
    N: Ord + Hash,
{
    type NodeKey<'a> = (&'a N, &'a K) where Self: 'a, N: 'a, K: 'a;
    type Iter<'a> = priority_queue::core_iterators::Iter<'a, N, K> where Self: 'a, N: 'a, K: 'a;

    fn len(&self) -> usize {
        priority_queue::PriorityQueue::len(self)
    }

    fn capacity(&self) -> usize {
        priority_queue::PriorityQueue::capacity(self)
    }

    #[inline(always)]
    fn peek(&self) -> Option<Self::NodeKey<'_>> {
        priority_queue::PriorityQueue::peek(self)
    }

    #[inline(always)]
    fn clear(&mut self) {
        priority_queue::PriorityQueue::clear(self)
    }

    #[inline(always)]
    fn pop(&mut self) -> Option<(N, K)> {
        priority_queue::PriorityQueue::pop(self)
    }

    #[inline(always)]
    fn pop_node(&mut self) -> Option<N> {
        priority_queue::PriorityQueue::pop(self).map(|x| x.0)
    }

    #[inline(always)]
    fn pop_key(&mut self) -> Option<K> {
        priority_queue::PriorityQueue::pop(self).map(|x| x.1)
    }

    #[inline(always)]
    fn push(&mut self, node: N, key: K) {
        priority_queue::PriorityQueue::push(self, node, key);
    }

    #[inline(always)]
    fn push_then_pop(&mut self, node: N, key: K) -> (N, K) {
        priority_queue::PriorityQueue::push(self, node, key);
        priority_queue::PriorityQueue::pop(self).expect("queue is not empty")
    }

    fn iter(&self) -> Self::Iter<'_> {
        priority_queue::PriorityQueue::iter(self)
    }
}

impl<N, K> PriorityQueueDecKey<N, K> for priority_queue::PriorityQueue<N, K>
where
    K: PartialOrd + Ord + Clone,
    N: Ord + Hash + Clone,
{
    #[inline(always)]
    fn contains(&self, node: &N) -> bool {
        priority_queue::PriorityQueue::get(self, node).is_some()
    }

    #[inline(always)]
    fn key_of(&self, node: &N) -> Option<K> {
        priority_queue::PriorityQueue::get(self, node).map(|x| x.1.clone())
    }

    fn decrease_key(&mut self, node: &N, decreased_key: K) {
        let old_key =
            priority_queue::PriorityQueue::change_priority(self, node, decreased_key.clone())
                .expect("Failed to update key of the node, it is not present in the queue");
        let _decreased = (if decreased_key <= old_key {
            Some(true)
        } else {
            None
        })
        .expect("Failed to decrease the key of the node, received a greater key");
    }

    fn update_key(&mut self, node: &N, new_key: K) -> ResUpdateKey {
        let old_key = priority_queue::PriorityQueue::change_priority(self, node, new_key.clone())
            .expect("Failed to update key of the node, it is not present in the queue");
        if new_key < old_key {
            ResUpdateKey::Decreased
        } else {
            ResUpdateKey::Increased
        }
    }

    #[inline(always)]
    fn remove(&mut self, node: &N) -> K {
        priority_queue::PriorityQueue::remove(self, node)
            .expect("Failed to remove the node, it is not present in the queue")
            .1
    }

    fn try_decrease_key_or_push(&mut self, node: &N, key: K) -> ResTryDecreaseKeyOrPush {
        let old_key = priority_queue::PriorityQueue::push_decrease(self, node.clone(), key.clone());
        match old_key {
            None => ResTryDecreaseKeyOrPush::Pushed,
            Some(old_key) => {
                if old_key <= key {
                    ResTryDecreaseKeyOrPush::Unchanged
                } else {
                    ResTryDecreaseKeyOrPush::Decreased
                }
            }
        }
    }
}