The cl-custom-hash-table Reference Manual

This is the cl-custom-hash-table Reference Manual, version 0.3, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 04:48:46 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-custom-hash-table

Author

Willem Broekema

License

Copyright (c) 2010-2014, Willem Broekema All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Long Description

This library allows creation of hash tables with arbitrary TEST/HASH functions,
in addition to the TEST functions allowed by the standard (EQ, EQL, EQUAL and EQUALP), even in implementations that don’t support this functionality directly.

Version

0.3

Source

cl-custom-hash-table.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 cl-custom-hash-table/cl-custom-hash-table.asd

Source

cl-custom-hash-table.asd.

Parent Component

cl-custom-hash-table (system).

ASDF Systems

cl-custom-hash-table.


3.1.2 cl-custom-hash-table/package.lisp

Source

cl-custom-hash-table.asd.

Parent Component

cl-custom-hash-table (system).

Packages

cl-custom-hash-table.


3.1.3 cl-custom-hash-table/custom-hash-table.lisp

Dependency

package.lisp (file).

Source

cl-custom-hash-table.asd.

Parent Component

cl-custom-hash-table (system).

Public Interface
Internals

checking-reader-conditionals (macro).


4 Packages

Packages are listed by definition order.


4.1 cl-custom-hash-table

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

checking-reader-conditionals (macro).


5 Definitions

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


5.1 Public Interface


5.1.1 Macros

Macro: define-custom-hash-table-constructor (make &key test hash-function)

Generate a function that can be used to create a new hash table that uses the given TEST and HASH-FUNCTION.
For example: (DEFINE-CUSTOM-HASH-TABLE-CONSTRUCTOR MAKE-FOO-HT :TEST FOO-EQUAL-P :HASH-FUNCTION FOO-HASH)
defines function (MAKE-FOO-HT &REST OPTIONS).
OPTIONS are passed on to MAKE-HASH-TABLE if the platform supports custom hash tables natively, and ignored otherwise.

Package

cl-custom-hash-table.

Source

custom-hash-table.lisp.

Macro: with-custom-hash-table (&body body)

Wrap BODY in an environment where access to custom hash-tables (GET-HASH etc) works as expected.
This macro is a no-op in Lisp implementations that support custom hash-tables natively, but it is
required in implementations where the fallback solution is used (*FEATURES* value :CUSTOM-HASH-TABLE-FALLBACK)

Package

cl-custom-hash-table.

Source

custom-hash-table.lisp.


5.2 Internals


5.2.1 Macros

Macro: checking-reader-conditionals (&body body)

Break unless the body contains exactly one form. Inspired by code from Steve Haflich.

Package

cl-custom-hash-table.

Source

custom-hash-table.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables