This is the hh-redblack Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 16:41:04 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
hh-redblack0.1
package.lisp (file).
base.lisp (file).
memory.lisp (file).
persistent.lisp (file).
array.lisp (file).
text.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
hh-redblack/hh-redblack.asdhh-redblack/package.lisphh-redblack/base.lisphh-redblack/memory.lisphh-redblack/persistent.lisphh-redblack/array.lisphh-redblack/text.lisphh-redblack/base.lisppackage.lisp (file).
hh-redblack (system).
initialize-instance (method).
print-object (method).
print-object (method).
rb-get (generic function).
rb-keys (generic function).
rb-put (generic function).
rb-remove (generic function).
rb-size (generic function).
rb< (generic function).
rb= (generic function).
with-rb-keys-and-data (macro).
color (generic function).
(setf color) (generic function).
data (generic function).
(setf data) (generic function).
deduplicate (generic reader).
(setf deduplicate) (generic writer).
key (generic function).
(setf key) (generic function).
leafp (generic function).
left (generic function).
(setf left) (generic function).
parent (generic function).
(setf parent) (generic function).
rb-delete (generic function).
rb-delete-fixup (generic function).
rb-find (generic function).
rb-first (generic function).
rb-insert (generic function).
rb-insert-fixup (generic function).
rb-last (generic function).
rb-left-rotate (generic function).
rb-make-node (generic function).
rb-next (generic function).
rb-node-class (generic function).
rb-previous (generic function).
rb-right-rotate (generic function).
rb-transplant (generic function).
rb-tree-maximum (generic function).
rb-tree-minimum (generic function).
red-black-node (class).
red-black-tree (class).
right (generic function).
(setf right) (generic function).
root (generic function).
(setf root) (generic writer).
hh-redblack/memory.lispbase.lisp (file).
hh-redblack (system).
make-red-black-tree (function).
color (reader method).
(setf color) (writer method).
data (reader method).
(setf data) (writer method).
deduplicate (reader method).
(setf deduplicate) (writer method).
key (reader method).
(setf key) (writer method).
leaf (reader method).
(setf leaf) (writer method).
left (reader method).
(setf left) (writer method).
memory-red-black-node (class).
memory-red-black-tree (class).
parent (reader method).
(setf parent) (writer method).
rb-node-class (method).
right (reader method).
(setf right) (writer method).
root (reader method).
(setf root) (writer method).
hh-redblack/persistent.lispbase.lisp (file).
hh-redblack (system).
initialize-instance (method).
print-object (method).
print-object (method).
requires-red-black-transaction (condition).
with-rb-transaction (macro).
*rb-transaction* (special variable).
add-changed-object (generic function).
add-child-object (generic function).
add-new-object (generic function).
ancestor-p (generic function).
changedp (generic function).
changes (reader method).
(setf changes) (writer method).
clear-changes (function).
color (reader method).
color (method).
(setf color) (writer method).
(setf color) (method).
compare-save-order (generic function).
contents (reader method).
contents (method).
(setf contents) (writer method).
data (reader method).
data (method).
(setf data) (writer method).
(setf data) (method).
deduplicate (reader method).
(setf deduplicate) (writer method).
key (reader method).
key (method).
(setf key) (writer method).
(setf key) (method).
leaf (reader method).
(setf leaf) (writer method).
(setf leaf) (method).
left (reader method).
left (method).
(setf left) (writer method).
(setf left) (method).
loaded-p (generic function).
location (reader method).
(setf location) (writer method).
new-root (reader method).
(setf new-root) (writer method).
node-state (type).
object-loaded (type).
object-unloaded (type).
parent (method).
(setf parent) (method).
parents (reader method).
(setf parents) (writer method).
persistent-red-black-data (class).
persistent-red-black-node (class).
persistent-red-black-object (class).
persistent-red-black-tree (class).
prb-abort (generic function).
prb-close-storage (generic function).
prb-commit (generic function).
prb-fetch-data (generic function).
prb-fetch-node (generic function).
prb-leaf-location-p (generic function).
prb-load-data (generic function).
prb-load-node (generic function).
prb-location (generic function).
prb-open-storage (generic function).
prb-save-object (generic function).
prb-save-root (generic function).
prb-stash-data (generic function).
prb-stash-node (generic function).
rb-data-class (generic function).
rb-make-data (generic function).
rb-make-node (method).
rb-node-class (method).
red-black-tree-transaction (class).
refresh-node (generic function).
require-rb-transaction (function).
right (reader method).
right (method).
(setf right) (writer method).
(setf right) (method).
root (reader method).
root (method).
(setf root) (writer method).
sort-into-save-order (function).
state (reader method).
(setf state) (writer method).
transaction-aborted (condition).
tree (reader method).
(setf tree) (writer method).
hh-redblack/array.lisppersistent.lisp (file).
hh-redblack (system).
make-memory-persistent-red-black-tree (function).
memory-persistent-red-black-tree (class).
objects (reader method).
(setf objects) (writer method).
prb-close-storage (method).
prb-fetch-data (method).
prb-fetch-node (method).
prb-leaf-location-p (method).
prb-location (method).
prb-open-storage (method).
prb-save-root (method).
prb-stash-data (method).
prb-stash-node (method).
hh-redblack/text.lisppersistent.lisp (file).
hh-redblack (system).
make-text-file-red-black-tree (function).
print-object (method).
print-object (method).
print-object (method).
print-object (method).
print-object (method).
print-object (method).
allocation-size (generic function).
close-storage-stream (function).
color (reader method).
(setf color) (writer method).
content (reader method).
(setf content) (writer method).
contents (reader method).
(setf contents) (writer method).
data (reader method).
(setf data) (writer method).
equality (generic function).
file-name (reader method).
(setf file-name) (writer method).
footer (macro).
form (macro).
form-number (reader method).
form-number (reader method).
(setf form-number) (writer method).
(setf form-number) (writer method).
header (macro).
inconsistent-storage (condition).
key (reader method).
(setf key) (writer method).
leaf (reader method).
(setf leaf) (writer method).
left (reader method).
(setf left) (writer method).
loc (macro).
location (reader method).
(setf location) (writer method).
make-storage-footer (function).
make-storage-header (function).
next-form-number (reader method).
next-form-number (reader method).
(setf next-form-number) (writer method).
(setf next-form-number) (writer method).
node (macro).
node-data (macro).
offset (reader method).
(setf offset) (writer method).
open-storage-stream (function).
prb-close-storage (method).
prb-fetch-data (method).
prb-fetch-node (method).
prb-leaf-location-p (method).
prb-location (method).
prb-open-storage (method).
prb-save-root (method).
prb-stash-data (method).
prb-stash-node (method).
rb-data-class (method).
rb-node-class (method).
read-stored-object (function).
right (reader method).
(setf right) (writer method).
root (reader method).
(setf root) (writer method).
storage-data (class).
storage-footer (class).
storage-form (class).
storage-header (class).
storage-location (class).
storage-node (class).
storage-stream (reader method).
(setf storage-stream) (writer method).
text-file-red-black-data (class).
text-file-red-black-node (class).
text-file-red-black-object (class).
text-file-red-black-tree (class).
version (reader method).
(setf version) (writer method).
write-stored-object (function).
Packages are listed by definition order.
hh-redblackcommon-lisp.
make-memory-persistent-red-black-tree (function).
make-red-black-tree (function).
make-text-file-red-black-tree (function).
rb-get (generic function).
rb-keys (generic function).
rb-put (generic function).
rb-remove (generic function).
rb-size (generic function).
rb< (generic function).
rb= (generic function).
requires-red-black-transaction (condition).
with-rb-keys-and-data (macro).
with-rb-transaction (macro).
*rb-transaction* (special variable).
add-changed-object (generic function).
add-child-object (generic function).
add-new-object (generic function).
allocation-size (generic function).
ancestor-p (generic function).
changedp (generic function).
changes (generic reader).
(setf changes) (generic writer).
clear-changes (function).
close-storage-stream (function).
color (generic function).
(setf color) (generic function).
compare-save-order (generic function).
content (generic reader).
(setf content) (generic writer).
contents (generic function).
(setf contents) (generic writer).
data (generic function).
(setf data) (generic function).
deduplicate (generic reader).
(setf deduplicate) (generic writer).
equality (generic function).
file-name (generic reader).
(setf file-name) (generic writer).
footer (macro).
form (macro).
form-number (generic reader).
(setf form-number) (generic writer).
header (macro).
inconsistent-storage (condition).
key (generic function).
(setf key) (generic function).
leaf (generic reader).
(setf leaf) (generic function).
leafp (generic function).
left (generic function).
(setf left) (generic function).
loaded-p (generic function).
loc (macro).
location (generic reader).
(setf location) (generic writer).
make-storage-footer (function).
make-storage-header (function).
memory-persistent-red-black-tree (class).
memory-red-black-node (class).
memory-red-black-tree (class).
new-root (generic reader).
(setf new-root) (generic writer).
next-form-number (generic reader).
(setf next-form-number) (generic writer).
node (macro).
node-data (macro).
node-state (type).
object-loaded (type).
object-unloaded (type).
objects (generic reader).
(setf objects) (generic writer).
offset (generic reader).
(setf offset) (generic writer).
open-storage-stream (function).
parent (generic function).
(setf parent) (generic function).
parents (generic reader).
(setf parents) (generic writer).
persistent-red-black-data (class).
persistent-red-black-node (class).
persistent-red-black-object (class).
persistent-red-black-tree (class).
prb-abort (generic function).
prb-close-storage (generic function).
prb-commit (generic function).
prb-fetch-data (generic function).
prb-fetch-node (generic function).
prb-leaf-location-p (generic function).
prb-load-data (generic function).
prb-load-node (generic function).
prb-location (generic function).
prb-open-storage (generic function).
prb-save-object (generic function).
prb-save-root (generic function).
prb-stash-data (generic function).
prb-stash-node (generic function).
rb-data-class (generic function).
rb-delete (generic function).
rb-delete-fixup (generic function).
rb-find (generic function).
rb-first (generic function).
rb-insert (generic function).
rb-insert-fixup (generic function).
rb-last (generic function).
rb-left-rotate (generic function).
rb-make-data (generic function).
rb-make-node (generic function).
rb-next (generic function).
rb-node-class (generic function).
rb-previous (generic function).
rb-right-rotate (generic function).
rb-transplant (generic function).
rb-tree-maximum (generic function).
rb-tree-minimum (generic function).
read-stored-object (function).
red-black-node (class).
red-black-tree (class).
red-black-tree-transaction (class).
refresh-node (generic function).
require-rb-transaction (function).
right (generic function).
(setf right) (generic function).
root (generic function).
(setf root) (generic writer).
sort-into-save-order (function).
state (generic reader).
(setf state) (generic writer).
storage-data (class).
storage-footer (class).
storage-form (class).
storage-header (class).
storage-location (class).
storage-node (class).
storage-stream (generic reader).
(setf storage-stream) (generic writer).
text-file-red-black-data (class).
text-file-red-black-node (class).
text-file-red-black-object (class).
text-file-red-black-tree (class).
transaction-aborted (condition).
tree (generic reader).
(setf tree) (generic writer).
version (generic reader).
(setf version) (generic writer).
write-stored-object (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Returns 2 values, just like gethash: if the key is present, returns the associated data and t (indicating data was present), otherwise returns the default and nil
red-black-tree) key &optional default) ¶Return all keys of the tree as an ordered list; not recommended for large trees
red-black-tree)) ¶Equivalent to sethash with a hashtable: set the data for a given key in the provided tree
red-black-tree) key data) ¶Remove the node with the indicated key from the tree
red-black-tree) key) ¶Calculate the number of nodes in the tree
red-black-tree)) ¶Return t if the left key is less than the right key, nil otherwise
Return t if the left key and right key are equivalent
persistent-red-black-tree) &key) ¶red-black-tree) &key) ¶storage-data) stream) ¶storage-form) stream) ¶storage-footer) stream) ¶red-black-tree) stream) ¶persistent-red-black-data) stream) ¶storage-node) stream) ¶storage-header) stream) ¶persistent-red-black-node) stream) ¶red-black-node) stream) ¶storage-location) stream) ¶condition.
The currently active transaction on a red-black tree
red-black-tree-transaction) object) ¶red-black-tree-transaction) (parent persistent-red-black-node) child) ¶red-black-tree-transaction) (parent persistent-red-black-node) (child persistent-red-black-object)) ¶red-black-tree-transaction) object) ¶Size of the object persisted in the tree’s storage; the units of measures for the size depend on the tree’s storage implementation
text-file-red-black-tree) (footer storage-footer)) ¶text-file-red-black-tree) (header storage-header)) ¶text-file-red-black-tree) object) ¶persistent-red-black-node) (possible-ancestor persistent-red-black-node)) ¶red-black-tree-transaction) object) ¶red-black-tree-transaction)) ¶automatically generated reader method
red-black-tree-transaction)) ¶automatically generated writer method
storage-node)) ¶automatically generated reader method
persistent-red-black-node)) ¶persistent-red-black-node)) ¶automatically generated reader method
memory-red-black-node)) ¶automatically generated reader method
storage-node)) ¶automatically generated writer method
persistent-red-black-node)) ¶persistent-red-black-node)) ¶automatically generated writer method
memory-red-black-node)) ¶automatically generated writer method
persistent-red-black-node) (right persistent-red-black-node)) ¶persistent-red-black-node)) ¶persistent-red-black-node) right) ¶storage-data)) ¶automatically generated reader method
storage-data)) ¶automatically generated writer method
storage-form)) ¶automatically generated reader method
persistent-red-black-data)) ¶persistent-red-black-data)) ¶automatically generated reader method
storage-form)) ¶automatically generated writer method
persistent-red-black-data)) ¶automatically generated writer method
storage-node)) ¶automatically generated reader method
persistent-red-black-node)) ¶data.
persistent-red-black-node)) ¶automatically generated reader method
memory-red-black-node)) ¶automatically generated reader method
data.
storage-node)) ¶automatically generated writer method
persistent-red-black-node)) ¶data.
persistent-red-black-node)) ¶automatically generated writer method
memory-red-black-node)) ¶automatically generated writer method
data.
persistent-red-black-tree)) ¶automatically generated reader method
memory-red-black-tree)) ¶automatically generated reader method
persistent-red-black-tree)) ¶automatically generated writer method
memory-red-black-tree)) ¶automatically generated writer method
The equality test is important for detecting consistency of the footer and its backup
storage-location) (right storage-location)) ¶storage-footer) (right storage-footer)) ¶text-file-red-black-tree)) ¶automatically generated reader method
text-file-red-black-tree)) ¶automatically generated writer method
storage-form)) ¶automatically generated reader method
storage-location)) ¶automatically generated reader method
storage-form)) ¶automatically generated writer method
storage-location)) ¶automatically generated writer method
storage-node)) ¶automatically generated reader method
persistent-red-black-node)) ¶key.
persistent-red-black-node)) ¶automatically generated reader method
memory-red-black-node)) ¶automatically generated reader method
key.
storage-node)) ¶automatically generated writer method
persistent-red-black-node)) ¶key.
persistent-red-black-node)) ¶automatically generated writer method
memory-red-black-node)) ¶automatically generated writer method
key.
storage-footer)) ¶automatically generated reader method
persistent-red-black-tree)) ¶automatically generated reader method
leaf.
memory-red-black-tree)) ¶automatically generated reader method
leaf.
storage-footer)) ¶automatically generated writer method
persistent-red-black-tree)) ¶leaf.
persistent-red-black-tree)) ¶automatically generated writer method
memory-red-black-tree)) ¶automatically generated writer method
leaf.
red-black-tree) (node red-black-node)) ¶storage-node)) ¶automatically generated reader method
persistent-red-black-node)) ¶left.
persistent-red-black-node)) ¶automatically generated reader method
memory-red-black-node)) ¶automatically generated reader method
left.
storage-node)) ¶automatically generated writer method
persistent-red-black-node)) ¶left.
persistent-red-black-node)) ¶automatically generated writer method
memory-red-black-node)) ¶automatically generated writer method
left.
persistent-red-black-object)) ¶text-file-red-black-object)) ¶automatically generated reader method
persistent-red-black-object)) ¶automatically generated reader method
text-file-red-black-object)) ¶automatically generated writer method
persistent-red-black-object)) ¶automatically generated writer method
red-black-tree-transaction)) ¶automatically generated reader method
red-black-tree-transaction)) ¶automatically generated writer method
storage-footer)) ¶automatically generated reader method
text-file-red-black-tree)) ¶automatically generated reader method
storage-footer)) ¶automatically generated writer method
text-file-red-black-tree)) ¶automatically generated writer method
memory-persistent-red-black-tree)) ¶automatically generated reader method
memory-persistent-red-black-tree)) ¶automatically generated writer method
storage-location)) ¶automatically generated reader method
storage-location)) ¶automatically generated writer method
persistent-red-black-node)) ¶memory-red-black-node)) ¶automatically generated reader method
persistent-red-black-node)) ¶memory-red-black-node)) ¶automatically generated writer method
red-black-tree-transaction)) ¶red-black-tree-transaction)) ¶For mapping objects to their parent objects
Abandon any changes in the tree; note that any nodes held should be reacquired after an abort
red-black-tree-transaction)) ¶Release storage from use; further load & save operations cannot succeed without a subsequent open call
text-file-red-black-tree)) ¶memory-persistent-red-black-tree)) ¶Orchestrate the persisting of all changes to a tree, including all changed nodes
red-black-tree-transaction)) ¶Return data from the indicated location
text-file-red-black-tree) location) ¶memory-persistent-red-black-tree) location) ¶Return the state of a node as multiple values:
– location of left child, or location for nil sentinel
– location of right child, or location for nil sentinel
– color value
– key value
– location of data
text-file-red-black-tree) location) ¶memory-persistent-red-black-tree) location) ¶Return true if the location points to the nil or leaf sentinel
text-file-red-black-tree) location) ¶memory-persistent-red-black-tree) location) ¶Load data from storage, if not already loaded
persistent-red-black-tree) (data persistent-red-black-data)) ¶Load the node’s state from storage, if not already loaded
persistent-red-black-tree) (node persistent-red-black-node)) ¶Return the current location within storage where new objects would be written
text-file-red-black-tree)) ¶memory-persistent-red-black-tree)) ¶Prepare tree for use; after this call load & save operations should succeed, the root should be loaded, and the leaf sentinel identified
text-file-red-black-tree)) ¶Open storage and move file-position to end of file for appending any new data
memory-persistent-red-black-tree)) ¶Write the object to memory.
persistent-red-black-tree) (data persistent-red-black-data)) ¶persistent-red-black-tree) (node persistent-red-black-node)) ¶Save the indicated root to storage; after this call, any subsequent transaction should see this object as the root of the tree
text-file-red-black-tree) root) ¶memory-persistent-red-black-tree) root) ¶Save the indicated contents of a data object in storage
text-file-red-black-tree) contents) ¶memory-persistent-red-black-tree) data) ¶Save node state into storage
text-file-red-black-tree) left-location right-location color-value key-value data-location) ¶memory-persistent-red-black-tree) left-location right-location color-value key-value data-location) ¶Return the class to be used for storing data in the tree
text-file-red-black-tree)) ¶persistent-red-black-tree)) ¶red-black-tree) (node red-black-node)) ¶red-black-tree) (node red-black-node)) ¶red-black-tree) key) ¶red-black-tree)) ¶red-black-tree) (node red-black-node)) ¶red-black-tree) (node red-black-node)) ¶red-black-tree)) ¶red-black-tree) (node red-black-node)) ¶persistent-red-black-tree) &key location contents) ¶Return a node suitable for insertion within the tree
persistent-red-black-tree) &key key data) ¶red-black-tree) &key key data) ¶Return the node with the next higher key in the tree
red-black-tree) (node red-black-node)) ¶Return the class to be used for creating nodes in the tree
text-file-red-black-tree)) ¶persistent-red-black-tree)) ¶memory-red-black-tree)) ¶Return the node with the next lower (aka previous) key in the tree
red-black-tree) (node red-black-node)) ¶red-black-tree) (node red-black-node)) ¶red-black-tree) (u red-black-node) (v red-black-node)) ¶red-black-tree) (node red-black-node)) ¶red-black-tree) (node red-black-node)) ¶Refresh a node’s state from storage, if necessary
storage-node)) ¶automatically generated reader method
persistent-red-black-node)) ¶persistent-red-black-node)) ¶automatically generated reader method
memory-red-black-node)) ¶automatically generated reader method
storage-node)) ¶automatically generated writer method
persistent-red-black-node)) ¶persistent-red-black-node)) ¶automatically generated writer method
memory-red-black-node)) ¶automatically generated writer method
storage-footer)) ¶automatically generated reader method
persistent-red-black-tree)) ¶root.
persistent-red-black-tree)) ¶automatically generated reader method
memory-red-black-tree)) ¶automatically generated reader method
root.
storage-footer)) ¶automatically generated writer method
persistent-red-black-tree)) ¶root.
memory-red-black-tree)) ¶automatically generated writer method
root.
persistent-red-black-object)) ¶automatically generated reader method
persistent-red-black-object)) ¶automatically generated writer method
text-file-red-black-tree)) ¶automatically generated reader method
text-file-red-black-tree)) ¶automatically generated writer method
red-black-tree-transaction)) ¶automatically generated reader method
tree.
red-black-tree-transaction)) ¶automatically generated writer method
tree.
storage-header)) ¶automatically generated reader method
storage-header)) ¶automatically generated writer method
condition.
(make-array 0 :adjustable t :fill-pointer t)
:contents
add-child-object.
add-child-object.
ancestor-p.
(setf color).
color.
(setf color).
color.
compare-save-order.
compare-save-order.
compare-save-order.
(setf data).
data.
(setf data).
data.
(setf key).
key.
(setf key).
key.
(setf left).
left.
(setf left).
left.
(setf parent).
parent.
prb-load-node.
prb-save-object.
print-object.
(setf right).
right.
(setf right).
right.
For mapping objects to their parent objects
(make-hash-table)
(make-array 0 :adjustable t :fill-pointer t)
:content
(make-instance (quote hh-redblack::storage-location))
:leaf
leaf.
(make-instance (quote hh-redblack::storage-location))
:root
root.
0
:next
0
:version
(make-instance (quote hh-redblack::storage-location))
:location
allocation-size.
allocation-size.
allocation-size.
(setf file-name).
file-name.
(setf next-form-number).
next-form-number.
prb-close-storage.
prb-fetch-data.
prb-fetch-node.
prb-leaf-location-p.
prb-location.
prb-open-storage.
prb-save-root.
prb-stash-data.
prb-stash-node.
rb-data-class.
rb-node-class.
(setf storage-stream).
storage-stream.
:file-name
common-lisp.
0
| Jump to: | (
A C D E F G H I K L M N O P R S T V W |
|---|
| Jump to: | (
A C D E F G H I K L M N O P R S T V W |
|---|
| Jump to: | *
C D F K L N O P R S T V |
|---|
| Jump to: | *
C D F K L N O P R S T V |
|---|
| Jump to: | A B C F H I M N O P R S T |
|---|
| Jump to: | A B C F H I M N O P R S T |
|---|