The planks Reference Manual

Table of Contents

The planks Reference Manual

This is the planks Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 17:24:18 2021 GMT+0.

1 Systems

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

1.1 planks

Author

Drew Crampsie <drewc@tech.coop>

License

MIT

Dependencies

• rucksack
• ironclad
• bordeaux-threads
• trivial-garbage
• babel
• closer-mop

Source

planks.asd (file)

Component

src (module)

2 Modules

Modules are listed depth-first from the system components tree.

2.1 planks/src

Parent

planks (system)

Location

src/

Components

• btree-protocol.lisp (file)
• btree.lisp (file)
• btree-utils.lisp (file)
• btree-search.lisp (file)
• map-btree.lisp (file)
• file-btree.lisp (file)
• heap-btree.lisp (file)
• view.lisp (file)
• btree-class.lisp (file)
• object-btree.lisp (file)
• persistent-objects.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 planks.asd

Location

planks.asd

Systems

planks (system)

3.1.2 planks/src/btree-protocol.lisp

Parent

src (module)

Location

src/btree-protocol.lisp

Packages

planks.btree

Exported Definitions

• btree-error (condition)
• btree-error-btree (method)
• btree-error-key (method)
• btree-error-key (method)
• btree-error-value (method)
• btree-insert (generic function)
• btree-insertion-error (condition)
• btree-key-already-present-error (condition)
• btree-search-error (condition)
• btree-type-error (condition)
• map-btree (generic function)
• update-btree (generic function)

3.1.3 planks/src/btree.lisp

Dependency

btree-protocol.lisp (file)

Parent

src (module)

Location

src/btree.lisp

Exported Definitions

• btree (class)
• btree-insert (method)
• btree-key-type (method)
• btree-max-node-size (method)
• btree-node (class)
• btree-node-class (method)
• btree-root (method)
• (setf btree-root) (method)
• btree-unique-keys-p (method)
• btree-value-type (method)
• update-btree (method)

Internal Definitions

• %update-btree (function)
• btree-key-key (method)
• btree-node-binding (function)
• btree-node-binding-key (method)
• btree-node-binding-value (method)
• btree-node-index (method)
• (setf btree-node-index) (method)
• btree-node-leaf-p (method)
• (setf btree-node-leaf-p) (method)
• btree-value-key (method)
• find-key-position-in-index (function)
• largest-key-in-node (method)
• make-root-node (method)
• node-almost-full-p (function)
• split-binding-node (function)
• update-binding-for-insert (function)
• update-bnode (function)
• update-index-for-insert (function)
• update-node (method)
• update-node-for-insert (method)

3.1.4 planks/src/btree-utils.lisp

Dependency

btree.lisp (file)

Parent

src (module)

Location

src/btree-utils.lisp

Exported Definitions

• btree-key< (method)
• btree-key= (method)
• btree-value= (method)

Internal Definitions

• btree-balanced-p (method)
• btree-depths (method)
• btree-key<= (method)
• btree-key> (method)
• btree-key>= (method)
• btree-node-binding-count (function)
• btree-node-max-depth (method)
• btree-node-min-depth (method)

3.1.5 planks/src/btree-search.lisp

Dependency

btree-utils.lisp (file)

Parent

src (module)

Location

src/btree-search.lisp

Exported Definitions

• btree-search (generic function)
• btree-search (method)

Internal Definitions

• find-subnode (function)
• node-search (generic function)
• node-search (method)
• not-found (function)

3.1.6 planks/src/map-btree.lisp

Dependency

btree-search.lisp (file)

Parent

src (module)

Location

src/map-btree.lisp

Exported Definitions

map-btree (method)

Internal Definitions

• map-btree-keys (method)
• map-btree-keys-for-node (generic function)
• map-btree-keys-for-node (method)
• map-btree-keys-for-node (method)

3.1.7 planks/src/file-btree.lisp

Dependency

map-btree.lisp (file)

Parent

src (module)

Location

src/file-btree.lisp

Exported Definitions

• btree-file-size (function)
• btree-root (method)
• close-btree (function)
• find-btree (function)
• make-btree (function)
• update-btree (method)
• update-btree (method)

Internal Definitions

• *btree-file-root* (special variable)
• *btree-stream* (special variable)
• *btrees* (special variable)
• *max-footer-size* (special variable)
• +footer-marker+ (special variable)
• btree-depths (method)
• btree-file-footer (method)
• (setf btree-file-footer) (method)
• btree-file-footer-action (method)
• (setf btree-file-footer-action) (method)
• btree-file-footer-address (method)
• (setf btree-file-footer-address) (method)
• btree-file-footer-class (method)
• (setf btree-file-footer-class) (method)
• btree-file-footer-key (method)
• (setf btree-file-footer-key) (method)
• btree-file-footer-previous-address (method)
• (setf btree-file-footer-previous-address) (method)
• btree-file-footer-version (method)
• (setf btree-file-footer-version) (method)
• btree-footer (class)
• btree-lock (method)
• (setf btree-lock) (method)
• btree-node-address (method)
• (setf btree-node-address) (method)
• btree-node-file-position (function)
• btree-node-max-depth (method)
• btree-node-min-depth (method)
• btree-pathname (method)
• (setf btree-pathname) (method)
• call-with-btree-stream (function)
• file-btree (class)
• file-btree-node (class)
• largest-key-in-node (method)
• load-btree-node (function)
• load-btree-node-from-stream (function)
• make-btree-footer (method)
• make-btree-lock (function)
• make-footer-buffer (function)
• map-btree-keys-for-node (method)
• map-btree-node (method)
• node-search (method)
• persist (method)
• read-btree-from-file-stream (function)
• read-file-footer (function)
• read-footer-checksum (method)
• read-node-tag (method)
• root-node-file-position (method)
• (setf root-node-file-position) (method)
• single-file-btree (class)
• update-node (method)
• update-node-for-insert (method)
• write-file-footer (function)
• write-footer-checksum (method)
• write-node-tag (method)

3.1.8 planks/src/heap-btree.lisp

Dependency

file-btree.lisp (file)

Parent

src (module)

Location

src/heap-btree.lisp

Exported Definitions

• btree-search (method)
• heap-btree (class)
• map-btree (method)
• update-btree (method)

Internal Definitions

• allocate-heap (method)
• allocate-object (method)
• btree-heap-free-space-start (method)
• btree-heap-size (method)
• (setf btree-heap-size) (method)
• btree-heap-start (method)
• find-heap-object (method)
• heap-btree-file-footer (class)
• make-btree-footer (method)

3.1.9 planks/src/view.lisp

Dependency

heap-btree.lisp (file)

Parent

src (module)

Location

src/view.lisp

Exported Definitions

• add-function-btree (function)
• btree-search (method)
• find-function-btree (function)
• multi-btree (class)
• update-btree (method)

Internal Definitions

• *current-btree* (special variable)
• *current-footer* (special variable)
• btree-function-name (method)
• (setf btree-function-name) (method)
• current-btree (function)
• current-footer (function)
• function-btree (class)
• make-btree-footer (method)
• multi-btree-file-footer (class)

3.1.10 planks/src/btree-class.lisp

Dependency

view.lisp (file)

Parent

src (module)

Location

src/btree-class.lisp

Internal Definitions

• btree-class (class)
• btree-class-pathname (method)
• btree-class-pathname (method)
• (setf btree-class-pathname) (method)
• btree-object (class)
• btree-object-id (method)
• (setf btree-object-id) (method)
• btree-pathname (method)

