;;; HASH-TABLE is implemented as a STRUCTURE-OBJECT.
(sb!xc:defstruct (hash-table (:constructor %make-hash-table))
- ;; The type of hash table this is. Only used for printing and as part of
- ;; the exported interface.
+ ;; The type of hash table this is. Only used for printing and as
+ ;; part of the exported interface.
(test (required-argument) :type symbol :read-only t)
- ;; The function used to compare two keys. Returns T if they are the same
- ;; and NIL if not.
+ ;; The function used to compare two keys. Returns T if they are the
+ ;; same and NIL if not.
(test-fun (required-argument) :type function :read-only t)
- ;; The function used to compute the hashing of a key. Returns two values:
- ;; the index hashing and T if that might change with the next GC.
+ ;; The function used to compute the hashing of a key. Returns two
+ ;; values: the index hashing and T if that might change with the
+ ;; next GC.
(hash-fun (required-argument) :type function :read-only t)
- ;; How much to grow the hash table by when it fills up. If an index, then
- ;; add that amount. If a floating point number, then multiple it by that.
+ ;; how much to grow the hash table by when it fills up. If an index,
+ ;; then add that amount. If a floating point number, then multiply
+ ;; it by that.
(rehash-size (required-argument) :type (or index (single-float (1.0)))
:read-only t)
- ;; How full the hash table has to get before we rehash.
+ ;; how full the hash table has to get before we rehash
(rehash-threshold (required-argument) :type (single-float (0.0) 1.0)
:read-only t)
- ;; The number of entries before a rehash, just the one less than the
+ ;; The number of entries before a rehash, just one less than the
;; size of the next-vector, hash-vector, and half the size of the
;; kv-vector.
(rehash-trigger (required-argument) :type index)
(number-entries 0 :type index)
;; The Key-Value pair vector.
(table (required-argument) :type simple-vector)
- ;; True if this is a weak hash table, meaning that key->value mappings will
- ;; disappear if there are no other references to the key. Note: this only
- ;; matters if the hash function indicates that the hashing is EQ based.
+ ;; True if this is a weak hash table, meaning that key->value
+ ;; mappings will disappear if there are no other references to the
+ ;; key. Note: this only matters if the hash function indicates that
+ ;; the hashing is EQ based.
(weak-p nil :type (member t nil))
;; Index into the next-vector, chaining together buckets that need
;; to be rehashed because their hashing is EQ based and the key has