The genhash Reference Manual

This is the genhash Reference Manual, version 1.7, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 16:35:22 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 genhash

Generic hashtable code

Maintainer

Paul Nathan <>

Author

Ingvar Mattsson <>

License

Public Domain

Version

1.7

Source

genhash.asd.

Child Components

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


3.1 Lisp


3.1.1 genhash/genhash.asd

Source

genhash.asd.

Parent Component

genhash (system).

ASDF Systems

genhash.


3.1.2 genhash/packages.lisp

Source

genhash.asd.

Parent Component

genhash (system).

Packages

net.hexapodia.hashtables.


3.1.3 genhash/genhash.lisp

Dependency

packages.lisp (file).

Source

genhash.asd.

Parent Component

genhash (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 net.hexapodia.hashtables

Source

packages.lisp.

Nickname

genhash

Use List

common-lisp.

Public Interface
Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


5.1 Public Interface


5.1.1 Ordinary functions

Function: make-generic-hash-table (&key size test)
Package

net.hexapodia.hashtables.

Source

genhash.lisp.

Function: make-generic-hashtable (&key size test)
Package

net.hexapodia.hashtables.

Source

genhash.lisp.

Function: register-hash-function (test-designator hash-function equal-function)
Package

net.hexapodia.hashtables.

Source

genhash.lisp.

Function: register-test-designator (test-designator hash-function equal-function)
Package

net.hexapodia.hashtables.

Source

genhash.lisp.


5.1.2 Generic functions

Generic Function: generic-hash-table-count (table)
Package

net.hexapodia.hashtables.

Source

genhash.lisp.

Methods
Method: generic-hash-table-count ((table hash-table))
Method: generic-hash-table-count ((table hash-container))
Generic Function: generic-hash-table-p (table)
Package

net.hexapodia.hashtables.

Source

genhash.lisp.

Methods
Method: generic-hash-table-p ((table hash-table))
Method: generic-hash-table-p ((table hash-container))
Method: generic-hash-table-p (table)
Generic Function: generic-hash-table-size (table)
Package

net.hexapodia.hashtables.

Source

genhash.lisp.

Methods
Method: generic-hash-table-size ((table hash-table))
Method: generic-hash-table-size ((table hash-container))
Generic Function: hashclr (table)
Package

net.hexapodia.hashtables.

Methods
Method: hashclr ((table hash-table))
Source

genhash.lisp.

Method: hashclr ((table hash-container))
Source

genhash.lisp.

Generic Function: hashmap (key table)
Package

net.hexapodia.hashtables.

Source

genhash.lisp.

Methods
Method: hashmap (fn (table hash-table))
Method: hashmap (fn (table hash-container))
Generic Function: hashref (key table &optional default)
Package

net.hexapodia.hashtables.

Source

genhash.lisp.

Methods
Method: hashref (key (table hash-table) &optional default)
Method: hashref (key (table hash-container) &optional default)
Generic Function: (setf hashref) (key table &optional default)
Package

net.hexapodia.hashtables.

Source

genhash.lisp.

Methods
Method: (setf hashref) (key (table hash-table) &optional default)
Method: (setf hashref) (key (table hash-container) &optional def)
Generic Function: hashrem (key table)
Package

net.hexapodia.hashtables.

Source

genhash.lisp.

Methods
Method: hashrem (key (table hash-table))
Method: hashrem (key (table hash-container))

5.1.3 Conditions

Condition: hash-exists
Package

net.hexapodia.hashtables.

Source

genhash.lisp.

Direct superclasses

simple-error.

Direct Default Initargs
InitargValue
:format-controlhash table type ~a already registered
Condition: unknown-hash
Package

net.hexapodia.hashtables.

Source

genhash.lisp.

Direct superclasses

simple-error.

Direct Default Initargs
InitargValue
:format-controlunknown hash table type ~a

5.2 Internals


5.2.1 Special variables

Special Variable: *hash-test-designator-map*
Package

net.hexapodia.hashtables.

Source

genhash.lisp.

Special Variable: *initialized*
Package

net.hexapodia.hashtables.

Source

genhash.lisp.


5.2.2 Macros

Macro: with-generic-hash-table-iterator ((name table) &body body)
Package

net.hexapodia.hashtables.

Source

genhash.lisp.


5.2.3 Ordinary functions

Function: expand-hash-table (table)
Package

net.hexapodia.hashtables.

Source

genhash.lisp.

Function: register-builtin (test-designator)
Package

net.hexapodia.hashtables.

Source

genhash.lisp.


5.2.4 Generic functions

Generic Function: all-hash-keys (table)
Package

net.hexapodia.hashtables.

Methods
Method: all-hash-keys ((table hash-table))
Source

genhash.lisp.

Method: all-hash-keys ((table hash-container))
Source

genhash.lisp.

Generic Reader: allocated-buckets (object)
Package

net.hexapodia.hashtables.

Methods
Reader Method: allocated-buckets ((hash-container hash-container))

automatically generated reader method

Source

genhash.lisp.

Target Slot

allocated-buckets.

Generic Writer: (setf allocated-buckets) (object)
Package

net.hexapodia.hashtables.

Methods
Writer Method: (setf allocated-buckets) ((hash-container hash-container))

automatically generated writer method

Source

genhash.lisp.

Target Slot

allocated-buckets.

Generic Reader: buckets (object)
Package

net.hexapodia.hashtables.

Methods
Reader Method: buckets ((hash-container hash-container))

automatically generated reader method

Source

genhash.lisp.

Target Slot

buckets.

Generic Writer: (setf buckets) (object)
Package

net.hexapodia.hashtables.

Methods
Writer Method: (setf buckets) ((hash-container hash-container))

automatically generated writer method

Source

genhash.lisp.

Target Slot

buckets.

Generic Reader: builtin (object)
Package

net.hexapodia.hashtables.

Methods
Reader Method: builtin ((hash-test-designator hash-test-designator))

automatically generated reader method

Source

genhash.lisp.

Target Slot

builtin.

Generic Reader: eq-test (object)
Package

net.hexapodia.hashtables.

Methods
Reader Method: eq-test ((hash-test-designator hash-test-designator))

automatically generated reader method

Source

genhash.lisp.

Target Slot

eq-test.

Generic Reader: hash-function (object)
Package

net.hexapodia.hashtables.

Methods
Reader Method: hash-function ((hash-test-designator hash-test-designator))

automatically generated reader method

Source

genhash.lisp.

Target Slot

hash-function.

Generic Reader: stored-items (object)
Package

net.hexapodia.hashtables.

Methods
Reader Method: stored-items ((hash-container hash-container))

automatically generated reader method

Source

genhash.lisp.

Target Slot

stored-items.

Generic Writer: (setf stored-items) (object)
Package

net.hexapodia.hashtables.

Methods
Writer Method: (setf stored-items) ((hash-container hash-container))

automatically generated writer method

Source

genhash.lisp.

Target Slot

stored-items.

Generic Reader: test-designator (object)
Package

net.hexapodia.hashtables.

Methods
Reader Method: test-designator ((hash-container hash-container))

automatically generated reader method

Source

genhash.lisp.

Target Slot

test-designator.

Reader Method: test-designator ((hash-test-designator hash-test-designator))

automatically generated reader method

Source

genhash.lisp.

Target Slot

test-designator.

Generic Reader: used-buckets (object)
Package

net.hexapodia.hashtables.

Methods
Reader Method: used-buckets ((hash-container hash-container))

automatically generated reader method

Source

genhash.lisp.

Target Slot

used-buckets.

Generic Writer: (setf used-buckets) (object)
Package

net.hexapodia.hashtables.

Methods
Writer Method: (setf used-buckets) ((hash-container hash-container))

automatically generated writer method

Source

genhash.lisp.

Target Slot

used-buckets.


5.2.5 Classes

Class: hash-container
Package

net.hexapodia.hashtables.

Source

genhash.lisp.

Direct methods
Direct slots
Slot: buckets
Initargs

:buckets

Readers

buckets.

Writers

(setf buckets).

Slot: allocated-buckets
Initargs

:allocated-buckets

Readers

allocated-buckets.

Writers

(setf allocated-buckets).

Slot: used-buckets
Initform

0

Readers

used-buckets.

Writers

(setf used-buckets).

Slot: stored-items
Initargs

:stored-items

Readers

stored-items.

Writers

(setf stored-items).

Slot: test-designator
Initargs

:test-designator

Readers

test-designator.

Writers

This slot is read-only.

Class: hash-test-designator
Package

net.hexapodia.hashtables.

Source

genhash.lisp.

Direct methods
Direct slots
Slot: test-designator
Initargs

:test-designator

Readers

test-designator.

Writers

This slot is read-only.

Slot: hash-function
Initargs

:hash-function

Readers

hash-function.

Writers

This slot is read-only.

Slot: eq-test
Initargs

:eq-test

Readers

eq-test.

Writers

This slot is read-only.

Slot: builtin
Initargs

:builtin

Readers

builtin.

Writers

This slot is read-only.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
A   B   E   F   G   H   M   R   S   T   U   W  
Index Entry  Section

(
(setf allocated-buckets): Private generic functions
(setf allocated-buckets): Private generic functions
(setf buckets): Private generic functions
(setf buckets): Private generic functions
(setf hashref): Public generic functions
(setf hashref): Public generic functions
(setf hashref): Public generic functions
(setf stored-items): Private generic functions
(setf stored-items): Private generic functions
(setf used-buckets): Private generic functions
(setf used-buckets): Private generic functions

A
all-hash-keys: Private generic functions
all-hash-keys: Private generic functions
all-hash-keys: Private generic functions
allocated-buckets: Private generic functions
allocated-buckets: Private generic functions

B
buckets: Private generic functions
buckets: Private generic functions
builtin: Private generic functions
builtin: Private generic functions

E
eq-test: Private generic functions
eq-test: Private generic functions
expand-hash-table: Private ordinary functions

F
Function, expand-hash-table: Private ordinary functions
Function, make-generic-hash-table: Public ordinary functions
Function, make-generic-hashtable: Public ordinary functions
Function, register-builtin: Private ordinary functions
Function, register-hash-function: Public ordinary functions
Function, register-test-designator: Public ordinary functions

G
Generic Function, (setf allocated-buckets): Private generic functions
Generic Function, (setf buckets): Private generic functions
Generic Function, (setf hashref): Public generic functions
Generic Function, (setf stored-items): Private generic functions
Generic Function, (setf used-buckets): Private generic functions
Generic Function, all-hash-keys: Private generic functions
Generic Function, allocated-buckets: Private generic functions
Generic Function, buckets: Private generic functions
Generic Function, builtin: Private generic functions
Generic Function, eq-test: Private generic functions
Generic Function, generic-hash-table-count: Public generic functions
Generic Function, generic-hash-table-p: Public generic functions
Generic Function, generic-hash-table-size: Public generic functions
Generic Function, hash-function: Private generic functions
Generic Function, hashclr: Public generic functions
Generic Function, hashmap: Public generic functions
Generic Function, hashref: Public generic functions
Generic Function, hashrem: Public generic functions
Generic Function, stored-items: Private generic functions
Generic Function, test-designator: Private generic functions
Generic Function, used-buckets: Private generic functions
generic-hash-table-count: Public generic functions
generic-hash-table-count: Public generic functions
generic-hash-table-count: Public generic functions
generic-hash-table-p: Public generic functions
generic-hash-table-p: Public generic functions
generic-hash-table-p: Public generic functions
generic-hash-table-p: Public generic functions
generic-hash-table-size: Public generic functions
generic-hash-table-size: Public generic functions
generic-hash-table-size: Public generic functions

H
hash-function: Private generic functions
hash-function: Private generic functions
hashclr: Public generic functions
hashclr: Public generic functions
hashclr: Public generic functions
hashmap: Public generic functions
hashmap: Public generic functions
hashmap: Public generic functions
hashref: Public generic functions
hashref: Public generic functions
hashref: Public generic functions
hashrem: Public generic functions
hashrem: Public generic functions
hashrem: Public generic functions

M
Macro, with-generic-hash-table-iterator: Private macros
make-generic-hash-table: Public ordinary functions
make-generic-hashtable: Public ordinary functions
Method, (setf allocated-buckets): Private generic functions
Method, (setf buckets): Private generic functions
Method, (setf hashref): Public generic functions
Method, (setf hashref): Public generic functions
Method, (setf stored-items): Private generic functions
Method, (setf used-buckets): Private generic functions
Method, all-hash-keys: Private generic functions
Method, all-hash-keys: Private generic functions
Method, allocated-buckets: Private generic functions
Method, buckets: Private generic functions
Method, builtin: Private generic functions
Method, eq-test: Private generic functions
Method, generic-hash-table-count: Public generic functions
Method, generic-hash-table-count: Public generic functions
Method, generic-hash-table-p: Public generic functions
Method, generic-hash-table-p: Public generic functions
Method, generic-hash-table-p: Public generic functions
Method, generic-hash-table-size: Public generic functions
Method, generic-hash-table-size: Public generic functions
Method, hash-function: Private generic functions
Method, hashclr: Public generic functions
Method, hashclr: Public generic functions
Method, hashmap: Public generic functions
Method, hashmap: Public generic functions
Method, hashref: Public generic functions
Method, hashref: Public generic functions
Method, hashrem: Public generic functions
Method, hashrem: Public generic functions
Method, stored-items: Private generic functions
Method, test-designator: Private generic functions
Method, test-designator: Private generic functions
Method, used-buckets: Private generic functions

R
register-builtin: Private ordinary functions
register-hash-function: Public ordinary functions
register-test-designator: Public ordinary functions

S
stored-items: Private generic functions
stored-items: Private generic functions

T
test-designator: Private generic functions
test-designator: Private generic functions
test-designator: Private generic functions

U
used-buckets: Private generic functions
used-buckets: Private generic functions

W
with-generic-hash-table-iterator: Private macros