The persistent-tables Reference Manual

Table of Contents

The persistent-tables Reference Manual

This is the persistent-tables Reference Manual, version 0.0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 17:21:04 2021 GMT+0.

1 Introduction

Persistent Hash Tables

This is a dead simple implementation of persistent hash tables on top of a port of David Va Horn's persistent random-access lists, SRFI-101.

These are like hash tables in most respects, with similar, but not identical performance profiles, with the major exception that modification is functional, ptbl-set returns a new hash table with the new association in it. The previous table is left unmodified.

Example Usage:

(setq tbl ({} the-empty-ptbl :x 10))
(ptbl-get tbl :x) -> 10
(ptbl-get the-empty-ptbl :x) -> nil

The function {} allows you to quickly create a new ptbl or to update the associations in a ptbl, when the first argument is itself a ptbl. Eg:

({} :x 10 :y 11)

Creates a new ptbl with :x and :y associations.

({} a-table :x 10 :y 11)

Returns a new ptbl with the same associations as a-table except where :x and :y are concerned.

2 Systems

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

2.1 persistent-tables

Maintainer

Vincent Toups

Author

Vincent Toups

Description

Persistent tables.

Version

0.0.1

Dependencies

• random-access-lists
• lisp-unit

Source

persistent-tables.asd (file)

Components

• package.lisp (file)
• persistent-tables.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 persistent-tables.asd

Location

persistent-tables.asd

Systems

persistent-tables (system)

3.1.2 persistent-tables/package.lisp

Parent

persistent-tables (system)

Location

package.lisp

Packages

persistent-tables

3.1.3 persistent-tables/persistent-tables.lisp

Dependency

package.lisp (file)

Parent

persistent-tables (system)

Location

persistent-tables.lisp

Exported Definitions

• fresh-ptbl (function)
• ptbl->alist (function)
• ptbl->ppstring (function)
• ptbl-get (function)
• ptbl-keys (function)
• ptbl-set (function)
• ptbl-values (function)
• {} (function)

Internal Definitions

• bucket-keys (function)
• bucket-values (function)
• copy-ptbl (function)
• empty? (function)
• make-ptbl (function)
• named-let (macro)
• ptbl (structure)
• ptbl-add-to-bucket (function)
• ptbl-buckets (function)
• (setf ptbl-buckets) (function)
• ptbl-dip-buckets (function)
• ptbl-get-from-bucket (function)
• ptbl-n-buckets (function)
• ptbl-p (function)
• ptbl-set-buckets (function)
• ptbl-test (function)
• (setf ptbl-test) (function)
• ptbl? (function)
• the-empty-ptbl (special variable)
• the-empty-ptbl-eq (special variable)

4 Packages

Packages are listed by definition order.

4.1 persistent-tables

Source

package.lisp (file)

Use List

• random-access-lists
• common-lisp

Exported Definitions

• fresh-ptbl (function)
• ptbl->alist (function)
• ptbl->ppstring (function)
• ptbl-get (function)
• ptbl-keys (function)
• ptbl-set (function)
• ptbl-values (function)
• {} (function)

Internal Definitions

• bucket-keys (function)
• bucket-values (function)
• copy-ptbl (function)
• empty? (function)
• make-ptbl (function)
• named-let (macro)
• ptbl (structure)
• ptbl-add-to-bucket (function)
• ptbl-buckets (function)
• (setf ptbl-buckets) (function)
• ptbl-dip-buckets (function)
• ptbl-get-from-bucket (function)
• ptbl-n-buckets (function)
• ptbl-p (function)
• ptbl-set-buckets (function)
• ptbl-test (function)
• (setf ptbl-test) (function)
• ptbl? (function)
• the-empty-ptbl (special variable)
• the-empty-ptbl-eq (special variable)

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: fresh-ptbl &optional N TEST

Create a fresh persistent hash table with N (107) bins and TEST for equality.

Package

persistent-tables

Source

persistent-tables.lisp (file)

Function: ptbl->alist TBL

Return an association list with the same assocations as TBL.

Package

persistent-tables

Source

persistent-tables.lisp (file)

Function: ptbl->ppstring TBL

