The funds Reference Manual

Table of Contents

The funds Reference Manual

This is the funds Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Sun May 15 04:47:47 2022 GMT+0.

1 Systems

The main system appears first, followed by any subsystem dependency.

1.1 funds

Source

funds.asd (file)

Components

• package.lisp (file)
• stack.lisp (file)
• trees (module)
• heap (module)
• vector.lisp (file)
• hash.lisp (file)
• hash-set.lisp (file)
• queue.lisp (file)

2 Modules

Modules are listed depth-first from the system components tree.

2.1 funds/trees

Dependency

stack.lisp (file)

Parent

funds (system)

Location

trees/

Components

• classes.lisp (file)
• constructors.lisp (file)
• bt.lisp (file)
• avl.lisp (file)
• stitch-tree.lisp (file)
• tree-as-alist.lisp (file)
• tree-empty-p.lisp (file)
• tree-insert.lisp (file)
• tree-remove.lisp (file)
• tree-find.lisp (file)
• tree-weight.lisp (file)
• tree-height.lisp (file)
• utilities.lisp (file)

2.2 funds/heap

Dependency

trees (module)

Parent

funds (system)

Location

heap/

Components

• heap.lisp (file)
• heap-empty-p.lisp (file)
• heap-insert.lisp (file)
• heap-remove.lisp (file)
• heap-first.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 funds.asd

Location

funds.asd

Systems

funds (system)

3.1.2 funds/package.lisp

Parent

funds (system)

Location

package.lisp

Packages

funds

3.1.3 funds/stack.lisp

Dependency

package.lisp (file)

Parent

funds (system)

Location

stack.lisp

Exported Definitions

• make-stack (function)
• map-stack (function)
• stack-as-list (function)
• stack-count (function)
• stack-count-if (function)
• stack-empty-p (function)
• stack-from-list (function)
• stack-pop (function)
• stack-push (function)
• stack-size (function)
• stack-top (function)

3.1.4 funds/trees/classes.lisp

Parent

trees (module)

Location

trees/classes.lisp

Exported Definitions

• bt-key (method)
• bt-value (method)

Internal Definitions

• avl-height (method)
• avl-leaf (class)
• avl-tree (class)
• binary-tree (class)
• bt-leaf (class)
• bt-left (method)
• bt-right (method)
• leaf (class)
• tree (class)

3.1.5 funds/trees/constructors.lisp

Dependency

classes.lisp (file)

Parent

trees (module)

Location

trees/constructors.lisp

Exported Definitions

• make-avl-tree (function)
• make-binary-tree (function)

Internal Definitions

• +avl-leaf+ (special variable)
• +bt-leaf+ (special variable)
• make-avl-leaf (function)
• make-bt-leaf (function)

3.1.6 funds/trees/bt.lisp

Dependency

constructors.lisp (file)

Parent

trees (module)

Location

trees/bt.lisp

Internal Definitions

• left-p (function)
• next-in-order (function)
• other-side (function)
• side-to-insert (function)
• tree-child (function)

3.1.7 funds/trees/avl.lisp

Dependency

bt.lisp (file)

Parent

trees (module)

Location

trees/avl.lisp

Internal Definitions

• balance (function)
• balanced-p (function)
• heavier-p (function)
• height-difference (function)
• parent-height (function)
• rotate (function)

3.1.8 funds/trees/stitch-tree.lisp

Dependency

avl.lisp (file)

Parent

trees (module)

Location

trees/stitch-tree.lisp

Internal Definitions

• stitch-avl-tree (function)
• stitch-binary-tree (function)
• stitch-tree (method)
• stitch-tree (method)

3.1.9 funds/trees/tree-as-alist.lisp

Dependency

stitch-tree.lisp (file)

Parent

trees (module)

Location

trees/tree-as-alist.lisp

Exported Definitions

• tree-as-alist (generic function)
• tree-as-alist (method)
• tree-as-alist (method)

Internal Definitions

• tree-as-pre-order-alist (method)
• tree-as-pre-order-alist (method)

3.1.10 funds/trees/tree-empty-p.lisp

Dependency

tree-as-alist.lisp (file)

Parent

trees (module)

Location

trees/tree-empty-p.lisp

Exported Definitions

