The planks Reference Manual

This is the planks Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 07:18:07 2024 GMT+0.

Table of Contents


1 Systems

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


1.1 planks

Author

Drew Crampsie <>

License

MIT

Dependencies
  • rucksack (system).
  • ironclad (system).
  • bordeaux-threads (system).
  • trivial-garbage (system).
  • babel (system).
  • closer-mop (system).
Source

planks.asd.

Child Component

src (module).


2 Modules

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


2.1 planks/src

Source

planks.asd.

Parent Component

planks (system).

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 planks/planks.asd

Source

planks.asd.

Parent Component

planks (system).

ASDF Systems

planks.


3.1.2 planks/src/btree-protocol.lisp

Source

planks.asd.

Parent Component

src (module).

Packages

planks.btree.

Public Interface

3.1.3 planks/src/btree.lisp

Dependency

btree-protocol.lisp (file).

Source

planks.asd.

Parent Component

src (module).

Public Interface
Internals

3.1.4 planks/src/btree-utils.lisp

Dependency

btree.lisp (file).

Source

planks.asd.

Parent Component

src (module).

Public Interface
Internals

3.1.5 planks/src/btree-search.lisp

Dependency

btree-utils.lisp (file).

Source

planks.asd.

Parent Component

src (module).

Public Interface

btree-search (generic function).

Internals

3.1.6 planks/src/map-btree.lisp

Dependency

btree-search.lisp (file).

Source

planks.asd.

Parent Component

src (module).

Public Interface

map-btree (method).

Internals

3.1.7 planks/src/file-btree.lisp

Dependency

map-btree.lisp (file).

Source

planks.asd.

Parent Component

src (module).

Public Interface
Internals

3.1.8 planks/src/heap-btree.lisp

Dependency

file-btree.lisp (file).

Source

planks.asd.

Parent Component

src (module).

Public Interface
Internals

3.1.9 planks/src/view.lisp

Dependency

heap-btree.lisp (file).

Source

planks.asd.

Parent Component

src (module).

Public Interface
Internals

3.1.10 planks/src/btree-class.lisp

Dependency

view.lisp (file).

Source

planks.asd.

Parent Component

src (module).

Public Interface
Internals

3.1.11 planks/src/object-btree.lisp

Dependency

btree-class.lisp (file).

Source

planks.asd.

Parent Component

src (module).

Public Interface
Internals

3.1.12 planks/src/persistent-objects.lisp

Dependency

object-btree.lisp (file).

Source

planks.asd.

Parent Component

src (module).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 planks.btree

Source

btree-protocol.lisp.

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: add-function-btree (btree function-name &rest args)
Package

planks.btree.

Source

view.lisp.

Function: btree-file-size (btree)
Package

planks.btree.

Source

file-btree.lisp.

Function: close-btree (path)
Package

planks.btree.

Source

file-btree.lisp.

Function: find-btree (path)
Package

planks.btree.

Source

file-btree.lisp.

Function: find-function-btree (btree function-name)
Package

planks.btree.

Source

view.lisp.

Function: make-btree (pathname &rest args &key if-exists class &allow-other-keys)
Package

planks.btree.

Source

file-btree.lisp.


5.1.2 Generic functions

Generic Reader: btree-error-btree (condition)
Package

planks.btree.

Methods
Reader Method: btree-error-btree ((condition btree-error))
Source

btree-protocol.lisp.

Target Slot

btree.

Generic Reader: btree-error-key (condition)
Package

planks.btree.

Methods
Reader Method: btree-error-key ((condition btree-insertion-error))
Source

btree-protocol.lisp.

Target Slot

key.

Reader Method: btree-error-key ((condition btree-search-error))
Source

btree-protocol.lisp.

Target Slot

key.

Generic Reader: btree-error-value (condition)
Package

planks.btree.

Methods
Reader Method: btree-error-value ((condition btree-insertion-error))
Source

btree-protocol.lisp.

Target Slot

value.

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.

Methods
Method: btree-insert ((btree btree) key value &key if-exists)
Source

btree.lisp.

Generic Reader: btree-key-type (object)
Package

planks.btree.

Methods
Reader Method: btree-key-type ((btree btree))

The type of all keys.

Source

btree.lisp.

Target Slot

key-type.

Generic Reader: btree-key< (object)
Package

planks.btree.

Methods
Reader Method: btree-key< ((btree btree))
Source

btree-utils.lisp.

Target Slot

key<.

Generic Reader: btree-key= (object)
Package

planks.btree.

Methods
Reader Method: btree-key= ((btree btree))
Source

btree-utils.lisp.

Target Slot

key=.

Generic Reader: btree-max-node-size (object)
Package

planks.btree.

Methods
Reader Method: btree-max-node-size ((btree btree))

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

Source

btree.lisp.

Target Slot

max-node-size.

Generic Reader: btree-node-class (object)
Package

planks.btree.

Methods
Reader Method: btree-node-class ((btree btree))

automatically generated reader method

Source

btree.lisp.

Target Slot

node-class.

Generic Function: btree-root (object)
Package

planks.btree.

Methods
Method: btree-root ((btree file-btree))
Source

file-btree.lisp.

Reader Method: btree-root ((btree btree))

automatically generated reader method

Source

btree.lisp.

Target Slot

root.

Generic Writer: (setf btree-root) (object)
Package

planks.btree.

Methods
Writer Method: (setf btree-root) ((btree btree))

automatically generated writer method

Source

btree.lisp.

Target Slot

root.

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.

Methods
Method: btree-search :around ((btree multi-btree) key &key errorp default-value function)
Source

view.lisp.

Method: btree-search ((btree heap-btree) key &key address-only &allow-other-keys)
Source

heap-btree.lisp.

Method: btree-search (btree key &key errorp default-value)
Generic Reader: btree-unique-keys-p (object)
Package

planks.btree.

Methods
Reader Method: btree-unique-keys-p ((btree btree))

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

Source

btree.lisp.

Target Slot

unique-keys-p.

Generic Reader: btree-value-type (object)
Package

planks.btree.

Methods
Reader Method: btree-value-type ((btree btree))

The type of all values.

Source

btree.lisp.

Target Slot

value-type.

Generic Reader: btree-value= (object)
Package

planks.btree.

Methods
Reader Method: btree-value= ((btree btree))
Source

btree-utils.lisp.

Target Slot

value=.

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.

Methods
Method: map-btree :around ((bt heap-btree) fn &rest args &key address-only &allow-other-keys)
Source

heap-btree.lisp.

Method: map-btree ((btree btree) function &key min max include-min include-max order)
Source

map-btree.lisp.

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.

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

persistent-objects.lisp.

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

object-btree.lisp.

Method: update-btree ((btree object-storage-btree) &rest args &key value-thunk &allow-other-keys)
Source

object-btree.lisp.

Method: update-btree :around ((btree function-btree) &rest args)
Source

view.lisp.

Method: update-btree ((btree heap-btree) &rest args &key value action)
Source

heap-btree.lisp.

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

file-btree.lisp.

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

file-btree.lisp.

Method: update-btree (btree &key key value)
Source

btree.lisp.


5.1.3 Standalone methods

Method: compute-effective-slot-definition ((class persistent-standard-class) name direct-slot-definitions)
Package

sb-mop.

Source

persistent-objects.lisp.

Method: direct-slot-definition-class ((class persistent-standard-class) &key &allow-other-keys)
Package

sb-mop.

Source

persistent-objects.lisp.

Method: effective-slot-definition-class ((class persistent-standard-class) &key &allow-other-keys)
Package

sb-mop.

Source

persistent-objects.lisp.

Method: initialize-instance :around ((class persistent-standard-class) &rest initargs &key direct-superclasses)
Source

persistent-objects.lisp.

Method: initialize-instance :around ((class btree-class) &rest initargs &key direct-superclasses)
Source

btree-class.lisp.

Method: print-object ((object btree-node) stream)
Source

btree.lisp.

Method: reinitialize-instance :around ((class persistent-standard-class) &rest initargs &key direct-superclasses)
Source

persistent-objects.lisp.

Method: reinitialize-instance :around ((class btree-class) &rest initargs &key direct-superclasses)
Source

btree-class.lisp.

Method: shared-initialize :before ((object persistent-standard-object) slots &rest initargs)
Source

persistent-objects.lisp.

Method: shared-initialize :after ((object file-btree) slots &rest args)
Source

file-btree.lisp.

Method: shared-initialize :around ((object btree-object) slots &rest initargs &key btree)
Source

btree-class.lisp.

