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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
|
/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
/*
* This code is based on the CRAB engine
*
* Copyright (c) Arvind Raja Yadav
*
* Licensed under MIT
*
*/
#ifndef CRAB_PRIORITYQUEUE_H
#define CRAB_PRIORITYQUEUE_H
namespace Crab {
//! \brief The open heap used by all cost-based search algorithms.
//!
//! This class template is basically a thin wrapper on top of both the <code>std::deque</code>
//! class template and the <a href="http://www.sgi.com/tech/stl/">STL</a> heap operations.
template<typename Node>
class PriorityQueue {
Common::Array<Node *> _open;
bool (*compare)(Node const *, Node const *);
public:
//! \brief Constructs a new <code>%PriorityQueue</code> that heap-sorts nodes
//! using the specified comparator.
explicit PriorityQueue(bool (*)(Node const *, Node const *));
//! \brief Returns <code>true</code> if the heap contains no nodes,
//! <code>false</code> otherwise.
bool empty() const;
//! \brief Removes all nodes from the heap.
//!
//! \post
//! - <code>empty()</code>
void clear();
//! \brief Returns the number of nodes currently in the heap.
size_t size() const;
//! \brief Pushes the specified node onto the heap.
//!
//! The heap will maintain the ordering of its nodes during this operation.
//!
//! \post
//! - <code>! empty()</code>
void push(Node *node);
//! \brief Returns the least costly node in the heap.
//!
//! \pre
//! - <code>! empty()</code>
Node *front() const;
//! \brief Removes the least costly node from the heap.
//!
//! The heap will maintain the ordering of its nodes during this operation.
//!
//! \pre
//! - <code>! empty()</code>
void pop();
//! \brief Removes all instances of the specified node from the heap.
void remove(Node const *node);
//! \brief Enumerates all nodes in the heap so far.
//!
//! \param sorted the container to which each node will be added.
//!
//! \pre
//! - There must be no <code>NULL</code> pointers in the heap.
//! \post
//! - All nodes should be sorted by this heap's comparator.
void enumerate(Common::Array<Node const *> &sorted) const;
};
template<typename Node>
PriorityQueue<Node>::PriorityQueue(bool (*c)(Node const *, Node const *)) : _open(), compare(c) {
}
template<typename Node>
bool PriorityQueue<Node>::empty() const {
return _open.empty();
}
template<typename Node>
void PriorityQueue<Node>::clear() {
_open.clear();
}
template<typename Node>
size_t PriorityQueue<Node>::size() const {
return _open.size();
}
template<typename Node>
void PriorityQueue<Node>::push(Node *node) {
_open.insert(Common::upperBound(_open.begin(), _open.end(), node, compare), node);
}
template<typename Node>
Node *PriorityQueue<Node>::front() const {
return _open.back();
}
template<typename Node>
void PriorityQueue<Node>::pop() {
_open.pop_back();
}
template<typename Node>
void PriorityQueue<Node>::remove(Node const *node) {
_open.erase(Common::remove(_open.begin(), _open.end(), node), _open.end());
}
template<typename Node>
void PriorityQueue<Node>::enumerate(Common::Array<Node const *> &sorted) const {
sorted.resize(_open.size());
Common::copy(_open.begin(), _open.end(), sorted.begin());
}
} // End of namespace Crab
#endif // CRAB_PRIORITYQUEUE_H
|
