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 Mon Jul 15 05:17:25 2024 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 depthfirst 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 heapasd
 Source
heap.asd
.
 Use List
asdf/interface
.
commonlisp
.
4.2 heap
 Source
heap.lisp
.
 Use List
commonlisp
.
 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: heapcontents (heap) ¶

Return a copy of the heap items.
 Package
heap
.
 Source
heap.lisp
.
 Function: heapflush (heap) ¶

Remove all elements from the heap.
 Package
heap
.
 Source
heap.lisp
.
 Function: heappeek (heap) ¶

Return the next element to be removed from the heap.
 Package
heap
.
 Source
heap.lisp
.
 Function: heappop (heap) ¶

Remove the root element from the heap.
 Package
heap
.
 Source
heap.lisp
.
 Function: heappush (x heap) ¶

Insert a new element onto the heap.
 Package
heap
.
 Source
heap.lisp
.
 Function: makeheap (test &key key initialcontents) ¶

Create a heap with data in it.
 Package
heap
.
 Source
heap.lisp
.
5.1.2 Standalone methods
 Method: printobject ((h
heap
) stream) ¶

Output a heap to a stream.
 Source
heap.lisp
.
5.2 Internals
5.2.1 Ordinary functions
 Function: %makeheap (test &key key) ¶

 Package
heap
.
 Source
heap.lisp
.
 Function: copyheap (instance) ¶

 Package
heap
.
 Source
heap.lisp
.
 Reader: heapcompare (instance) ¶

 Writer: (setf heapcompare) (instance) ¶

 Package
heap
.
 Source
heap.lisp
.
 Target Slot
compare
.
 Reader: heapelts (instance) ¶

 Writer: (setf heapelts) (instance) ¶

 Package
heap
.
 Source
heap.lisp
.
 Target Slot
elts
.
 Function: heapp (object) ¶

 Package
heap
.
 Source
heap.lisp
.
5.2.2 Structures
 Structure: heap ¶

 Package
heap
.
 Source
heap.lisp
.
 Direct superclasses
structureobject
.
 Direct methods
printobject
.
 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
heapcompare
.
 Writers
(setf heapcompare)
.
 Slot: elts ¶

 Initform
(makearray 0 :adjustable t :fillpointer t)
 Readers
heapelts
.
 Writers
(setf heapelts)
.
Appendix A Indexes
A.2 Functions
 

%   
 %makeheap :   Private ordinary functions 

(   
 (setf heapcompare) :   Private ordinary functions 
 (setf heapelts) :   Private ordinary functions 

C   
 copyheap :   Private ordinary functions 

F   
 Function, %makeheap :   Private ordinary functions 
 Function, (setf heapcompare) :   Private ordinary functions 
 Function, (setf heapelts) :   Private ordinary functions 
 Function, copyheap :   Private ordinary functions 
 Function, heapcompare :   Private ordinary functions 
 Function, heapcontents :   Public ordinary functions 
 Function, heapelts :   Private ordinary functions 
 Function, heapflush :   Public ordinary functions 
 Function, heapp :   Private ordinary functions 
 Function, heappeek :   Public ordinary functions 
 Function, heappop :   Public ordinary functions 
 Function, heappush :   Public ordinary functions 
 Function, makeheap :   Public ordinary functions 

H   
 heapcompare :   Private ordinary functions 
 heapcontents :   Public ordinary functions 
 heapelts :   Private ordinary functions 
 heapflush :   Public ordinary functions 
 heapp :   Private ordinary functions 
 heappeek :   Public ordinary functions 
 heappop :   Public ordinary functions 
 heappush :   Public ordinary functions 

M   
 makeheap :   Public ordinary functions 
 Method, printobject :   Public standalone methods 

P   
 printobject :   Public standalone methods 