• tree-empty-p (generic function)
• tree-empty-p (method)
• tree-empty-p (method)

3.1.11 funds/trees/tree-insert.lisp

Dependency

tree-empty-p.lisp (file)

Parent

trees (module)

Location

trees/tree-insert.lisp

Exported Definitions

• tree-insert (generic function)
• tree-insert (method)
• tree-insert (method)
• tree-insert (method)

3.1.12 funds/trees/tree-remove.lisp

Dependency

tree-insert.lisp (file)

Parent

trees (module)

Location

trees/tree-remove.lisp

Exported Definitions

• tree-remove (generic function)
• tree-remove (method)
• tree-remove (method)

Internal Definitions

• remove-root (function)
• remove-root-with-children (function)

3.1.13 funds/trees/tree-find.lisp

Dependency

tree-remove.lisp (file)

Parent

trees (module)

Location

trees/tree-find.lisp

Exported Definitions

• tree-find (generic function)
• tree-find (method)
• tree-find (method)

3.1.14 funds/trees/tree-weight.lisp

Dependency

tree-find.lisp (file)

Parent

trees (module)

Location

trees/tree-weight.lisp

Exported Definitions

• tree-weight (generic function)
• tree-weight (method)
• tree-weight (method)

3.1.15 funds/trees/tree-height.lisp

Dependency

tree-weight.lisp (file)

Parent

trees (module)

Location

trees/tree-height.lisp

Exported Definitions

• tree-height (generic function)
• tree-height (method)
• tree-height (method)
• tree-height (method)

3.1.16 funds/trees/utilities.lisp

Dependency

tree-height.lisp (file)

Parent

trees (module)

Location

trees/utilities.lisp

Exported Definitions

• map-tree (function)
• tree-count (function)
• tree-count-if (function)

3.1.17 funds/heap/heap.lisp

Parent

heap (module)

Location

heap/heap.lisp

Exported Definitions

• make-heap (function)
• tree-weight (method)

Internal Definitions

• +heap-leaf+ (special variable)
• attach-heap (function)
• heap (class)
• heap-leaf (class)
• heap-priority (method)
• heap-weight (method)
• make-heap-leaf (function)
• stitch-tree (method)

3.1.18 funds/heap/heap-empty-p.lisp

Dependency

heap.lisp (file)

Parent

heap (module)

Location

heap/heap-empty-p.lisp

Exported Definitions

heap-empty-p (function)

3.1.19 funds/heap/heap-insert.lisp

Dependency

heap-empty-p.lisp (file)

Parent

heap (module)

Location

heap/heap-insert.lisp

Exported Definitions

• heap-insert (generic function)
• heap-insert (method)
• heap-insert (method)

Internal Definitions

• last-direction (function)
• next-direction (function)
• path-direction (function)

3.1.20 funds/heap/heap-remove.lisp

Dependency

heap-insert.lisp (file)

Parent

heap (module)

Location

heap/heap-remove.lisp

Exported Definitions

• heap-remove (generic function)
• heap-remove (method)
• heap-remove (method)

Internal Definitions

• bubble-down (function)
• clip-last (function)
• in-order-p (function)
• last-node (function)
• no-children-p (function)

3.1.21 funds/heap/heap-first.lisp

Dependency

heap-remove.lisp (file)

Parent

heap (module)

Location

heap/heap-first.lisp

Exported Definitions

heap-first (function)

3.1.22 funds/vector.lisp

Dependency

heap (module)

Parent

funds (system)

Location

vector.lisp

Exported Definitions

• make-vector (function)
• map-vector (function)
• vector-as-list (function)
• vector-copy (function)
• vector-count (function)
• vector-count-if (function)
• vector-from-list (function)
• vector-ref (function)
• vector-set (function)
• vector-size (function)

3.1.23 funds/hash.lisp

Dependency

vector.lisp (file)

Parent

funds (system)

Location

hash.lisp

Exported Definitions

• hash-as-alist (function)
• hash-from-alist (function)
• hash-keys (function)
• hash-ref (function)
• hash-remove (function)
• hash-set (function)
• hash-size (function)
• make-hash (function)
• map-hash (function)

Internal Definitions