Method: slot-boundp-using-class ((class persistent-standard-class) (object persistent-standard-object) (slotd persistent-standard-class-effective-slot-definition))
Package

sb-mop.

Source

persistent-objects.lisp.

Method: (setf slot-value-using-class) ((class persistent-standard-class) (object persistent-standard-object) (slotd persistent-standard-class-effective-slot-definition))
Package

sb-mop.

Source

persistent-objects.lisp.

Method: slot-value-using-class ((class persistent-standard-class) (object persistent-standard-object) (slotd persistent-standard-class-effective-slot-definition))
Package

sb-mop.

Source

persistent-objects.lisp.

Method: validate-superclass ((class persistent-standard-class) sc)
Package

sb-mop.

Source

persistent-objects.lisp.

Method: validate-superclass ((class btree-class) sc)
Package

sb-mop.

Source

btree-class.lisp.


5.1.4 Conditions

Condition: btree-error
Package

planks.btree.

Source

btree-protocol.lisp.

Direct superclasses

error.

Direct subclasses
Direct methods

btree-error-btree.

Direct slots
Slot: btree
Initargs

:btree

Readers

btree-error-btree.

Writers

This slot is read-only.

Condition: btree-insertion-error
Package

planks.btree.

Source

btree-protocol.lisp.

Direct superclasses

btree-error.

Direct subclasses

btree-key-already-present-error.

Direct methods
Direct slots
Slot: key
Initargs

:key

Readers

btree-error-key.

Writers

This slot is read-only.

Slot: value
Initargs

:value

Readers

btree-error-value.

Writers

This slot is read-only.

Condition: btree-key-already-present-error
Package

planks.btree.

Source

btree-protocol.lisp.

Direct superclasses

btree-insertion-error.

Condition: btree-search-error
Package

planks.btree.

Source

btree-protocol.lisp.

Direct superclasses

btree-error.

Direct methods

btree-error-key.

Direct slots
Slot: key
Initargs

:key

Readers

btree-error-key.

Writers

This slot is read-only.

Condition: btree-type-error
Package

planks.btree.

Source

btree-protocol.lisp.

Direct superclasses

5.1.5 Classes

Class: btree
Package

planks.btree.

Source

btree.lisp.

Direct subclasses

file-btree.

Direct methods
Direct slots
Slot: key<
Initform

(quote <)

Initargs

:key<

Readers

btree-key<.

Writers

This slot is read-only.

Slot: key=
Initform

(quote eql)

Initargs

:key=

Readers

btree-key=.

Writers

This slot is read-only.

Slot: value=
Initform

(quote eql)

Initargs

:value=

Readers

btree-value=.

Writers

This slot is read-only.

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<.

Initform

(quote identity)

Initargs

:key-key

Readers

btree-key-key.

Writers

This slot is read-only.

Slot: value-key

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

Initform

(quote identity)

Initargs

:value-key

Readers

btree-value-key.

Writers

This slot is read-only.

Slot: node-class
Initform

(quote planks.btree:btree-node)

Initargs

:node-class

Readers

btree-node-class.

Writers

This slot is read-only.

Slot: max-node-size

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

Initform

100

Initargs

:max-node-size

Readers

btree-max-node-size.

Writers

This slot is read-only.

Slot: unique-keys-p

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

Initform

t

Initargs

:unique-keys-p

Readers

btree-unique-keys-p.

Writers

This slot is read-only.

Slot: key-type

The type of all keys.

Initform

t

Initargs

:key-type

Readers

btree-key-type.

Writers

This slot is read-only.

Slot: value-type

The type of all values.

Initform

t

Initargs

:value-type

Readers

btree-value-type.

Writers

This slot is read-only.

Slot: root
Readers

btree-root.

Writers

(setf btree-root).

Class: btree-node
Package

planks.btree.

Source

btree.lisp.

Direct subclasses

file-btree-node.

Direct methods
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.

Initform

(vector)

Initargs

:index

Readers

btree-node-index.

Writers

(setf btree-node-index).

Slot: leaf-p
Initargs

:leaf-p

Readers

btree-node-leaf-p.

Writers

(setf btree-node-leaf-p).

Class: heap-btree
Package

planks.btree.

Source

heap-btree.lisp.

Direct superclasses

multi-btree.

Direct methods
Direct Default Initargs
InitargValue
:footer-class(quote heap-btree-file-footer)
Direct slots
Slot: heap-size
Initform

(* 1024 1024)

Initargs

:heap-size

Readers

btree-heap-size.

Writers

(setf btree-heap-size).

Slot: heap-start
Initform

0

Slot: free-space-start
Initform

0

Class: multi-btree
Package

planks.btree.

Source

view.lisp.

Direct superclasses

single-file-btree.

Direct subclasses

heap-btree.

Direct methods
Direct Default Initargs
InitargValue
:footer-class(quote multi-btree-file-footer)

5.2 Internals


5.2.1 Constants

Constant: +persistent-standard-object-marker+
Package

planks.btree.

Source

persistent-objects.lisp.


5.2.2 Special variables

Special Variable: *btree-file-root*
Package

planks.btree.

Source

file-btree.lisp.

Special Variable: *btree-stream*
Package

planks.btree.

Source

file-btree.lisp.

Special Variable: *btrees*
Package

planks.btree.

Source

file-btree.lisp.

Special Variable: *current-btree*
Package

planks.btree.

Source

view.lisp.

Special Variable: *current-footer*
Package

planks.btree.

Source

view.lisp.

Special Variable: *max-footer-size*
Package

planks.btree.

Source

file-btree.lisp.

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

planks.btree.

Source

persistent-objects.lisp.

Special Variable: +footer-marker+
Package

planks.btree.

Source

file-btree.lisp.


5.2.3 Ordinary functions

Function: %update-btree (btree &key root)
Package

planks.btree.

Source

btree.lisp.

Function: btree-node-binding (node i)
Package

planks.btree.

Source

btree.lisp.

Function: btree-node-binding-count (node)
Package

planks.btree.

Source

btree-utils.lisp.

Function: btree-node-file-position (node)
Package

planks.btree.

Source

file-btree.lisp.

Function: call-with-btree-stream (btree fn &optional direction)
Package

planks.btree.

Source

file-btree.lisp.

Function: current-btree ()
Package

planks.btree.

Source

view.lisp.

Function: current-footer ()
Package

planks.btree.

Source

view.lisp.

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.

Function: find-subnode (btree node key)

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

Package

planks.btree.

Source

btree-search.lisp.

Function: load-btree-node (btree address)
Package

planks.btree.

Source

file-btree.lisp.

Function: load-btree-node-from-stream (btree stream &optional address)
Package

planks.btree.

Source

file-btree.lisp.

Function: make-btree-lock (btree)
Package

planks.btree.

Source

file-btree.lisp.

Function: make-footer-buffer (footer)
Package

planks.btree.

Source

file-btree.lisp.

Function: node-almost-full-p (btree node)
Package

planks.btree.

Source

btree.lisp.

Function: not-found (btree key errorp default-value)
Package

planks.btree.

Source

btree-search.lisp.

Function: read-btree-from-file-stream (stream)
Package

planks.btree.

Source

file-btree.lisp.

Function: read-file-footer (btree stream &key count start)
Package

planks.btree.

Source

file-btree.lisp.

Function: split-binding-node (btree node key value leaf-p)
Package

planks.btree.

Source

btree.lisp.

Function: update-binding-for-insert (btree binding key value leaf-p)
Package

planks.btree.

Source

btree.lisp.

Function: update-bnode (btree node key value)
Package

planks.btree.

Source

btree.lisp.

Function: update-index-for-insert (btree index key value leaf-p)
Package

planks.btree.

Source

btree.lisp.

Function: write-file-footer (btree stream footer)
Package

planks.btree.

Source

file-btree.lisp.


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.

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.

Generic Function: btree-balanced-p (btree)
Package

planks.btree.

Methods
Method: btree-balanced-p ((btree btree))
Source

btree-utils.lisp.

Generic Function: btree-class-pathname (object)
Package

planks.btree.

Methods
Reader Method: btree-class-pathname ((persistent-standard-class persistent-standard-class))

automatically generated reader method

Source

persistent-objects.lisp.

Target Slot

btree.

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

btree-class.lisp.

Reader Method: btree-class-pathname ((btree-class btree-class))

automatically generated reader method

Source

btree-class.lisp.

Target Slot

pathname.

Generic Writer: (setf btree-class-pathname) (object)
Package

planks.btree.

Methods
Writer Method: (setf btree-class-pathname) ((persistent-standard-class persistent-standard-class))

automatically generated writer method

Source

persistent-objects.lisp.

Target Slot

