The priority-queue Reference Manual

Table of Contents

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

The priority-queue Reference Manual

This is the priority-queue Reference Manual, version 0.1, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 04:26:21 2018 GMT+0.


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

1 Introduction

PRIORITY-QUEUE -- a priority queue for Common Lisp

The implementation uses an array-based heap.

Licence:

 Copyright (c) 2012 David Sorokin 

 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation files
 (the "Software"), to deal in the Software without restriction,
 including without limitation the rights to use, copy, modify, merge,
 publish, distribute, sublicense, and/or sell copies of the Software,
 and to permit persons to whom the Software is furnished to do so,
 subject to the following conditions:

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


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 priority-queue

Author

David Sorokin

License

MIT

Description

A priority queue for Common Lisp.

Version

0.1

Source

priority-queue.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.


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

3.1 Lisp


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

3.1.1 priority-queue.asd

Location

priority-queue.asd

Systems

priority-queue (system)


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

3.1.2 priority-queue/priority-queue.lisp

Parent

priority-queue (system)

Location

priority-queue.lisp

Packages

priority-queue

Exported Definitions
Internal Definitions

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

3.2 Other


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

3.2.1 priority-queue/README

Parent

priority-queue (system)

Location

README


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

4 Packages

Packages are listed by definition order.


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

4.1 priority-queue

Source

priority-queue.lisp (file)

Nickname

pqueue

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: make-pqueue PREDICATE &key KEY-TYPE VALUE-TYPE

Make a priority queue with the specfied types for keys and values.

Package

priority-queue

Source

priority-queue.lisp (file)

Function: pqueue-clear PQUEUE

Clear the piority queue.

Package

priority-queue

Source

priority-queue.lisp (file)

Function: pqueue-empty-p PQUEUE

Test whether the priority queue is empty.

Package

priority-queue

Source

priority-queue.lisp (file)

Function: pqueue-front PQUEUE

Take an element with the minimal priority key and return a multiple value: the element value, its key.

Package

priority-queue

Source

priority-queue.lisp (file)

Function: pqueue-front-key PQUEUE

Return the minimal priority key.

Package

priority-queue

Source

priority-queue.lisp (file)

Function: pqueue-front-value PQUEUE

Return the value with the minimal priority key.

Package

priority-queue

Source

priority-queue.lisp (file)

Function: pqueue-length INSTANCE
Function: (setf pqueue-length) VALUE INSTANCE
Package

priority-queue

Source

priority-queue.lisp (file)

Function: pqueue-p OBJECT
Package

priority-queue

Source

priority-queue.lisp (file)

Function: pqueue-pop PQUEUE

Dequeue the element with the minimal priority key and return a multiple value: the element value, its key.

Package

priority-queue

Source

priority-queue.lisp (file)

Function: pqueue-push VALUE KEY PQUEUE

Enqueue a new value with the specified priority key and return the queue.

Package

priority-queue

Source

priority-queue.lisp (file)


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

5.2 Internal definitions


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

5.2.1 Functions

Function: %make-pqueue &key (LENGTH LENGTH) (PREDICATE PREDICATE) (KEYS KEYS) (VALUES VALUES) (KEY-TYPE KEY-TYPE) (VALUE-TYPE VALUE-TYPE)
Package

priority-queue

Source

priority-queue.lisp (file)

Function: copy-pqueue INSTANCE
Package

priority-queue

Source

priority-queue.lisp (file)

Function: increase PQUEUE CAPACITY

Increase the capacity of the priority queue.

Package

priority-queue

Source

priority-queue.lisp (file)

Function: pqueue-key-type INSTANCE
Function: (setf pqueue-key-type) VALUE INSTANCE
Package

priority-queue

Source

priority-queue.lisp (file)

Function: pqueue-keys INSTANCE
Function: (setf pqueue-keys) VALUE INSTANCE
Package

priority-queue

Source

priority-queue.lisp (file)

Function: pqueue-predicate INSTANCE
Function: (setf pqueue-predicate) VALUE INSTANCE
Package

priority-queue

Source

priority-queue.lisp (file)

Function: pqueue-value-type INSTANCE
Function: (setf pqueue-value-type) VALUE INSTANCE
Package

priority-queue

Source

priority-queue.lisp (file)

Function: pqueue-values INSTANCE
Function: (setf pqueue-values) VALUE INSTANCE
Package

priority-queue

Source

priority-queue.lisp (file)

Function: print-pqueue PQUEUE STREAM DEPTH

Print the priority queue.

Package

priority-queue

Source

priority-queue.lisp (file)

Function: sift-down INDEX LENGTH PREDICATE KEYS VALUES KEY VALUE

Sift down the key and value starting at the specified index.

Package

priority-queue

Source

priority-queue.lisp (file)

Function: sift-up INDEX PREDICATE KEYS VALUES KEY VALUE