3.1.11 planks/src/object-btree.lisp

Dependency

btree-class.lisp (file)

Parent

src (module)

Location

src/object-btree.lisp

Exported Definitions

• update-btree (method)
• update-btree (method)

Internal Definitions

• btree-footer-next-id (method)
• (setf btree-footer-next-id) (method)
• btree-pathname (method)
• make-btree-footer (generic function)
• make-btree-footer (method)
• nested-btree (class)
• object-storage-btree (class)
• object-storage-footer (class)

3.1.12 planks/src/persistent-objects.lisp

Dependency

object-btree.lisp (file)

Parent

src (module)

Location

src/persistent-objects.lisp

Exported Definitions

update-btree (method)

Internal Definitions

• *persistent-standard-class-effective-slot-definition-class* (special variable)
• +persistent-standard-object-marker+ (constant)
• btree-class-pathname (method)
• (setf btree-class-pathname) (method)
• btree-pathname (method)
• persistent-standard-class (class)
• persistent-standard-class-btree (method)
• (setf persistent-standard-class-btree) (method)
• persistent-standard-class-direct-slot-definition (class)
• persistent-standard-class-effective-slot-definition (class)
• persistent-standard-class-slot-definition (class)
• persistent-standard-object (class)
• persistent-standard-object-slot-btree (method)
• (setf persistent-standard-object-slot-btree) (method)
• persistent-standard-object-slot-btree (class)
• persistent-standard-object-slot-btree-class-name (method)
• (setf persistent-standard-object-slot-btree-class-name) (method)
• slot-definition-persistentp (method)
• slot-definition-persistentp (method)
• (setf slot-definition-persistentp) (method)

4 Packages

Packages are listed by definition order.

4.1 planks.btree

Source

btree-protocol.lisp (file)

Use List

common-lisp

Exported Definitions

• add-function-btree (function)
• btree (class)
• btree-error (condition)
• btree-error-btree (generic function)
• btree-error-btree (method)
• btree-error-key (generic function)
• btree-error-key (method)
• btree-error-key (method)
• btree-error-value (generic function)
• btree-error-value (method)
• btree-file-size (function)
• btree-insert (generic function)
• btree-insert (method)
• btree-insertion-error (condition)
• btree-key-already-present-error (condition)
• btree-key-type (generic function)
• btree-key-type (method)
• btree-key< (generic function)
• btree-key< (method)
• btree-key= (generic function)
• btree-key= (method)
• btree-max-node-size (generic function)
• btree-max-node-size (method)
• btree-node (class)
• btree-node-class (generic function)
• btree-node-class (method)
• btree-root (generic function)
• btree-root (method)
• btree-root (method)
• (setf btree-root) (method)
• (setf btree-root) (generic function)
• btree-search (generic function)
• btree-search (method)
• btree-search (method)
• btree-search (method)
• btree-search-error (condition)
• btree-type-error (condition)
• btree-unique-keys-p (generic function)
• btree-unique-keys-p (method)
• btree-value-type (generic function)
• btree-value-type (method)
• btree-value= (generic function)
• btree-value= (method)
• close-btree (function)
• find-btree (function)
• find-function-btree (function)
• heap-btree (class)
• make-btree (function)
• map-btree (generic function)
• map-btree (method)
• map-btree (method)
• multi-btree (class)
• update-btree (generic function)
• update-btree (method)
• update-btree (method)
• update-btree (method)
• update-btree (method)
• update-btree (method)
• update-btree (method)
• update-btree (method)
• update-btree (method)

Internal Definitions

