This is the planks Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 14:41:18 2020 GMT+0.
• Systems | The systems documentation | |
• Modules | The modules documentation | |
• Files | The files documentation | |
• Packages | The packages documentation | |
• Definitions | The symbols documentation | |
• Indexes | Concepts, functions, variables and data types |
The main system appears first, followed by any subsystem dependency.
• The planks system |
Drew Crampsie <drewc@tech.coop>
MIT
planks.asd (file)
src (module)
Modules are listed depth-first from the system components tree.
• The planks/src module |
planks (system)
src/
Files are sorted by type and then listed depth-first from the systems components trees.
• Lisp files |
Next: The planks/src/btree-protocol․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
planks.asd
planks (system)
Next: The planks/src/btree․lisp file, Previous: The planks․asd file, Up: Lisp files [Contents][Index]
src (module)
src/btree-protocol.lisp
Next: The planks/src/btree-utils․lisp file, Previous: The planks/src/btree-protocol․lisp file, Up: Lisp files [Contents][Index]
btree-protocol.lisp (file)
src (module)
src/btree.lisp
Next: The planks/src/btree-search․lisp file, Previous: The planks/src/btree․lisp file, Up: Lisp files [Contents][Index]
btree.lisp (file)
src (module)
src/btree-utils.lisp
Next: The planks/src/map-btree․lisp file, Previous: The planks/src/btree-utils․lisp file, Up: Lisp files [Contents][Index]
btree-utils.lisp (file)
src (module)
src/btree-search.lisp
Next: The planks/src/file-btree․lisp file, Previous: The planks/src/btree-search․lisp file, Up: Lisp files [Contents][Index]
btree-search.lisp (file)
src (module)
src/map-btree.lisp
map-btree (method)
Next: The planks/src/heap-btree․lisp file, Previous: The planks/src/map-btree․lisp file, Up: Lisp files [Contents][Index]
map-btree.lisp (file)
src (module)
src/file-btree.lisp
Next: The planks/src/view․lisp file, Previous: The planks/src/file-btree․lisp file, Up: Lisp files [Contents][Index]
file-btree.lisp (file)
src (module)
src/heap-btree.lisp
Next: The planks/src/btree-class․lisp file, Previous: The planks/src/heap-btree․lisp file, Up: Lisp files [Contents][Index]
heap-btree.lisp (file)
src (module)
src/view.lisp
Next: The planks/src/object-btree․lisp file, Previous: The planks/src/view․lisp file, Up: Lisp files [Contents][Index]
view.lisp (file)
src (module)
src/btree-class.lisp
Next: The planks/src/persistent-objects․lisp file, Previous: The planks/src/btree-class․lisp file, Up: Lisp files [Contents][Index]
btree-class.lisp (file)
src (module)
src/object-btree.lisp
Previous: The planks/src/object-btree․lisp file, Up: Lisp files [Contents][Index]
object-btree.lisp (file)
src (module)
src/persistent-objects.lisp
update-btree (method)
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
• The planks.btree package |
btree-protocol.lisp (file)
common-lisp
Definitions are sorted by export status, category, package, and then by lexicographic order.
• Exported definitions | ||
• Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
• Exported functions | ||
• Exported generic functions | ||
• Exported conditions | ||
• Exported classes |
Next: Exported generic functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
view.lisp (file)
file-btree.lisp (file)
file-btree.lisp (file)
file-btree.lisp (file)
view.lisp (file)
file-btree.lisp (file)
Next: Exported conditions, Previous: Exported functions, Up: Exported definitions [Contents][Index]
btree-protocol.lisp (file)
btree-protocol.lisp (file)
btree-protocol.lisp (file)
btree-protocol.lisp (file)
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).
btree-protocol.lisp (file)
btree.lisp (file)
The type of all keys.
btree.lisp (file)
btree-utils.lisp (file)
btree-utils.lisp (file)
An integer specifying the preferred maximum number of keys per btree node.
btree.lisp (file)
automatically generated reader method
btree.lisp (file)
file-btree.lisp (file)
automatically generated reader method
btree.lisp (file)
automatically generated writer method
btree.lisp (file)
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.
btree-search.lisp (file)
view.lisp (file)
heap-btree.lisp (file)
If false, one key can correspond to more than one value.
btree.lisp (file)
The type of all values.
btree.lisp (file)
btree-utils.lisp (file)
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.
btree-protocol.lisp (file)
heap-btree.lisp (file)
map-btree.lisp (file)
This is the function that implements the functional b+tree. It is not meant to be called by users, but is specialized when extending
btree-protocol.lisp (file)
persistent-objects.lisp (file)
object-btree.lisp (file)
object-btree.lisp (file)
view.lisp (file)
heap-btree.lisp (file)
file-btree.lisp (file)
file-btree.lisp (file)
btree.lisp (file)
Next: Exported classes, Previous: Exported generic functions, Up: Exported definitions [Contents][Index]
btree-protocol.lisp (file)
error (condition)
btree-error-btree (method)
:btree
btree-error-btree (generic function)
btree-protocol.lisp (file)
btree-error (condition)
btree-key-already-present-error (condition)
:key
btree-error-key (generic function)
:value
btree-error-value (generic function)
btree-protocol.lisp (file)
btree-insertion-error (condition)
btree-protocol.lisp (file)
btree-error (condition)
btree-error-key (method)
:key
btree-error-key (generic function)
btree-protocol.lisp (file)
Previous: Exported conditions, Up: Exported definitions [Contents][Index]
btree.lisp (file)
standard-object (class)
file-btree (class)
:key<
(quote <)
btree-key< (generic function)
:key=
(quote eql)
btree-key= (generic function)
:value=
(quote eql)
btree-value= (generic function)
A unary function that is applied to a
btree key before comparing it to another key with a key comparison
predicate like BTREE-KEY<.
:key-key
(quote identity)
btree-key-key (generic function)
A unary function that is applied to a
btree value before comparing it to another value with the BTREE-VALUE=
predicate.
:value-key
(quote identity)
btree-value-key (generic function)
:node-class
(quote planks.btree:btree-node)
btree-node-class (generic function)
An integer specifying the preferred maximum number of keys per btree node.
:max-node-size
100
btree-max-node-size (generic function)
If false, one key can correspond to more than one value.
:unique-keys-p
t
btree-unique-keys-p (generic function)
The type of all keys.
:key-type
t
btree-key-type (generic function)
The type of all values.
:value-type
t
btree-value-type (generic function)
btree-root (generic function)
(setf btree-root) (generic function)
btree.lisp (file)
standard-object (class)
file-btree-node (class)
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.
:index
(vector)
btree-node-index (generic function)
(setf btree-node-index) (generic function)
:leaf-p
btree-node-leaf-p (generic function)
(setf btree-node-leaf-p) (generic function)
heap-btree.lisp (file)
multi-btree (class)
:heap-size
(* 1024 1024)
btree-heap-size (generic function)
(setf btree-heap-size) (generic function)
0
0
Initarg | Value |
---|---|
:footer-class | (quote planks.btree::heap-btree-file-footer) |
view.lisp (file)
single-file-btree (class)
heap-btree (class)
Initarg | Value |
---|---|
:footer-class | (quote planks.btree::multi-btree-file-footer) |
Previous: Exported definitions, Up: Definitions [Contents][Index]
• Internal constants | ||
• Internal special variables | ||
• Internal functions | ||
• Internal generic functions | ||
• Internal classes |
Next: Internal special variables, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
persistent-objects.lisp (file)
Next: Internal functions, Previous: Internal constants, Up: Internal definitions [Contents][Index]
file-btree.lisp (file)
file-btree.lisp (file)
file-btree.lisp (file)
view.lisp (file)
view.lisp (file)
file-btree.lisp (file)
persistent-objects.lisp (file)
file-btree.lisp (file)
Next: Internal generic functions, Previous: Internal special variables, Up: Internal definitions [Contents][Index]
btree.lisp (file)
btree.lisp (file)
btree-utils.lisp (file)
file-btree.lisp (file)
file-btree.lisp (file)
view.lisp (file)
view.lisp (file)
Returns the position of the subnode that contains more information for the given key.
btree.lisp (file)
Returns the subnode that contains more information for the given key.
btree-search.lisp (file)
file-btree.lisp (file)
file-btree.lisp (file)
file-btree.lisp (file)
file-btree.lisp (file)
btree.lisp (file)
btree-search.lisp (file)
file-btree.lisp (file)
file-btree.lisp (file)
btree.lisp (file)
btree.lisp (file)
btree.lisp (file)
btree.lisp (file)
file-btree.lisp (file)
Next: Internal classes, Previous: Internal functions, Up: Internal definitions [Contents][Index]
heap-btree.lisp (file)
heap-btree.lisp (file)
btree-utils.lisp (file)
automatically generated reader method
persistent-objects.lisp (file)
automatically generated writer method
persistent-objects.lisp (file)
btree-class.lisp (file)
automatically generated reader method
btree-class.lisp (file)
automatically generated writer method
btree-class.lisp (file)
file-btree.lisp (file)
btree-utils.lisp (file)
automatically generated reader method
file-btree.lisp (file)
automatically generated writer method
file-btree.lisp (file)
automatically generated reader method
file-btree.lisp (file)
automatically generated writer method
file-btree.lisp (file)
automatically generated reader method
file-btree.lisp (file)
automatically generated writer method
file-btree.lisp (file)
automatically generated reader method
file-btree.lisp (file)
automatically generated writer method
file-btree.lisp (file)
automatically generated reader method
file-btree.lisp (file)
automatically generated writer method
file-btree.lisp (file)
automatically generated reader method
file-btree.lisp (file)
automatically generated writer method
file-btree.lisp (file)
automatically generated reader method
file-btree.lisp (file)
automatically generated writer method
file-btree.lisp (file)
automatically generated reader method
object-btree.lisp (file)
automatically generated writer method
object-btree.lisp (file)
heap-btree.lisp (file)
automatically generated reader method
heap-btree.lisp (file)
automatically generated writer method
heap-btree.lisp (file)
heap-btree.lisp (file)
A unary function that is applied to a
btree key before comparing it to another key with a key comparison
predicate like BTREE-KEY<.
btree.lisp (file)
btree-utils.lisp (file)
btree-utils.lisp (file)
btree-utils.lisp (file)
automatically generated reader method
file-btree.lisp (file)
automatically generated writer method
file-btree.lisp (file)
automatically generated reader method
file-btree.lisp (file)
automatically generated writer method
file-btree.lisp (file)
btree.lisp (file)
btree.lisp (file)
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.lisp (file)
automatically generated reader method
btree.lisp (file)
automatically generated writer method
btree.lisp (file)
file-btree.lisp (file)
btree-utils.lisp (file)
file-btree.lisp (file)
btree-utils.lisp (file)
automatically generated reader method
btree-class.lisp (file)
automatically generated writer method
btree-class.lisp (file)
persistent-objects.lisp (file)
object-btree.lisp (file)
btree-class.lisp (file)
automatically generated reader method
file-btree.lisp (file)
automatically generated writer method
file-btree.lisp (file)
A unary function that is applied to a
btree value before comparing it to another value with the BTREE-VALUE=
predicate.
btree.lisp (file)
heap-btree.lisp (file)
file-btree.lisp (file)
btree.lisp (file)
object-btree.lisp (file)
view.lisp (file)
heap-btree.lisp (file)
file-btree.lisp (file)
btree.lisp (file)
map-btree.lisp (file)
map-btree.lisp (file)
file-btree.lisp (file)
file-btree.lisp (file)
btree-search.lisp (file)
file-btree.lisp (file)
file-btree.lisp (file)
automatically generated reader method
persistent-objects.lisp (file)
automatically generated writer method
persistent-objects.lisp (file)
automatically generated reader method
persistent-objects.lisp (file)
automatically generated writer method
persistent-objects.lisp (file)
automatically generated reader method
persistent-objects.lisp (file)
automatically generated writer method
persistent-objects.lisp (file)
file-btree.lisp (file)
file-btree.lisp (file)
automatically generated reader method
file-btree.lisp (file)
automatically generated writer method
file-btree.lisp (file)
automatically generated reader method
persistent-objects.lisp (file)
persistent-objects.lisp (file)
automatically generated writer method
persistent-objects.lisp (file)
file-btree.lisp (file)
btree.lisp (file)
file-btree.lisp (file)
btree.lisp (file)
file-btree.lisp (file)
file-btree.lisp (file)
Previous: Internal generic functions, Up: Internal definitions [Contents][Index]
btree-class.lisp (file)
standard-class (class)
:btree-path
btree-class-pathname (generic function)
(setf btree-class-pathname) (generic function)
file-btree.lisp (file)
standard-object (class)
:root-node-position
root-node-file-position (generic function)
(setf root-node-file-position) (generic function)
:address
btree-file-footer-address (generic function)
(setf btree-file-footer-address) (generic function)
:action
:create
btree-file-footer-action (generic function)
(setf btree-file-footer-action) (generic function)
:version
0
btree-file-footer-version (generic function)
(setf btree-file-footer-version) (generic function)
:previous-address
btree-file-footer-previous-address (generic function)
(setf btree-file-footer-previous-address) (generic function)
btree-file-footer-key (generic function)
(setf btree-file-footer-key) (generic function)
btree-class.lisp (file)
standard-object (class)
:id
btree-object-id (generic function)
(setf btree-object-id) (generic function)
file-btree.lisp (file)
btree (class)
:pathname
btree-pathname (generic function)
(setf btree-pathname) (generic function)
Initarg | Value |
---|---|
:node-class | (quote planks.btree::file-btree-node) |
file-btree.lisp (file)
btree-node (class)
:address
btree-node-address (generic function)
(setf btree-node-address) (generic function)
view.lisp (file)
file-btree (class)
:name
btree-function-name (generic function)
(setf btree-function-name) (generic function)
heap-btree.lisp (file)
multi-btree-file-footer (class)
0
0
view.lisp (file)
btree-footer (class)
heap-btree-file-footer (class)
object-btree.lisp (file)
file-btree (class)
:btree
planks.btree::key
object-btree.lisp (file)
single-file-btree (class)
Initarg | Value |
---|---|
:footer-class | (quote planks.btree::object-storage-footer) |
object-btree.lisp (file)
btree-footer (class)
0
btree-footer-next-id (generic function)
(setf btree-footer-next-id) (generic function)
persistent-objects.lisp (file)
standard-class (class)
:btree
persistent-objects.lisp (file)
persistent-objects.lisp (file)
persistent-objects.lisp (file)
standard-object (class)
:persistent
t
slot-definition-persistentp (generic function)
(setf slot-definition-persistentp) (generic function)
persistent-objects.lisp (file)
standard-object (class)
persistent-standard-object-slot-btree (generic function)
(setf persistent-standard-object-slot-btree) (generic function)
persistent-objects.lisp (file)
:class-name
persistent-standard-object-slot-btree-class-name (generic function)
(setf persistent-standard-object-slot-btree-class-name) (generic function)
Initarg | Value |
---|---|
:key< | (quote string=) |
:key= | (quote string=) |
:key-type | (quote symbol) |
file-btree.lisp (file)
file-btree (class)
btree-file-footer (generic function)
(setf btree-file-footer) (generic function)
:footer-class
(quote planks.btree::btree-footer)
btree-file-footer-class (generic function)
(setf btree-file-footer-class) (generic function)
btree-lock (generic function)
(setf btree-lock) (generic function)
Previous: Definitions, Up: Top [Contents][Index]
• Concept index | ||
• Function index | ||
• Variable index | ||
• Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
Jump to: | F L M P |
---|
Jump to: | F L M P |
---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
Jump to: | %
(
A B C F G L M N P R S U W |
---|
Jump to: | %
(
A B C F G L M N P R S U W |
---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
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 |
---|
Previous: Variable index, Up: Indexes [Contents][Index]
Jump to: | B C F H M N O P S |
---|
Jump to: | B C F H M N O P S |
---|