• copy-dict (function)
• dict (structure)
• dict-hash (function)
• (setf dict-hash) (function)
• dict-p (function)
• dict-test (function)
• (setf dict-test) (function)
• dict-tree (function)
• (setf dict-tree) (function)
• hash-values (function)
• make-dict (function)

3.1.24 funds/hash-set.lisp

Dependency

hash.lisp (file)

Parent

funds (system)

Location

hash-set.lisp

Exported Definitions

• hash-as-list (function)
• hash-difference (function)
• hash-from-list (function)
• hash-intersection (function)
• hash-union (function)

3.1.25 funds/queue.lisp

Dependency

hash-set.lisp (file)

Parent

funds (system)

Location

queue.lisp

Exported Definitions

• dequeue (function)
• enqueue (function)
• make-queue (function)
• map-queue (function)
• queue-as-list (function)
• queue-count (function)
• queue-count-if (function)
• queue-empty-p (function)
• queue-first (function)
• queue-size (function)

Internal Definitions

• queue (class)
• queue-heap (method)
• queue-next-priority (method)

4 Packages

Packages are listed by definition order.

4.1 funds

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• bt-key (generic function)
• bt-key (method)
• bt-value (generic function)
• bt-value (method)
• dequeue (function)
• enqueue (function)
• hash-as-alist (function)
• hash-as-list (function)
• hash-difference (function)
• hash-from-alist (function)
• hash-from-list (function)
• hash-intersection (function)
• hash-keys (function)
• hash-ref (function)
• hash-remove (function)
• hash-set (function)
• hash-size (function)
• hash-union (function)
• heap-empty-p (function)
• heap-first (function)
• heap-insert (generic function)
• heap-insert (method)
• heap-insert (method)
• heap-remove (generic function)
• heap-remove (method)
• heap-remove (method)
• make-avl-tree (function)
• make-binary-tree (function)
• make-hash (function)
• make-heap (function)
• make-queue (function)
• make-stack (function)
• make-vector (function)
• map-hash (function)
• map-queue (function)
• map-stack (function)
• map-tree (function)
• map-vector (function)
• queue-as-list (function)
• queue-count (function)
• queue-count-if (function)
• queue-empty-p (function)
• queue-first (function)
• queue-size (function)
• stack-as-list (function)
• stack-count (function)
• stack-count-if (function)
• stack-empty-p (function)
• stack-from-list (function)
• stack-pop (function)
• stack-push (function)
• stack-size (function)
• stack-top (function)
• tree-as-alist (generic function)
• tree-as-alist (method)
• tree-as-alist (method)
• tree-count (function)
• tree-count-if (function)
• tree-empty-p (generic function)
• tree-empty-p (method)
• tree-empty-p (method)
• tree-find (generic function)
• tree-find (method)
• tree-find (method)
• tree-height (generic function)
• tree-height (method)
• tree-height (method)
• tree-height (method)
• tree-insert (generic function)
• tree-insert (method)
• tree-insert (method)
• tree-insert (method)
• tree-remove (generic function)
• tree-remove (method)
• tree-remove (method)
• tree-weight (generic function)
• tree-weight (method)
• tree-weight (method)
• tree-weight (method)
• vector-as-list (function)
• vector-copy (function)
• vector-count (function)
• vector-count-if (function)
• vector-from-list (function)
• vector-ref (function)
• vector-set (function)
• vector-size (function)

Internal Definitions

• +avl-leaf+ (special variable)
• +bt-leaf+ (special variable)
• +heap-leaf+ (special variable)
• attach-heap (function)
• avl-height (generic function)
• avl-height (method)
• avl-leaf (class)
• avl-tree (class)
• balance (function)
• balanced-p (function)
• binary-tree (class)
• bt-leaf (class)
• bt-left (generic function)
• bt-left (method)
• bt-right (generic function)
• bt-right (method)
• bubble-down (function)
• clip-last (function)
• copy-dict (function)
• dict (structure)
• dict-hash (function)
• (setf dict-hash) (function)
• dict-p (function)
• dict-test (function)
• (setf dict-test) (function)
• dict-tree (function)
• (setf dict-tree) (function)
• hash-values (function)
• heap (class)
• heap-leaf (class)
• heap-priority (generic function)
• heap-priority (method)
• heap-weight (generic function)
• heap-weight (method)
• heavier-p (function)
• height-difference (function)
• in-order-p (function)
• last-direction (function)
• last-node (function)
• leaf (class)
• left-p (function)
• make-avl-leaf (function)
• make-bt-leaf (function)
• make-dict (function)
• make-heap-leaf (function)
• next-direction (function)
• next-in-order (function)
• no-children-p (function)
• other-side (function)
• parent-height (function)
• path-direction (function)
• queue (class)
• queue-heap (generic function)
• queue-heap (method)
• queue-next-priority (generic function)
• queue-next-priority (method)
• remove-root (function)
• remove-root-with-children (function)
• rotate (function)
• side-to-insert (function)
• stitch-avl-tree (function)
• stitch-binary-tree (function)
• stitch-tree (generic function)
• stitch-tree (method)
• stitch-tree (method)
• stitch-tree (method)
• tree (class)
• tree-as-pre-order-alist (generic function)
• tree-as-pre-order-alist (method)
• tree-as-pre-order-alist (method)
• tree-child (function)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Functions