• %update-btree (function)
• *btree-file-root* (special variable)
• *btree-stream* (special variable)
• *btrees* (special variable)
• *current-btree* (special variable)
• *current-footer* (special variable)
• *max-footer-size* (special variable)
• *persistent-standard-class-effective-slot-definition-class* (special variable)
• +footer-marker+ (special variable)
• +persistent-standard-object-marker+ (constant)
• allocate-heap (generic function)
• allocate-heap (method)
• allocate-object (generic function)
• allocate-object (method)
• btree-balanced-p (generic function)
• btree-balanced-p (method)
• btree-class (class)
• btree-class-pathname (generic function)
• btree-class-pathname (method)
• (setf btree-class-pathname) (method)
• btree-class-pathname (method)
• btree-class-pathname (method)
• (setf btree-class-pathname) (method)
• (setf btree-class-pathname) (generic function)
• btree-depths (generic function)
• btree-depths (method)
• btree-depths (method)
• btree-file-footer (generic function)
• btree-file-footer (method)
• (setf btree-file-footer) (method)
• (setf btree-file-footer) (generic function)
• btree-file-footer-action (generic function)
• btree-file-footer-action (method)
• (setf btree-file-footer-action) (method)
• (setf btree-file-footer-action) (generic function)
• btree-file-footer-address (generic function)
• btree-file-footer-address (method)
• (setf btree-file-footer-address) (method)
• (setf btree-file-footer-address) (generic function)
• btree-file-footer-class (generic function)
• btree-file-footer-class (method)
• (setf btree-file-footer-class) (method)
• (setf btree-file-footer-class) (generic function)
• btree-file-footer-key (generic function)
• btree-file-footer-key (method)
• (setf btree-file-footer-key) (method)
• (setf btree-file-footer-key) (generic function)
• btree-file-footer-previous-address (generic function)
• btree-file-footer-previous-address (method)
• (setf btree-file-footer-previous-address) (method)
• (setf btree-file-footer-previous-address) (generic function)
• btree-file-footer-version (generic function)
• btree-file-footer-version (method)
• (setf btree-file-footer-version) (method)
• (setf btree-file-footer-version) (generic function)
• btree-footer (class)
• btree-footer-next-id (generic function)
• btree-footer-next-id (method)
• (setf btree-footer-next-id) (method)
• (setf btree-footer-next-id) (generic function)
• btree-function-name (generic function)
• btree-function-name (method)
• (setf btree-function-name) (method)
• (setf btree-function-name) (generic function)
• btree-heap-free-space-start (generic function)
• btree-heap-free-space-start (method)
• btree-heap-size (generic function)
• btree-heap-size (method)
• (setf btree-heap-size) (method)
• (setf btree-heap-size) (generic function)
• btree-heap-start (generic function)
• btree-heap-start (method)
• btree-key-key (generic function)
• btree-key-key (method)
• btree-key<= (generic function)
• btree-key<= (method)
• btree-key> (generic function)
• btree-key> (method)
• btree-key>= (generic function)
• btree-key>= (method)
• btree-lock (generic function)
• btree-lock (method)
• (setf btree-lock) (method)
• (setf btree-lock) (generic function)
• btree-node-address (generic function)
• btree-node-address (method)
• (setf btree-node-address) (method)
• (setf btree-node-address) (generic function)
• btree-node-binding (function)
• btree-node-binding-count (function)
• btree-node-binding-key (generic function)
• btree-node-binding-key (method)
• btree-node-binding-value (generic function)
• btree-node-binding-value (method)
• btree-node-file-position (function)
• btree-node-index (generic function)
• btree-node-index (method)
• (setf btree-node-index) (method)
• (setf btree-node-index) (generic function)
• btree-node-leaf-p (generic function)
• btree-node-leaf-p (method)
• (setf btree-node-leaf-p) (method)
• (setf btree-node-leaf-p) (generic function)
• btree-node-max-depth (generic function)
• btree-node-max-depth (method)
• btree-node-max-depth (method)
• btree-node-min-depth (generic function)
• btree-node-min-depth (method)
• btree-node-min-depth (method)
• btree-object (class)
• btree-object-id (generic function)
• btree-object-id (method)
• (setf btree-object-id) (method)
• (setf btree-object-id) (generic function)
• btree-pathname (generic function)
• btree-pathname (method)
• btree-pathname (method)
• btree-pathname (method)
• btree-pathname (method)
• (setf btree-pathname) (method)
• (setf btree-pathname) (generic function)
• btree-value-key (generic function)
• btree-value-key (method)
• call-with-btree-stream (function)
• current-btree (function)
• current-footer (function)
• file-btree (class)
• file-btree-node (class)
• find-heap-object (generic function)
• find-heap-object (method)
• find-key-position-in-index (function)
• find-subnode (function)
• function-btree (class)
• heap-btree-file-footer (class)
• largest-key-in-node (generic function)
• largest-key-in-node (method)
• largest-key-in-node (method)
• load-btree-node (function)
• load-btree-node-from-stream (function)
• make-btree-footer (generic function)
• make-btree-footer (method)
• make-btree-footer (method)
• make-btree-footer (method)
• make-btree-footer (method)
• make-btree-lock (function)
• make-footer-buffer (function)
• make-root-node (generic function)
• make-root-node (method)
• map-btree-keys (generic function)
• map-btree-keys (method)
• map-btree-keys-for-node (generic function)
• map-btree-keys-for-node (method)
• map-btree-keys-for-node (method)
• map-btree-keys-for-node (method)
• map-btree-node (generic function)
• map-btree-node (method)
• multi-btree-file-footer (class)
• nested-btree (class)
• node-almost-full-p (function)
• node-search (generic function)
• node-search (method)
• node-search (method)
• not-found (function)
• object-storage-btree (class)
• object-storage-footer (class)
• persist (generic function)
• persist (method)
• persistent-standard-class (class)
• persistent-standard-class-btree (generic function)
• persistent-standard-class-btree (method)
• (setf persistent-standard-class-btree) (method)
• (setf persistent-standard-class-btree) (generic function)
• persistent-standard-class-direct-slot-definition (class)
• persistent-standard-class-effective-slot-definition (class)
• persistent-standard-class-slot-definition (class)
• persistent-standard-object (class)
• persistent-standard-object-slot-btree (generic function)
• persistent-standard-object-slot-btree (method)
• (setf persistent-standard-object-slot-btree) (method)
• (setf persistent-standard-object-slot-btree) (generic function)
• persistent-standard-object-slot-btree (class)
• persistent-standard-object-slot-btree-class-name (generic function)
• persistent-standard-object-slot-btree-class-name (method)
• (setf persistent-standard-object-slot-btree-class-name) (method)
• (setf persistent-standard-object-slot-btree-class-name) (generic function)
• read-btree-from-file-stream (function)
• read-file-footer (function)
• read-footer-checksum (generic function)
• read-footer-checksum (method)
• read-node-tag (generic function)
• read-node-tag (method)
• root-node-file-position (generic function)
• root-node-file-position (method)
• (setf root-node-file-position) (method)
• (setf root-node-file-position) (generic function)
• single-file-btree (class)
• slot-definition-persistentp (generic function)
• slot-definition-persistentp (method)
• slot-definition-persistentp (method)
• (setf slot-definition-persistentp) (generic function)
• (setf slot-definition-persistentp) (method)
• split-binding-node (function)
• update-binding-for-insert (function)
• update-bnode (function)
• update-index-for-insert (function)
• update-node (generic function)
• update-node (method)
• update-node (method)
• update-node-for-insert (generic function)
• update-node-for-insert (method)
• update-node-for-insert (method)
• write-file-footer (function)
• write-footer-checksum (generic function)
• write-footer-checksum (method)
• write-node-tag (generic function)
• write-node-tag (method)

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: add-function-btree BTREE FUNCTION-NAME &rest ARGS

Package

planks.btree

Source

view.lisp (file)

Function: btree-file-size BTREE

Package

planks.btree

Source

file-btree.lisp (file)

Function: close-btree PATH

Package

planks.btree

Source

file-btree.lisp (file)

Function: find-btree PATH

Package

planks.btree

Source

file-btree.lisp (file)

Function: find-function-btree BTREE FUNCTION-NAME

Package

planks.btree

Source

view.lisp (file)

Function: make-btree PATHNAME &rest ARGS &key IF-EXISTS CLASS &allow-other-keys

Package

planks.btree

Source

file-btree.lisp (file)

5.1.2 Generic functions

Generic Function: btree-error-btree CONDITION

Package

planks.btree

Methods

Method: btree-error-btree (CONDITION btree-error)

Source

btree-protocol.lisp (file)

Generic Function: btree-error-key CONDITION

Package

planks.btree

Methods

Method: btree-error-key (CONDITION btree-insertion-error)

Source

btree-protocol.lisp (file)

Method: btree-error-key (CONDITION btree-search-error)

Source

btree-protocol.lisp (file)

Generic Function: btree-error-value CONDITION

Package

planks.btree

Methods

Method: btree-error-value (CONDITION btree-insertion-error)

Source

btree-protocol.lisp (file)

Generic Function: btree-insert BTREE KEY VALUE &key IF-EXISTS

Adds an association from KEY to VALUE to a btree.

IF-EXISTS can be either :OVERWRITE (default) or :ERROR.

If the btree has unique keys (see BTREE-UNIQUE-KEYS-P) and KEY is already associated with another (according to BTREE-VALUE=) value, the result depends on the IF-EXISTS option: if IF-EXISTS is :OVERWRITE, the old value is overwriten; if IF-EXISTS is :ERROR, a BTREE-KEY-ALREADY-PRESENT-ERROR is signaled.

For btrees with non-unique keys, the IF-EXISTS option is ignored and VALUE is just added to the list of values associated with KEY (unless VALUE is already associated with KEY; in that case nothing happens).

Package

planks.btree

Source

btree-protocol.lisp (file)

Methods

Method: btree-insert (BTREE btree) KEY VALUE &key IF-EXISTS

Source

btree.lisp (file)

Generic Function: btree-key-type OBJECT

Package

planks.btree

Methods

Method: btree-key-type (BTREE btree)

The type of all keys.

Source

btree.lisp (file)

Generic Function: btree-key< OBJECT

Package

planks.btree

Methods

Method: btree-key< (BTREE btree)

Source

btree-utils.lisp (file)

Generic Function: btree-key= OBJECT

Package

planks.btree

Methods

Method: btree-key= (BTREE btree)

Source

btree-utils.lisp (file)

Generic Function: btree-max-node-size OBJECT

Package

planks.btree

Methods

Method: btree-max-node-size (BTREE btree)

An integer specifying the preferred maximum number of keys per btree node.

Source

btree.lisp (file)

Generic Function: btree-node-class OBJECT

Package

planks.btree

Methods

Method: btree-node-class (BTREE btree)

automatically generated reader method

Source

btree.lisp (file)

Generic Function: btree-root OBJECT

Generic Function: (setf btree-root) NEW-VALUE OBJECT

Package

planks.btree

Methods

Method: btree-root (BTREE file-btree)

Source

file-btree.lisp (file)

Method: btree-root (BTREE btree)

automatically generated reader method

Source

