diff options
| author | Paul Eggert | 2019-07-22 21:27:33 -0700 |
|---|---|---|
| committer | Paul Eggert | 2019-07-22 21:28:18 -0700 |
| commit | f378ed1a0b1ca2ceed5afabcf5f303ae339039ba (patch) | |
| tree | 767e994477690e2681cb7fe027af7d708efd6cc6 /doc/lispref | |
| parent | 97477edaf2044e51696f46b166b43801893156a3 (diff) | |
| download | emacs-f378ed1a0b1ca2ceed5afabcf5f303ae339039ba.tar.gz emacs-f378ed1a0b1ca2ceed5afabcf5f303ae339039ba.zip | |
Avoid overexposing fixnums for hash codes
Following a suggestion by Stefan Monnier in:
https://lists.gnu.org/r/emacs-devel/2019-07/msg00530.html
* doc/lispref/hash.texi (Creating Hash, Defining Hash):
* src/fns.c (Fsxhash_eq, Fsxhash_eql, Fsxhash_equal, Fmake_hash_table):
Don’t insist that hash codes be fixnums, reverting
the recent doc changes to the contrary.
* src/bytecode.c (exec_byte_code): Special-case only the eq case,
as the others aren’t worth tuning now that we treat bignum hashes
like fixnums.
* src/fns.c (hashfn_user_defined): If the hash code is a bignum,
reduce its hash down to a fixnum.
Diffstat (limited to 'doc/lispref')
| -rw-r--r-- | doc/lispref/hash.texi | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/doc/lispref/hash.texi b/doc/lispref/hash.texi index 051531491c0..50d4c5742cb 100644 --- a/doc/lispref/hash.texi +++ b/doc/lispref/hash.texi | |||
| @@ -132,7 +132,7 @@ When you add an association to a hash table and the table is full, | |||
| 132 | it grows automatically. This value specifies how to make the hash table | 132 | it grows automatically. This value specifies how to make the hash table |
| 133 | larger, at that time. | 133 | larger, at that time. |
| 134 | 134 | ||
| 135 | If @var{rehash-size} is a fixnum, it should be positive and the hash | 135 | If @var{rehash-size} is an integer, it should be positive, and the hash |
| 136 | table grows by adding approximately that much to the nominal size. If | 136 | table grows by adding approximately that much to the nominal size. If |
| 137 | @var{rehash-size} is floating point, it had better be greater | 137 | @var{rehash-size} is floating point, it had better be greater |
| 138 | than 1, and the hash table grows by multiplying the old size by | 138 | than 1, and the hash table grows by multiplying the old size by |
| @@ -239,8 +239,8 @@ to understand how hash tables work, and what a @dfn{hash code} means. | |||
| 239 | 239 | ||
| 240 | You can think of a hash table conceptually as a large array of many | 240 | You can think of a hash table conceptually as a large array of many |
| 241 | slots, each capable of holding one association. To look up a key, | 241 | slots, each capable of holding one association. To look up a key, |
| 242 | @code{gethash} first computes a fixnum, the hash code, from the key. | 242 | @code{gethash} first computes an integer, the hash code, from the key. |
| 243 | It reduces this fixnum modulo the length of the array, to produce an | 243 | It can reduce this integer modulo the length of the array, to produce an |
| 244 | index in the array. Then it looks in that slot, and if necessary in | 244 | index in the array. Then it looks in that slot, and if necessary in |
| 245 | other nearby slots, to see if it has found the key being sought. | 245 | other nearby slots, to see if it has found the key being sought. |
| 246 | 246 | ||
| @@ -265,7 +265,7 @@ The function @var{test-fn} should accept two arguments, two keys, and | |||
| 265 | return non-@code{nil} if they are considered the same. | 265 | return non-@code{nil} if they are considered the same. |
| 266 | 266 | ||
| 267 | The function @var{hash-fn} should accept one argument, a key, and return | 267 | The function @var{hash-fn} should accept one argument, a key, and return |
| 268 | a fixnum that is the hash code of that key. For good results, the | 268 | an integer that is the hash code of that key. For good results, the |
| 269 | function should use the whole range of fixnums for hash codes, | 269 | function should use the whole range of fixnums for hash codes, |
| 270 | including negative fixnums. | 270 | including negative fixnums. |
| 271 | 271 | ||
| @@ -276,12 +276,12 @@ under the property @code{hash-table-test}; the property value's form is | |||
| 276 | 276 | ||
| 277 | @defun sxhash-equal obj | 277 | @defun sxhash-equal obj |
| 278 | This function returns a hash code for Lisp object @var{obj}. | 278 | This function returns a hash code for Lisp object @var{obj}. |
| 279 | This is a fixnum that reflects the contents of @var{obj} | 279 | This is an integer that reflects the contents of @var{obj} |
| 280 | and the other Lisp objects it points to. | 280 | and the other Lisp objects it points to. |
| 281 | 281 | ||
| 282 | If two objects @var{obj1} and @var{obj2} are @code{equal}, then | 282 | If two objects @var{obj1} and @var{obj2} are @code{equal}, then |
| 283 | @code{(sxhash-equal @var{obj1})} and @code{(sxhash-equal @var{obj2})} | 283 | @code{(sxhash-equal @var{obj1})} and @code{(sxhash-equal @var{obj2})} |
| 284 | are the same fixnum. | 284 | are the same integer. |
| 285 | 285 | ||
| 286 | If the two objects are not @code{equal}, the values returned by | 286 | If the two objects are not @code{equal}, the values returned by |
| 287 | @code{sxhash-equal} are usually different, but not always; once in a | 287 | @code{sxhash-equal} are usually different, but not always; once in a |
| @@ -299,7 +299,7 @@ result reflects identity of @var{obj}, but not its contents. | |||
| 299 | 299 | ||
| 300 | If two objects @var{obj1} and @var{obj2} are @code{eq}, then | 300 | If two objects @var{obj1} and @var{obj2} are @code{eq}, then |
| 301 | @code{(sxhash-eq @var{obj1})} and @code{(sxhash-eq @var{obj2})} are | 301 | @code{(sxhash-eq @var{obj1})} and @code{(sxhash-eq @var{obj2})} are |
| 302 | the same fixnum. | 302 | the same integer. |
| 303 | @end defun | 303 | @end defun |
| 304 | 304 | ||
| 305 | @defun sxhash-eql obj | 305 | @defun sxhash-eql obj |
| @@ -310,7 +310,7 @@ in which case a hash code is generated for the value. | |||
| 310 | 310 | ||
| 311 | If two objects @var{obj1} and @var{obj2} are @code{eql}, then | 311 | If two objects @var{obj1} and @var{obj2} are @code{eql}, then |
| 312 | @code{(sxhash-eql @var{obj1})} and @code{(sxhash-eql @var{obj2})} are | 312 | @code{(sxhash-eql @var{obj1})} and @code{(sxhash-eql @var{obj2})} are |
| 313 | the same fixnum. | 313 | the same integer. |
| 314 | @end defun | 314 | @end defun |
| 315 | 315 | ||
| 316 | This example creates a hash table whose keys are strings that are | 316 | This example creates a hash table whose keys are strings that are |