The bodge-heap Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The bodge-heap Reference Manual

This is the bodge-heap Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Nov 04 11:40:54 2020 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

BODGE-HEAP

Just a couple of heap implementations: in-place binary and pairing heaps.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 bodge-heap

Author

Pavel Korolev

Contact

dev@borodust.org

License

MIT

Description

Heap implementation

Source

bodge-heap.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 bodge-heap.asd

Location

bodge-heap.asd

Systems

bodge-heap (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 bodge-heap/packages.lisp

Parent

bodge-heap (system)

Location

packages.lisp

Packages

bodge-heap


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 bodge-heap/pairing-heap.lisp

Dependency

packages.lisp (file)

Parent

bodge-heap (system)

Location

pairing-heap.lisp

Exported Definitions
Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

3.1.4 bodge-heap/binary-heap.lisp

Dependency

pairing-heap.lisp (file)

Parent

bodge-heap (system)

Location

binary-heap.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 bodge-heap

Source

packages.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Functions

Function: binary-heap-peek HEAP
Package

bodge-heap

Source

binary-heap.lisp (file)

Function: binary-heap-pop HEAP
Package

bodge-heap

Source

binary-heap.lisp (file)

Function: binary-heap-push HEAP VALUE
Package

bodge-heap

Source

binary-heap.lisp (file)

Function: make-binary-heap &key KEY TEST EXPANSION-FACTOR
Package

bodge-heap

Source

binary-heap.lisp (file)

Function: make-pairing-heap &key KEY
Package

bodge-heap

Source

pairing-heap.lisp (file)

Function: pairing-heap-peek PAIRING-HEAP
Package

bodge-heap

Source

pairing-heap.lisp (file)

Function: pairing-heap-pop HEAP
Package

bodge-heap

Source

pairing-heap.lisp (file)

Function: pairing-heap-push HEAP VALUE
Package

bodge-heap

Source

pairing-heap.lisp (file)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Constants

Constant: +default-expansion-factor+
Package

bodge-heap

Source

binary-heap.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Functions

Function: %leftmost-sibling-p NODE
Package

bodge-heap

Source

pairing-heap.lisp (file)

Function: %make-binary-heap KEY TEST EXPANSION-FACTOR
Package

bodge-heap

Source

binary-heap.lisp (file)

Function: %make-pairing-heap KEY-EXTRACTOR
Package

bodge-heap

Source

pairing-heap.lisp (file)

Package

bodge-heap

Source

pairing-heap.lisp (file)

Function: binary-heap-expansion-factor INSTANCE
Package

bodge-heap

Source

binary-heap.lisp (file)

Function: binary-heap-key INSTANCE
Package

bodge-heap

Source

binary-heap.lisp (file)

Function: binary-heap-p OBJECT
Package

bodge-heap

Source

binary-heap.lisp (file)

Function: binary-heap-queue INSTANCE
Package

bodge-heap

Source

binary-heap.lisp (file)

Function: binary-heap-test INSTANCE
Package

bodge-heap

Source

binary-heap.lisp (file)

Function: copy-binary-heap INSTANCE
Package

bodge-heap

Source

binary-heap.lisp (file)

Function: copy-pairing-heap INSTANCE
Package

bodge-heap

Source

pairing-heap.lisp (file)

Function: copy-pairing-heap-node INSTANCE
Package

bodge-heap

Source

pairing-heap.lisp (file)

Function: make-pairing-heap-node VALUE
Package

bodge-heap

Source

pairing-heap.lisp (file)

Function: pairing-heap-key-extractor INSTANCE
Function: (setf pairing-heap-key-extractor) VALUE INSTANCE
Package

bodge-heap

Source

pairing-heap.lisp (file)

Function: pairing-heap-node-p OBJECT
Package

bodge-heap

Source

pairing-heap.lisp (file)

Function: pairing-heap-p OBJECT
Package

bodge-heap

Source

pairing-heap.lisp (file)

Function: pairing-heap-root INSTANCE
Function: (setf pairing-heap-root) VALUE INSTANCE
Package

bodge-heap

Source

pairing-heap.lisp (file)

Function: phn-child INSTANCE
Function: (setf phn-child) VALUE INSTANCE
Package

bodge-heap

Source

pairing-heap.lisp (file)

Function: phn-left-sibling INSTANCE
Function: (setf phn-left-sibling) VALUE INSTANCE
Package

bodge-heap

Source

pairing-heap.lisp (file)

Function: phn-right-sibling INSTANCE
Function: (setf phn-right-sibling) VALUE INSTANCE
Package

bodge-heap

Source

pairing-heap.lisp (file)

Function: phn-value INSTANCE
Function: (setf phn-value) VALUE INSTANCE
Package

bodge-heap

Source

pairing-heap.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 Structures

Structure: binary-heap ()
Package

bodge-heap

Source

binary-heap.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: queue
Type

array

Initform

(make-array 1 :adjustable t :fill-pointer 0)

Readers

binary-heap-queue (function)

Writers

(setf binary-heap-queue) (function)

Slot: key
Type

function

Initform

(function identity)

Readers

binary-heap-key (function)

Writers

(setf binary-heap-key) (function)

Slot: test
Type

function

Initform

(function bodge-heap::m)

Readers

binary-heap-test (function)

Writers

(setf binary-heap-test) (function)

Slot: expansion-factor
Type

number

Initform

bodge-heap::+default-expansion-factor+

Readers

binary-heap-expansion-factor (function)

Writers

(setf binary-heap-expansion-factor) (function)

Structure: pairing-heap ()
Package

bodge-heap

Source

pairing-heap.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: root
Readers

pairing-heap-root (function)

Writers

(setf pairing-heap-root) (function)

Slot: key-extractor
Readers

pairing-heap-key-extractor (function)

Writers

(setf pairing-heap-key-extractor) (function)

Structure: pairing-heap-node ()
Package

bodge-heap

Source

pairing-heap.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: child
Readers

phn-child (function)

Writers

(setf phn-child) (function)

Slot: left-sibling
Readers

phn-left-sibling (function)

Writers

(setf phn-left-sibling) (function)

Slot: right-sibling
Readers

phn-right-sibling (function)

Writers

(setf phn-right-sibling) (function)

Slot: value
Readers

phn-value (function)

Writers

(setf phn-value) (function)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   B   F   L  
Index Entry  Section

B
bodge-heap.asd: The bodge-heap․asd file
bodge-heap/binary-heap.lisp: The bodge-heap/binary-heap․lisp file
bodge-heap/packages.lisp: The bodge-heap/packages․lisp file
bodge-heap/pairing-heap.lisp: The bodge-heap/pairing-heap․lisp file

F
File, Lisp, bodge-heap.asd: The bodge-heap․asd file
File, Lisp, bodge-heap/binary-heap.lisp: The bodge-heap/binary-heap․lisp file
File, Lisp, bodge-heap/packages.lisp: The bodge-heap/packages․lisp file
File, Lisp, bodge-heap/pairing-heap.lisp: The bodge-heap/pairing-heap․lisp file

L
Lisp File, bodge-heap.asd: The bodge-heap․asd file
Lisp File, bodge-heap/binary-heap.lisp: The bodge-heap/binary-heap․lisp file
Lisp File, bodge-heap/packages.lisp: The bodge-heap/packages․lisp file
Lisp File, bodge-heap/pairing-heap.lisp: The bodge-heap/pairing-heap․lisp file

Jump to:   B   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   %   (  
B   C   F   M   P  
Index Entry  Section

%
%leftmost-sibling-p: Internal functions
%make-binary-heap: Internal functions
%make-pairing-heap: Internal functions
%phn-comparison-link: Internal functions

(
(setf pairing-heap-key-extractor): Internal functions
(setf pairing-heap-root): Internal functions
(setf phn-child): Internal functions
(setf phn-left-sibling): Internal functions
(setf phn-right-sibling): Internal functions
(setf phn-value): Internal functions

B
binary-heap-expansion-factor: Internal functions
binary-heap-key: Internal functions
binary-heap-p: Internal functions
binary-heap-peek: Exported functions
binary-heap-pop: Exported functions
binary-heap-push: Exported functions
binary-heap-queue: Internal functions
binary-heap-test: Internal functions

C
copy-binary-heap: Internal functions
copy-pairing-heap: Internal functions
copy-pairing-heap-node: Internal functions

F
Function, %leftmost-sibling-p: Internal functions
Function, %make-binary-heap: Internal functions
Function, %make-pairing-heap: Internal functions
Function, %phn-comparison-link: Internal functions
Function, (setf pairing-heap-key-extractor): Internal functions
Function, (setf pairing-heap-root): Internal functions
Function, (setf phn-child): Internal functions
Function, (setf phn-left-sibling): Internal functions
Function, (setf phn-right-sibling): Internal functions
Function, (setf phn-value): Internal functions
Function, binary-heap-expansion-factor: Internal functions
Function, binary-heap-key: Internal functions
Function, binary-heap-p: Internal functions
Function, binary-heap-peek: Exported functions
Function, binary-heap-pop: Exported functions
Function, binary-heap-push: Exported functions
Function, binary-heap-queue: Internal functions
Function, binary-heap-test: Internal functions
Function, copy-binary-heap: Internal functions
Function, copy-pairing-heap: Internal functions
Function, copy-pairing-heap-node: Internal functions
Function, make-binary-heap: Exported functions
Function, make-pairing-heap: Exported functions
Function, make-pairing-heap-node: Internal functions
Function, pairing-heap-key-extractor: Internal functions
Function, pairing-heap-node-p: Internal functions
Function, pairing-heap-p: Internal functions
Function, pairing-heap-peek: Exported functions
Function, pairing-heap-pop: Exported functions
Function, pairing-heap-push: Exported functions
Function, pairing-heap-root: Internal functions
Function, phn-child: Internal functions
Function, phn-left-sibling: Internal functions
Function, phn-right-sibling: Internal functions
Function, phn-value: Internal functions

M
make-binary-heap: Exported functions
make-pairing-heap: Exported functions
make-pairing-heap-node: Internal functions

P
pairing-heap-key-extractor: Internal functions
pairing-heap-node-p: Internal functions
pairing-heap-p: Internal functions
pairing-heap-peek: Exported functions
pairing-heap-pop: Exported functions
pairing-heap-push: Exported functions
pairing-heap-root: Internal functions
phn-child: Internal functions
phn-left-sibling: Internal functions
phn-right-sibling: Internal functions
phn-value: Internal functions

Jump to:   %   (  
B   C   F   M   P  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   +  
C   E   K   L   Q   R   S   T   V  
Index Entry  Section

+
+default-expansion-factor+: Internal constants

C
child: Internal structures
Constant, +default-expansion-factor+: Internal constants

E
expansion-factor: Internal structures

K
key: Internal structures
key-extractor: Internal structures

L
left-sibling: Internal structures

Q
queue: Internal structures

R
right-sibling: Internal structures
root: Internal structures

S
Slot, child: Internal structures
Slot, expansion-factor: Internal structures
Slot, key: Internal structures
Slot, key-extractor: Internal structures
Slot, left-sibling: Internal structures
Slot, queue: Internal structures
Slot, right-sibling: Internal structures
Slot, root: Internal structures
Slot, test: Internal structures
Slot, value: Internal structures

T
test: Internal structures

V
value: Internal structures

Jump to:   +  
C   E   K   L   Q   R   S   T   V  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   B   P   S  
Index Entry  Section

B
binary-heap: Internal structures
bodge-heap: The bodge-heap system
bodge-heap: The bodge-heap package

P
Package, bodge-heap: The bodge-heap package
pairing-heap: Internal structures
pairing-heap-node: Internal structures

S
Structure, binary-heap: Internal structures
Structure, pairing-heap: Internal structures
Structure, pairing-heap-node: Internal structures
System, bodge-heap: The bodge-heap system

Jump to:   B   P   S