btree.lisp (file)

Method: (setf btree-root) NEW-VALUE (BTREE btree)

automatically generated writer method

Source

btree.lisp (file)

Generic Function: btree-search BTREE KEY &key ERRORP DEFAULT-VALUE FUNCTION ADDRESS-ONLY &allow-other-keys

Returns the value (or list of values, for btrees
that don’t have unique keys) corresponding to KEY. If the btree has non-unique keys and no value is found, the empty list is returned. If the btree has unique keys and no value is found, the result depends on ERRORP option: if ERRORP is true, a btree-search-error is signalled; otherwise, DEFAULT-VALUE is returned.

Package

planks.btree

Source

btree-search.lisp (file)

Methods

Method: btree-search (BTREE multi-btree) KEY &key ERRORP DEFAULT-VALUE FUNCTION around

Source

view.lisp (file)

Method: btree-search (BTREE heap-btree) KEY &key ADDRESS-ONLY &allow-other-keys

Source

heap-btree.lisp (file)

Method: btree-search BTREE KEY &key ERRORP DEFAULT-VALUE

Generic Function: btree-unique-keys-p OBJECT

Package

planks.btree

Methods

Method: btree-unique-keys-p (BTREE btree)

If false, one key can correspond to more than one value.

Source

btree.lisp (file)

Generic Function: btree-value-type OBJECT

Package

planks.btree

Methods

Method: btree-value-type (BTREE btree)

The type of all values.

Source

btree.lisp (file)

Generic Function: btree-value= OBJECT

Package

planks.btree

Methods

Method: btree-value= (BTREE btree)

Source

btree-utils.lisp (file)

Generic Function: map-btree BTREE FUNCTION &key MIN MAX INCLUDE-MIN INCLUDE-MAX ORDER ADDRESS-ONLY &allow-other-keys

Calls FUNCTION for all key/value associations in the btree where key is in the specified interval (this means that FUNCTION can be called with the same key more than once for btrees with non-unique keys). FUNCTION must be a binary function; the first argument is the btree key, the second argument is an associated value.

MIN, MAX, INCLUDE-MIN and INCLUDE-MAX specify the interval. The interval is left-open if MIN is nil, right-open if MAX is nil. The interval is inclusive on the left if INCLUDE-MIN is true (and exclusive on the left otherwise). The interval is inclusive on the right if INCLUDE-MAX is true (and exclusive on the right otherwise).

ORDER is either :ASCENDING (default) or :DESCENDING.

Package

planks.btree

Source

btree-protocol.lisp (file)

Methods

Method: map-btree (BT heap-btree) FN &rest ARGS &key ADDRESS-ONLY &allow-other-keys around

Source

heap-btree.lisp (file)

Method: map-btree (BTREE btree) FUNCTION &key MIN MAX INCLUDE-MIN INCLUDE-MAX ORDER

Source

map-btree.lisp (file)

Generic Function: update-btree BTREE &key KEY VALUE VALUE-THUNK ACTION &allow-other-keys

This is the function that implements the functional b+tree. It is not meant to be called by users, but is specialized when extending

Package

planks.btree

Source

btree-protocol.lisp (file)

Methods

Method: update-btree (BTREE persistent-standard-object-slot-btree) &key &allow-other-keys

Source

persistent-objects.lisp (file)

Method: update-btree (BTREE nested-btree) &key &allow-other-keys around

Source

object-btree.lisp (file)

Method: update-btree (BTREE object-storage-btree) &rest ARGS &key VALUE-THUNK &allow-other-keys

Source

object-btree.lisp (file)

Method: update-btree (BTREE function-btree) &rest ARGS around

Source

view.lisp (file)

Method: update-btree (BTREE heap-btree) &rest ARGS &key VALUE ACTION

Source

heap-btree.lisp (file)

Method: update-btree (BTREE single-file-btree) &rest ARGS &key &allow-other-keys around

Source

file-btree.lisp (file)

Method: update-btree (BTREE file-btree) &key &allow-other-keys around

Source

file-btree.lisp (file)

Method: update-btree BTREE &key KEY VALUE

Source

btree.lisp (file)

5.1.3 Conditions

Condition: btree-error ()

Package

planks.btree

Source

btree-protocol.lisp (file)

Direct superclasses

error (condition)

Direct subclasses

• btree-search-error (condition)
• btree-insertion-error (condition)
• btree-type-error (condition)

Direct methods

btree-error-btree (method)

Direct slots

Slot: btree

Initargs

:btree

Readers

btree-error-btree (generic function)

Condition: btree-insertion-error ()

Package

planks.btree

Source

btree-protocol.lisp (file)

Direct superclasses

btree-error (condition)

Direct subclasses

btree-key-already-present-error (condition)

Direct methods

• btree-error-value (method)
• btree-error-key (method)

Direct slots

Slot: key

Initargs

:key

Readers

btree-error-key (generic function)

Slot: value

Initargs

:value

Readers

btree-error-value (generic function)

Condition: btree-key-already-present-error ()

Package

planks.btree

Source

btree-protocol.lisp (file)

Direct superclasses

btree-insertion-error (condition)

Condition: btree-search-error ()

Package

planks.btree

Source

btree-protocol.lisp (file)

Direct superclasses

btree-error (condition)

Direct methods

btree-error-key (method)

Direct slots

Slot: key

Initargs

:key

Readers

btree-error-key (generic function)

Condition: btree-type-error ()

Package

planks.btree

Source

btree-protocol.lisp (file)

Direct superclasses

• type-error (condition)
• btree-error (condition)

5.1.4 Classes

Class: btree ()

Package

planks.btree

Source

btree.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

file-btree (class)

Direct methods

• map-btree-keys (method)
• map-btree (method)
• node-search (method)
• btree-balanced-p (method)
• btree-depths (method)
• btree-value= (method)
• btree-key> (method)
• btree-key<= (method)
• btree-key>= (method)
• btree-key= (method)
• btree-key< (method)
• btree-insert (method)
• btree-root (method)
• btree-root (method)
• btree-value-type (method)
• btree-key-type (method)
• btree-unique-keys-p (method)
• btree-max-node-size (method)
• btree-node-class (method)
• btree-value-key (method)
• btree-key-key (method)

Direct slots

Slot: key<

Initargs

:key<

Initform

(quote <)

Readers

btree-key< (generic function)

Slot: key=

Initargs

:key=

Initform

(quote eql)

Readers

btree-key= (generic function)

Slot: value=

Initargs

:value=

Initform

(quote eql)

Readers

btree-value= (generic function)

Slot: key-key

A unary function that is applied to a
btree key before comparing it to another key with a key comparison predicate like BTREE-KEY<.

Initargs

:key-key

Initform

(quote identity)

Readers

btree-key-key (generic function)

Slot: value-key

A unary function that is applied to a
btree value before comparing it to another value with the BTREE-VALUE= predicate.

Initargs

:value-key

Initform

(quote identity)

Readers

btree-value-key (generic function)

Slot: node-class

Initargs

:node-class

Initform

(quote planks.btree:btree-node)

Readers

btree-node-class (generic function)

Slot: max-node-size

An integer specifying the preferred maximum number of keys per btree node.

Initargs

:max-node-size

Initform

100

Readers

btree-max-node-size (generic function)

Slot: unique-keys-p

If false, one key can correspond to more than one value.

Initargs

:unique-keys-p

Initform

t

Readers

btree-unique-keys-p (generic function)

