This is the cl-bplustree Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:00:57 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-bplustreeIn-memory B+ tree
Francisco Soto <ebobby@ebobby.org>
BSD
packages.lisp (file).
bplustree.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-bplustree/bplustree.lisppackages.lisp (file).
cl-bplustree (system).
bplustree-delete (function).
bplustree-empty-p (function).
bplustree-insert (function).
bplustree-insert-many (function).
bplustree-new (function).
bplustree-search (function).
bplustree-search-next (function).
bplustree-search-prev (function).
bplustree-search-range (function).
bplustree-traverse (function).
bplustree-traverse-with-keys (function).
print-object (method).
bplustree (structure).
bplustree-cache (reader).
(setf bplustree-cache) (writer).
bplustree-comparer (reader).
(setf bplustree-comparer) (writer).
bplustree-depth (reader).
(setf bplustree-depth) (writer).
bplustree-key (reader).
(setf bplustree-key) (writer).
bplustree-order (reader).
(setf bplustree-order) (writer).
bplustree-p (function).
bplustree-root (reader).
(setf bplustree-root) (writer).
bplustree-traverse-node (function).
bplustree-traverse-node-with-keys (function).
build-node (function).
build-node-collection-accesors (macro).
build-node-collection-transfer (macro).
copy-bplustree (function).
copy-node (function).
find-leaf-node (function).
find-node (function).
find-record (function).
make-bplustree (function).
make-node (function).
move-records-left (function).
move-records-right (function).
node (structure).
node-internal-p (function).
node-key (function).
node-key-record-set (function).
node-key-set (function).
node-key-transfer (function).
node-keys (reader).
(setf node-keys) (writer).
node-kind (reader).
(setf node-kind) (writer).
node-min-size (function).
node-next-node (reader).
(setf node-next-node) (writer).
node-num-keys (function).
node-order (reader).
(setf node-order) (writer).
node-overflow-p (function).
node-p (function).
node-prev-node (reader).
(setf node-prev-node) (writer).
node-record (function).
node-record-set (function).
node-record-transfer (function).
node-records (reader).
(setf node-records) (writer).
node-size (reader).
(setf node-size) (writer).
node-underflow-p (function).
promote-first-key (function).
search-node-keys (function).
with-comparer-function (macro).
Packages are listed by definition order.
org.ebobby.bplustreecommon-lisp.
bplustree-delete (function).
bplustree-empty-p (function).
bplustree-insert (function).
bplustree-insert-many (function).
bplustree-new (function).
bplustree-search (function).
bplustree-search-next (function).
bplustree-search-prev (function).
bplustree-search-range (function).
bplustree-traverse (function).
bplustree-traverse-with-keys (function).
bplustree (structure).
bplustree-cache (reader).
(setf bplustree-cache) (writer).
bplustree-comparer (reader).
(setf bplustree-comparer) (writer).
bplustree-depth (reader).
(setf bplustree-depth) (writer).
bplustree-key (reader).
(setf bplustree-key) (writer).
bplustree-order (reader).
(setf bplustree-order) (writer).
bplustree-p (function).
bplustree-root (reader).
(setf bplustree-root) (writer).
bplustree-traverse-node (function).
bplustree-traverse-node-with-keys (function).
build-node (function).
build-node-collection-accesors (macro).
build-node-collection-transfer (macro).
copy-bplustree (function).
copy-node (function).
find-leaf-node (function).
find-node (function).
find-record (function).
make-bplustree (function).
make-node (function).
move-records-left (function).
move-records-right (function).
node (structure).
node-internal-p (function).
node-key (function).
node-key-record-set (function).
node-key-set (function).
node-key-transfer (function).
node-keys (reader).
(setf node-keys) (writer).
node-kind (reader).
(setf node-kind) (writer).
node-min-size (function).
node-next-node (reader).
(setf node-next-node) (writer).
node-num-keys (function).
node-order (reader).
(setf node-order) (writer).
node-overflow-p (function).
node-p (function).
node-prev-node (reader).
(setf node-prev-node) (writer).
node-record (function).
node-record-set (function).
node-record-transfer (function).
node-records (reader).
(setf node-records) (writer).
node-size (reader).
(setf node-size) (writer).
node-underflow-p (function).
promote-first-key (function).
search-node-keys (function).
with-comparer-function (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Deletes a record from the given tree using the given key. Returns the tree with the record deleted.
Insert a record into the given tree using the given key. Returns the tree with the new record inserted.
If ‘key‘ is included, uses that instead of calling the key function on ‘record‘.
This enabled using the tree as a key/value store instead of a sorted set.
Insert as many records given into the tree. Returns the tree with the new records inserted.
Makes a new B+ tree with the given order.
Search for a record in the given tree using the given key.
Return the first key in ‘tree‘ after the passed ‘key‘.
Return the record as a second value.
If the third values is true, then the key and value were cached.
Return the key in ‘tree‘ before the passed ‘key‘.
Return the record as a second value.
If the third values is true, then the key and value were cached.
Search and return a range of records in the given tree between the given keys.
Generates the getter/setter functions for the btreeplus-node internal collections, keys and records.
Generates functions to transfer elements from a node into another node.
Wrap code inside a block that will create a dynamic variable that holds the comparer function.
key.
root.
Call ‘fn‘ on each leaf record in ‘node‘.
Call ‘fn‘ with key and record for each leaf of ‘node‘.
Makes an empty B+ tree node with the given order and the optional type (:leaf or :internal).
Find the proper leaf node for the given key.
Get the next node using the given key in the given node.
Get the record with the given key in the given node, nil if none.
Move the keys and records going left to right from given starting point.
Move the keys and records from the given starting point to the right.
Is the node an internal node?
Sets both the key and record at the given index to the given B+ node.
keys.
kind.
Returns the minimum size a node can have (except root).
Get the number of keys based on the node size and node type.
Does the node have more records than it should?
size.
Does the node have less records than it should?
Promotes the first key in the node, if its a leaf it simply returns it, if its an internal node it returns it but shifts the other keys to the left.
Search the given node keys vector using binary search.
Keys assumed to be sorted. Optional mix and max define the search space.
The keyword record-search indicates if you are looking for a record or a node.
| Jump to: | (
B C F M N P S W |
|---|
| Jump to: | (
B C F M N P S W |
|---|
| Jump to: | C D K N O P R S |
|---|
| Jump to: | C D K N O P R S |
|---|
| Jump to: | B C F N O P S |
|---|
| Jump to: | B C F N O P S |
|---|