Function: dequeue Q

The queue that results when the first item is removed from the given queue.

Package

funds

Source

queue.lisp (file)

Function: enqueue Q ITEM

The queue that results when the given item is equeued on the given queue.

Package

funds

Source

queue.lisp (file)

Function: hash-as-alist HASH

An alist containing the same key-value pairs as the given hash.

Package

funds

Source

hash.lisp (file)

Function: hash-as-list HASH

Package

funds

Source

hash-set.lisp (file)

Function: hash-difference HASH &rest HASHES

Elements of the first hash that are not in hashes.

Package

funds

Source

hash-set.lisp (file)

Function: hash-from-alist ALIST &key TEST HASH

Package

funds

Source

hash.lisp (file)

Function: hash-from-list LIST &key TEST HASH

Package

funds

Source

hash-set.lisp (file)

Function: hash-intersection &rest HASHES

Elements that all hashes share.

Package

funds

Source

hash-set.lisp (file)

Function: hash-keys HASH

Package

funds

Source

hash.lisp (file)

Function: hash-ref HASH KEY &optional DEFAULT

The value associated with the given key in the given hash. A second value is returned to indicate whether the key is associated with any value or is not found.

Package

funds

Source

hash.lisp (file)

Function: hash-remove HASH KEY

A hash similar to the given hash, except that key does not map to any value in the returned hash.

Package

funds

Source

hash.lisp (file)

Function: hash-set HASH KEY &optional VALUE

A hash similar to the given hash except that key maps to value in the returned hash.

Package

funds

Source

hash.lisp (file)

Function: hash-size HASH

Package

funds

Source

hash.lisp (file)

Function: hash-union &rest HASHES

Elements of all hashes combine into one hash.

Package

funds

Source

hash-set.lisp (file)

Function: heap-empty-p HEAP

Whether the given heap has any elements.

Package

funds

Source

heap-empty-p.lisp (file)

Function: heap-first HEAP

The first value on the given heap.

Package

funds

Source

heap-first.lisp (file)

Function: make-avl-tree ()

An empty AVL tree.

Package

funds

Source

constructors.lisp (file)

Function: make-binary-tree ()

An empty binary tree.

Package

funds

Source

constructors.lisp (file)

Function: make-hash &key HASH TEST

An empty hash that hashes occording to the given hash function, which defaults to #’sxhash and and tests according to the given test function, which defaults to #’eql.

Package

funds

Source

hash.lisp (file)

Function: make-heap &key PRIORITY VALUE LEFT RIGHT

An empty binary heap.

Package

funds

Source

heap.lisp (file)

Function: make-queue &key INITIAL-CONTENTS

Package

funds

Source

queue.lisp (file)

Function: make-stack ()

An empty stack.

Package

funds

Source

stack.lisp (file)

Function: make-vector SIZE &key INITIAL-CONTENTS INITIAL-ELEMENT

A functional vector of the given size with the given initial contents.

Package

funds

Source

vector.lisp (file)

Function: map-hash FUNCTION HASH

A new hash where function has been applied to each key-value and the result of the each function call is the new value.

Package

funds

Source

hash.lisp (file)

Function: map-queue FUNCTION Q

A queue containing items that are the result of applying function to the items in the given queue.

Package

funds

Source

queue.lisp (file)