Slot: key-type

The type of all keys.

Initargs

:key-type

Initform

t

Readers

btree-key-type (generic function)

Slot: value-type

The type of all values.

Initargs

:value-type

Initform

t

Readers

btree-value-type (generic function)

Slot: root

Readers

btree-root (generic function)

Writers

(setf btree-root) (generic function)

Class: btree-node ()

Package

planks.btree

Source

btree.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

file-btree-node (class)

Direct methods

• node-search (method)
• btree-node-min-depth (method)
• btree-node-max-depth (method)
• print-object (method)
• btree-node-leaf-p (method)
• btree-node-leaf-p (method)
• btree-node-index (method)
• btree-node-index (method)

Direct slots

Slot: index

A vector of key/value pairs. The keys are
sorted by KEY<. No two keys can be the same. For leaf nodes of btrees with non-unique-keys, the value part is actually a list of values. For intermediate nodes, the value is a child node. All keys in the child node will be KEY< the child node’s key in the parent node.

Initargs

:index

Initform

(vector)

Readers

btree-node-index (generic function)

Writers

(setf btree-node-index) (generic function)

Slot: leaf-p

Initargs

:leaf-p

Readers

btree-node-leaf-p (generic function)

Writers

(setf btree-node-leaf-p) (generic function)

Class: heap-btree ()

Package

planks.btree

Source

heap-btree.lisp (file)

Direct superclasses

multi-btree (class)

Direct methods

• map-btree (method)
• btree-search (method)
• update-btree (method)
• allocate-object (method)
• allocate-heap (method)
• make-btree-footer (method)
• btree-heap-free-space-start (method)
• btree-heap-start (method)
• btree-heap-size (method)
• btree-heap-size (method)

Direct slots

Slot: heap-size

Initargs

:heap-size

Initform

(* 1024 1024)

Readers

btree-heap-size (generic function)

Writers

(setf btree-heap-size) (generic function)

Slot: heap-start

Initform

0

Slot: free-space-start

Initform

0

Direct Default Initargs

Initarg	Value
:footer-class	(quote planks.btree::heap-btree-file-footer)

Class: multi-btree ()

Package

planks.btree

Source

view.lisp (file)

Direct superclasses

single-file-btree (class)

Direct subclasses

heap-btree (class)

Direct methods

• btree-search (method)
• make-btree-footer (method)

Direct Default Initargs

Initarg	Value
:footer-class	(quote planks.btree::multi-btree-file-footer)

5.2 Internal definitions

5.2.1 Constants

Constant: +persistent-standard-object-marker+

Package

planks.btree

Source

persistent-objects.lisp (file)

5.2.2 Special variables

Special Variable: *btree-file-root*

Package

planks.btree

Source

file-btree.lisp (file)

Special Variable: *btree-stream*

Package

planks.btree

Source

file-btree.lisp (file)

Special Variable: *btrees*

Package

planks.btree

Source

file-btree.lisp (file)

Special Variable: *current-btree*

Package

planks.btree

Source

view.lisp (file)

Special Variable: *current-footer*

Package

planks.btree

Source

view.lisp (file)

Special Variable: *max-footer-size*

Package

planks.btree

Source

file-btree.lisp (file)

Special Variable: *persistent-standard-class-effective-slot-definition-class*

Package

planks.btree

Source

persistent-objects.lisp (file)

Special Variable: +footer-marker+

Package

planks.btree

Source

file-btree.lisp (file)

5.2.3 Functions

Function: %update-btree BTREE &key ROOT

Package

planks.btree

Source

btree.lisp (file)

Function: btree-node-binding NODE I

Package

planks.btree

Source

btree.lisp (file)

Function: btree-node-binding-count NODE

Package

planks.btree

Source

btree-utils.lisp (file)

Function: btree-node-file-position NODE

Package

planks.btree

Source

file-btree.lisp (file)

Function: call-with-btree-stream BTREE FN &optional DIRECTION

Package

planks.btree

Source

file-btree.lisp (file)

Function: current-btree ()

Package

planks.btree

Source

view.lisp (file)

Function: current-footer ()

Package

planks.btree

Source

view.lisp (file)

Function: find-key-position-in-index BTREE INDEX KEY

Returns the position of the subnode that contains more information for the given key.

Package

planks.btree

Source

btree.lisp (file)

Function: find-subnode BTREE NODE KEY

Returns the subnode that contains more information for the given key.

Package

planks.btree

Source

btree-search.lisp (file)

Function: load-btree-node BTREE ADDRESS

Package

planks.btree

Source

file-btree.lisp (file)

Function: load-btree-node-from-stream BTREE STREAM &optional ADDRESS

Package

planks.btree

Source

file-btree.lisp (file)

Function: make-btree-lock BTREE

Package

planks.btree

Source

file-btree.lisp (file)

Function: make-footer-buffer FOOTER

Package

planks.btree

Source

file-btree.lisp (file)

Function: node-almost-full-p BTREE NODE

Package

planks.btree

Source

btree.lisp (file)

Function: not-found BTREE KEY ERRORP DEFAULT-VALUE

Package

planks.btree

Source

btree-search.lisp (file)

Function: read-btree-from-file-stream STREAM

Package

planks.btree

Source

file-btree.lisp (file)

Function: read-file-footer BTREE STREAM &key COUNT START

Package

planks.btree

Source

file-btree.lisp (file)

Function: split-binding-node BTREE NODE KEY VALUE LEAF-P

Package

planks.btree

Source

btree.lisp (file)

Function: update-binding-for-insert BTREE BINDING KEY VALUE LEAF-P

Package

planks.btree

Source

btree.lisp (file)

Function: update-bnode BTREE NODE KEY VALUE

Package

planks.btree

Source

btree.lisp (file)

Function: update-index-for-insert BTREE INDEX KEY VALUE LEAF-P

Package

planks.btree

Source

btree.lisp (file)

Function: write-file-footer BTREE STREAM FOOTER

Package

planks.btree

Source

file-btree.lisp (file)

5.2.4 Generic functions

Generic Function: allocate-heap BTREE START STREAM

Package

planks.btree

Methods

Method: allocate-heap (BTREE heap-btree) START STREAM

Source

heap-btree.lisp (file)

Generic Function: allocate-object BTREE OBJECT OBJECT-START HEAP-START STREAM

Package

planks.btree

Methods

Method: allocate-object (BTREE heap-btree) OBJECT OBJECT-START HEAP-START STREAM

Source

heap-btree.lisp (file)

Generic Function: btree-balanced-p BTREE

Package

planks.btree

Methods

Method: btree-balanced-p (BTREE btree)

Source

btree-utils.lisp (file)

Generic Function: btree-class-pathname OBJECT

Generic Function: (setf btree-class-pathname) NEW-VALUE OBJECT

Package

planks.btree

Methods

Method: btree-class-pathname (PERSISTENT-STANDARD-CLASS persistent-standard-class)

automatically generated reader method

Source

persistent-objects.lisp (file)

Method: (setf btree-class-pathname) NEW-VALUE (PERSISTENT-STANDARD-CLASS persistent-standard-class)

automatically generated writer method

Source

persistent-objects.lisp (file)

Method: btree-class-pathname (CLASS standard-class) around

Source

btree-class.lisp (file)

Method: btree-class-pathname (BTREE-CLASS btree-class)

automatically generated reader method

Source

btree-class.lisp (file)

