/
index.html
371 lines (309 loc) · 16.1 KB
/
index.html
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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>clojure.data.priority-map - Priority maps 0.0.8 API documentation</title>
<link rel="icon" href="static/favicon.png" />
<link rel="shortcut icon" href="static/favicon.png" />
<link rel="stylesheet" href="static/clojure.css" type="text/css" media="all" />
<link rel="stylesheet" href="static/wiki.css" type="text/css" media="all" />
<link rel="stylesheet" href="static/internal.css" type="text/css" media="all" />
<style>.menuWrapper{height: 36px;}</style>
</head>
<!--
This document was auto-generated from the source by the clojure autodoc system.
To report errors or ask questions about the overall documentation structure, formatting,
etc., contact Tom Faulhaber (google mail name: tomfaulhaber).
For errors in the documentation of a particular namespace, contact the author of that
namespace.
-->
<body>
<div id="AllContentContainer">
<div id="Header">
<a href="index.html" id="Logo"><img src="static/clojure-icon.gif" width="100" height="100" alt="Clojure" /></a>
<h1><a href="index.html" id="page-header" title="page header title">data.priority-map API Reference</a></h1>
</div>
<div id="leftcolumn"><div style="text-align: center;"></div>
<div class="menu">
<div class="WikiCustomNav WikiElement wiki">
<span class="toc-header"><span id="project-name">Priority maps</span> <span id="version">0.0.8</span> API</span><br />
<ul>
<li><a href="index.html" class="wiki_link">Overview</a></li>
<li><a href="api-index.html" class="wiki_link">API Index</a></li>
</ul>
<a class="wiki_link" href="http://clojure.org">Clojure Home</a>
</div>
</div>
</div>
<div id="rightcolumn">
<div id="Content">
<div class="contentBox"><div class="innerContentBox">
<div class="wiki wikiPage" id="content_view">
<div id="right-sidebar"><div id="toc">
<h1 class="nopad">Table of Contents</h1>
<div class="toc-section" style="margin-left: 1em;">
<a style="margin-top: 3px;" href="#toc0">Overview</a>
</div><div class="toc-section" style="margin-left: 1em;">
<a style="margin-top: 3px;" href="#"></a>
</div><div class="toc-section" style="margin-left: 1em;">
<a style="margin-top: 3px;" href="#type-section">Types</a>
<div class="toc-entry" style="margin-left: 1em;">
<a href="#clojure.data.priority-map/PersistentPriorityMap" class="toc-entry-anchor">PersistentPriorityMap</a>
</div>
</div><div class="toc-section" style="margin-left: 1em;">
<a style="margin-top: 3px;" href="#var-section">Vars and Functions</a>
<div class="toc-entry" style="margin-left: 1em;">
<a href="#clojure.data.priority-map/->PersistentPriorityMap" class="toc-entry-anchor">->PersistentPriorityMap</a>
</div><div class="toc-entry" style="margin-left: 1em;">
<a href="#clojure.data.priority-map/priority-map" class="toc-entry-anchor">priority-map</a>
</div><div class="toc-entry" style="margin-left: 1em;">
<a href="#clojure.data.priority-map/priority-map-by" class="toc-entry-anchor">priority-map-by</a>
</div><div class="toc-entry" style="margin-left: 1em;">
<a href="#clojure.data.priority-map/priority-map-keyfn" class="toc-entry-anchor">priority-map-keyfn</a>
</div><div class="toc-entry" style="margin-left: 1em;">
<a href="#clojure.data.priority-map/priority-map-keyfn-by" class="toc-entry-anchor">priority-map-keyfn-by</a>
</div>
</div><div class="toc-section" style="margin-left: 1em;">
<a style="margin-top: 3px;" href="#"></a>
</div>
</div>
</div>
<div id="content-tag"><h1 id="overview">API for <span id="clojure.data.priority-map">clojure.data.priority-map</span>
- <span id="header-project">Priority maps</span> <span id="header-version">0.0.8</span><span id="header-status-block"> (<span id="header-status">in development</span>)</span>
</h1>
<span id="author-line">by <span id="author-name">Mark Engelberg</span><br /></span>
<br />Full namespace name: <span id="long-name">clojure.data.priority-map</span>
<p></p>
<h2>Overview</h2>
<div id="home-page">Project home page is <a href="http://github.com/clojure/data.priority-map/">http://github.com/clojure/data.priority-map/</a></div>
<pre id="namespace-docstr">A priority map is very similar to a sorted map, but whereas a sorted map produces a
sequence of the entries sorted by key, a priority map produces the entries sorted by value.
In addition to supporting all the functions a sorted map supports, a priority map
can also be thought of as a queue of [item priority] pairs. To support usage as
a versatile priority queue, priority maps also support conj/peek/pop operations.
The standard way to construct a priority map is with priority-map:
user=> (def p (priority-map :a 2 :b 1 :c 3 :d 5 :e 4 :f 3))
#'user/p
user=> p
{:b 1, :a 2, :c 3, :f 3, :e 4, :d 5}
So :b has priority 1, :a has priority 2, and so on.
Notice how the priority map prints in an order sorted by its priorities (i.e., the map's values)
We can use assoc to assign a priority to a new item:
user=> (assoc p :g 1)
{:b 1, :g 1, :a 2, :c 3, :f 3, :e 4, :d 5}
or to assign a new priority to an extant item:
user=> (assoc p :c 4)
{:b 1, :a 2, :f 3, :c 4, :e 4, :d 5}
We can remove an item from the priority map:
user=> (dissoc p :e)
{:b 1, :a 2, :c 3, :f 3, :d 5}
An alternative way to add to the priority map is to conj a [item priority] pair:
user=> (conj p [:g 0])
{:g 0, :b 1, :a 2, :c 3, :f 3, :e 4, :d 5}
or use into:
user=> (into p [[:g 0] [:h 1] [:i 2]])
{:g 0, :b 1, :h 1, :a 2, :i 2, :c 3, :f 3, :e 4, :d 5}
Priority maps are countable:
user=> (count p)
6
Like other maps, equivalence is based not on type, but on contents.
In other words, just as a sorted-map can be equal to a hash-map,
so can a priority-map.
user=> (= p {:b 1, :a 2, :c 3, :f 3, :e 4, :d 5})
true
You can test them for emptiness:
user=> (empty? (priority-map))
true
user=> (empty? p)
false
You can test whether an item is in the priority map:
user=> (contains? p :a)
true
user=> (contains? p :g)
false
It is easy to look up the priority of a given item, using any of the standard map mechanisms:
user=> (get p :a)
2
user=> (get p :g 10)
10
user=> (p :a)
2
user=> (:a p)
2
Priority maps derive much of their utility by providing priority-based seq.
Note that no guarantees are made about the order in which items of the same priority appear.
user=> (seq p)
([:b 1] [:a 2] [:c 3] [:f 3] [:e 4] [:d 5])
Because no guarantees are made about the order of same-priority items, note that
rseq might not be an exact reverse of the seq. It is only guaranteed to be in
descending order.
user=> (rseq p)
([:d 5] [:e 4] [:c 3] [:f 3] [:a 2] [:b 1])
This means first/rest/next/for/map/etc. all operate in priority order.
user=> (first p)
[:b 1]
user=> (rest p)
([:a 2] [:c 3] [:f 3] [:e 4] [:d 5])
Priority maps support metadata:
user=> (meta (with-meta p {:extra :info}))
{:extra :info}
But perhaps most importantly, priority maps can also function as priority queues.
peek, like first, gives you the first [item priority] pair in the collection.
pop removes the first [item priority] from the collection.
(Note that unlike rest, which returns a seq, pop returns a priority map).
user=> (peek p)
[:b 1]
user=> (pop p)
{:a 2, :c 3, :f 3, :e 4, :d 5}
It is also possible to use a custom comparator:
user=> (priority-map-by > :a 1 :b 2 :c 3)
{:c 3, :b 2, :a 1}
Sometimes, it is desirable to have a map where the values contain more information
than just the priority. For example, let's say you want a map like:
{:a [2 :apple], :b [1 :banana], :c [3 :carrot]}
and you want to sort the map by the numeric priority found in the pair.
A common mistake is to try to solve this with a custom comparator:
(priority-map
(fn [[priority1 _] [priority2 _]] (< priority1 priority2))
:a [2 :apple], :b [1 :banana], :c [3 :carrot])
This will not work! In Clojure, like Java, all comparators must be total orders,
meaning that you can't have a tie unless the objects you are comparing are
in fact equal. The above comparator breaks that rule because
[2 :apple] and [2 :apricot] tie, but are not equal.
The correct way to construct such a priority map is by specifying a keyfn, which is used
to extract the true priority from the priority map's vals. (Note: It might seem a little odd
that the priority-extraction function is called a *key*fn, even though it is applied to the
map's values. This terminology is based on the docstring of clojure.core/sort-by, which
uses `keyfn` for the function which extracts the sort order.)
In the above example,
user=> (priority-map-keyfn first :a [2 :apple], :b [1 :banana], :c [3 :carrot])
{:b [1 :banana], :a [2 :apple], :c [3 :carrot]}
You can also combine a keyfn with a comparator that operates on the extracted priorities:
user=> (priority-map-keyfn-by
first >
:a [2 :apple], :b [1 :banana], :c [3 :carrot])
{:c [3 :carrot], :a [2 :apple], :b [1 :banana]}
All of these operations are efficient. Generally speaking, most operations
are O(log n) where n is the number of distinct priorities. Some operations
(for example, straightforward lookup of an item's priority, or testing
whether a given item is in the priority map) are as efficient
as Clojure's built-in map.
The key to this efficiency is that internally, not only does the priority map store
an ordinary hash map of items to priority, but it also stores a sorted map that
maps priorities to sets of items with that priority.
A typical textbook priority queue data structure supports at the ability to add
a [item priority] pair to the queue, and to pop/peek the next [item priority] pair.
But many real-world applications of priority queues require more features, such
as the ability to test whether something is already in the queue, or to reassign
a priority. For example, a standard formulation of Dijkstra's algorithm requires the
ability to reduce the priority number associated with a given item. Once you
throw persistence into the mix with the desire to adjust priorities, the traditional
structures just don't work that well.
This particular blend of Clojure's built-in hash sets, hash maps, and sorted maps
proved to be a great way to implement an especially flexible persistent priority queue.
Connoisseurs of algorithms will note that this structure's peek operation is not O(1) as
it would be if based upon a heap data structure, but I feel this is a small concession for
the blend of persistence, priority reassignment, and priority-sorted seq, which can be
quite expensive to achieve with a heap (I did actually try this for comparison). Furthermore,
this peek's logarithmic behavior is quite good (on my computer I can do a million
peeks at a priority map with a million items in 750ms). Also, consider that peek and pop
usually follow one another, and even with a heap, pop is logarithmic. So the net combination
of peek and pop is not much different between this versatile formulation of a priority map and
a more limited heap-based one. In a nutshell, peek, although not O(1), is unlikely to be the
bottleneck in your program.
All in all, I hope you will find priority maps to be an easy-to-use and useful addition
to Clojure's assortment of built-in maps (hash-map and sorted-map).</pre>
<br />
<div id="type-section">
<p></p>
<h2>Types</h2>
<div id="type-entry">
<br />
<hr />
<h2 id="clojure.data.priority-map/PersistentPriorityMap">PersistentPriorityMap</h2>
<span id="type-type">type</span><br />
<pre id="type-docstr"></pre>
Fields: <span id="type-fields">[priority->set-of-items item->priority _meta keyfn]</span><br />
Protocols: <span id="type-protocols"></span><br />
Interfaces: <span id="type-interfaces">clojure.lang.IFn, clojure.lang.ILookup, clojure.lang.IObj, clojure.lang.IPersistentMap, clojure.lang.IPersistentStack, clojure.lang.MapEquivalence, clojure.lang.Reversible, java.io.Serializable, java.lang.Iterable, java.util.Map</span><br />
</div>
</div>
<div id="var-section">
<p></p>
<h2>Public Variables and Functions</h2>
<div id="var-entry">
<br />
<hr />
<h2 id="clojure.data.priority-map/->PersistentPriorityMap">->PersistentPriorityMap</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (->PersistentPriorityMap priority->set-of-items item->priority _meta keyfn)
</pre>
<pre id="var-docstr">Positional factory function for class clojure.data.priority_map.PersistentPriorityMap.</pre>
<pre id="var-specs"></pre>
<a id="var-source" href="https://github.com/clojure/data.priority-map/blob/f06c67015b621af712fbabe2f495878945158a40/src/main/clojure/clojure/data/priority_map.clj#L203">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.data.priority-map/priority-map">priority-map</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (priority-map & keyvals)
</pre>
<pre id="var-docstr">Usage: (priority-map key val key val ...)
Returns a new priority map with optional supplied mappings.
(priority-map) returns an empty priority map.</pre>
<pre id="var-specs"></pre>
<a id="var-source" href="https://github.com/clojure/data.priority-map/blob/f06c67015b621af712fbabe2f495878945158a40/src/main/clojure/clojure/data/priority_map.clj#L391">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.data.priority-map/priority-map-by">priority-map-by</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (priority-map-by comparator & keyvals)
</pre>
<pre id="var-docstr">Usage: (priority-map comparator key val key val ...)
Returns a new priority map with custom comparator and optional supplied mappings.
(priority-map-by comparator) yields an empty priority map with custom comparator.</pre>
<pre id="var-specs"></pre>
<a id="var-source" href="https://github.com/clojure/data.priority-map/blob/f06c67015b621af712fbabe2f495878945158a40/src/main/clojure/clojure/data/priority_map.clj#L399">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.data.priority-map/priority-map-keyfn">priority-map-keyfn</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (priority-map-keyfn keyfn & keyvals)
</pre>
<pre id="var-docstr">Usage: (priority-map-keyfn keyfn key val key val ...)
Returns a new priority map with custom keyfn and optional supplied mappings.
The priority is determined by comparing (keyfn val).
(priority-map-keyfn keyfn) yields an empty priority map with custom keyfn.</pre>
<pre id="var-specs"></pre>
<a id="var-source" href="https://github.com/clojure/data.priority-map/blob/f06c67015b621af712fbabe2f495878945158a40/src/main/clojure/clojure/data/priority_map.clj#L407">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.data.priority-map/priority-map-keyfn-by">priority-map-keyfn-by</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (priority-map-keyfn-by keyfn comparator & keyvals)
</pre>
<pre id="var-docstr">Usage: (priority-map-keyfn-by keyfn comparator key val key val ...)
Returns a new priority map with custom keyfn, custom comparator, and optional supplied mappings.
The priority is determined by comparing (keyfn val).
(priority-map-keyfn-by keyfn comparator) yields an empty priority map with custom keyfn and comparator.</pre>
<pre id="var-specs"></pre>
<a id="var-source" href="https://github.com/clojure/data.priority-map/blob/f06c67015b621af712fbabe2f495878945158a40/src/main/clojure/clojure/data/priority_map.clj#L416">Source</a>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="foot">
<div id="copyright" style="text-align: center;">Copyright 2007-2016 by Rich Hickey and the various contributors</div>
</div>
</div>
<div id="DesignedBy">Logo & site design by <a href="http://www.tomhickey.com" title="Visit Tom Hickey's website.">Tom Hickey</a>.<br />
Clojure auto-documentation system by Tom Faulhaber.</div>
</div>
<!-- /AllContentContainer -->
</body>
</html>