The bodge-heap Reference Manual

This is the bodge-heap Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Nov 06 11:40:26 2023 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 bodge-heap

Heap implementation

Author

Pavel Korolev

Contact

License

MIT

Source

bodge-heap.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 bodge-heap/bodge-heap.asd

Source

bodge-heap.asd.

Parent Component

bodge-heap (system).

ASDF Systems

bodge-heap.


3.1.2 bodge-heap/packages.lisp

Source

bodge-heap.asd.

Parent Component

bodge-heap (system).

Packages

bodge-heap.


3.1.3 bodge-heap/pairing-heap.lisp

Dependency

packages.lisp (file).

Source

bodge-heap.asd.

Parent Component

bodge-heap (system).

Public Interface
Internals

3.1.4 bodge-heap/binary-heap.lisp

Dependency

pairing-heap.lisp (file).

Source

bodge-heap.asd.

Parent Component

bodge-heap (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 bodge-heap

Source

packages.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: binary-heap-peek (heap)
Package

bodge-heap.

Source

binary-heap.lisp.

Function: binary-heap-pop (heap)
Package

bodge-heap.

Source

binary-heap.lisp.

Function: binary-heap-push (heap value)
Package

bodge-heap.

Source

binary-heap.lisp.

Function: make-binary-heap (&key key test expansion-factor)
Package

bodge-heap.

Source

binary-heap.lisp.

Function: make-pairing-heap (&key key)
Package

bodge-heap.

Source

pairing-heap.lisp.

Function: pairing-heap-peek (pairing-heap)
Package

bodge-heap.

Source

pairing-heap.lisp.

Function: pairing-heap-pop (heap)
Package

bodge-heap.

Source

pairing-heap.lisp.

Function: pairing-heap-push (heap value)
Package

bodge-heap.

Source

pairing-heap.lisp.


5.2 Internals


5.2.1 Constants

Constant: +default-expansion-factor+
Package

bodge-heap.

Source

binary-heap.lisp.


5.2.2 Ordinary functions

Function: %leftmost-sibling-p (node)
Package

bodge-heap.

Source

pairing-heap.lisp.

Function: %make-binary-heap (key test expansion-factor)
Package

bodge-heap.

Source

binary-heap.lisp.

Function: %make-pairing-heap (key-extractor)
Package

bodge-heap.

Source

pairing-heap.lisp.

Package

bodge-heap.

Source

pairing-heap.lisp.

Reader: binary-heap-expansion-factor (instance)
Package

bodge-heap.

Source

binary-heap.lisp.

Target Slot

expansion-factor.

Reader: binary-heap-key (instance)
Package

bodge-heap.

Source

binary-heap.lisp.

Target Slot

key.

Function: binary-heap-p (object)
Package

bodge-heap.

Source

binary-heap.lisp.

Reader: binary-heap-queue (instance)
Package

bodge-heap.

Source

binary-heap.lisp.

Target Slot

queue.

Reader: binary-heap-test (instance)
Package

bodge-heap.

Source

binary-heap.lisp.

Target Slot

test.

Function: copy-binary-heap (instance)
Package

bodge-heap.

Source

binary-heap.lisp.

Function: copy-pairing-heap (instance)
Package

bodge-heap.

Source

pairing-heap.lisp.

Function: copy-pairing-heap-node (instance)
Package

bodge-heap.

Source

pairing-heap.lisp.

Function: make-pairing-heap-node (value)
Package

bodge-heap.

Source

pairing-heap.lisp.

Reader: pairing-heap-key-extractor (instance)
Writer: (setf pairing-heap-key-extractor) (instance)
Package

bodge-heap.

Source

pairing-heap.lisp.

Target Slot

key-extractor.

Function: pairing-heap-node-p (object)
Package

bodge-heap.

Source

pairing-heap.lisp.

Function: pairing-heap-p (object)
Package

bodge-heap.

Source

pairing-heap.lisp.

Reader: pairing-heap-root (instance)
Writer: (setf pairing-heap-root) (instance)
Package

bodge-heap.

Source

pairing-heap.lisp.

Target Slot

root.

Reader: phn-child (instance)
Writer: (setf phn-child) (instance)
Package

bodge-heap.

Source

pairing-heap.lisp.

Target Slot

child.

Reader: phn-left-sibling (instance)
Writer: (setf phn-left-sibling) (instance)
Package

bodge-heap.

Source

pairing-heap.lisp.

Target Slot

left-sibling.

Reader: phn-right-sibling (instance)
Writer: (setf phn-right-sibling) (instance)
Package

bodge-heap.

Source

pairing-heap.lisp.

Target Slot

right-sibling.

Reader: phn-value (instance)
Writer: (setf phn-value) (instance)
Package

bodge-heap.

Source

pairing-heap.lisp.

Target Slot

value.


5.2.3 Structures

Structure: binary-heap
Package

bodge-heap.

Source

binary-heap.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: queue
Type

array

Initform

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

Readers

binary-heap-queue.

Writers

This slot is read-only.

Slot: key
Type

function

Initform

(function identity)

Readers

binary-heap-key.

Writers

This slot is read-only.

Slot: test
Type

function

Initform

(function bodge-heap::m)

Readers

binary-heap-test.

Writers

This slot is read-only.

Slot: expansion-factor
Type

number

Initform

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

Readers

binary-heap-expansion-factor.

Writers

This slot is read-only.

Structure: pairing-heap
Package

bodge-heap.

Source

pairing-heap.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: root
Readers

pairing-heap-root.

Writers

(setf pairing-heap-root).

Slot: key-extractor
Readers

pairing-heap-key-extractor.

Writers

(setf pairing-heap-key-extractor).

Structure: pairing-heap-node
Package

bodge-heap.

Source

pairing-heap.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: child
Readers

phn-child.

Writers

(setf phn-child).

Slot: left-sibling
Readers

phn-left-sibling.

Writers

(setf phn-left-sibling).

Slot: right-sibling
Readers

phn-right-sibling.

Writers

(setf phn-right-sibling).

Slot: value
Readers

phn-value.

Writers

(setf phn-value).


Appendix A Indexes


A.1 Concepts


A.2 Functions

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

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

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

B
binary-heap-expansion-factor: Private ordinary functions
binary-heap-key: Private ordinary functions
binary-heap-p: Private ordinary functions
binary-heap-peek: Public ordinary functions
binary-heap-pop: Public ordinary functions
binary-heap-push: Public ordinary functions
binary-heap-queue: Private ordinary functions
binary-heap-test: Private ordinary functions

C
copy-binary-heap: Private ordinary functions
copy-pairing-heap: Private ordinary functions
copy-pairing-heap-node: Private ordinary functions

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

M
make-binary-heap: Public ordinary functions
make-pairing-heap: Public ordinary functions
make-pairing-heap-node: Private ordinary functions

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