Method: (setf btree-class-pathname) NEW-VALUE (BTREE-CLASS btree-class)

automatically generated writer method

Source

btree-class.lisp (file)

Generic Function: btree-depths BTREE

Package

planks.btree

Methods

Method: btree-depths (BTREE file-btree) around

Source

file-btree.lisp (file)

Method: btree-depths (BTREE btree)

Source

btree-utils.lisp (file)

Generic Function: btree-file-footer OBJECT

Generic Function: (setf btree-file-footer) NEW-VALUE OBJECT

Package

planks.btree

Methods

Method: btree-file-footer (SINGLE-FILE-BTREE single-file-btree)

automatically generated reader method

Source

file-btree.lisp (file)

Method: (setf btree-file-footer) NEW-VALUE (SINGLE-FILE-BTREE single-file-btree)

automatically generated writer method

Source

file-btree.lisp (file)

Generic Function: btree-file-footer-action OBJECT

Generic Function: (setf btree-file-footer-action) NEW-VALUE OBJECT

Package

planks.btree

Methods

Method: btree-file-footer-action (BTREE-FOOTER btree-footer)

automatically generated reader method

Source

file-btree.lisp (file)

Method: (setf btree-file-footer-action) NEW-VALUE (BTREE-FOOTER btree-footer)

automatically generated writer method

Source

file-btree.lisp (file)

Generic Function: btree-file-footer-address OBJECT

Generic Function: (setf btree-file-footer-address) NEW-VALUE OBJECT

Package

planks.btree

Methods

Method: btree-file-footer-address (BTREE-FOOTER btree-footer)

automatically generated reader method

Source

file-btree.lisp (file)

Method: (setf btree-file-footer-address) NEW-VALUE (BTREE-FOOTER btree-footer)

automatically generated writer method

Source

file-btree.lisp (file)

Generic Function: btree-file-footer-class OBJECT

Generic Function: (setf btree-file-footer-class) NEW-VALUE OBJECT

Package

planks.btree

Methods

Method: btree-file-footer-class (SINGLE-FILE-BTREE single-file-btree)

automatically generated reader method

Source

file-btree.lisp (file)

Method: (setf btree-file-footer-class) NEW-VALUE (SINGLE-FILE-BTREE single-file-btree)

automatically generated writer method

Source

file-btree.lisp (file)

Generic Function: btree-file-footer-key OBJECT

Generic Function: (setf btree-file-footer-key) NEW-VALUE OBJECT

Package

planks.btree

Methods

Method: btree-file-footer-key (BTREE-FOOTER btree-footer)

automatically generated reader method

Source

file-btree.lisp (file)

Method: (setf btree-file-footer-key) NEW-VALUE (BTREE-FOOTER btree-footer)

automatically generated writer method

Source

file-btree.lisp (file)

Generic Function: btree-file-footer-previous-address OBJECT

Generic Function: (setf btree-file-footer-previous-address) NEW-VALUE OBJECT

Package

planks.btree

Methods

Method: btree-file-footer-previous-address (BTREE-FOOTER btree-footer)

automatically generated reader method

Source

file-btree.lisp (file)

Method: (setf btree-file-footer-previous-address) NEW-VALUE (BTREE-FOOTER btree-footer)

automatically generated writer method

Source

file-btree.lisp (file)

Generic Function: btree-file-footer-version OBJECT

Generic Function: (setf btree-file-footer-version) NEW-VALUE OBJECT

Package

planks.btree

Methods

Method: btree-file-footer-version (BTREE-FOOTER btree-footer)

automatically generated reader method

Source

file-btree.lisp (file)

Method: (setf btree-file-footer-version) NEW-VALUE (BTREE-FOOTER btree-footer)

automatically generated writer method

Source

file-btree.lisp (file)

Generic Function: btree-footer-next-id OBJECT

Generic Function: (setf btree-footer-next-id) NEW-VALUE OBJECT

Package

planks.btree

Methods

Method: btree-footer-next-id (OBJECT-STORAGE-FOOTER object-storage-footer)

automatically generated reader method

Source

object-btree.lisp (file)

Method: (setf btree-footer-next-id) NEW-VALUE (OBJECT-STORAGE-FOOTER object-storage-footer)

automatically generated writer method

Source

object-btree.lisp (file)

Generic Function: btree-function-name OBJECT

Generic Function: (setf btree-function-name) NEW-VALUE OBJECT

Package

planks.btree

Methods

Method: btree-function-name (FUNCTION-BTREE function-btree)

automatically generated reader method

Source

view.lisp (file)

Method: (setf btree-function-name) NEW-VALUE (FUNCTION-BTREE function-btree)

automatically generated writer method

Source

view.lisp (file)

Generic Function: btree-heap-free-space-start BTREE

Package

planks.btree

Methods

Method: btree-heap-free-space-start (BTREE heap-btree)

Source

heap-btree.lisp (file)

Generic Function: btree-heap-size OBJECT

Generic Function: (setf btree-heap-size) NEW-VALUE OBJECT

Package

planks.btree

Methods

Method: btree-heap-size (HEAP-BTREE heap-btree)

automatically generated reader method

Source

heap-btree.lisp (file)

Method: (setf btree-heap-size) NEW-VALUE (HEAP-BTREE heap-btree)

automatically generated writer method

Source

heap-btree.lisp (file)

Generic Function: btree-heap-start BTREE

Package

planks.btree

Methods

Method: btree-heap-start (BTREE heap-btree)

Source

heap-btree.lisp (file)

Generic Function: btree-key-key OBJECT

Package

planks.btree

Methods

Method: btree-key-key (BTREE btree)

A unary function that is applied to a
btree key before comparing it to another key with a key comparison predicate like BTREE-KEY<.

Source

btree.lisp (file)

Generic Function: btree-key<= BTREE

Package

planks.btree

Methods

Method: btree-key<= (BTREE btree)

Source

btree-utils.lisp (file)

Generic Function: btree-key> BTREE

Package

planks.btree

Methods

Method: btree-key> (BTREE btree)

Source

btree-utils.lisp (file)

Generic Function: btree-key>= BTREE

Package

planks.btree

Methods

Method: btree-key>= (BTREE btree)

Source

btree-utils.lisp (file)

Generic Function: btree-lock OBJECT

Generic Function: (setf btree-lock) NEW-VALUE OBJECT

Package

planks.btree

Methods

Method: btree-lock (SINGLE-FILE-BTREE single-file-btree)

automatically generated reader method

Source

file-btree.lisp (file)

Method: (setf btree-lock) NEW-VALUE (SINGLE-FILE-BTREE single-file-btree)

automatically generated writer method

Source

file-btree.lisp (file)

Generic Function: btree-node-address OBJECT

Generic Function: (setf btree-node-address) NEW-VALUE OBJECT

Package

planks.btree

Methods

Method: btree-node-address (FILE-BTREE-NODE file-btree-node)

automatically generated reader method

Source

file-btree.lisp (file)

Method: (setf btree-node-address) NEW-VALUE (FILE-BTREE-NODE file-btree-node)

automatically generated writer method

Source

file-btree.lisp (file)

Generic Function: btree-node-binding-key NODE BINDING

Package

planks.btree

Methods

Method: btree-node-binding-key NODE BINDING

Source

btree.lisp (file)

Generic Function: btree-node-binding-value NODE BINDING

Package

planks.btree

Methods

Method: btree-node-binding-value NODE BINDING

Source

btree.lisp (file)