Function: map-stack FUNCTION STACK

A stack whose elements are those of the given stack when function is applied to them.

Package

funds

Source

stack.lisp (file)

Function: map-tree FUNCTION TREE

A tree each node of which corresponds to the application of function to one node of the given tree.

Package

funds

Source

utilities.lisp (file)

Function: map-vector FUNCTION VECTOR

A new vector whose elements are the results of the application of the given function to the elements of the given vector.

Package

funds

Source

vector.lisp (file)

Function: queue-as-list Q

The elements in the given queue, returned as a list, in the order they would be dequeued from the given queue.

Package

funds

Source

queue.lisp (file)

Function: queue-count ITEM Q &key KEY TEST

The number of elements in the given queue that satisfy the test.

Package

funds

Source

queue.lisp (file)

Function: queue-count-if PREDICATE Q &key KEY

The number of elements in the given queue that satisfy the test.

Package

funds

Source

queue.lisp (file)

Function: queue-empty-p Q

Whether the given queue does not contain any items.

Package

funds

Source

queue.lisp (file)

Function: queue-first Q

The value at the head of the given queue.

Package

funds

Source

queue.lisp (file)

Function: queue-size Q

The number of items in the given queue.

Package

funds

Source

queue.lisp (file)

Function: stack-as-list STACK

This function is here in case the implementation of stack changes from what it is now, a list.

Package

funds

Source

stack.lisp (file)

Function: stack-count ITEM STACK &key KEY TEST

Package

funds

Source

stack.lisp (file)

Function: stack-count-if PREDICATE STACK &key KEY

Package

funds

Source

stack.lisp (file)

Function: stack-empty-p STACK

Whether the given stack is empty.

Package

funds

Source

stack.lisp (file)

Function: stack-from-list LIST

This function is here in case the implementation of stack changes from what it is now, a list.

Package

funds

Source

stack.lisp (file)

Function: stack-pop STACK

The stack that results when the top item is popped off the given stack.

Package

funds

Source

stack.lisp (file)

Function: stack-push STACK ITEM

The stack that results when the given item is pushed onto the given stack.

Package

funds

Source

stack.lisp (file)

Function: stack-size STACK

The number of items on this stack; note that this is an O(n) operation.

Package

funds

Source

stack.lisp (file)

Function: stack-top STACK

The top item on the given stack.

Package

funds

Source

stack.lisp (file)

Function: tree-count ITEM TREE &key KEY TEST

The number of sub-trees in the tree that satisfy the test.

Package

funds

Source

utilities.lisp (file)

Function: tree-count-if PREDICATE TREE &key KEY

The number of sub-trees in the given tree that satisfy the test.

Package

funds

Source

utilities.lisp (file)

Function: vector-as-list VECTOR

Package

funds

Source

vector.lisp (file)

Function: vector-copy VECTOR &optional START END

Package

funds

Source

vector.lisp (file)

Function: vector-count ITEM VECTOR &key KEY TEST

The number of elements in the given vector that satisfy the test.

Package

funds

Source

vector.lisp (file)

Function: vector-count-if PRED VECTOR &key KEY

The number of elements in the given vector that satisfy the test.

Package

funds

Source

vector.lisp (file)

Function: vector-from-list LIST

Package

funds

Source

vector.lisp (file)

Function: vector-ref VECTOR INDEX

The element at the given index of the given vector.

Package

funds

Source

vector.lisp (file)

Function: vector-set VECTOR INDEX ELEMENT

An vector similar to the given vector except that index and element are associated in the returned vector.

Package

funds

Source

vector.lisp (file)

Function: vector-size VECTOR

The number of elements in the given vector.

Package

funds

Source

vector.lisp (file)

5.1.2 Generic functions

Generic Function: bt-key OBJECT

Package

funds

Methods

Method: bt-key (BINARY-TREE binary-tree)

automatically generated reader method

Source

classes.lisp (file)

Generic Function: bt-value OBJECT

Package

funds

Methods

Method: bt-value (BINARY-TREE binary-tree)

automatically generated reader method

Source

classes.lisp (file)

Generic Function: heap-insert HEAP VALUE PRIORITY &key ORDER

Package

funds

Source

heap-insert.lisp (file)

Methods

Method: heap-insert HEAP VALUE PRIORITY &key ORDER