Sift up the key and value starting at the specified index.

Package

priority-queue

Source

priority-queue.lisp (file)


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

5.2.2 Structures

Structure: pqueue ()
Package

priority-queue

Source

priority-queue.lisp (file)

Direct superclasses

structure-object (structure)

Direct methods

print-object (method)

Direct slots
Slot: length
Readers

pqueue-length (function)

Writers

(setf pqueue-length) (function)

Slot: predicate
Readers

pqueue-predicate (function)

Writers

(setf pqueue-predicate) (function)

Slot: keys
Readers

pqueue-keys (function)

Writers

(setf pqueue-keys) (function)

Slot: values
Readers

pqueue-values (function)

Writers

(setf pqueue-values) (function)

Slot: key-type
Readers

pqueue-key-type (function)

Writers

(setf pqueue-key-type) (function)

Slot: value-type
Readers

pqueue-value-type (function)

Writers

(setf pqueue-value-type) (function)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   O   P  
Index Entry  Section

F
File, Lisp, priority-queue.asd: The priority-queue<dot>asd file
File, Lisp, priority-queue/priority-queue.lisp: The priority-queue/priority-queue<dot>lisp file
File, other, priority-queue/README: The priority-queue/readme file

L
Lisp File, priority-queue.asd: The priority-queue<dot>asd file
Lisp File, priority-queue/priority-queue.lisp: The priority-queue/priority-queue<dot>lisp file

O
Other File, priority-queue/README: The priority-queue/readme file

P
priority-queue.asd: The priority-queue<dot>asd file
priority-queue/priority-queue.lisp: The priority-queue/priority-queue<dot>lisp file
priority-queue/README: The priority-queue/readme file

Jump to:   F   L   O   P  

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

A.2 Functions

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

%
%make-pqueue: Internal functions

(
(setf pqueue-key-type): Internal functions
(setf pqueue-keys): Internal functions
(setf pqueue-length): Exported functions
(setf pqueue-predicate): Internal functions
(setf pqueue-value-type): Internal functions
(setf pqueue-values): Internal functions

C
copy-pqueue: Internal functions

F
Function, %make-pqueue: Internal functions
Function, (setf pqueue-key-type): Internal functions
Function, (setf pqueue-keys): Internal functions
Function, (setf pqueue-length): Exported functions
Function, (setf pqueue-predicate): Internal functions
Function, (setf pqueue-value-type): Internal functions
Function, (setf pqueue-values): Internal functions
Function, copy-pqueue: Internal functions
Function, increase: Internal functions
Function, make-pqueue: Exported functions
Function, pqueue-clear: Exported functions
Function, pqueue-empty-p: Exported functions
Function, pqueue-front: Exported functions
Function, pqueue-front-key: Exported functions
Function, pqueue-front-value: Exported functions
Function, pqueue-key-type: Internal functions
Function, pqueue-keys: Internal functions
Function, pqueue-length: Exported functions
Function, pqueue-p: Exported functions
Function, pqueue-pop: Exported functions
Function, pqueue-predicate: Internal functions
Function, pqueue-push: Exported functions
Function, pqueue-value-type: Internal functions
Function, pqueue-values: Internal functions
Function, print-pqueue: Internal functions
Function, sift-down: Internal functions
Function, sift-up: Internal functions

I
increase: Internal functions

M
make-pqueue: Exported functions

P
pqueue-clear: Exported functions
pqueue-empty-p: Exported functions
pqueue-front: Exported functions
pqueue-front-key: Exported functions
pqueue-front-value: Exported functions
pqueue-key-type: Internal functions
pqueue-keys: Internal functions
pqueue-length: Exported functions
pqueue-p: Exported functions
pqueue-pop: Exported functions
pqueue-predicate: Internal functions
pqueue-push: Exported functions
pqueue-value-type: Internal functions
pqueue-values: Internal functions
print-pqueue: Internal functions

S
sift-down: Internal functions
sift-up: Internal functions

Jump to:   %   (  
C   F   I   M   P   S  

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

A.3 Variables

Jump to:   K   L   P   S   V  
Index Entry  Section

K
key-type: Internal structures
keys: Internal structures

L
length: Internal structures

P
predicate: Internal structures

S
Slot, key-type: Internal structures
Slot, keys: Internal structures
Slot, length: Internal structures
Slot, predicate: Internal structures
Slot, value-type: Internal structures
Slot, values: Internal structures

V
value-type: Internal structures
values: Internal structures

Jump to:   K   L   P   S   V  

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

A.4 Data types

Jump to:   P   S  
Index Entry  Section

P
Package, priority-queue: The priority-queue package
pqueue: Internal structures
priority-queue: The priority-queue system
priority-queue: The priority-queue package

S
Structure, pqueue: Internal structures
System, priority-queue: The priority-queue system

Jump to:   P   S