Generic Function: btree-node-index OBJECT

Generic Function: (setf btree-node-index) NEW-VALUE OBJECT

Package

planks.btree

Methods

Method: btree-node-index (BTREE-NODE btree-node)

Method: (setf btree-node-index) NEW-VALUE (BTREE-NODE btree-node)

A vector of key/value pairs. The keys are
sorted by KEY<. No two keys can be the same. For leaf nodes of btrees with non-unique-keys, the value part is actually a list of values. For intermediate nodes, the value is a child node. All keys in the child node will be KEY< the child node’s key in the parent node.

Source

btree.lisp (file)

Generic Function: btree-node-leaf-p OBJECT

Generic Function: (setf btree-node-leaf-p) NEW-VALUE OBJECT

Package

planks.btree

Methods

Method: btree-node-leaf-p (BTREE-NODE btree-node)

automatically generated reader method

Source

btree.lisp (file)

Method: (setf btree-node-leaf-p) NEW-VALUE (BTREE-NODE btree-node)

automatically generated writer method

Source

btree.lisp (file)

Generic Function: btree-node-max-depth NODE

Package

planks.btree

Methods

Method: btree-node-max-depth (NODE integer)

Source

file-btree.lisp (file)

Method: btree-node-max-depth (NODE btree-node)

Source

btree-utils.lisp (file)

Generic Function: btree-node-min-depth NODE

Package

planks.btree

Methods

Method: btree-node-min-depth (NODE integer)

Source

file-btree.lisp (file)

Method: btree-node-min-depth (NODE btree-node)

Source

btree-utils.lisp (file)

Generic Function: btree-object-id OBJECT

Generic Function: (setf btree-object-id) NEW-VALUE OBJECT

Package

planks.btree

Methods

Method: btree-object-id (BTREE-OBJECT btree-object)

automatically generated reader method

Source

btree-class.lisp (file)

Method: (setf btree-object-id) NEW-VALUE (BTREE-OBJECT btree-object)

automatically generated writer method

Source

btree-class.lisp (file)

Generic Function: btree-pathname OBJECT

Generic Function: (setf btree-pathname) NEW-VALUE OBJECT

Package

planks.btree

Methods

Method: btree-pathname (OBJECT persistent-standard-object)

Source

persistent-objects.lisp (file)

Method: btree-pathname (BTREE nested-btree) around

Source

object-btree.lisp (file)

Method: btree-pathname OBJECT

Source

btree-class.lisp (file)

Method: btree-pathname (FILE-BTREE file-btree)

automatically generated reader method

Source

file-btree.lisp (file)

Method: (setf btree-pathname) NEW-VALUE (FILE-BTREE file-btree)

automatically generated writer method

Source

file-btree.lisp (file)

Generic Function: btree-value-key OBJECT

Package

planks.btree

Methods

Method: btree-value-key (BTREE btree)

A unary function that is applied to a
btree value before comparing it to another value with the BTREE-VALUE= predicate.

Source

btree.lisp (file)

Generic Function: find-heap-object HEAP ADDRESS

Package

planks.btree

Methods

Method: find-heap-object HEAP ADDRESS

Source

heap-btree.lisp (file)

Generic Function: largest-key-in-node NODE

Package

planks.btree

Methods

Method: largest-key-in-node (POINTER integer)

Source

file-btree.lisp (file)

Method: largest-key-in-node NODE

Source

btree.lisp (file)

Generic Function: make-btree-footer BTREE OLD-FOOTER &key ACTION KEY VALUE FUNCTION-NAME FUNCTION-INDEX-INITARGS &allow-other-keys

Package

planks.btree

Source

object-btree.lisp (file)

Methods

Method: make-btree-footer (BTREE object-storage-btree) OLD-FOOTER &key ACTION around

Method: make-btree-footer (BTREE multi-btree) OLD-FOOTER &key KEY VALUE ACTION FUNCTION-NAME FUNCTION-INDEX-INITARGS &allow-other-keys around

Source

view.lisp (file)

Method: make-btree-footer (BTREE heap-btree) OLD-FOOTER &key &allow-other-keys around

Source

heap-btree.lisp (file)

Method: make-btree-footer (BTREE single-file-btree) OLD-FOOTER &key ACTION

Source

file-btree.lisp (file)

Generic Function: make-root-node BTREE KEY VAL

Package

planks.btree

Methods

Method: make-root-node BTREE KEY VAL

Source

btree.lisp (file)

Generic Function: map-btree-keys BTREE FUNCTION &key MIN MAX INCLUDE-MIN INCLUDE-MAX ORDER

Package

planks.btree

Methods

Method: map-btree-keys (BTREE btree) FUNCTION &key MIN MAX INCLUDE-MIN INCLUDE-MAX ORDER

Source

map-btree.lisp (file)

Generic Function: map-btree-keys-for-node BTREE NODE FUNCTION MIN MAX INCLUDE-MIN INCLUDE-MAX ORDER

Package

planks.btree

Source

map-btree.lisp (file)

Methods

Method: map-btree-keys-for-node BTREE (POINTER integer) FUNCTION MIN MAX INCLUDE-MIN INCLUDE-MAX ORDER around

Source

file-btree.lisp (file)

Method: map-btree-keys-for-node BTREE (NODE null) FUNCTION MIN MAX INCLUDE-MIN INCLUDE-MAX ORDER

Method: map-btree-keys-for-node BTREE NODE FUNCTION MIN MAX INCLUDE-MIN INCLUDE-MAX ORDER

Generic Function: map-btree-node BTREE FUNCTION POINTER

Package

planks.btree

Methods

Method: map-btree-node BTREE FUNCTION (POINTER integer)

Source

file-btree.lisp (file)

Generic Function: node-search BTREE NODE KEY ERRORP DEFAULT-VALUE

Package

planks.btree

Source

btree-search.lisp (file)

Methods

Method: node-search BTREE (NODE integer) KEY ERRORP DEFAULT-VALUE

Source

file-btree.lisp (file)

Method: node-search (BTREE btree) (NODE btree-node) KEY ERRORP DEFAULT-VALUE

Generic Function: persist NODE &key STREAM

Package

planks.btree

Methods

Method: persist NODE &key STREAM

Source

file-btree.lisp (file)

Generic Function: persistent-standard-class-btree OBJECT

Generic Function: (setf persistent-standard-class-btree) NEW-VALUE OBJECT

Package

planks.btree

Methods

Method: persistent-standard-class-btree (PERSISTENT-STANDARD-CLASS persistent-standard-class)

automatically generated reader method

Source

persistent-objects.lisp (file)

Method: (setf persistent-standard-class-btree) NEW-VALUE (PERSISTENT-STANDARD-CLASS persistent-standard-class)

automatically generated writer method

Source

persistent-objects.lisp (file)

Generic Function: persistent-standard-object-slot-btree OBJECT

Generic Function: (setf persistent-standard-object-slot-btree) NEW-VALUE OBJECT

Package

planks.btree

Methods

Method: persistent-standard-object-slot-btree (PERSISTENT-STANDARD-OBJECT persistent-standard-object)

automatically generated reader method

Source

persistent-objects.lisp (file)

Method: (setf persistent-standard-object-slot-btree) NEW-VALUE (PERSISTENT-STANDARD-OBJECT persistent-standard-object)

automatically generated writer method

Source

persistent-objects.lisp (file)

Generic Function: persistent-standard-object-slot-btree-class-name OBJECT