A new heap, similar to the given heap, except that the priority-value pair is inserted into the retured heap according to the standard heap insertion algorithm.

Method: heap-insert (HEAP heap-leaf) VALUE PRIORITY &key ORDER

Generic Function: heap-remove HEAP &key ORDER

The heap that results when first value is removed from the given heap.

Package

funds

Source

heap-remove.lisp (file)

Methods

Method: heap-remove HEAP &key ORDER

Method: heap-remove (HEAP heap-leaf) &key ORDER

Generic Function: tree-as-alist TREE

An association list containing the key-value pairs in the given tree.

Package

funds

Source

tree-as-alist.lisp (file)

Methods

Method: tree-as-alist (TREE binary-tree)

Method: tree-as-alist (TREE leaf)

Generic Function: tree-empty-p TREE

Whether the given tree does not contain key-value pairs.

Package

funds

Source

tree-empty-p.lisp (file)

Methods

Method: tree-empty-p (TREE leaf)

Method: tree-empty-p TREE

Generic Function: tree-find TREE KEY &key TEST ORDER

The value to which the given key is mapped, or nil if this tree contains no such key. The second value returned indicates whether the tree contained the key. So

(find t k) -> nil t

if k maps to nil. But

(find t k) -> nil nil
if there is no mapping for k in the tree.

Package

funds

Source

tree-find.lisp (file)

Methods

Method: tree-find TREE KEY &key TEST ORDER

Method: tree-find (TREE leaf) KEY &key TEST ORDER

Generic Function: tree-height TREE

The height of the given tree.

Package

funds

Source

tree-height.lisp (file)

Methods

Method: tree-height (TREE avl-tree)

Method: tree-height (TREE binary-tree)

Method: tree-height (TREE leaf)

Generic Function: tree-insert TREE KEY VALUE &key TEST ORDER

A new tree similar to the given tree except that the given key and
value are now associated with one another. If the given key is already contained in the tree, according to the test function, then the old value is replaced by the specified value in the returned tree. The order function specifies whether the given key-value pair should be inserted to the left or right of the given tree. The given tree is not modified.

Package

funds

Source

tree-insert.lisp (file)

Methods

Method: tree-insert TREE KEY VALUE &key TEST ORDER

Method: tree-insert (TREE avl-leaf) KEY VALUE &key TEST ORDER

Method: tree-insert (TREE bt-leaf) KEY VALUE &key TEST ORDER

Generic Function: tree-remove TREE KEY &key TEST ORDER

A new tree with the given key removed. The test function is used to compare the tree’s key to the given key. The order function is used to determine whether the key can be found to the left or right if it is not found at the root.

Package

funds

Source

tree-remove.lisp (file)

Methods

Method: tree-remove (TREE binary-tree) KEY &key TEST ORDER

Method: tree-remove (TREE leaf) KEY &key TEST ORDER

Generic Function: tree-weight TREE

The number of nodes in the given tree.

Package

funds

Source

tree-weight.lisp (file)

Methods

Method: tree-weight (TREE heap)

Source

heap.lisp (file)

Method: tree-weight (TREE binary-tree)

Method: tree-weight (TREE leaf)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: +avl-leaf+

Package

funds

Source

constructors.lisp (file)

Special Variable: +bt-leaf+

Package

funds

Source

constructors.lisp (file)

Special Variable: +heap-leaf+

Package

funds

Source

heap.lisp (file)

5.2.2 Functions

Function: attach-heap ROOT &key LEFT RIGHT

Package

funds

Source

heap.lisp (file)

Function: balance KEY VALUE LEFT RIGHT

Package

funds

Source

avl.lisp (file)

Function: balanced-p T1 T2

Package

funds

Source

avl.lisp (file)

Function: bubble-down ROOT &key LEFT RIGHT ORDER

Package

funds

Source

heap-remove.lisp (file)

Function: clip-last HEAP

The heap that results when the last node is removed.

Package

funds

Source

heap-remove.lisp (file)

Function: copy-dict INSTANCE

Package

funds

Source

hash.lisp (file)

Function: dict-hash INSTANCE

Function: (setf dict-hash) VALUE INSTANCE

Package

funds

Source

hash.lisp (file)

Function: dict-p OBJECT