btree.

Writer Method: (setf btree-class-pathname) ((btree-class btree-class))

automatically generated writer method

Source

btree-class.lisp.

Target Slot

pathname.

Generic Function: btree-depths (btree)
Package

planks.btree.

Methods
Method: btree-depths :around ((btree file-btree))
Source

file-btree.lisp.

Method: btree-depths ((btree btree))
Source

btree-utils.lisp.

Generic Reader: btree-file-footer (object)
Package

planks.btree.

Methods
Reader Method: btree-file-footer ((single-file-btree single-file-btree))

automatically generated reader method

Source

file-btree.lisp.

Target Slot

footer.

Generic Writer: (setf btree-file-footer) (object)
Package

planks.btree.

Methods
Writer Method: (setf btree-file-footer) ((single-file-btree single-file-btree))

automatically generated writer method

Source

file-btree.lisp.

Target Slot

footer.

Generic Reader: btree-file-footer-action (object)
Package

planks.btree.

Methods
Reader Method: btree-file-footer-action ((btree-footer btree-footer))

automatically generated reader method

Source

file-btree.lisp.

Target Slot

action.

Generic Writer: (setf btree-file-footer-action) (object)
Package

planks.btree.

Methods
Writer Method: (setf btree-file-footer-action) ((btree-footer btree-footer))

automatically generated writer method

Source

file-btree.lisp.

Target Slot

action.

Generic Reader: btree-file-footer-address (object)
Package

planks.btree.

Methods
Reader Method: btree-file-footer-address ((btree-footer btree-footer))

automatically generated reader method

Source

file-btree.lisp.

Target Slot

address.

Generic Writer: (setf btree-file-footer-address) (object)
Package

planks.btree.

Methods
Writer Method: (setf btree-file-footer-address) ((btree-footer btree-footer))

automatically generated writer method

Source

file-btree.lisp.

Target Slot

address.

Generic Reader: btree-file-footer-class (object)
Package

planks.btree.

Methods
Reader Method: btree-file-footer-class ((single-file-btree single-file-btree))

automatically generated reader method

Source

file-btree.lisp.

Target Slot

footer-class.

Generic Writer: (setf btree-file-footer-class) (object)
Package

planks.btree.

Methods
Writer Method: (setf btree-file-footer-class) ((single-file-btree single-file-btree))

automatically generated writer method

Source

file-btree.lisp.

Target Slot

footer-class.

Generic Reader: btree-file-footer-key (object)
Package

planks.btree.

Methods
Reader Method: btree-file-footer-key ((btree-footer btree-footer))

automatically generated reader method

Source

file-btree.lisp.

Target Slot

key.

Generic Writer: (setf btree-file-footer-key) (object)
Package

planks.btree.

Methods
Writer Method: (setf btree-file-footer-key) ((btree-footer btree-footer))

automatically generated writer method

Source

file-btree.lisp.

Target Slot

key.

Generic Reader: btree-file-footer-previous-address (object)
Package

planks.btree.

Methods
Reader Method: btree-file-footer-previous-address ((btree-footer btree-footer))

automatically generated reader method

Source

file-btree.lisp.

Target Slot

previous-address.

Generic Writer: (setf btree-file-footer-previous-address) (object)
Package

planks.btree.

Methods
Writer Method: (setf btree-file-footer-previous-address) ((btree-footer btree-footer))

automatically generated writer method

Source

file-btree.lisp.

Target Slot

previous-address.

Generic Reader: btree-file-footer-version (object)
Package

planks.btree.

Methods
Reader Method: btree-file-footer-version ((btree-footer btree-footer))

automatically generated reader method

Source

file-btree.lisp.

Target Slot

version.

Generic Writer: (setf btree-file-footer-version) (object)
Package

planks.btree.

Methods
Writer Method: (setf btree-file-footer-version) ((btree-footer btree-footer))

automatically generated writer method

Source

file-btree.lisp.

Target Slot

version.

Generic Reader: btree-footer-next-id (object)
Package

planks.btree.

Methods
Reader Method: btree-footer-next-id ((object-storage-footer object-storage-footer))

automatically generated reader method

Source

object-btree.lisp.

Target Slot

next-id.

Generic Writer: (setf btree-footer-next-id) (object)
Package

planks.btree.

Methods
Writer Method: (setf btree-footer-next-id) ((object-storage-footer object-storage-footer))

automatically generated writer method

Source

object-btree.lisp.

Target Slot

next-id.

Generic Reader: btree-function-name (object)
Package

planks.btree.

Methods
Reader Method: btree-function-name ((function-btree function-btree))

automatically generated reader method

Source

view.lisp.

Target Slot

name.

Generic Writer: (setf btree-function-name) (object)
Package

planks.btree.

Methods
Writer Method: (setf btree-function-name) ((function-btree function-btree))

automatically generated writer method

Source

view.lisp.

Target Slot

name.

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.

Generic Reader: btree-heap-size (object)
Package

planks.btree.

Methods
Reader Method: btree-heap-size ((heap-btree heap-btree))

automatically generated reader method

Source

heap-btree.lisp.

Target Slot

heap-size.

Generic Writer: (setf btree-heap-size) (object)
Package

planks.btree.

Methods
Writer Method: (setf btree-heap-size) ((heap-btree heap-btree))

automatically generated writer method

Source

heap-btree.lisp.

Target Slot

heap-size.

Generic Function: btree-heap-start (btree)
Package

planks.btree.

Methods
Method: btree-heap-start ((btree heap-btree))
Source

heap-btree.lisp.

Generic Reader: btree-key-key (object)
Package

planks.btree.

Methods
Reader 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.

Target Slot

key-key.

Generic Function: btree-key<= (btree)
Package

planks.btree.

Methods
Method: btree-key<= ((btree btree))
Source

btree-utils.lisp.

Generic Function: btree-key> (btree)
Package

planks.btree.

Methods
Method: btree-key> ((btree btree))
Source

btree-utils.lisp.

Generic Function: btree-key>= (btree)
Package

planks.btree.

Methods
Method: btree-key>= ((btree btree))
Source

btree-utils.lisp.

Generic Reader: btree-lock (object)
Package

planks.btree.

Methods
Reader Method: btree-lock ((single-file-btree single-file-btree))

automatically generated reader method

Source

file-btree.lisp.

Target Slot

lock.

Generic Writer: (setf btree-lock) (object)
Package

planks.btree.

Methods
Writer Method: (setf btree-lock) ((single-file-btree single-file-btree))

automatically generated writer method

Source

file-btree.lisp.

Target Slot

lock.

Generic Reader: btree-node-address (object)
Package

planks.btree.

Methods
Reader Method: btree-node-address ((file-btree-node file-btree-node))

automatically generated reader method

Source

file-btree.lisp.

Target Slot

address.

Generic Writer: (setf btree-node-address) (object)
Package

planks.btree.

Methods
Writer Method: (setf btree-node-address) ((file-btree-node file-btree-node))

automatically generated writer method

Source

file-btree.lisp.

Target Slot

address.

Generic Function: btree-node-binding-key (node binding)
Package

planks.btree.

Methods
Method: btree-node-binding-key (node binding)
Source

btree.lisp.

Generic Function: btree-node-binding-value (node binding)
Package

planks.btree.

Methods
Method: btree-node-binding-value (node binding)
Source

btree.lisp.

Generic Reader: btree-node-index (object)
Generic Writer: (setf btree-node-index) (object)
Package

planks.btree.