Generic Function: (setf persistent-standard-object-slot-btree-class-name) NEW-VALUE OBJECT

Package

planks.btree

Methods

Method: persistent-standard-object-slot-btree-class-name (PERSISTENT-STANDARD-OBJECT-SLOT-BTREE persistent-standard-object-slot-btree)

automatically generated reader method

Source

persistent-objects.lisp (file)

Method: (setf persistent-standard-object-slot-btree-class-name) NEW-VALUE (PERSISTENT-STANDARD-OBJECT-SLOT-BTREE persistent-standard-object-slot-btree)

automatically generated writer method

Source

persistent-objects.lisp (file)

Generic Function: read-footer-checksum BTREE STREAM

Package

planks.btree

Methods

Method: read-footer-checksum BTREE STREAM

Source

file-btree.lisp (file)

Generic Function: read-node-tag NODE &key STREAM

Package

planks.btree

Methods

Method: read-node-tag NODE &key STREAM

Source

file-btree.lisp (file)

Generic Function: root-node-file-position OBJECT

Generic Function: (setf root-node-file-position) NEW-VALUE OBJECT

Package

planks.btree

Methods

Method: root-node-file-position (BTREE-FOOTER btree-footer)

automatically generated reader method

Source

file-btree.lisp (file)

Method: (setf root-node-file-position) NEW-VALUE (BTREE-FOOTER btree-footer)

automatically generated writer method

Source

file-btree.lisp (file)

Generic Function: slot-definition-persistentp SLOT

Generic Function: (setf slot-definition-persistentp) NEW-VALUE OBJECT

Package

planks.btree

Methods

Method: slot-definition-persistentp (PERSISTENT-STANDARD-CLASS-SLOT-DEFINITION persistent-standard-class-slot-definition)

automatically generated reader method

Source

persistent-objects.lisp (file)

Method: slot-definition-persistentp SLOT

Source

persistent-objects.lisp (file)

Method: (setf slot-definition-persistentp) NEW-VALUE (PERSISTENT-STANDARD-CLASS-SLOT-DEFINITION persistent-standard-class-slot-definition)

automatically generated writer method

Source

persistent-objects.lisp (file)

Generic Function: update-node NODE &key INDEX LEAF-P &allow-other-keys

Package

planks.btree

Methods

Method: update-node (NODE file-btree-node) &key &allow-other-keys around

Source

file-btree.lisp (file)

Method: update-node NODE &key INDEX LEAF-P

Source

btree.lisp (file)

Generic Function: update-node-for-insert BTREE NODE BINDING-KEY KEY VALUE LEAF-P

Package

planks.btree

Methods

Method: update-node-for-insert BTREE (POINTER integer) BINDING-KEY KEY VALUE (LEAF-P null)

Source

file-btree.lisp (file)

Method: update-node-for-insert BTREE NODE BINDING-KEY KEY VALUE LEAF-P

Source

btree.lisp (file)

Generic Function: write-footer-checksum BTREE STREAM CHECKSUM

Package

planks.btree

Methods

Method: write-footer-checksum BTREE STREAM CHECKSUM

Source

file-btree.lisp (file)

Generic Function: write-node-tag NODE &key STREAM

Package

planks.btree

Methods

Method: write-node-tag NODE &key STREAM

Source

file-btree.lisp (file)

5.2.5 Classes

Class: btree-class ()

Package

planks.btree

Source

btree-class.lisp (file)

Direct superclasses

standard-class (class)

Direct methods

• reinitialize-instance (method)
• initialize-instance (method)
• validate-superclass (method)
• btree-class-pathname (method)
• btree-class-pathname (method)

Direct slots

Slot: pathname

Initargs

:btree-path

Readers

btree-class-pathname (generic function)

Writers

(setf btree-class-pathname) (generic function)

Class: btree-footer ()

Package

planks.btree

Source

file-btree.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

• multi-btree-file-footer (class)
• object-storage-footer (class)

Direct methods

• btree-file-footer-key (method)
• btree-file-footer-key (method)
• btree-file-footer-previous-address (method)
• btree-file-footer-previous-address (method)
• btree-file-footer-version (method)
• btree-file-footer-version (method)
• btree-file-footer-action (method)
• btree-file-footer-action (method)
• btree-file-footer-address (method)
• btree-file-footer-address (method)
• root-node-file-position (method)
• root-node-file-position (method)

Direct slots

Slot: root-node-address

Initargs

:root-node-position

Readers

root-node-file-position (generic function)

Writers

(setf root-node-file-position) (generic function)

Slot: address

Initargs

:address

Readers

btree-file-footer-address (generic function)

Writers

(setf btree-file-footer-address) (generic function)

Slot: action

Initargs

:action

Initform

:create

Readers

btree-file-footer-action (generic function)

Writers

(setf btree-file-footer-action) (generic function)

Slot: version

Initargs

:version

Initform

0

Readers

btree-file-footer-version (generic function)

Writers

(setf btree-file-footer-version) (generic function)

Slot: previous-address

Initargs

:previous-address

Readers

btree-file-footer-previous-address (generic function)

Writers

(setf btree-file-footer-previous-address) (generic function)

Slot: key

Readers

btree-file-footer-key (generic function)

Writers

(setf btree-file-footer-key) (generic function)

Class: btree-object ()

Package

planks.btree

Source

btree-class.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

persistent-standard-object-slot-btree (class)

Direct methods

• shared-initialize (method)
• btree-object-id (method)
• btree-object-id (method)

Direct slots

Slot: id

Initargs

:id

Readers

btree-object-id (generic function)

Writers

(setf btree-object-id) (generic function)

Class: file-btree ()

Package

planks.btree

Source

file-btree.lisp (file)

Direct superclasses

btree (class)

Direct subclasses

• single-file-btree (class)
• function-btree (class)
• nested-btree (class)

Direct methods

• update-btree (method)
• btree-depths (method)
• btree-root (method)
• shared-initialize (method)
• btree-pathname (method)
• btree-pathname (method)

Direct slots

Slot: pathname

Initargs

:pathname

Readers

btree-pathname (generic function)

Writers

(setf btree-pathname) (generic function)

Direct Default Initargs

Initarg	Value
:node-class	(quote planks.btree::file-btree-node)

Class: file-btree-node ()

Package

planks.btree

Source

file-btree.lisp (file)

Direct superclasses

btree-node (class)

Direct methods

• update-node (method)
• serialize (method)
• btree-node-address (method)
• btree-node-address (method)

Direct slots

Slot: address

Initargs

:address

Readers

btree-node-address (generic function)

Writers

(setf btree-node-address) (generic function)

Class: function-btree ()

Package

planks.btree

Source

view.lisp (file)

Direct superclasses

file-btree (class)

Direct methods

• update-btree (method)
• btree-function-name (method)
• btree-function-name (method)

Direct slots

Slot: name

Initargs

:name

Readers

btree-function-name (generic function)

Writers

(setf btree-function-name) (generic function)

Class: heap-btree-file-footer ()

Package

planks.btree

Source

heap-btree.lisp (file)

Direct superclasses

multi-btree-file-footer (class)

Direct slots

Slot: heap-start

Initform

0

Slot: free-space-start

Initform

0

Class: multi-btree-file-footer ()

Package

planks.btree

Source

view.lisp (file)

Direct superclasses

btree-footer (class)

Direct subclasses

heap-btree-file-footer (class)

Direct slots

Slot: btrees