Package

funds

Source

hash.lisp (file)

Function: dict-test INSTANCE

Function: (setf dict-test) VALUE INSTANCE

Package

funds

Source

hash.lisp (file)

Function: dict-tree INSTANCE

Function: (setf dict-tree) VALUE INSTANCE

Package

funds

Source

hash.lisp (file)

Function: hash-values HASH

Package

funds

Source

hash.lisp (file)

Function: heavier-p TREE &key SIDE

Package

funds

Source

avl.lisp (file)

Function: height-difference T1 T2

Package

funds

Source

avl.lisp (file)

Function: in-order-p H1 H2 &key ORDER

Package

funds

Source

heap-remove.lisp (file)

Function: last-direction HEAP

Package

funds

Source

heap-insert.lisp (file)

Function: last-node HEAP

Package

funds

Source

heap-remove.lisp (file)

Function: left-p SIDE

Package

funds

Source

bt.lisp (file)

Function: make-avl-leaf ()

Package

funds

Source

constructors.lisp (file)

Function: make-bt-leaf ()

Package

funds

Source

constructors.lisp (file)

Function: make-dict &key (HASH HASH) (TEST TEST) (TREE TREE)

Package

funds

Source

hash.lisp (file)

Function: make-heap-leaf ()

Package

funds

Source

heap.lisp (file)

Function: next-direction HEAP

Package

funds

Source

heap-insert.lisp (file)

Function: next-in-order TREE

Package

funds

Source

bt.lisp (file)

Function: no-children-p HEAP

Package

funds

Source

heap-remove.lisp (file)

Function: other-side SIDE

Package

funds

Source

bt.lisp (file)

Function: parent-height T1 T2

Package

funds

Source

avl.lisp (file)

Function: path-direction N

Package

funds

Source

heap-insert.lisp (file)

Function: remove-root TREE &key TEST ORDER

Package

funds

Source

tree-remove.lisp (file)

Function: remove-root-with-children TREE &key TEST ORDER

Package

funds

Source

tree-remove.lisp (file)

Function: rotate INSIDE ROOT-KEY ROOT-VALUE OUTSIDE &key SIDE

Package

funds

Source

avl.lisp (file)

Function: side-to-insert TREE KEY &key ORDER

Package

funds

Source

bt.lisp (file)

Function: stitch-avl-tree &key ROOT KEY VALUE LEFT RIGHT

Package

funds

Source

stitch-tree.lisp (file)

Function: stitch-binary-tree &key ROOT KEY VALUE LEFT RIGHT

Package

funds

Source

stitch-tree.lisp (file)

Function: tree-child TREE &key SIDE

Package

funds

Source

bt.lisp (file)

5.2.3 Generic functions

Generic Function: avl-height OBJECT

Package

funds

Methods

Method: avl-height (AVL-TREE avl-tree)

automatically generated reader method

Source

classes.lisp (file)

Generic Function: bt-left OBJECT

Package

funds

Methods

Method: bt-left (BINARY-TREE binary-tree)

automatically generated reader method

Source

classes.lisp (file)

Generic Function: bt-right OBJECT

Package

funds

Methods

Method: bt-right (BINARY-TREE binary-tree)

automatically generated reader method

Source

classes.lisp (file)

Generic Function: heap-priority OBJECT

Package

funds

Methods

Method: heap-priority (HEAP heap)

automatically generated reader method

Source

heap.lisp (file)

Generic Function: heap-weight OBJECT

Package

funds

Methods

Method: heap-weight (HEAP heap)

automatically generated reader method

Source

heap.lisp (file)

Generic Function: queue-heap OBJECT

Package

funds

Methods

Method: queue-heap (QUEUE queue)

automatically generated reader method

Source

queue.lisp (file)

Generic Function: queue-next-priority OBJECT

Package

funds

Methods

Method: queue-next-priority (QUEUE queue)

automatically generated reader method

Source

queue.lisp (file)

Generic Function: stitch-tree TREE &key KEY VALUE LEFT RIGHT

Package

funds

Methods

Method: stitch-tree (TREE heap) &key KEY VALUE LEFT RIGHT

Source

heap.lisp (file)

Method: stitch-tree (TREE avl-tree) &key KEY VALUE LEFT RIGHT

Source

