Mercurial > emacs
annotate lispref/hash.texi @ 53034:eb00830302e9
("Kannada"): Add sample-text.
author | Kenichi Handa <handa@m17n.org> |
---|---|
date | Mon, 10 Nov 2003 07:19:22 +0000 |
parents | 53be3d7fa5da |
children | 9958d8677feb |
rev | line source |
---|---|
25634 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
51585
b29f076f791a
(Creating Hash): Fix description of :weakness.
Andreas Schwab <schwab@suse.de>
parents:
49600
diff
changeset
|
3 @c Copyright (C) 1999, 2003 Free Software Foundation, Inc. |
25634 | 4 @c See the file elisp.texi for copying conditions. |
5 @setfilename ../info/hash | |
6 @node Hash Tables, Symbols, Sequences Arrays Vectors, Top | |
7 @chapter Hash Tables | |
8 @cindex hash tables | |
9 | |
10 A hash table is a very fast kind of lookup table, somewhat like | |
11 an alist in that it maps keys to corresponding values. It differs | |
12 from an alist in these ways: | |
13 | |
14 @itemize @bullet | |
15 @item | |
26710
ed440ffea308
(Hash Tables): Note that alists win for small tables.
Dave Love <fx@gnu.org>
parents:
26303
diff
changeset
|
16 Lookup in a hash table is extremely fast for large tables---in fact, the |
ed440ffea308
(Hash Tables): Note that alists win for small tables.
Dave Love <fx@gnu.org>
parents:
26303
diff
changeset
|
17 time required is essentially @emph{independent} of how many elements are |
ed440ffea308
(Hash Tables): Note that alists win for small tables.
Dave Love <fx@gnu.org>
parents:
26303
diff
changeset
|
18 stored in the table. For smaller tables (a few tens of elements) |
ed440ffea308
(Hash Tables): Note that alists win for small tables.
Dave Love <fx@gnu.org>
parents:
26303
diff
changeset
|
19 alists may still be faster because hash tables have a more-or-less |
ed440ffea308
(Hash Tables): Note that alists win for small tables.
Dave Love <fx@gnu.org>
parents:
26303
diff
changeset
|
20 constant overhead. |
25634 | 21 |
22 @item | |
23 The correspondences in a hash table are in no particular order. | |
24 | |
25 @item | |
26 There is no way to share structure between two hash tables, | |
27 the way two alists can share a common tail. | |
28 @end itemize | |
29 | |
30 Emacs Lisp (starting with Emacs 21) provides a general-purpose hash | |
31 table data type, along with a series of functions for operating on them. | |
32 Hash tables have no read syntax, and print in hash notation, like this: | |
33 | |
34 @example | |
35 (make-hash-table) | |
36 @result{} #<hash-table 'eql nil 0/65 0x83af980> | |
37 @end example | |
38 | |
26303 | 39 @noindent |
40 (The term ``hash notation'' refers to the initial @samp{#} | |
41 character---@pxref{Printed Representation}---and has nothing to do with | |
42 the term ``hash table.'') | |
43 | |
25634 | 44 Obarrays are also a kind of hash table, but they are a different type |
45 of object and are used only for recording interned symbols | |
46 (@pxref{Creating Symbols}). | |
47 | |
48 @menu | |
49 * Creating Hash:: | |
50 * Hash Access:: | |
51 * Defining Hash:: | |
52 * Other Hash:: | |
53 @end menu | |
54 | |
55 @node Creating Hash | |
56 @section Creating Hash Tables | |
57 | |
58 The principal function for creating a hash table is | |
59 @code{make-hash-table}. | |
60 | |
61 @tindex make-hash-table | |
62 @defun make-hash-table &rest keyword-args | |
63 This function creates a new hash table according to the specified | |
64 arguments. The arguments should consist of alternating keywords | |
65 (particular symbols recognized specially) and values corresponding to | |
66 them. | |
67 | |
68 Several keywords make sense in @code{make-hash-table}, but the only two | |
26182 | 69 that you really need to know about are @code{:test} and @code{:weakness}. |
25634 | 70 |
71 @table @code | |
72 @item :test @var{test} | |
73 This specifies the method of key lookup for this hash table. The | |
74 default is @code{eql}; @code{eq} and @code{equal} are other | |
75 alternatives: | |
76 | |
77 @table @code | |
78 @item eql | |
53025
53be3d7fa5da
(Creating Hash): Clarify description of `eql'. `makehash' is obsolete.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
79 Keys which are numbers are ``the same'' if they are @code{equal}, that |
53be3d7fa5da
(Creating Hash): Clarify description of `eql'. `makehash' is obsolete.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
80 is, if they are equal in value and either both are integers or both |
53be3d7fa5da
(Creating Hash): Clarify description of `eql'. `makehash' is obsolete.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
81 are floats; otherwise, two distinct objects are never ``the same''. |
25634 | 82 |
83 @item eq | |
84 Any two distinct Lisp objects are ``different'' as keys. | |
85 | |
86 @item equal | |
87 Two Lisp objects are ``the same'', as keys, if they are equal | |
88 according to @code{equal}. | |
89 @end table | |
90 | |
91 You can use @code{define-hash-table-test} (@pxref{Defining Hash}) to | |
92 define additional possibilities for @var{test}. | |
93 | |
94 @item :weakness @var{weak} | |
95 The weakness of a hash table specifies whether the presence of a key or | |
96 value in the hash table preserves it from garbage collection. | |
97 | |
98 The value, @var{weak}, must be one of @code{nil}, @code{key}, | |
30524 | 99 @code{value}, @code{key-or-value}, @code{key-and-value}, or @code{t} |
51585
b29f076f791a
(Creating Hash): Fix description of :weakness.
Andreas Schwab <schwab@suse.de>
parents:
49600
diff
changeset
|
100 which is an alias for @code{key-or-value}. If @var{weak} is @code{key} |
30524 | 101 then the hash table does not prevent its keys from being collected as |
102 garbage (if they are not referenced anywhere else); if a particular key | |
103 does get collected, the corresponding association is removed from the | |
104 hash table. | |
25634 | 105 |
30524 | 106 If @var{weak} is @code{value}, then the hash table does not prevent |
107 values from being collected as garbage (if they are not referenced | |
108 anywhere else); if a particular value does get collected, the | |
25634 | 109 corresponding association is removed from the hash table. |
110 | |
38786 | 111 If @var{weak} is @code{key-or-value} or @code{t}, the hash table does |
112 not protect either keys or values from garbage collection; if either | |
113 one is collected as garbage, the association is removed. | |
114 | |
115 If @var{weak} is @code{key-and-value}, associations are removed from | |
116 the hash table when both their key and value would be collected as | |
117 garbage, again not considering references to the key and value from | |
118 weak hash tables. | |
30524 | 119 |
25634 | 120 The default for @var{weak} is @code{nil}, so that all keys and values |
25875 | 121 referenced in the hash table are preserved from garbage collection. If |
122 @var{weak} is @code{t}, neither keys nor values are protected (that is, | |
123 both are weak). | |
25634 | 124 |
125 @item :size @var{size} | |
126 This specifies a hint for how many associations you plan to store in the | |
127 hash table. If you know the approximate number, you can make things a | |
26182 | 128 little more efficient by specifying it this way. If you specify too |
25634 | 129 small a size, the hash table will grow automatically when necessary, but |
26303 | 130 doing that takes some extra time. |
25634 | 131 |
132 The default size is 65. | |
133 | |
134 @item :rehash-size @var{rehash-size} | |
135 When you add an association to a hash table and the table is ``full,'' | |
136 it grows automatically. This value specifies how to make the hash table | |
137 larger, at that time. | |
138 | |
25875 | 139 If @var{rehash-size} is an integer, it should be positive, and the hash |
140 table grows by adding that much to the nominal size. If | |
141 @var{rehash-size} is a floating point number, it had better be greater | |
142 than 1, and the hash table grows by multiplying the old size by that | |
143 number. | |
25634 | 144 |
145 The default value is 1.5. | |
146 | |
147 @item :rehash-threshold @var{threshold} | |
148 This specifies the criterion for when the hash table is ``full.'' The | |
149 value, @var{threshold}, should be a positive floating point number, no | |
150 greater than 1. The hash table is ``full'' whenever the actual number of | |
151 entries exceeds this fraction of the nominal size. The default for | |
152 @var{threshold} is 0.8. | |
153 @end table | |
154 @end defun | |
155 | |
156 @tindex makehash | |
157 @defun makehash &optional test | |
158 This is equivalent to @code{make-hash-table}, but with a different style | |
159 argument list. The argument @var{test} specifies the method | |
160 of key lookup. | |
161 | |
53025
53be3d7fa5da
(Creating Hash): Clarify description of `eql'. `makehash' is obsolete.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
162 This function is obsolete. Use @code{make-hash-table} instead. |
25634 | 163 @end defun |
164 | |
165 @node Hash Access | |
166 @section Hash Table Access | |
167 | |
168 This section describes the functions for accessing and storing | |
169 associations in a hash table. | |
170 | |
171 @tindex gethash | |
172 @defun gethash key table &optional default | |
173 This function looks up @var{key} in @var{table}, and returns its | |
174 associated @var{value}---or @var{default}, if @var{key} has no | |
175 association in @var{table}. | |
176 @end defun | |
177 | |
178 @tindex puthash | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
38786
diff
changeset
|
179 @defun puthash key value table |
25634 | 180 This function enters an association for @var{key} in @var{table}, with |
181 value @var{value}. If @var{key} already has an association in | |
182 @var{table}, @var{value} replaces the old associated value. | |
183 @end defun | |
184 | |
185 @tindex remhash | |
186 @defun remhash key table | |
187 This function removes the association for @var{key} from @var{table}, if | |
188 there is one. If @var{key} has no association, @code{remhash} does | |
189 nothing. | |
53025
53be3d7fa5da
(Creating Hash): Clarify description of `eql'. `makehash' is obsolete.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
190 |
53be3d7fa5da
(Creating Hash): Clarify description of `eql'. `makehash' is obsolete.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
191 @b{Common Lisp note:} In Common Lisp, @code{remhash} returns |
53be3d7fa5da
(Creating Hash): Clarify description of `eql'. `makehash' is obsolete.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
192 non-@code{nil} if it actually removed an association and @code{nil} |
53be3d7fa5da
(Creating Hash): Clarify description of `eql'. `makehash' is obsolete.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
193 otherwise. In Emacs Lisp, @code{remhash} always returns @code{nil}. |
25634 | 194 @end defun |
195 | |
196 @tindex clrhash | |
197 @defun clrhash table | |
198 This function removes all the associations from hash table @var{table}, | |
199 so that it becomes empty. This is also called @dfn{clearing} the hash | |
200 table. | |
53025
53be3d7fa5da
(Creating Hash): Clarify description of `eql'. `makehash' is obsolete.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
201 |
53be3d7fa5da
(Creating Hash): Clarify description of `eql'. `makehash' is obsolete.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
202 @b{Common Lisp note:} In Common Lisp, @code{clrhash} returns the empty |
53be3d7fa5da
(Creating Hash): Clarify description of `eql'. `makehash' is obsolete.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
203 @var{table}. In Emacs Lisp, it returns @code{nil}. |
25634 | 204 @end defun |
205 | |
206 @tindex maphash | |
207 @defun maphash function table | |
208 This function calls @var{function} once for each of the associations in | |
209 @var{table}. The function @var{function} should accept two | |
210 arguments---a @var{key} listed in @var{table}, and its associated | |
211 @var{value}. | |
212 @end defun | |
213 | |
214 @node Defining Hash | |
215 @section Defining Hash Comparisons | |
216 @cindex hash code | |
217 | |
218 You can define new methods of key lookup by means of | |
219 @code{define-hash-table-test}. In order to use this feature, you need | |
220 to understand how hash tables work, and what a @dfn{hash code} means. | |
221 | |
222 You can think of a hash table conceptually as a large array of many | |
223 slots, each capable of holding one association. To look up a key, | |
224 @code{gethash} first computes an integer, the hash code, from the key. | |
225 It reduces this integer modulo the length of the array, to produce an | |
226 index in the array. Then it looks in that slot, and if necessary in | |
227 other nearby slots, to see if it has found the key being sought. | |
228 | |
229 Thus, to define a new method of key lookup, you need to specify both a | |
230 function to compute the hash code from a key, and a function to compare | |
231 two keys directly. | |
232 | |
233 @tindex define-hash-table-test | |
234 @defun define-hash-table-test name test-fn hash-fn | |
235 This function defines a new hash table test, named @var{name}. | |
236 | |
237 After defining @var{name} in this way, you can use it as the @var{test} | |
238 argument in @code{make-hash-table}. When you do that, the hash table | |
239 will use @var{test-fn} to compare key values, and @var{hash-fn} to compute | |
240 a ``hash code'' from a key value. | |
241 | |
242 The function @var{test-fn} should accept two arguments, two keys, and | |
243 return non-@code{nil} if they are considered ``the same.'' | |
244 | |
245 The function @var{hash-fn} should accept one argument, a key, and return | |
246 an integer that is the ``hash code'' of that key. For good results, the | |
247 function should use the whole range of integer values for hash codes, | |
248 including negative integers. | |
249 | |
250 The specified functions are stored in the property list of @var{name} | |
251 under the property @code{hash-table-test}; the property value's form is | |
252 @code{(@var{test-fn} @var{hash-fn})}. | |
253 @end defun | |
254 | |
255 @tindex sxhash | |
256 @defun sxhash obj | |
257 This function returns a hash code for Lisp object @var{obj}. | |
258 This is an integer which reflects the contents of @var{obj} | |
259 and the other Lisp objects it points to. | |
260 | |
261 If two objects @var{obj1} and @var{obj2} are equal, then @code{(sxhash | |
262 @var{obj1})} and @code{(sxhash @var{obj2})} are the same integer. | |
263 | |
264 If the two objects are not equal, the values returned by @code{sxhash} | |
53025
53be3d7fa5da
(Creating Hash): Clarify description of `eql'. `makehash' is obsolete.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
265 are usually different, but not always; once in a rare while, by luck, |
53be3d7fa5da
(Creating Hash): Clarify description of `eql'. `makehash' is obsolete.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
266 you will encounter two distinct-looking objects that give the same |
25634 | 267 result from @code{sxhash}. |
268 @end defun | |
269 | |
38786 | 270 This example creates a hash table whose keys are strings that are |
271 compared case-insensitively. | |
272 | |
273 @example | |
274 (defun case-fold-string= (a b) | |
275 (compare-strings a nil nil b nil nil t)) | |
276 | |
277 (defun case-fold-string-hash (a) | |
278 (sxhash (upcase a))) | |
279 | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
38786
diff
changeset
|
280 (define-hash-table-test 'case-fold 'case-fold-string= |
38786 | 281 'case-fold-string-hash)) |
282 | |
283 (make-hash-table :test 'case-fold) | |
284 @end example | |
285 | |
286 Here is how you could define a hash table test equivalent to the | |
287 predefined test value @code{equal}. The keys can be any Lisp object, | |
288 and equal-looking objects are considered the same key. | |
289 | |
290 @example | |
291 (define-hash-table-test 'contents-hash 'equal 'sxhash) | |
292 | |
293 (make-hash-table :test 'contents-hash) | |
294 @end example | |
295 | |
25634 | 296 @node Other Hash |
297 @section Other Hash Table Functions | |
298 | |
299 Here are some other functions for working with hash tables. | |
300 | |
301 @tindex hash-table-p | |
302 @defun hash-table-p table | |
303 This returns non-@code{nil} if @var{table} is a hash table object. | |
304 @end defun | |
305 | |
306 @tindex copy-hash-table | |
307 @defun copy-hash-table table | |
308 This function creates and returns a copy of @var{table}. Only the table | |
309 itself is copied---the keys and values are shared. | |
310 @end defun | |
311 | |
312 @tindex hash-table-count | |
313 @defun hash-table-count table | |
314 This function returns the actual number of entries in @var{table}. | |
315 @end defun | |
316 | |
26182 | 317 @tindex hash-table-test |
318 @defun hash-table-test table | |
25875 | 319 This returns the @var{test} value that was given when @var{table} was |
320 created, to specify how to hash and compare keys. See | |
25634 | 321 @code{make-hash-table} (@pxref{Creating Hash}). |
322 @end defun | |
323 | |
324 @tindex hash-table-weakness | |
325 @defun hash-table-weakness table | |
326 This function returns the @var{weak} value that was specified for hash | |
327 table @var{table}. | |
328 @end defun | |
329 | |
330 @tindex hash-table-rehash-size | |
331 @defun hash-table-rehash-size table | |
332 This returns the rehash size of @var{table}. | |
333 @end defun | |
334 | |
335 @tindex hash-table-rehash-threshold | |
336 @defun hash-table-rehash-threshold table | |
337 This returns the rehash threshold of @var{table}. | |
338 @end defun | |
339 | |
26182 | 340 @tindex hash-table-size |
341 @defun hash-table-size table | |
25634 | 342 This returns the current nominal size of @var{table}. |
343 @end defun | |
52401 | 344 |
345 @ignore | |
346 arch-tag: 3b5107f9-d2f0-47d5-ad61-3498496bea0e | |
347 @end ignore |