This is the planks Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 06:22:20 2024 GMT+0.
planks/planks.asd
planks/src/btree-protocol.lisp
planks/src/btree.lisp
planks/src/btree-utils.lisp
planks/src/btree-search.lisp
planks/src/map-btree.lisp
planks/src/file-btree.lisp
planks/src/heap-btree.lisp
planks/src/view.lisp
planks/src/btree-class.lisp
planks/src/object-btree.lisp
planks/src/persistent-objects.lisp
The main system appears first, followed by any subsystem dependency.
planks
Drew Crampsie <drewc@tech.coop>
MIT
rucksack
(system).
ironclad
(system).
bordeaux-threads
(system).
trivial-garbage
(system).
babel
(system).
closer-mop
(system).
src
(module).
Modules are listed depth-first from the system components tree.
planks/src
planks
(system).
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).
Files are sorted by type and then listed depth-first from the systems components trees.
planks/planks.asd
planks/src/btree-protocol.lisp
planks/src/btree.lisp
planks/src/btree-utils.lisp
planks/src/btree-search.lisp
planks/src/map-btree.lisp
planks/src/file-btree.lisp
planks/src/heap-btree.lisp
planks/src/view.lisp
planks/src/btree-class.lisp
planks/src/object-btree.lisp
planks/src/persistent-objects.lisp
planks/src/btree-protocol.lisp
src
(module).
btree-error
(condition).
btree-error-btree
(reader method).
btree-error-key
(reader method).
btree-error-key
(reader method).
btree-error-value
(reader 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).
planks/src/btree.lisp
btree-protocol.lisp
(file).
src
(module).
btree
(class).
btree-insert
(method).
btree-key-type
(reader method).
btree-max-node-size
(reader method).
btree-node
(class).
btree-node-class
(reader method).
btree-root
(reader method).
(setf btree-root)
(writer method).
btree-unique-keys-p
(reader method).
btree-value-type
(reader method).
print-object
(method).
update-btree
(method).
%update-btree
(function).
btree-key-key
(reader method).
btree-node-binding
(function).
btree-node-binding-key
(method).
btree-node-binding-value
(method).
btree-node-index
(reader method).
(setf btree-node-index)
(writer method).
btree-node-leaf-p
(reader method).
(setf btree-node-leaf-p)
(writer method).
btree-value-key
(reader 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).
planks/src/btree-utils.lisp
btree.lisp
(file).
src
(module).
btree-key<
(reader method).
btree-key=
(reader method).
btree-value=
(reader method).
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).
planks/src/btree-search.lisp
btree-utils.lisp
(file).
src
(module).
btree-search
(generic function).
find-subnode
(function).
node-search
(generic function).
not-found
(function).
planks/src/map-btree.lisp
btree-search.lisp
(file).
src
(module).
map-btree
(method).
map-btree-keys
(method).
map-btree-keys-for-node
(generic function).
planks/src/file-btree.lisp
map-btree.lisp
(file).
src
(module).
btree-file-size
(function).
btree-root
(method).
close-btree
(function).
find-btree
(function).
make-btree
(function).
shared-initialize
(method).
update-btree
(method).
update-btree
(method).
*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
(reader method).
(setf btree-file-footer)
(writer method).
btree-file-footer-action
(reader method).
(setf btree-file-footer-action)
(writer method).
btree-file-footer-address
(reader method).
(setf btree-file-footer-address)
(writer method).
btree-file-footer-class
(reader method).
(setf btree-file-footer-class)
(writer method).
btree-file-footer-key
(reader method).
(setf btree-file-footer-key)
(writer method).
btree-file-footer-previous-address
(reader method).
(setf btree-file-footer-previous-address)
(writer method).
btree-file-footer-version
(reader method).
(setf btree-file-footer-version)
(writer method).
btree-footer
(class).
btree-lock
(reader method).
(setf btree-lock)
(writer method).
btree-node-address
(reader method).
(setf btree-node-address)
(writer method).
btree-node-file-position
(function).
btree-node-max-depth
(method).
btree-node-min-depth
(method).
btree-pathname
(reader method).
(setf btree-pathname)
(writer 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
(reader method).
(setf root-node-file-position)
(writer method).
serialize
(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).
planks/src/heap-btree.lisp
file-btree.lisp
(file).
src
(module).
btree-search
(method).
heap-btree
(class).
map-btree
(method).
update-btree
(method).
allocate-heap
(method).
allocate-object
(method).
btree-heap-free-space-start
(method).
btree-heap-size
(reader method).
(setf btree-heap-size)
(writer method).
btree-heap-start
(method).
find-heap-object
(method).
heap-btree-file-footer
(class).
make-btree-footer
(method).
planks/src/view.lisp
heap-btree.lisp
(file).
src
(module).
add-function-btree
(function).
btree-search
(method).
find-function-btree
(function).
multi-btree
(class).
update-btree
(method).
*current-btree*
(special variable).
*current-footer*
(special variable).
btree-function-name
(reader method).
(setf btree-function-name)
(writer method).
current-btree
(function).
current-footer
(function).
function-btree
(class).
make-btree-footer
(method).
multi-btree-file-footer
(class).
planks/src/btree-class.lisp
view.lisp
(file).
src
(module).
initialize-instance
(method).
reinitialize-instance
(method).
shared-initialize
(method).
validate-superclass
(method).
btree-class
(class).
btree-class-pathname
(method).
btree-class-pathname
(reader method).
(setf btree-class-pathname)
(writer method).
btree-object
(class).
btree-object-id
(reader method).
(setf btree-object-id)
(writer method).
btree-pathname
(method).
planks/src/object-btree.lisp
btree-class.lisp
(file).
src
(module).
update-btree
(method).
update-btree
(method).
btree-footer-next-id
(reader method).
(setf btree-footer-next-id)
(writer method).
btree-pathname
(method).
make-btree-footer
(generic function).
nested-btree
(class).
object-storage-btree
(class).
object-storage-footer
(class).
planks/src/persistent-objects.lisp
object-btree.lisp
(file).
src
(module).
compute-effective-slot-definition
(method).
direct-slot-definition-class
(method).
effective-slot-definition-class
(method).
initialize-instance
(method).
reinitialize-instance
(method).
shared-initialize
(method).
slot-boundp-using-class
(method).
(setf slot-value-using-class)
(method).
slot-value-using-class
(method).
update-btree
(method).
validate-superclass
(method).
*persistent-standard-class-effective-slot-definition-class*
(special variable).
+persistent-standard-object-marker+
(constant).
btree-class-pathname
(reader method).
(setf btree-class-pathname)
(writer method).
btree-pathname
(method).
persistent-standard-class
(class).
persistent-standard-class-btree
(reader method).
(setf persistent-standard-class-btree)
(writer 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
(reader method).
(setf persistent-standard-object-slot-btree)
(writer method).
persistent-standard-object-slot-btree
(class).
persistent-standard-object-slot-btree-class-name
(reader method).
(setf persistent-standard-object-slot-btree-class-name)
(writer method).
serialize
(method).
serialize
(method).
slot-definition-persistentp
(reader method).
slot-definition-persistentp
(method).
(setf slot-definition-persistentp)
(writer method).
Packages are listed by definition order.
planks.btree
common-lisp
.
add-function-btree
(function).
btree
(class).
btree-error
(condition).
btree-error-btree
(generic reader).
btree-error-key
(generic reader).
btree-error-value
(generic reader).
btree-file-size
(function).
btree-insert
(generic function).
btree-insertion-error
(condition).
btree-key-already-present-error
(condition).
btree-key-type
(generic reader).
btree-key<
(generic reader).
btree-key=
(generic reader).
btree-max-node-size
(generic reader).
btree-node
(class).
btree-node-class
(generic reader).
btree-root
(generic function).
(setf btree-root)
(generic writer).
btree-search
(generic function).
btree-search-error
(condition).
btree-type-error
(condition).
btree-unique-keys-p
(generic reader).
btree-value-type
(generic reader).
btree-value=
(generic reader).
close-btree
(function).
find-btree
(function).
find-function-btree
(function).
heap-btree
(class).
make-btree
(function).
map-btree
(generic function).
multi-btree
(class).
update-btree
(generic function).
%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-object
(generic function).
btree-balanced-p
(generic function).
btree-class
(class).
btree-class-pathname
(generic function).
(setf btree-class-pathname)
(generic writer).
btree-depths
(generic function).
btree-file-footer
(generic reader).
(setf btree-file-footer)
(generic writer).
btree-file-footer-action
(generic reader).
(setf btree-file-footer-action)
(generic writer).
btree-file-footer-address
(generic reader).
(setf btree-file-footer-address)
(generic writer).
btree-file-footer-class
(generic reader).
(setf btree-file-footer-class)
(generic writer).
btree-file-footer-key
(generic reader).
(setf btree-file-footer-key)
(generic writer).
btree-file-footer-previous-address
(generic reader).
(setf btree-file-footer-previous-address)
(generic writer).
btree-file-footer-version
(generic reader).
(setf btree-file-footer-version)
(generic writer).
btree-footer
(class).
btree-footer-next-id
(generic reader).
(setf btree-footer-next-id)
(generic writer).
btree-function-name
(generic reader).
(setf btree-function-name)
(generic writer).
btree-heap-free-space-start
(generic function).
btree-heap-size
(generic reader).
(setf btree-heap-size)
(generic writer).
btree-heap-start
(generic function).
btree-key-key
(generic reader).
btree-key<=
(generic function).
btree-key>
(generic function).
btree-key>=
(generic function).
btree-lock
(generic reader).
(setf btree-lock)
(generic writer).
btree-node-address
(generic reader).
(setf btree-node-address)
(generic writer).
btree-node-binding
(function).
btree-node-binding-count
(function).
btree-node-binding-key
(generic function).
btree-node-binding-value
(generic function).
btree-node-file-position
(function).
btree-node-index
(generic reader).
(setf btree-node-index)
(generic writer).
btree-node-leaf-p
(generic reader).
(setf btree-node-leaf-p)
(generic writer).
btree-node-max-depth
(generic function).
btree-node-min-depth
(generic function).
btree-object
(class).
btree-object-id
(generic reader).
(setf btree-object-id)
(generic writer).
btree-pathname
(generic function).
(setf btree-pathname)
(generic writer).
btree-value-key
(generic reader).
call-with-btree-stream
(function).
current-btree
(function).
current-footer
(function).
file-btree
(class).
file-btree-node
(class).
find-heap-object
(generic function).
find-key-position-in-index
(function).
find-subnode
(function).
function-btree
(class).
heap-btree-file-footer
(class).
largest-key-in-node
(generic function).
load-btree-node
(function).
load-btree-node-from-stream
(function).
make-btree-footer
(generic function).
make-btree-lock
(function).
make-footer-buffer
(function).
make-root-node
(generic function).
map-btree-keys
(generic function).
map-btree-keys-for-node
(generic function).
map-btree-node
(generic function).
multi-btree-file-footer
(class).
nested-btree
(class).
node-almost-full-p
(function).
node-search
(generic function).
not-found
(function).
object-storage-btree
(class).
object-storage-footer
(class).
persist
(generic function).
persistent-standard-class
(class).
persistent-standard-class-btree
(generic reader).
(setf persistent-standard-class-btree)
(generic writer).
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 reader).
(setf persistent-standard-object-slot-btree)
(generic writer).
persistent-standard-object-slot-btree
(class).
persistent-standard-object-slot-btree-class-name
(generic reader).
(setf persistent-standard-object-slot-btree-class-name)
(generic writer).
read-btree-from-file-stream
(function).
read-file-footer
(function).
read-footer-checksum
(generic function).
read-node-tag
(generic function).
root-node-file-position
(generic reader).
(setf root-node-file-position)
(generic writer).
single-file-btree
(class).
slot-definition-persistentp
(generic function).
(setf slot-definition-persistentp)
(generic writer).
split-binding-node
(function).
update-binding-for-insert
(function).
update-bnode
(function).
update-index-for-insert
(function).
update-node
(generic function).
update-node-for-insert
(generic function).
write-file-footer
(function).
write-footer-checksum
(generic function).
write-node-tag
(generic function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
btree-error
)) ¶btree-insertion-error
)) ¶key
.
btree-search-error
)) ¶key
.
btree-insertion-error
)) ¶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).
file-btree
)) ¶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.
multi-btree
) key &key errorp default-value function) ¶heap-btree
) key &key 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.
heap-btree
) fn &rest args &key address-only &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
persistent-standard-object-slot-btree
) &key &allow-other-keys) ¶nested-btree
) &key &allow-other-keys) ¶object-storage-btree
) &rest args &key value-thunk &allow-other-keys) ¶function-btree
) &rest args) ¶heap-btree
) &rest args &key value action) ¶single-file-btree
) &rest args &key &allow-other-keys) ¶file-btree
) &key &allow-other-keys) ¶persistent-standard-class
) name direct-slot-definitions) ¶sb-mop
.
persistent-standard-class
) &key &allow-other-keys) ¶sb-mop
.
persistent-standard-class
) &key &allow-other-keys) ¶sb-mop
.
persistent-standard-class
) &rest initargs &key direct-superclasses) ¶btree-class
) &rest initargs &key direct-superclasses) ¶btree-node
) stream) ¶persistent-standard-class
) &rest initargs &key direct-superclasses) ¶btree-class
) &rest initargs &key direct-superclasses) ¶persistent-standard-class
) (object persistent-standard-object
) (slotd persistent-standard-class-effective-slot-definition
)) ¶sb-mop
.
persistent-standard-class
) (object persistent-standard-object
) (slotd persistent-standard-class-effective-slot-definition
)) ¶sb-mop
.
persistent-standard-class
) (object persistent-standard-object
) (slotd persistent-standard-class-effective-slot-definition
)) ¶sb-mop
.
persistent-standard-class
) sc) ¶sb-mop
.
btree-class
) sc) ¶sb-mop
.
error
.
:btree
This slot is read-only.
:key
This slot is read-only.
btree-error
.
type-error
.
btree-balanced-p
.
btree-depths
.
btree-insert
.
btree-key-key
.
btree-key-type
.
btree-key<
.
btree-key<=
.
btree-key=
.
btree-key>
.
btree-key>=
.
btree-max-node-size
.
btree-node-class
.
(setf btree-root)
.
btree-root
.
btree-unique-keys-p
.
btree-value-key
.
btree-value-type
.
btree-value=
.
map-btree
.
map-btree-keys
.
node-search
.
(quote <)
:key<
This slot is read-only.
(quote eql)
:key=
This slot is read-only.
(quote eql)
:value=
This slot is read-only.
A unary function that is applied to a
btree key before comparing it to another key with a key comparison
predicate like BTREE-KEY<.
(quote identity)
:key-key
This slot is read-only.
A unary function that is applied to a
btree value before comparing it to another value with the BTREE-VALUE=
predicate.
(quote identity)
:value-key
This slot is read-only.
(quote planks.btree:btree-node)
:node-class
This slot is read-only.
An integer specifying the preferred maximum number of keys per btree node.
100
:max-node-size
This slot is read-only.
If false, one key can correspond to more than one value.
t
:unique-keys-p
This slot is read-only.
The type of all keys.
t
:key-type
This slot is read-only.
The type of all values.
t
:value-type
This slot is read-only.
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.
(vector)
:index
:leaf-p
Initarg | Value |
---|---|
:footer-class | (quote multi-btree-file-footer) |
Returns the position of the subnode that contains more information for the given key.
Returns the subnode that contains more information for the given key.
heap-btree
) start stream) ¶heap-btree
) object object-start heap-start stream) ¶persistent-standard-class
)) ¶automatically generated reader method
standard-class
)) ¶btree-class
)) ¶automatically generated reader method
persistent-standard-class
)) ¶automatically generated writer method
btree-class
)) ¶automatically generated writer method
file-btree
)) ¶automatically generated reader method
key
.
automatically generated writer method
key
.
function-btree
)) ¶automatically generated reader method
function-btree
)) ¶automatically generated writer method
heap-btree
)) ¶heap-btree
)) ¶automatically generated reader method
heap-btree
)) ¶automatically generated writer method
heap-btree
)) ¶single-file-btree
)) ¶automatically generated reader method
lock
.
single-file-btree
)) ¶automatically generated writer method
lock
.
file-btree-node
)) ¶automatically generated reader method
file-btree-node
)) ¶automatically generated writer method
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.
btree-node
)) ¶automatically generated reader method
btree-node
)) ¶automatically generated writer method
integer
)) ¶btree-node
)) ¶integer
)) ¶btree-node
)) ¶btree-object
)) ¶automatically generated reader method
id
.
btree-object
)) ¶automatically generated writer method
id
.
persistent-standard-object
)) ¶nested-btree
)) ¶file-btree
)) ¶automatically generated reader method
file-btree
)) ¶automatically generated writer method
integer
) function min max include-min include-max order) ¶null
) function min max include-min include-max order) ¶integer
)) ¶integer
) key errorp default-value) ¶btree
) (node btree-node
) key errorp default-value) ¶persistent-standard-class
)) ¶automatically generated reader method
persistent-standard-class
)) ¶automatically generated writer method
persistent-standard-object
)) ¶automatically generated reader method
persistent-standard-object
)) ¶automatically generated writer method
persistent-standard-object-slot-btree
)) ¶automatically generated reader method
persistent-standard-object-slot-btree
)) ¶automatically generated writer method
btree-footer
)) ¶automatically generated reader method
btree-footer
)) ¶automatically generated writer method
persistent-standard-class-slot-definition
)) ¶automatically generated reader method
persistent-standard-class-slot-definition
)) ¶automatically generated writer method
file-btree-node
) &key &allow-other-keys) ¶file-btree-node
) stream) ¶rucksack
.
persistent-standard-object-slot-btree
) stream) ¶rucksack
.
persistent-standard-object
) stream) ¶rucksack
.
standard-class
.
common-lisp
.
:btree-path
(setf btree-file-footer-action)
.
btree-file-footer-action
.
(setf btree-file-footer-address)
.
btree-file-footer-address
.
(setf btree-file-footer-key)
.
btree-file-footer-key
.
(setf btree-file-footer-previous-address)
.
btree-file-footer-previous-address
.
(setf btree-file-footer-version)
.
btree-file-footer-version
.
(setf root-node-file-position)
.
root-node-file-position
.
:root-node-position
:address
:create
:action
0
:version
:previous-address
:id
Initarg | Value |
---|---|
:node-class | (quote file-btree-node) |
common-lisp
.
:pathname
:address
:name
Initarg | Value |
---|---|
:footer-class | (quote object-storage-footer) |
0
standard-class
.
(setf btree-class-pathname)
.
btree-class-pathname
.
compute-effective-slot-definition
.
direct-slot-definition-class
.
effective-slot-definition-class
.
initialize-instance
.
(setf persistent-standard-class-btree)
.
persistent-standard-class-btree
.
reinitialize-instance
.
slot-boundp-using-class
.
(setf slot-value-using-class)
.
slot-value-using-class
.
validate-superclass
.
:btree
persistent-standard-class-slot-definition
.
standard-direct-slot-definition
.
persistent-standard-class-slot-definition
.
standard-effective-slot-definition
.
t
:persistent
Initarg | Value |
---|---|
:key< | (quote string=) |
:key= | (quote string=) |
:key-type | (quote symbol) |
common-lisp
.
:class-name
Jump to: | %
(
A B C D E F G I L M N P R S U V W |
---|
Jump to: | %
(
A B C D E F G I L M N P R S U V W |
---|
Jump to: | *
+
A B C F H I K L M N P R S U V |
---|
Jump to: | *
+
A B C F H I K L M N P R S U V |
---|
Jump to: | B C F H M N O P S V |
---|
Jump to: | B C F H M N O P S V |
---|