Produce a nice string representation of the persistent hash table TBL.

Package

persistent-tables

Source

persistent-tables.lisp (file)

Function: ptbl-get TBL KEY &optional OR-VALUE

Retreive the association for KEY from the persistent hashtable TBL. Return OR-VALUE if no association exists, which defaults to NIL.

Package

persistent-tables

Source

persistent-tables.lisp (file)

Function: ptbl-keys TBL

Return a list of all keys in the persistent hash table TBL. Order is unspecified.

Package

persistent-tables

Source

persistent-tables.lisp (file)

Function: ptbl-set TBL KEY VAL

Return a new persistent hash table which is like TBL except that KEY is associated with VAL.

Package

persistent-tables

Source

persistent-tables.lisp (file)

Function: ptbl-values TBL

Return a list of all values in the persistent hash table TBL. Order is unspecified.

Package

persistent-tables

Source

persistent-tables.lisp (file)

Function: {} MAYBE-PTBL &rest ARGS

Construct or augment a PTBL with the KEY/VAL pairs in ARGS. If MAYBE-PTBL is not a PTBL, treat it as the first key and use an empty persistent table.

Package

persistent-tables

Source

persistent-tables.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: the-empty-ptbl

An empty EQUAL testing persistent hash table.

Package

persistent-tables

Source

persistent-tables.lisp (file)

Special Variable: the-empty-ptbl-eq

An empty EQ testing persistent hash table.

Package

persistent-tables

Source

persistent-tables.lisp (file)

5.2.2 Macros

Macro: named-let NAME BINDINGS &body BODY

Package

persistent-tables

Source

persistent-tables.lisp (file)

5.2.3 Functions

Function: bucket-keys BUCKET

Return all the keys in a BUCKET.

Package

persistent-tables

Source

persistent-tables.lisp (file)

Function: bucket-values BUCKET

Return all the values in a BUCKET.

Package

persistent-tables

Source

persistent-tables.lisp (file)

Function: copy-ptbl INSTANCE

Package

persistent-tables

Source

persistent-tables.lisp (file)

Function: empty? X

Package

persistent-tables

Source

persistent-tables.lisp (file)

Function: make-ptbl &key (BUCKETS BUCKETS) (TEST TEST)

Package

persistent-tables

Source

persistent-tables.lisp (file)

Function: ptbl-add-to-bucket BUCKET KEY VAL TEST &optional ACC

Add an association to BUCKET with KEY, VAL and KEY equality tested under TEST.

Package

persistent-tables

Source

persistent-tables.lisp (file)

Function: ptbl-buckets INSTANCE

Function: (setf ptbl-buckets) VALUE INSTANCE

Package

persistent-tables

Source

persistent-tables.lisp (file)

Function: ptbl-dip-buckets P F

Set the BUCKETS part of a persistent table P to (FUNCALL F B), where B is the old buckets.

Package

persistent-tables

Source

persistent-tables.lisp (file)

Function: ptbl-get-from-bucket BUCKET KEY TEST

Find an association to BUCKET with KEY. TEST defines key equality.

Package

persistent-tables

Source

persistent-tables.lisp (file)

Function: ptbl-n-buckets P

Return the number of buckets in the table P.

Package

persistent-tables

Source

persistent-tables.lisp (file)

Function: ptbl-p OBJECT

Package

persistent-tables

Source

persistent-tables.lisp (file)

Function: ptbl-set-buckets P B

Set the BUCKETS part of a persistent table P to B.

Package

persistent-tables

Source

persistent-tables.lisp (file)

Function: ptbl-test INSTANCE

Function: (setf ptbl-test) VALUE INSTANCE

Package

persistent-tables

Source

persistent-tables.lisp (file)

Function: ptbl? OBJECT

Package

persistent-tables

Source

persistent-tables.lisp (file)

5.2.4 Structures

Structure: ptbl ()

Package

persistent-tables

Source

persistent-tables.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: buckets

Readers

ptbl-buckets (function)

Writers

(setf ptbl-buckets) (function)

Slot: test

Readers

ptbl-test (function)

Writers

(setf ptbl-test) (function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types