The heap Reference Manual
This is the heap Reference Manual, version 1.0,
generated automatically by Declt version 4.0 beta 2 "William Riker"
on Tue Jul 15 05:15:48 2025 GMT+0.
2 Systems
The main system appears first, followed by any subsystem dependency.
2.1 heap
Binary Heap for Common Lisp.
- Author
Jeffrey Massung
- License
Apache 2.0
- Version
1.0
- Source
heap.asd.
- Child Component
heap.lisp (file).
3 Files
Files are sorted by type and then listed depth-first from the systems
components trees.
3.1 Lisp
3.1.2 heap/heap.lisp
- Source
heap.asd.
- Parent Component
heap (system).
- Packages
heap.
- Public Interface
-
- Internals
-
4 Packages
Packages are listed by definition order.
4.1 heap-asd
- Source
heap.asd.
- Use List
asdf/interface.
common-lisp.
4.2 heap
- Source
heap.lisp.
- Use List
common-lisp.
- Public Interface
-
- Internals
-
5 Definitions
Definitions are sorted by export status, category, package, and then by
lexicographic order.
5.1 Public Interface
5.1.1 Ordinary functions
- Function: heap-contents (heap) ¶
-
Return a copy of the heap items.
- Package
heap.
- Source
heap.lisp.
- Function: heap-flush (heap) ¶
-
Remove all elements from the heap.
- Package
heap.
- Source
heap.lisp.
- Function: heap-peek (heap) ¶
-
Return the next element to be removed from the heap.
- Package
heap.
- Source
heap.lisp.
- Function: heap-pop (heap) ¶
-
Remove the root element from the heap.
- Package
heap.
- Source
heap.lisp.
- Function: heap-push (x heap) ¶
-
Insert a new element onto the heap.
- Package
heap.
- Source
heap.lisp.
- Function: make-heap (test &key key initial-contents) ¶
-
Create a heap with data in it.
- Package
heap.
- Source
heap.lisp.
5.1.2 Standalone methods
- Method: print-object ((h
heap) stream) ¶
-
Output a heap to a stream.
- Source
heap.lisp.
5.2 Internals
5.2.1 Ordinary functions
- Function: %make-heap (test &key key) ¶
-
- Package
heap.
- Source
heap.lisp.
- Function: copy-heap (instance) ¶
-
- Package
heap.
- Source
heap.lisp.
- Reader: heap-compare (instance) ¶
-
- Writer: (setf heap-compare) (instance) ¶
-
- Package
heap.
- Source
heap.lisp.
- Target Slot
compare.
- Reader: heap-elts (instance) ¶
-
- Writer: (setf heap-elts) (instance) ¶
-
- Package
heap.
- Source
heap.lisp.
- Target Slot
elts.
- Function: heap-p (object) ¶
-
- Package
heap.
- Source
heap.lisp.
5.2.2 Structures
- Structure: heap ¶
-
- Package
heap.
- Source
heap.lisp.
- Direct superclasses
structure-object.
- Direct methods
print-object.
- Direct slots
- Slot: compare ¶
-
- Initform
(if (null heap::key) heap::test (lambda (heap::a heap::b) (funcall heap::test (funcall heap::key heap::a) (funcall heap::key heap::b))))
- Readers
heap-compare.
- Writers
(setf heap-compare).
- Slot: elts ¶
-
- Initform
(make-array 0 :adjustable t :fill-pointer t)
- Readers
heap-elts.
- Writers
(setf heap-elts).
Appendix A Indexes
A.2 Functions
| |
|
| % | | |
| %make-heap: | | Private ordinary functions |
|
| ( | | |
| (setf heap-compare): | | Private ordinary functions |
| (setf heap-elts): | | Private ordinary functions |
|
| C | | |
| copy-heap: | | Private ordinary functions |
|
| F | | |
| Function, %make-heap: | | Private ordinary functions |
| Function, (setf heap-compare): | | Private ordinary functions |
| Function, (setf heap-elts): | | Private ordinary functions |
| Function, copy-heap: | | Private ordinary functions |
| Function, heap-compare: | | Private ordinary functions |
| Function, heap-contents: | | Public ordinary functions |
| Function, heap-elts: | | Private ordinary functions |
| Function, heap-flush: | | Public ordinary functions |
| Function, heap-p: | | Private ordinary functions |
| Function, heap-peek: | | Public ordinary functions |
| Function, heap-pop: | | Public ordinary functions |
| Function, heap-push: | | Public ordinary functions |
| Function, make-heap: | | Public ordinary functions |
|
| H | | |
| heap-compare: | | Private ordinary functions |
| heap-contents: | | Public ordinary functions |
| heap-elts: | | Private ordinary functions |
| heap-flush: | | Public ordinary functions |
| heap-p: | | Private ordinary functions |
| heap-peek: | | Public ordinary functions |
| heap-pop: | | Public ordinary functions |
| heap-push: | | Public ordinary functions |
|
| M | | |
| make-heap: | | Public ordinary functions |
| Method, print-object: | | Public standalone methods |
|
| P | | |
| print-object: | | Public standalone methods |
|