stitch-tree.lisp (file)

Method: stitch-tree (TREE binary-tree) &key KEY VALUE LEFT RIGHT

Source

stitch-tree.lisp (file)

Generic Function: tree-as-pre-order-alist TREE

Package

funds

Methods

Method: tree-as-pre-order-alist (TREE binary-tree)

Source

tree-as-alist.lisp (file)

Method: tree-as-pre-order-alist (TREE leaf)

Source

tree-as-alist.lisp (file)

5.2.4 Structures

Structure: dict ()

Package

funds

Source

hash.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: hash

Readers

dict-hash (function)

Writers

(setf dict-hash) (function)

Slot: test

Readers

dict-test (function)

Writers

(setf dict-test) (function)

Slot: tree

Readers

dict-tree (function)

Writers

(setf dict-tree) (function)

5.2.5 Classes

Class: avl-leaf ()

A leaf node of an AVL tree.

Package

funds

Source

classes.lisp (file)

Direct superclasses

leaf (class)

Direct methods

tree-insert (method)

Class: avl-tree ()

A height-balanced binary tree.

Package

funds

Source

classes.lisp (file)

Direct superclasses

binary-tree (class)

Direct methods

• tree-height (method)
• stitch-tree (method)
• avl-height (method)

Direct slots

Slot: height

Initargs

:height

Readers

avl-height (generic function)

Slot: left

Initform

(funds:make-avl-tree)

Slot: right

Initform

(funds:make-avl-tree)

Class: binary-tree ()

A binary tree that holds a key-value pair in its root.

Package

funds

Source

classes.lisp (file)

Direct superclasses

tree (class)

Direct subclasses

• avl-tree (class)
• heap (class)

Direct methods

• tree-height (method)
• tree-weight (method)
• tree-remove (method)
• tree-as-pre-order-alist (method)
• tree-as-alist (method)
• stitch-tree (method)
• bt-right (method)
• bt-left (method)
• bt-value (method)
• bt-key (method)

Direct slots

Slot: key

Initargs

:key

Readers

bt-key (generic function)

Slot: value

Initargs

:value

Readers

bt-value (generic function)

Slot: left

Initargs

:left

Initform

(funds:make-binary-tree)

Readers

bt-left (generic function)

Slot: right

Initargs

:right

Initform

(funds:make-binary-tree)

Readers

bt-right (generic function)

Class: bt-leaf ()

A leaf node of an AVL tree.

Package

funds

Source

classes.lisp (file)

Direct superclasses

leaf (class)

Direct methods

tree-insert (method)

Class: heap ()

Package

funds

Source

heap.lisp (file)

Direct superclasses

binary-tree (class)

Direct methods

• stitch-tree (method)
• tree-weight (method)
• heap-weight (method)
• heap-priority (method)

Direct slots

Slot: key

Initargs

:priority

Readers

heap-priority (generic function)

Slot: left

Initform

(funds:make-heap)

Slot: right

Initform

(funds:make-heap)

Slot: weight

Initargs

:weight

Initform

1

Readers

heap-weight (generic function)

Class: heap-leaf ()

A leaf node of a heap.

Package

funds

Source

heap.lisp (file)

Direct superclasses

leaf (class)

Direct methods

• heap-remove (method)
• heap-insert (method)

Class: leaf ()

A leaf with no data or children.

Package

funds

Source

classes.lisp (file)

Direct superclasses

tree (class)

Direct subclasses

• avl-leaf (class)
• bt-leaf (class)
• heap-leaf (class)

Direct methods

• tree-height (method)
• tree-weight (method)
• tree-find (method)
• tree-remove (method)
• tree-empty-p (method)
• tree-as-pre-order-alist (method)
• tree-as-alist (method)

Class: queue ()

Package

funds

Source

queue.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• queue-heap (method)
• queue-next-priority (method)

Direct slots

Slot: next-priority

Initargs

:next-priority

Initform

0

Readers

queue-next-priority (generic function)

Slot: heap

Initargs

:heap

Initform

(funds:make-heap)

Readers

queue-heap (generic function)

Class: tree ()

The foundation of all trees.

Package

funds

Source

classes.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

• leaf (class)
• binary-tree (class)

Appendix A Indexes

A.1 Concepts

A.2 Functions