Methods
Reader Method: btree-node-index ((btree-node btree-node))
Writer Method: (setf btree-node-index) ((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.

Target Slot

index.

Generic Reader: btree-node-leaf-p (object)
Package

planks.btree.

Methods
Reader Method: btree-node-leaf-p ((btree-node btree-node))

automatically generated reader method

Source

btree.lisp.

Target Slot

leaf-p.

Generic Writer: (setf btree-node-leaf-p) (object)
Package

planks.btree.

Methods
Writer Method: (setf btree-node-leaf-p) ((btree-node btree-node))

automatically generated writer method

Source

btree.lisp.

Target Slot

leaf-p.

Generic Function: btree-node-max-depth (node)
Package

planks.btree.

Methods
Method: btree-node-max-depth ((node integer))
Source

file-btree.lisp.

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

btree-utils.lisp.

Generic Function: btree-node-min-depth (node)
Package

planks.btree.

Methods
Method: btree-node-min-depth ((node integer))
Source

file-btree.lisp.

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

btree-utils.lisp.

Generic Reader: btree-object-id (object)
Package

planks.btree.

Methods
Reader Method: btree-object-id ((btree-object btree-object))

automatically generated reader method

Source

btree-class.lisp.

Target Slot

id.

Generic Writer: (setf btree-object-id) (object)
Package

planks.btree.

Methods
Writer Method: (setf btree-object-id) ((btree-object btree-object))

automatically generated writer method

Source

btree-class.lisp.

Target Slot

id.

Generic Function: btree-pathname (object)
Package

planks.btree.

Methods
Method: btree-pathname ((object persistent-standard-object))
Source

persistent-objects.lisp.

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

object-btree.lisp.

Method: btree-pathname (object)
Source

btree-class.lisp.

Reader Method: btree-pathname ((file-btree file-btree))

automatically generated reader method

Source

file-btree.lisp.

Target Slot

pathname.

Generic Writer: (setf btree-pathname) (object)
Package

planks.btree.

Methods
Writer Method: (setf btree-pathname) ((file-btree file-btree))

automatically generated writer method

Source

file-btree.lisp.

Target Slot

pathname.

Generic Reader: btree-value-key (object)
Package

planks.btree.

Methods
Reader 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.

Target Slot

value-key.

Generic Function: find-heap-object (heap address)
Package

planks.btree.

Methods
Method: find-heap-object (heap address)
Source

heap-btree.lisp.

Generic Function: largest-key-in-node (node)
Package

planks.btree.

Methods
Method: largest-key-in-node ((pointer integer))
Source

file-btree.lisp.

Method: largest-key-in-node (node)
Source

btree.lisp.

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.

Methods
Method: make-btree-footer :around ((btree object-storage-btree) old-footer &key action)
Method: make-btree-footer :around ((btree multi-btree) old-footer &key key value action function-name function-index-initargs &allow-other-keys)
Source

view.lisp.

Method: make-btree-footer :around ((btree heap-btree) old-footer &key &allow-other-keys)
Source

heap-btree.lisp.

Method: make-btree-footer ((btree single-file-btree) old-footer &key action)
Source

file-btree.lisp.

Generic Function: make-root-node (btree key val)
Package

planks.btree.

Methods
Method: make-root-node (btree key val)
Source

btree.lisp.

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.

Generic Function: map-btree-keys-for-node (btree node function min max include-min include-max order)
Package

planks.btree.

Source

map-btree.lisp.

Methods
Method: map-btree-keys-for-node :around (btree (pointer integer) function min max include-min include-max order)
Source

file-btree.lisp.

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.

Generic Function: node-search (btree node key errorp default-value)
Package

planks.btree.

Source

btree-search.lisp.

Methods
Method: node-search (btree (node integer) key errorp default-value)
Source

file-btree.lisp.

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.

Generic Reader: persistent-standard-class-btree (object)
Package

planks.btree.

Methods
Reader Method: persistent-standard-class-btree ((persistent-standard-class persistent-standard-class))

automatically generated reader method

Source

persistent-objects.lisp.

Target Slot

btree.

Generic Writer: (setf persistent-standard-class-btree) (object)
Package

planks.btree.

Methods
Writer Method: (setf persistent-standard-class-btree) ((persistent-standard-class persistent-standard-class))

automatically generated writer method

Source

persistent-objects.lisp.

Target Slot

btree.

Generic Reader: persistent-standard-object-slot-btree (object)
Package

planks.btree.

Methods
Reader Method: persistent-standard-object-slot-btree ((persistent-standard-object persistent-standard-object))

automatically generated reader method

Source

persistent-objects.lisp.

Target Slot

slot-btree.

Generic Writer: (setf persistent-standard-object-slot-btree) (object)
Package

planks.btree.

Methods
Writer Method: (setf persistent-standard-object-slot-btree) ((persistent-standard-object persistent-standard-object))

automatically generated writer method

Source

persistent-objects.lisp.

Target Slot

slot-btree.

Generic Reader: persistent-standard-object-slot-btree-class-name (object)
Package

planks.btree.

Methods
Reader 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.

Target Slot

class-name.

Generic Writer: (setf persistent-standard-object-slot-btree-class-name) (object)
Package

planks.btree.

Methods
Writer Method: (setf persistent-standard-object-slot-btree-class-name) ((persistent-standard-object-slot-btree persistent-standard-object-slot-btree))

automatically generated writer method

Source

persistent-objects.lisp.

Target Slot

class-name.

Generic Function: read-footer-checksum (btree stream)
Package

planks.btree.

Methods
Method: read-footer-checksum (btree stream)
Source

file-btree.lisp.

Generic Function: read-node-tag (node &key stream)
Package

planks.btree.

Methods
Method: read-node-tag (node &key stream)
Source

file-btree.lisp.

Generic Reader: root-node-file-position (object)
Package

planks.btree.

Methods
Reader Method: root-node-file-position ((btree-footer btree-footer))

automatically generated reader method

Source

file-btree.lisp.

Target Slot

root-node-address.

Generic Writer: (setf root-node-file-position) (object)
Package

planks.btree.

Methods
Writer Method: (setf root-node-file-position) ((btree-footer btree-footer))

automatically generated writer method

Source

file-btree.lisp.

Target Slot

root-node-address.

Generic Function: slot-definition-persistentp (slot)
Package

planks.btree.

Methods
Reader Method: slot-definition-persistentp ((persistent-standard-class-slot-definition persistent-standard-class-slot-definition))

automatically generated reader method

Source

persistent-objects.lisp.

Target Slot

persistentp.

Method: slot-definition-persistentp (slot)
Source

persistent-objects.lisp.

Generic Writer: (setf slot-definition-persistentp) (object)
Package

planks.btree.

Methods
Writer Method: (setf slot-definition-persistentp) ((persistent-standard-class-slot-definition persistent-standard-class-slot-definition))

automatically generated writer method

Source

persistent-objects.lisp.

Target Slot

persistentp.

Generic Function: update-node (node &key index leaf-p &allow-other-keys)
Package

planks.btree.

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

file-btree.lisp.

Method: update-node (node &key index leaf-p)
Source

btree.lisp.

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.

Method: update-node-for-insert (btree node binding-key key value leaf-p)
Source

btree.lisp.

Generic Function: write-footer-checksum (btree stream checksum)
Package

planks.btree.

Methods
Method: write-footer-checksum (btree stream checksum)
Source

file-btree.lisp.

Generic Function: write-node-tag (node &key stream)
Package

planks.btree.

Methods
Method: write-node-tag (node &key stream)
Source

file-btree.lisp.


5.2.5 Standalone methods

Method: serialize ((object file-btree-node) stream)
Package

rucksack.

Source

file-btree.lisp.

Method: serialize ((object persistent-standard-object-slot-btree) stream)
Package

rucksack.

Source

persistent-objects.lisp.

Method: serialize ((object persistent-standard-object) stream)
Package

rucksack.

Source

persistent-objects.lisp.


5.2.6 Classes

Class: btree-class
Package

planks.btree.

Source

btree-class.lisp.

Direct superclasses

standard-class.

Direct methods
Direct slots
Slot: pathname
Package

common-lisp.

Initargs

:btree-path

Readers

btree-class-pathname.

Writers

(setf btree-class-pathname).

Class: btree-footer
Package

planks.btree.

Source

file-btree.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: root-node-address
Initargs

:root-node-position

Readers

root-node-file-position.

Writers

(setf root-node-file-position).

Slot: address
Initargs

:address

Readers

btree-file-footer-address.

Writers

(setf btree-file-footer-address).

Slot: action
Initform

:create

Initargs

:action

Readers

btree-file-footer-action.

Writers

(setf btree-file-footer-action).

Slot: version
Initform

0

Initargs

:version

Readers

btree-file-footer-version.

Writers

(setf btree-file-footer-version).

Slot: previous-address
Initargs

:previous-address

Readers

btree-file-footer-previous-address.

Writers

(setf btree-file-footer-previous-address).

Slot: key
Readers

btree-file-footer-key.

Writers

(setf btree-file-footer-key).

Class: btree-object
Package

planks.btree.

Source

btree-class.lisp.

Direct subclasses

persistent-standard-object-slot-btree.

Direct methods
Direct slots
Slot: id
Initargs

:id

Readers

btree-object-id.

Writers

(setf btree-object-id).

Class: file-btree
Package

planks.btree.

Source

file-btree.lisp.

Direct superclasses

btree.

Direct subclasses
Direct methods
Direct Default Initargs
InitargValue
:node-class(quote file-btree-node)
Direct slots
Slot: pathname
Package

common-lisp.

Initargs

:pathname

Readers

btree-pathname.

Writers

(setf btree-pathname).

Class: file-btree-node
Package

planks.btree.

Source

file-btree.lisp.

Direct superclasses

btree-node.

Direct methods
Direct slots
Slot: address
Initargs

:address

Readers

btree-node-address.

Writers

(setf btree-node-address).

Class: function-btree
Package

planks.btree.

Source

view.lisp.

Direct superclasses

file-btree.

Direct methods
Direct slots
Slot: name
Initargs

:name

Readers

btree-function-name.

Writers

(setf btree-function-name).

Class: heap-btree-file-footer
Package

planks.btree.

Source

heap-btree.lisp.

Direct superclasses

multi-btree-file-footer.

Direct slots
Slot: heap-start
Initform

0

Slot: free-space-start
Initform

0

Class: multi-btree-file-footer
Package

planks.btree.

Source

view.lisp.

Direct superclasses

btree-footer.

Direct subclasses

heap-btree-file-footer.

Direct slots
Slot: btrees
Class: nested-btree
Package

planks.btree.

Source

object-btree.lisp.

Direct superclasses

file-btree.

Direct subclasses

persistent-standard-object-slot-btree.

Direct methods
Direct slots
Slot: pathname
Package

common-lisp.

Initargs

:btree

Slot: key
Initargs

planks.btree::key

Class: object-storage-btree
Package

planks.btree.

Source

object-btree.lisp.

Direct superclasses

single-file-btree.

Direct methods
Direct Default Initargs
InitargValue
:footer-class(quote object-storage-footer)
Class: object-storage-footer
Package

planks.btree.

Source

object-btree.lisp.

Direct superclasses

btree-footer.

Direct methods
Direct slots
Slot: next-id
Initform

0

Readers

btree-footer-next-id.

Writers

(setf btree-footer-next-id).

Class: persistent-standard-class
Package

planks.btree.

Source

persistent-objects.lisp.

Direct superclasses

standard-class.

Direct methods
Direct slots
Slot: btree
Initargs

:btree

Readers
Writers
Class: persistent-standard-class-direct-slot-definition
Package

planks.btree.

Source

persistent-objects.lisp.

Direct superclasses
Class: persistent-standard-class-effective-slot-definition
Package

planks.btree.

Source

persistent-objects.lisp.

Direct superclasses
Direct methods
Class: persistent-standard-class-slot-definition
Package

planks.btree.

Source

persistent-objects.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: persistentp
Initform

t

Initargs

:persistent

Readers

slot-definition-persistentp.

Writers

(setf slot-definition-persistentp).

Class: persistent-standard-object
Package

planks.btree.

Source

persistent-objects.lisp.

Direct methods
Direct slots
Slot: slot-btree
Readers

persistent-standard-object-slot-btree.

Writers

(setf persistent-standard-object-slot-btree).

Class: persistent-standard-object-slot-btree
Package

planks.btree.

Source

persistent-objects.lisp.

Direct superclasses
Direct methods
Direct Default Initargs
InitargValue
:key<(quote string=)
:key=(quote string=)
:key-type(quote symbol)
Direct slots
Slot: class-name
Package

common-lisp.

Initargs

:class-name

Readers

persistent-standard-object-slot-btree-class-name.

Writers

(setf persistent-standard-object-slot-btree-class-name).

Class: single-file-btree
Package

planks.btree.

Source

file-btree.lisp.

Direct superclasses

file-btree.

Direct subclasses
Direct methods
Direct slots
Readers

btree-file-footer.

Writers

(setf btree-file-footer).

Initform

(quote planks.btree::btree-footer)

Initargs

:footer-class

Readers

btree-file-footer-class.

Writers

(setf btree-file-footer-class).

Slot: lock
Readers

btree-lock.

Writers

(setf btree-lock).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %   (  
A   B   C   D   E   F   G   I   L   M   N   P   R   S   U   V   W  
Index Entry  Section

%
%update-btree: Private ordinary functions

(
(setf btree-class-pathname): Private generic functions
(setf btree-class-pathname): Private generic functions
(setf btree-class-pathname): Private generic functions
(setf btree-file-footer): Private generic functions
(setf btree-file-footer): Private generic functions
(setf btree-file-footer-action): Private generic functions
(setf btree-file-footer-action): Private generic functions
(setf btree-file-footer-address): Private generic functions
(setf btree-file-footer-address): Private generic functions
(setf btree-file-footer-class): Private generic functions
(setf btree-file-footer-class): Private generic functions
(setf btree-file-footer-key): Private generic functions
(setf btree-file-footer-key): Private generic functions
(setf btree-file-footer-previous-address): Private generic functions
(setf btree-file-footer-previous-address): Private generic functions
(setf btree-file-footer-version): Private generic functions
(setf btree-file-footer-version): Private generic functions
(setf btree-footer-next-id): Private generic functions
(setf btree-footer-next-id): Private generic functions
(setf btree-function-name): Private generic functions
(setf btree-function-name): Private generic functions
(setf btree-heap-size): Private generic functions
(setf btree-heap-size): Private generic functions
(setf btree-lock): Private generic functions
(setf btree-lock): Private generic functions
(setf btree-node-address): Private generic functions
(setf btree-node-address): Private generic functions
(setf btree-node-index): Private generic functions
(setf btree-node-index): Private generic functions
(setf btree-node-leaf-p): Private generic functions
(setf btree-node-leaf-p): Private generic functions
(setf btree-object-id): Private generic functions
(setf btree-object-id): Private generic functions
(setf btree-pathname): Private generic functions
(setf btree-pathname): Private generic functions
(setf btree-root): Public generic functions
(setf btree-root): Public generic functions
(setf persistent-standard-class-btree): Private generic functions
(setf persistent-standard-class-btree): Private generic functions
(setf persistent-standard-object-slot-btree): Private generic functions
(setf persistent-standard-object-slot-btree): Private generic functions
(setf persistent-standard-object-slot-btree-class-name): Private generic functions
(setf persistent-standard-object-slot-btree-class-name): Private generic functions
(setf root-node-file-position): Private generic functions
(setf root-node-file-position): Private generic functions
(setf slot-definition-persistentp): Private generic functions
(setf slot-definition-persistentp): Private generic functions
(setf slot-value-using-class): Public standalone methods

A
add-function-btree: Public ordinary functions
allocate-heap: Private generic functions
allocate-heap: Private generic functions
allocate-object: Private generic functions
allocate-object: Private generic functions

B
btree-balanced-p: Private generic functions
btree-balanced-p: Private generic functions
btree-class-pathname: Private generic functions
btree-class-pathname: Private generic functions
btree-class-pathname: Private generic functions
btree-class-pathname: Private generic functions
btree-depths: Private generic functions
btree-depths: Private generic functions
btree-depths: Private generic functions
btree-error-btree: Public generic functions
btree-error-btree: Public generic functions
btree-error-key: Public generic functions
btree-error-key: Public generic functions
btree-error-key: Public generic functions
btree-error-value: Public generic functions
btree-error-value: Public generic functions
btree-file-footer: Private generic functions
btree-file-footer: Private generic functions
btree-file-footer-action: Private generic functions
btree-file-footer-action: Private generic functions
btree-file-footer-address: Private generic functions
btree-file-footer-address: Private generic functions
btree-file-footer-class: Private generic functions
btree-file-footer-class: Private generic functions
btree-file-footer-key: Private generic functions
btree-file-footer-key: Private generic functions
btree-file-footer-previous-address: Private generic functions
btree-file-footer-previous-address: Private generic functions
btree-file-footer-version: Private generic functions
btree-file-footer-version: Private generic functions
btree-file-size: Public ordinary functions
btree-footer-next-id: Private generic functions
btree-footer-next-id: Private generic functions
btree-function-name: Private generic functions
btree-function-name: Private generic functions
btree-heap-free-space-start: Private generic functions
btree-heap-free-space-start: Private generic functions
btree-heap-size: Private generic functions
btree-heap-size: Private generic functions
btree-heap-start: Private generic functions
btree-heap-start: Private generic functions
btree-insert: Public generic functions
btree-insert: Public generic functions
btree-key-key: Private generic functions
btree-key-key: Private generic functions
btree-key-type: Public generic functions
btree-key-type: Public generic functions
btree-key<: Public generic functions
btree-key<: Public generic functions
btree-key<=: Private generic functions
btree-key<=: Private generic functions
btree-key=: Public generic functions
btree-key=: Public generic functions
btree-key>: Private generic functions
btree-key>: Private generic functions
btree-key>=: Private generic functions
btree-key>=: Private generic functions
btree-lock: Private generic functions
btree-lock: Private generic functions
btree-max-node-size: Public generic functions
btree-max-node-size: Public generic functions
btree-node-address: Private generic functions
btree-node-address: Private generic functions
btree-node-binding: Private ordinary functions
btree-node-binding-count: Private ordinary functions
btree-node-binding-key: Private generic functions
btree-node-binding-key: Private generic functions
btree-node-binding-value: Private generic functions
btree-node-binding-value: Private generic functions
btree-node-class: Public generic functions
btree-node-class: Public generic functions
btree-node-file-position: Private ordinary functions
btree-node-index: Private generic functions
btree-node-index: Private generic functions
btree-node-leaf-p: Private generic functions
btree-node-leaf-p: Private generic functions
btree-node-max-depth: Private generic functions
btree-node-max-depth: Private generic functions
btree-node-max-depth: Private generic functions
btree-node-min-depth: Private generic functions
btree-node-min-depth: Private generic functions
btree-node-min-depth: Private generic functions
btree-object-id: Private generic functions
btree-object-id: Private generic functions
btree-pathname: Private generic functions
btree-pathname: Private generic functions
btree-pathname: Private generic functions
btree-pathname: Private generic functions
btree-pathname: Private generic functions
btree-root: Public generic functions
btree-root: Public generic functions
btree-root: Public generic functions
btree-search: Public generic functions
btree-search: Public generic functions
btree-search: Public generic functions
btree-search: Public generic functions
btree-unique-keys-p: Public generic functions
btree-unique-keys-p: Public generic functions
btree-value-key: Private generic functions
btree-value-key: Private generic functions
btree-value-type: Public generic functions
btree-value-type: Public generic functions
btree-value=: Public generic functions
btree-value=: Public generic functions

C
call-with-btree-stream: Private ordinary functions
close-btree: Public ordinary functions
compute-effective-slot-definition: Public standalone methods
current-btree: Private ordinary functions
current-footer: Private ordinary functions

D
direct-slot-definition-class: Public standalone methods

E
effective-slot-definition-class: Public standalone methods

F
find-btree: Public ordinary functions
find-function-btree: Public ordinary functions
find-heap-object: Private generic functions
find-heap-object: Private generic functions
find-key-position-in-index: Private ordinary functions
find-subnode: Private ordinary functions
Function, %update-btree: Private ordinary functions
Function, add-function-btree: Public ordinary functions
Function, btree-file-size: Public ordinary functions
Function, btree-node-binding: Private ordinary functions
Function, btree-node-binding-count: Private ordinary functions
Function, btree-node-file-position: Private ordinary functions
Function, call-with-btree-stream: Private ordinary functions
Function, close-btree: Public ordinary functions
Function, current-btree: Private ordinary functions
Function, current-footer: Private ordinary functions
Function, find-btree: Public ordinary functions
Function, find-function-btree: Public ordinary functions
Function, find-key-position-in-index: Private ordinary functions
Function, find-subnode: Private ordinary functions
Function, load-btree-node: Private ordinary functions
Function, load-btree-node-from-stream: Private ordinary functions
Function, make-btree: Public ordinary functions
Function, make-btree-lock: Private ordinary functions
Function, make-footer-buffer: Private ordinary functions
Function, node-almost-full-p: Private ordinary functions
Function, not-found: Private ordinary functions
Function, read-btree-from-file-stream: Private ordinary functions
Function, read-file-footer: Private ordinary functions
Function, split-binding-node: Private ordinary functions
Function, update-binding-for-insert: Private ordinary functions
Function, update-bnode: Private ordinary functions
Function, update-index-for-insert: Private ordinary functions
Function, write-file-footer: Private ordinary functions

G
Generic Function, (setf btree-class-pathname): Private generic functions
Generic Function, (setf btree-file-footer): Private generic functions
Generic Function, (setf btree-file-footer-action): Private generic functions
Generic Function, (setf btree-file-footer-address): Private generic functions
Generic Function, (setf btree-file-footer-class): Private generic functions
Generic Function, (setf btree-file-footer-key): Private generic functions
Generic Function, (setf btree-file-footer-previous-address): Private generic functions
Generic Function, (setf btree-file-footer-version): Private generic functions
Generic Function, (setf btree-footer-next-id): Private generic functions
Generic Function, (setf btree-function-name): Private generic functions
Generic Function, (setf btree-heap-size): Private generic functions
Generic Function, (setf btree-lock): Private generic functions
Generic Function, (setf btree-node-address): Private generic functions
Generic Function, (setf btree-node-index): Private generic functions
Generic Function, (setf btree-node-leaf-p): Private generic functions
Generic Function, (setf btree-object-id): Private generic functions
Generic Function, (setf btree-pathname): Private generic functions
Generic Function, (setf btree-root): Public generic functions
Generic Function, (setf persistent-standard-class-btree): Private generic functions
Generic Function, (setf persistent-standard-object-slot-btree): Private generic functions
Generic Function, (setf persistent-standard-object-slot-btree-class-name): Private generic functions
Generic Function, (setf root-node-file-position): Private generic functions
Generic Function, (setf slot-definition-persistentp): Private generic functions
Generic Function, allocate-heap: Private generic functions
Generic Function, allocate-object: Private generic functions
Generic Function, btree-balanced-p: Private generic functions
Generic Function, btree-class-pathname: Private generic functions
Generic Function, btree-depths: Private generic functions
Generic Function, btree-error-btree: Public generic functions
Generic Function, btree-error-key: Public generic functions
Generic Function, btree-error-value: Public generic functions
Generic Function, btree-file-footer: Private generic functions
Generic Function, btree-file-footer-action: Private generic functions
Generic Function, btree-file-footer-address: Private generic functions
Generic Function, btree-file-footer-class: Private generic functions
Generic Function, btree-file-footer-key: Private generic functions
Generic Function, btree-file-footer-previous-address: Private generic functions
Generic Function, btree-file-footer-version: Private generic functions
Generic Function, btree-footer-next-id: Private generic functions
Generic Function, btree-function-name: Private generic functions
Generic Function, btree-heap-free-space-start: Private generic functions
Generic Function, btree-heap-size: Private generic functions
Generic Function, btree-heap-start: Private generic functions
Generic Function, btree-insert: Public generic functions
Generic Function, btree-key-key: Private generic functions
Generic Function, btree-key-type: Public generic functions
Generic Function, btree-key<: Public generic functions
Generic Function, btree-key<=: Private generic functions
Generic Function, btree-key=: Public generic functions
Generic Function, btree-key>: Private generic functions
Generic Function, btree-key>=: Private generic functions
Generic Function, btree-lock: Private generic functions
Generic Function, btree-max-node-size: Public generic functions
Generic Function, btree-node-address: Private generic functions
Generic Function, btree-node-binding-key: Private generic functions
Generic Function, btree-node-binding-value: Private generic functions
Generic Function, btree-node-class: Public generic functions
Generic Function, btree-node-index: Private generic functions
Generic Function, btree-node-leaf-p: Private generic functions
Generic Function, btree-node-max-depth: Private generic functions
Generic Function, btree-node-min-depth: Private generic functions
Generic Function, btree-object-id: Private generic functions
Generic Function, btree-pathname: Private generic functions
Generic Function, btree-root: Public generic functions
Generic Function, btree-search: Public generic functions
Generic Function, btree-unique-keys-p: Public generic functions
Generic Function, btree-value-key: Private generic functions
Generic Function, btree-value-type: Public generic functions
Generic Function, btree-value=: Public generic functions
Generic Function, find-heap-object: Private generic functions
Generic Function, largest-key-in-node: Private generic functions
Generic Function, make-btree-footer: Private generic functions
Generic Function, make-root-node: Private generic functions
Generic Function, map-btree: Public generic functions
Generic Function, map-btree-keys: Private generic functions
Generic Function, map-btree-keys-for-node: Private generic functions
Generic Function, map-btree-node: Private generic functions
Generic Function, node-search: Private generic functions
Generic Function, persist: Private generic functions
Generic Function, persistent-standard-class-btree: Private generic functions
Generic Function, persistent-standard-object-slot-btree: Private generic functions
Generic Function, persistent-standard-object-slot-btree-class-name: Private generic functions
Generic Function, read-footer-checksum: Private generic functions
Generic Function, read-node-tag: Private generic functions
Generic Function, root-node-file-position: Private generic functions
Generic Function, slot-definition-persistentp: Private generic functions
Generic Function, update-btree: Public generic functions
Generic Function, update-node: Private generic functions
Generic Function, update-node-for-insert: Private generic functions
Generic Function, write-footer-checksum: Private generic functions
Generic Function, write-node-tag: Private generic functions

I
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods

L
largest-key-in-node: Private generic functions
largest-key-in-node: Private generic functions
largest-key-in-node: Private generic functions
load-btree-node: Private ordinary functions
load-btree-node-from-stream: Private ordinary functions

M
make-btree: Public ordinary functions
make-btree-footer: Private generic functions
make-btree-footer: Private generic functions
make-btree-footer: Private generic functions
make-btree-footer: Private generic functions
make-btree-footer: Private generic functions
make-btree-lock: Private ordinary functions
make-footer-buffer: Private ordinary functions
make-root-node: Private generic functions
make-root-node: Private generic functions
map-btree: Public generic functions
map-btree: Public generic functions
map-btree: Public generic functions
map-btree-keys: Private generic functions
map-btree-keys: Private generic functions
map-btree-keys-for-node: Private generic functions
map-btree-keys-for-node: Private generic functions
map-btree-keys-for-node: Private generic functions
map-btree-keys-for-node: Private generic functions
map-btree-node: Private generic functions
map-btree-node: Private generic functions
Method, (setf btree-class-pathname): Private generic functions
Method, (setf btree-class-pathname): Private generic functions
Method, (setf btree-file-footer): Private generic functions
Method, (setf btree-file-footer-action): Private generic functions
Method, (setf btree-file-footer-address): Private generic functions
Method, (setf btree-file-footer-class): Private generic functions
Method, (setf btree-file-footer-key): Private generic functions
Method, (setf btree-file-footer-previous-address): Private generic functions
Method, (setf btree-file-footer-version): Private generic functions
Method, (setf btree-footer-next-id): Private generic functions
Method, (setf btree-function-name): Private generic functions
Method, (setf btree-heap-size): Private generic functions
Method, (setf btree-lock): Private generic functions
Method, (setf btree-node-address): Private generic functions
Method, (setf btree-node-index): Private generic functions
Method, (setf btree-node-leaf-p): Private generic functions
Method, (setf btree-object-id): Private generic functions
Method, (setf btree-pathname): Private generic functions
Method, (setf btree-root): Public generic functions
Method, (setf persistent-standard-class-btree): Private generic functions
Method, (setf persistent-standard-object-slot-btree): Private generic functions
Method, (setf persistent-standard-object-slot-btree-class-name): Private generic functions
Method, (setf root-node-file-position): Private generic functions
Method, (setf slot-definition-persistentp): Private generic functions
Method, (setf slot-value-using-class): Public standalone methods
Method, allocate-heap: Private generic functions
Method, allocate-object: Private generic functions
Method, btree-balanced-p: Private generic functions
Method, btree-class-pathname: Private generic functions
Method, btree-class-pathname: Private generic functions
Method, btree-class-pathname: Private generic functions
Method, btree-depths: Private generic functions
Method, btree-depths: Private generic functions
Method, btree-error-btree: Public generic functions
Method, btree-error-key: Public generic functions
Method, btree-error-key: Public generic functions
Method, btree-error-value: Public generic functions
Method, btree-file-footer: Private generic functions
Method, btree-file-footer-action: Private generic functions
Method, btree-file-footer-address: Private generic functions
Method, btree-file-footer-class: Private generic functions
Method, btree-file-footer-key: Private generic functions
Method, btree-file-footer-previous-address: Private generic functions
Method, btree-file-footer-version: Private generic functions
Method, btree-footer-next-id: Private generic functions
Method, btree-function-name: Private generic functions
Method, btree-heap-free-space-start: Private generic functions
Method, btree-heap-size: Private generic functions
Method, btree-heap-start: Private generic functions
Method, btree-insert: Public generic functions
Method, btree-key-key: Private generic functions
Method, btree-key-type: Public generic functions
Method, btree-key<: Public generic functions
Method, btree-key<=: Private generic functions
Method, btree-key=: Public generic functions
Method, btree-key>: Private generic functions
Method, btree-key>=: Private generic functions
Method, btree-lock: Private generic functions
Method, btree-max-node-size: Public generic functions
Method, btree-node-address: Private generic functions
Method, btree-node-binding-key: Private generic functions
Method, btree-node-binding-value: Private generic functions
Method, btree-node-class: Public generic functions
Method, btree-node-index: Private generic functions
Method, btree-node-leaf-p: Private generic functions
Method, btree-node-max-depth: Private generic functions
Method, btree-node-max-depth: Private generic functions
Method, btree-node-min-depth: Private generic functions
Method, btree-node-min-depth: Private generic functions
Method, btree-object-id: Private generic functions
Method, btree-pathname: Private generic functions
Method, btree-pathname: Private generic functions
Method, btree-pathname: Private generic functions
Method, btree-pathname: Private generic functions
Method, btree-root: Public generic functions
Method, btree-root: Public generic functions
Method, btree-search: Public generic functions
Method, btree-search: Public generic functions
Method, btree-search: Public generic functions
Method, btree-unique-keys-p: Public generic functions
Method, btree-value-key: Private generic functions
Method, btree-value-type: Public generic functions
Method, btree-value=: Public generic functions
Method, compute-effective-slot-definition: Public standalone methods
Method, direct-slot-definition-class: Public standalone methods
Method, effective-slot-definition-class: Public standalone methods
Method, find-heap-object: Private generic functions
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, largest-key-in-node: Private generic functions
Method, largest-key-in-node: Private generic functions
Method, make-btree-footer: Private generic functions
Method, make-btree-footer: Private generic functions
Method, make-btree-footer: Private generic functions
Method, make-btree-footer: Private generic functions
Method, make-root-node: Private generic functions
Method, map-btree: Public generic functions
Method, map-btree: Public generic functions
Method, map-btree-keys: Private generic functions
Method, map-btree-keys-for-node: Private generic functions
Method, map-btree-keys-for-node: Private generic functions
Method, map-btree-keys-for-node: Private generic functions
Method, map-btree-node: Private generic functions
Method, node-search: Private generic functions
Method, node-search: Private generic functions
Method, persist: Private generic functions
Method, persistent-standard-class-btree: Private generic functions
Method, persistent-standard-object-slot-btree: Private generic functions
Method, persistent-standard-object-slot-btree-class-name: Private generic functions
Method, print-object: Public standalone methods
Method, read-footer-checksum: Private generic functions
Method, read-node-tag: Private generic functions
Method, reinitialize-instance: Public standalone methods
Method, reinitialize-instance: Public standalone methods
Method, root-node-file-position: Private generic functions
Method, serialize: Private standalone methods
Method, serialize: Private standalone methods
Method, serialize: Private standalone methods
Method, shared-initialize: Public standalone methods
Method, shared-initialize: Public standalone methods
Method, shared-initialize: Public standalone methods
Method, slot-boundp-using-class: Public standalone methods
Method, slot-definition-persistentp: Private generic functions
Method, slot-definition-persistentp: Private generic functions
Method, slot-value-using-class: Public standalone methods
Method, update-btree: Public generic functions
Method, update-btree: Public generic functions
Method, update-btree: Public generic functions
Method, update-btree: Public generic functions
Method, update-btree: Public generic functions
Method, update-btree: Public generic functions
Method, update-btree: Public generic functions
Method, update-btree: Public generic functions
Method, update-node: Private generic functions
Method, update-node: Private generic functions
Method, update-node-for-insert: Private generic functions
Method, update-node-for-insert: Private generic functions
Method, validate-superclass: Public standalone methods
Method, validate-superclass: Public standalone methods
Method, write-footer-checksum: Private generic functions
Method, write-node-tag: Private generic functions

N
node-almost-full-p: Private ordinary functions
node-search: Private generic functions
node-search: Private generic functions
node-search: Private generic functions
not-found: Private ordinary functions

P
persist: Private generic functions
persist: Private generic functions
persistent-standard-class-btree: Private generic functions
persistent-standard-class-btree: Private generic functions
persistent-standard-object-slot-btree: Private generic functions
persistent-standard-object-slot-btree: Private generic functions
persistent-standard-object-slot-btree-class-name: Private generic functions
persistent-standard-object-slot-btree-class-name: Private generic functions
print-object: Public standalone methods

R
read-btree-from-file-stream: Private ordinary functions
read-file-footer: Private ordinary functions
read-footer-checksum: Private generic functions
read-footer-checksum: Private generic functions
read-node-tag: Private generic functions
read-node-tag: Private generic functions
reinitialize-instance: Public standalone methods
reinitialize-instance: Public standalone methods
root-node-file-position: Private generic functions
root-node-file-position: Private generic functions

S
serialize: Private standalone methods
serialize: Private standalone methods
serialize: Private standalone methods
shared-initialize: Public standalone methods
shared-initialize: Public standalone methods
shared-initialize: Public standalone methods
slot-boundp-using-class: Public standalone methods
slot-definition-persistentp: Private generic functions
slot-definition-persistentp: Private generic functions
slot-definition-persistentp: Private generic functions
slot-value-using-class: Public standalone methods
split-binding-node: Private ordinary functions

U
update-binding-for-insert: Private ordinary functions
update-bnode: Private ordinary functions
update-btree: Public generic functions
update-btree: Public generic functions
update-btree: Public generic functions
update-btree: Public generic functions
update-btree: Public generic functions
update-btree: Public generic functions
update-btree: Public generic functions
update-btree: Public generic functions
update-btree: Public generic functions
update-index-for-insert: Private ordinary functions
update-node: Private generic functions
update-node: Private generic functions
update-node: Private generic functions
update-node-for-insert: Private generic functions
update-node-for-insert: Private generic functions
update-node-for-insert: Private generic functions

V
validate-superclass: Public standalone methods
validate-superclass: Public standalone methods

W
write-file-footer: Private ordinary functions
write-footer-checksum: Private generic functions
write-footer-checksum: Private generic functions
write-node-tag: Private generic functions
write-node-tag: Private generic functions


A.3 Variables

Jump to:   *   +  
A   B   C   F   H   I   K   L   M   N   P   R   S   U   V  
Index Entry  Section

*
*btree-file-root*: Private special variables
*btree-stream*: Private special variables
*btrees*: Private special variables
*current-btree*: Private special variables
*current-footer*: Private special variables
*max-footer-size*: Private special variables
*persistent-standard-class-effective-slot-definition-class*: Private special variables

+
+footer-marker+: Private special variables
+persistent-standard-object-marker+: Private constants

A
action: Private classes
address: Private classes
address: Private classes

B
btree: Public conditions
btree: Private classes
btrees: Private classes

C
class-name: Private classes
Constant, +persistent-standard-object-marker+: Private constants

F
footer: Private classes
footer-class: Private classes
free-space-start: Public classes
free-space-start: Private classes

H
heap-size: Public classes
heap-start: Public classes
heap-start: Private classes

I
id: Private classes
index: Public classes

K
key: Public conditions
key: Public conditions
key: Private classes
key: Private classes
key-key: Public classes
key-type: Public classes
key<: Public classes
key=: Public classes

L
leaf-p: Public classes
lock: Private classes

M
max-node-size: Public classes

N
name: Private classes
next-id: Private classes
node-class: Public classes

P
pathname: Private classes
pathname: Private classes
pathname: Private classes
persistentp: Private classes
previous-address: Private classes

R
root: Public classes
root-node-address: Private classes

S
Slot, action: Private classes
Slot, address: Private classes
Slot, address: Private classes
Slot, btree: Public conditions
Slot, btree: Private classes
Slot, btrees: Private classes
Slot, class-name: Private classes
Slot, footer: Private classes
Slot, footer-class: Private classes
Slot, free-space-start: Public classes
Slot, free-space-start: Private classes
Slot, heap-size: Public classes
Slot, heap-start: Public classes
Slot, heap-start: Private classes
Slot, id: Private classes
Slot, index: Public classes
Slot, key: Public conditions
Slot, key: Public conditions
Slot, key: Private classes
Slot, key: Private classes
Slot, key-key: Public classes
Slot, key-type: Public classes
Slot, key<: Public classes
Slot, key=: Public classes
Slot, leaf-p: Public classes
Slot, lock: Private classes
Slot, max-node-size: Public classes
Slot, name: Private classes
Slot, next-id: Private classes
Slot, node-class: Public classes
Slot, pathname: Private classes
Slot, pathname: Private classes
Slot, pathname: Private classes
Slot, persistentp: Private classes
Slot, previous-address: Private classes
Slot, root: Public classes
Slot, root-node-address: Private classes
Slot, slot-btree: Private classes
Slot, unique-keys-p: Public classes
Slot, value: Public conditions
Slot, value-key: Public classes
Slot, value-type: Public classes
Slot, value=: Public classes
Slot, version: Private classes
slot-btree: Private classes
Special Variable, *btree-file-root*: Private special variables
Special Variable, *btree-stream*: Private special variables
Special Variable, *btrees*: Private special variables
Special Variable, *current-btree*: Private special variables
Special Variable, *current-footer*: Private special variables
Special Variable, *max-footer-size*: Private special variables
Special Variable, *persistent-standard-class-effective-slot-definition-class*: Private special variables
Special Variable, +footer-marker+: Private special variables

U
unique-keys-p: Public classes

V
value: Public conditions
value-key: Public classes
value-type: Public classes
value=: Public classes
version: Private classes


A.4 Data types

Jump to:   B   C   F   H   M   N   O   P   S   V  
Index Entry  Section

B
btree: Public classes
btree-class: Private classes
btree-class.lisp: The planks/src/btree-class․lisp file
btree-error: Public conditions
btree-footer: Private classes
btree-insertion-error: Public conditions
btree-key-already-present-error: Public conditions
btree-node: Public classes
btree-object: Private classes
btree-protocol.lisp: The planks/src/btree-protocol․lisp file
btree-search-error: Public conditions
btree-search.lisp: The planks/src/btree-search․lisp file
btree-type-error: Public conditions
btree-utils.lisp: The planks/src/btree-utils․lisp file
btree.lisp: The planks/src/btree․lisp file

C
Class, btree: Public classes
Class, btree-class: Private classes
Class, btree-footer: Private classes
Class, btree-node: Public classes
Class, btree-object: Private classes
Class, file-btree: Private classes
Class, file-btree-node: Private classes
Class, function-btree: Private classes
Class, heap-btree: Public classes
Class, heap-btree-file-footer: Private classes
Class, multi-btree: Public classes
Class, multi-btree-file-footer: Private classes
Class, nested-btree: Private classes
Class, object-storage-btree: Private classes
Class, object-storage-footer: Private classes
Class, persistent-standard-class: Private classes
Class, persistent-standard-class-direct-slot-definition: Private classes
Class, persistent-standard-class-effective-slot-definition: Private classes
Class, persistent-standard-class-slot-definition: Private classes
Class, persistent-standard-object: Private classes
Class, persistent-standard-object-slot-btree: Private classes
Class, single-file-btree: Private classes
Condition, btree-error: Public conditions
Condition, btree-insertion-error: Public conditions
Condition, btree-key-already-present-error: Public conditions
Condition, btree-search-error: Public conditions
Condition, btree-type-error: Public conditions

F
File, btree-class.lisp: The planks/src/btree-class․lisp file
File, btree-protocol.lisp: The planks/src/btree-protocol․lisp file
File, btree-search.lisp: The planks/src/btree-search․lisp file
File, btree-utils.lisp: The planks/src/btree-utils․lisp file
File, btree.lisp: The planks/src/btree․lisp file
File, file-btree.lisp: The planks/src/file-btree․lisp file
File, heap-btree.lisp: The planks/src/heap-btree․lisp file
File, map-btree.lisp: The planks/src/map-btree․lisp file
File, object-btree.lisp: The planks/src/object-btree․lisp file
File, persistent-objects.lisp: The planks/src/persistent-objects․lisp file
File, planks.asd: The planks/planks․asd file
File, view.lisp: The planks/src/view․lisp file
file-btree: Private classes
file-btree-node: Private classes
file-btree.lisp: The planks/src/file-btree․lisp file
function-btree: Private classes

H
heap-btree: Public classes
heap-btree-file-footer: Private classes
heap-btree.lisp: The planks/src/heap-btree․lisp file

M
map-btree.lisp: The planks/src/map-btree․lisp file
Module, src: The planks/src module
multi-btree: Public classes
multi-btree-file-footer: Private classes

N
nested-btree: Private classes

O
object-btree.lisp: The planks/src/object-btree․lisp file
object-storage-btree: Private classes
object-storage-footer: Private classes

P
Package, planks.btree: The planks․btree package
persistent-objects.lisp: The planks/src/persistent-objects․lisp file
persistent-standard-class: Private classes
persistent-standard-class-direct-slot-definition: Private classes
persistent-standard-class-effective-slot-definition: Private classes
persistent-standard-class-slot-definition: Private classes
persistent-standard-object: Private classes
persistent-standard-object-slot-btree: Private classes
planks: The planks system
planks.asd: The planks/planks․asd file
planks.btree: The planks․btree package

S
single-file-btree: Private classes
src: The planks/src module
System, planks: The planks system

V
view.lisp: The planks/src/view․lisp file