This is the flat-tree Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:12:30 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
flat-treeA flat-tree implementation in Common Lisp.
noffle <sww@eight45.net>
MIT
0.0.1
package.lisp (file).
flat-tree.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
flat-tree/flat-tree.lisppackage.lisp (file).
flat-tree (system).
children (function).
counts (function).
depth (function).
full-roots (function).
index (function).
iterator-depth (reader).
(setf iterator-depth) (writer).
iterator-index (reader).
(setf iterator-index) (writer).
iterator-is-left? (function).
iterator-is-right? (function).
iterator-left-child (function).
iterator-left-span (function).
iterator-next (function).
iterator-offset (reader).
(setf iterator-offset) (writer).
iterator-p (function).
iterator-parent (function).
iterator-prev (function).
iterator-right-child (function).
iterator-right-span (function).
iterator-seek (function).
iterator-step-size (reader).
(setf iterator-step-size) (writer).
left-span (function).
make-iterator (function).
offset (function).
parent (function).
right-span (function).
sibling (function).
spans (function).
copy-iterator (function).
depth-n? (function).
iterator (structure).
iterator-sibling (function).
multf (macro).
step-size (function).
Packages are listed by definition order.
flat-treecommon-lisp.
children (function).
counts (function).
depth (function).
full-roots (function).
index (function).
iterator-depth (reader).
(setf iterator-depth) (writer).
iterator-index (reader).
(setf iterator-index) (writer).
iterator-is-left? (function).
iterator-is-right? (function).
iterator-left-child (function).
iterator-left-span (function).
iterator-next (function).
iterator-offset (reader).
(setf iterator-offset) (writer).
iterator-p (function).
iterator-parent (function).
iterator-prev (function).
iterator-right-child (function).
iterator-right-span (function).
iterator-seek (function).
iterator-step-size (reader).
(setf iterator-step-size) (writer).
left-span (function).
make-iterator (function).
offset (function).
parent (function).
right-span (function).
sibling (function).
spans (function).
copy-iterator (function).
depth-n? (function).
iterator (structure).
iterator-sibling (function).
multf (macro).
step-size (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Returns a list (leftChild rightChild) with the indexes of this element’s children. If this element does not have any children it returns NIL.
Returns how many nodes (including parent nodes) a tree contains.
Returns the depth of an index.
Returns a list of all the full roots (subtrees where all nodes have either 2 or 0 children) < index.
For example (full-roots 8) returns (3), since the subtree rooted at 3 spans 0 -> 6 and the tree rooted at 7 has a child located at 9 which is >= 8.
Returns an array index for the tree element at the given depth and offset.
Is the iterator at a left sibling?
Is the iterator at a right sibling?
Move the iterator to its left child. No change if there is no child.
Move the iterator to the current left span index.
Move one step right across the tree, at the current depth.
Move the iterator to its parent.
Move one step left across the tree, at the current depth.
Move the iterator to its right child. No change if there is no child.
Move the iterator to the current right span index.
Move the iterator to a specific index.
Returns the left spanning in index in the tree index spans.
Returns the offset of an index.
Returns the index of the parent element in tree.
Returns the right spanning in index in the tree index spans.
Returns the index of this element’s sibling.
Returns the range (inclusive) that the tree rooted at ’index’ spans. For example (spans 3) would return (0 6).
Returns T if ’index’ is of depth ’depth’.
Move the iterator to its sibling.
Returns the offset step size, given ’depth’.
| Jump to: | (
C D F I L M O P R S |
|---|
| Jump to: | (
C D F I L M O P R S |
|---|
| Jump to: | D I O S |
|---|
| Jump to: | D I O S |
|---|
| Jump to: | F I P S |
|---|
| Jump to: | F I P S |
|---|