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
|
<!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!--
Generated from r6rs-lib.tex by tex2page, v 20070803
(running on MzScheme 371, unix),
(c) Dorai Sitaram,
http://www.ccs.neu.edu/~dorai/tex2page/tex2page-doc.html
-->
<head>
<title>
r6rs-lib
</title>
<link rel="stylesheet" type="text/css" href="r6rs-lib-Z-S.css" title=default>
<meta name=robots content="index,follow">
</head>
<body>
<div id=slidecontent>
<div align=right class=navigation>[Go to <span><a href="r6rs-lib.html">first</a>, <a href="r6rs-lib-Z-H-13.html">previous</a></span><span>, <a href="r6rs-lib-Z-H-15.html">next</a></span> page<span>; </span><span><a href="r6rs-lib-Z-H-1.html#node_toc_start">contents</a></span><span><span>; </span><a href="r6rs-lib-Z-H-21.html#node_index_start">index</a></span>]</div>
<p></p>
<a name="node_chap_13"></a>
<h1 class=chapter>
<div class=chapterheading><a href="r6rs-lib-Z-H-1.html#node_toc_node_chap_13">Chapter 13</a></div><br>
<a href="r6rs-lib-Z-H-1.html#node_toc_node_chap_13">Hashtables</a></h1>
<p></p>
<p>
The <tt>(rnrs hashtables (6))</tt><a name="node_idx_1164"></a>library provides a set of operations on
hashtables.
A <a name="node_idx_1166"></a><em>hashtable</em> is a data structure that associates keys with values.
Any object can be used as a key, provided a <a name="node_idx_1168"></a><em>hash function</em>
and a suitable <a name="node_idx_1170"></a><em>equivalence function</em> is available. A hash function is a
procedure that maps
keys to exact integer objects.
It is the programmer’s responsibility to ensure that the hash function
is compatible with the equivalence function,
which is a procedure that accepts two keys and returns true if they
are equivalent and <tt>#f</tt> otherwise.
Standard hashtables for arbitrary objects based on the <tt>eq?</tt> and
<tt>eqv?</tt> predicates (see report section on “Equivalence predicates”) are provided.
Also, hash functions for arbitrary objects, strings, and symbols are provided.</p>
<p>
This section uses the <i>hashtable</i> parameter name for arguments
that must be hashtables, and the <i>key</i> parameter name for
arguments that must be hashtable keys.</p>
<p>
</p>
<a name="node_sec_13.1"></a>
<h2 class=section><a href="r6rs-lib-Z-H-1.html#node_toc_node_sec_13.1">13.1 Constructors</a></h2>
<p><a name="node_idx_1172"></a></p>
<p>
</p>
<p></p>
<div align=left><tt>(<a name="node_idx_1174"></a>make-eq-hashtable<i></i>)</tt> procedure </div>
<div align=left><tt>(<a name="node_idx_1176"></a>make-eq-hashtable<i> <i>k</i></i>)</tt> procedure </div>
<p>
Returns a newly allocated mutable hashtable that accepts
arbitrary objects as keys,
and compares those keys with <tt>eq?</tt>. If an argument is given, the initial
capacity of the hashtable is set to approximately <i>k</i> elements.</p>
<p>
</p>
<p></p>
<p>
</p>
<p></p>
<div align=left><tt>(<a name="node_idx_1178"></a>make-eqv-hashtable<i></i>)</tt> procedure </div>
<div align=left><tt>(<a name="node_idx_1180"></a>make-eqv-hashtable<i> <i>k</i></i>)</tt> procedure </div>
<p>
Returns a newly allocated mutable hashtable that accepts
arbitrary objects as keys,
and compares those keys with <tt>eqv?</tt>.
If an argument is given, the initial
capacity of the hashtable is set to approximately <i>k</i> elements.</p>
<p>
</p>
<p></p>
<p>
</p>
<p></p>
<div align=left><tt>(<a name="node_idx_1182"></a>make-hashtable<i> <i>hash-function</i> <i>equiv</i></i>)</tt> procedure </div>
<div align=left><tt>(<a name="node_idx_1184"></a>make-hashtable<i> <i>hash-function</i> <i>equiv</i> <i>k</i></i>)</tt> procedure </div>
<p>
<i>Hash-function</i> and <i>equiv</i> must be procedures.
<i>Hash-function</i> should accept a key as an argument and should return a
non-negative exact integer object.
<i>Equiv</i> should accept two keys as arguments and return a single
value.
Neither procedure should mutate the hashtable returned by <tt>make-hashtable</tt>.
The <tt>make-hashtable</tt> procedure returns a newly allocated mutable
hashtable using <i>hash-function</i>
as the hash function and <i>equiv</i> as the equivalence function used to
compare keys.
If a third argument is given, the
initial capacity of the hashtable is set to approximately <i>k</i> elements.</p>
<p>
Both <i>hash-function</i> and <i>equiv</i> should behave like pure functions
on the domain of keys. For example, the <tt>string-hash</tt>
and <tt>string=?</tt> procedures are permissible only if all
keys are strings and the contents of those strings are never
changed so long as any of them continues to serve as a key in
the hashtable. Furthermore, any pair of keys for which
<i>equiv</i> returns true should
be hashed to the same exact integer objects by
<i>hash-function</i>.</p>
<p>
<em>Implementation responsibilities: </em>The implementation must check the restrictions on
<i>hash-function</i> and <i>equiv</i> to the extent performed by
applying them as described.</p>
<p>
</p>
<blockquote><em>Note: </em>
Hashtables are allowed to cache the results of calling the
hash function and equivalence function, so programs cannot
rely on the hash function being called for every lookup or
update. Furthermore any hashtable operation may call the
hash function more than once.
</blockquote><p>
</p>
<p></p>
<p>
</p>
<a name="node_sec_13.2"></a>
<h2 class=section><a href="r6rs-lib-Z-H-1.html#node_toc_node_sec_13.2">13.2 Procedures</a></h2>
<p></p>
<p></p>
<div align=left><tt>(<a name="node_idx_1186"></a>hashtable?<i> <i>hashtable</i></i>)</tt> procedure </div>
<p>
Returns <tt>#t</tt> if <i>hashtable</i> is a hashtable,
<tt>#f</tt> otherwise.
</p>
<p></p>
<p>
</p>
<p></p>
<div align=left><tt>(<a name="node_idx_1188"></a>hashtable-size<i> <i>hashtable</i></i>)</tt> procedure </div>
<p>
Returns the number of keys contained in <i>hashtable</i> as an exact
integer object.
</p>
<p></p>
<p>
</p>
<p></p>
<div align=left><tt>(<a name="node_idx_1190"></a>hashtable-ref<i> <i>hashtable</i> <i>key</i> <i>default</i></i>)</tt> procedure </div>
<p>
Returns the value in <i>hashtable</i> associated with <i>key</i>.
If <i>hashtable</i> does not contain an association for <i>key</i>,
<i>default</i> is returned.
</p>
<p></p>
<p>
</p>
<p></p>
<div align=left><tt>(<a name="node_idx_1192"></a>hashtable-set!<i> <i>hashtable</i> <i>key</i> <i>obj</i></i>)</tt> procedure </div>
<p>
Changes <i>hashtable</i> to associate <i>key</i> with <i>obj</i>,
adding a new association or replacing any existing association for <i>key</i>,
and returns unspecified values.
</p>
<p></p>
<p>
</p>
<p></p>
<div align=left><tt>(<a name="node_idx_1194"></a>hashtable-delete!<i> <i>hashtable</i> <i>key</i></i>)</tt> procedure </div>
<p>
Removes any association for <i>key</i> within <i>hashtable</i> and
returns unspecified values.
</p>
<p></p>
<p>
</p>
<p></p>
<div align=left><tt>(<a name="node_idx_1196"></a>hashtable-contains?<i> <i>hashtable</i> <i>key</i></i>)</tt> procedure </div>
<p>
Returns <tt>#t</tt> if <i>hashtable</i> contains an association
for <i>key</i>, <tt>#f</tt> otherwise.
</p>
<p></p>
<p>
</p>
<p></p>
<div align=left><tt>(<a name="node_idx_1198"></a>hashtable-update!<i> <i>hashtable</i> <i>key</i> <i>proc</i> <i>default</i></i>)</tt> procedure </div>
<p>
<i>Proc</i> should accept one argument,
should return a single value, and should not mutate <i>hashtable</i>.
The <tt>hashtable-update!</tt> procedure applies <i>proc</i> to the value in <i>hashtable</i>
associated with <i>key</i>,
or to <i>default</i> if <i>hashtable</i> does not contain an
association for <i>key</i>.
The <i>hashtable</i> is then changed to associate <i>key</i>
with the value returned by <i>proc</i>.</p>
<p>
The behavior of <tt>hashtable-update!</tt> is equivalent to the
following code, but may be implemented
more efficiently in cases where the implementation can
avoid multiple lookups of the same key:
</p>
<tt>(hashtable-set!<br>
hashtable key<br>
(proc (hashtable-ref<br>
hashtable key default)))<br>
<p></tt>
</p>
<p></p>
<p>
</p>
<p></p>
<div align=left><tt>(<a name="node_idx_1200"></a>hashtable-copy<i> <i>hashtable</i></i>)</tt> procedure </div>
<div align=left><tt>(<a name="node_idx_1202"></a>hashtable-copy<i> <i>hashtable</i> <i>mutable</i></i>)</tt> procedure </div>
<p>
Returns a copy of <i>hashtable</i>. If the
<i>mutable</i> argument is provided and is true, the returned hashtable is mutable;
otherwise it is immutable.</p>
<p>
</p>
<p>
</p>
<p></p>
<div align=left><tt>(<a name="node_idx_1204"></a>hashtable-clear!<i> <i>hashtable</i></i>)</tt> procedure </div>
<div align=left><tt>(<a name="node_idx_1206"></a>hashtable-clear!<i> <i>hashtable</i> <i>k</i></i>)</tt> procedure </div>
<p>
Removes all associations from <i>hashtable</i> and returns unspecified values.</p>
<p>
If a second argument is given, the current
capacity of the hashtable is reset to approximately <i>k</i> elements.
</p>
<p></p>
<p>
</p>
<p></p>
<div align=left><tt>(<a name="node_idx_1208"></a>hashtable-keys<i> <i>hashtable</i></i>)</tt> procedure </div>
<p>
Returns a vector of all keys in <i>hashtable</i>.
The order of the vector is unspecified.
</p>
<p></p>
<p>
</p>
<p></p>
<div align=left><tt>(<a name="node_idx_1210"></a>hashtable-entries<i> <i>hashtable</i></i>)</tt> procedure </div>
<p>
Returns two values, a vector of the keys in <i>hashtable</i>, and a
vector of the corresponding values.</p>
<p>
</p>
<tt>(let ((h (make-eqv-hashtable)))<br>
(hashtable-set! h 1 ’one)<br>
(hashtable-set! h 2 ’two)<br>
(hashtable-set! h 3 ’three)<br>
(hashtable-entries h)) <br> ⇒ <tt>#</tt>(1 2 3) <tt>#</tt>(one two three)<br>
; two return values<p></tt>
</p>
<p></p>
<p>
</p>
<a name="node_sec_13.3"></a>
<h2 class=section><a href="r6rs-lib-Z-H-1.html#node_toc_node_sec_13.3">13.3 Inspection</a></h2>
<p></p>
<p></p>
<div align=left><tt>(<a name="node_idx_1212"></a>hashtable-equivalence-function<i> <i>hashtable</i></i>)</tt> procedure </div>
<p>
Returns the equivalence function used by
<i>hashtable</i> to compare keys. For hashtables
created with <tt>make-eq-hashtable</tt> and <tt>make-eqv-hashtable</tt>,
returns <tt>eq?</tt> and <tt>eqv?</tt> respectively.
</p>
<p></p>
<p>
</p>
<p></p>
<div align=left><tt>(<a name="node_idx_1214"></a>hashtable-hash-function<i> <i>hashtable</i></i>)</tt> procedure </div>
<p>
Returns the hash function used by <i>hashtable</i>.
For hashtables created by <tt>make-eq-hashtable</tt>
or <tt>make-eqv-hashtable</tt>, <tt>#f</tt> is returned.
</p>
<p></p>
<p>
</p>
<p></p>
<div align=left><tt>(<a name="node_idx_1216"></a>hashtable-mutable?<i> <i>hashtable</i></i>)</tt> procedure </div>
<p>
Returns <tt>#t</tt> if <i>hashtable</i> is mutable, otherwise <tt>#f</tt>.
</p>
<p></p>
<p>
</p>
<a name="node_sec_13.4"></a>
<h2 class=section><a href="r6rs-lib-Z-H-1.html#node_toc_node_sec_13.4">13.4 Hash functions</a></h2>
<p>The <tt>equal-hash</tt>, <tt>string-hash</tt>, and <tt>string-ci-hash</tt>
procedures of this section are acceptable as the hash functions of
a hashtable only if the keys on which they are called are not mutated
while they remain in use as keys in the hashtable.</p>
<p>
</p>
<p></p>
<div align=left><tt>(<a name="node_idx_1218"></a>equal-hash<i> <i>obj</i></i>)</tt> procedure </div>
<p>
Returns an integer hash value for <i>obj</i>, based on
its structure and current contents. This hash function is suitable
for use with <tt>equal?</tt> as an equivalence function.</p>
<p>
</p>
<blockquote><em>Note: </em>
Like <tt>equal?</tt>, the <tt>equal-hash</tt> procedure must always
terminate, even if its arguments contain cycles.
</blockquote>
<p></p>
<p>
</p>
<p></p>
<div align=left><tt>(<a name="node_idx_1220"></a>string-hash<i> <i>string</i></i>)</tt> procedure </div>
<p>
Returns an integer hash value for <i>string</i>, based on
its current contents.
This hash function is suitable
for use with <tt>string=?</tt> as an equivalence function.
</p>
<p></p>
<p>
</p>
<p></p>
<div align=left><tt>(<a name="node_idx_1222"></a>string-ci-hash<i> <i>string</i></i>)</tt> procedure </div>
<p>
Returns an integer hash value for <i>string</i> based on
its current contents, ignoring case.
This hash function is suitable
for use with <tt>string-ci=?</tt> as an equivalence function.
</p>
<p></p>
<p>
</p>
<p></p>
<div align=left><tt>(<a name="node_idx_1224"></a>symbol-hash<i> <i>symbol</i></i>)</tt> procedure </div>
<p>
Returns an integer hash value for <i>symbol</i>.
</p>
<p></p>
<p>
</p>
<p></p>
<div class=smallskip></div>
<p style="margin-top: 0pt; margin-bottom: 0pt">
<div align=right class=navigation>[Go to <span><a href="r6rs-lib.html">first</a>, <a href="r6rs-lib-Z-H-13.html">previous</a></span><span>, <a href="r6rs-lib-Z-H-15.html">next</a></span> page<span>; </span><span><a href="r6rs-lib-Z-H-1.html#node_toc_start">contents</a></span><span><span>; </span><a href="r6rs-lib-Z-H-21.html#node_index_start">index</a></span>]</div>
</p>
<p></p>
</div>
</body>
</html>
|
