The queues Reference Manual

Table of Contents

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

The queues Reference Manual

This is the queues Reference Manual, version 1.1.0, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 04:29:18 2018 GMT+0.


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

1 Introduction

Queues (for Lisp!)

This is a simple queue library for Common Lisp. It's goals are to exist, be simple, nicely wrapped, and efficient.

The library depends on "bordeaux-threads" for locking, although that dependency is only required if you use one of the "cqueue" concurrent queues.

Four queue types are provided:

Thread safe versions are provided in:

ASDF systems are:

Example: (asdf:oos 'asdf:load-op :queues.simple-cqueue) or (require :queues.simple-cqueue)

Bug reports/fixes welcome: <Eric O'Connor> oconnore@gmail.com

Application Programming Interface

Package: queues

General API functions:

Priority Queue Only:

Miscellaneous Exported Symbols:


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 queues

Maintainer

Eric O’Connor

Author

Eric O’Connor

License

MIT

Description

A queue interface – used to create and
manipulate queue structures from simple-queue, priority-queue, or their concurrent versions (cqueue).

Version

1.1.0

Source

queues.asd (file)

Component

interface.lisp (file)


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 queues.asd

Location

queues.asd

Systems

queues (system)


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

3.1.2 queues/interface.lisp

Parent

queues (system)

Location

interface.lisp

Packages

queues

Exported Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 queues

Source

interface.lisp (file)

Nickname

q

Use List

common-lisp

Exported Definitions

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

5 Definitions

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


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

5.1 Exported definitions


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

5.1.1 Generic functions

Generic Function: make-queue TYPE &key &allow-other-keys

Creates a queue of type (:simple-queue :simple-cqueue :priority-queue :priority-cqueue). *-cqueue denotes the threadsafe version of the datastructure.

The allowed arguments are :minimum-size and :copy for simple-queues, and :compare and :copy for priority queues. Minimum size denotes the smallest size of the underlying vector. Copy will accept elements from another queue of the same type. Compare accepts a binary relation such as #’<

Package

queues

Source

interface.lisp (file)

Methods
Method: make-queue TYPE &rest ARGS
Generic Function: map-queue FN QUEUE
Package

queues

Source

interface.lisp (file)

Generic Function: node-active-p QUEUE NODE
Package

queues

Source

interface.lisp (file)

Generic Function: print-queue QUEUE &optional STREAM
Package

queues

Source

interface.lisp (file)

Generic Function: qclear QUEUE
Package

queues

Source

interface.lisp (file)

Generic Function: qpop QUEUE &optional EMPTY
Package

queues

Source

interface.lisp (file)

Generic Function: qpush QUEUE ELEMENT
Package

queues

Source

interface.lisp (file)

Generic Function: qsize QUEUE
Package

queues

Source

interface.lisp (file)

Generic Function: qtop QUEUE &optional EMPTY
Package

queues

Source

interface.lisp (file)

Generic Function: queue-change QUEUE NODE NEW-VALUE
Package

queues

Source

interface.lisp (file)

Generic Function: queue-comparison QUEUE
Package

queues

Source

interface.lisp (file)

Generic Function: queue-delete QUEUE NODE
Package

queues

Source

interface.lisp (file)

Generic Function: queue-find QUEUE PREDICATE-OR-KEY
Package

queues

Source

interface.lisp (file)

Generic Function: queue-merge QUEUE-1 QUEUE-2
Package

queues

Source

interface.lisp (file)

Generic Function: queue-merge-safe QUEUE-1 QUEUE-2
Package

queues

Source

interface.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   Q  
Index Entry  Section

F
File, Lisp, queues.asd: The queues<dot>asd file
File, Lisp, queues/interface.lisp: The queues/interface<dot>lisp file

L
Lisp File, queues.asd: The queues<dot>asd file
Lisp File, queues/interface.lisp: The queues/interface<dot>lisp file

Q
queues.asd: The queues<dot>asd file
queues/interface.lisp: The queues/interface<dot>lisp file

Jump to:   F   L   Q  

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

A.2 Functions

Jump to:   G   M   N   P   Q  
Index Entry  Section

G
Generic Function, make-queue: Exported generic functions
Generic Function, map-queue: Exported generic functions
Generic Function, node-active-p: Exported generic functions
Generic Function, print-queue: Exported generic functions
Generic Function, qclear: Exported generic functions
Generic Function, qpop: Exported generic functions
Generic Function, qpush: Exported generic functions
Generic Function, qsize: Exported generic functions
Generic Function, qtop: Exported generic functions
Generic Function, queue-change: Exported generic functions
Generic Function, queue-comparison: Exported generic functions
Generic Function, queue-delete: Exported generic functions
Generic Function, queue-find: Exported generic functions
Generic Function, queue-merge: Exported generic functions
Generic Function, queue-merge-safe: Exported generic functions

M
make-queue: Exported generic functions
make-queue: Exported generic functions
map-queue: Exported generic functions
Method, make-queue: Exported generic functions

N
node-active-p: Exported generic functions

P
print-queue: Exported generic functions

Q
qclear: Exported generic functions
qpop: Exported generic functions
qpush: Exported generic functions
qsize: Exported generic functions
qtop: Exported generic functions
queue-change: Exported generic functions
queue-comparison: Exported generic functions
queue-delete: Exported generic functions
queue-find: Exported generic functions
queue-merge: Exported generic functions
queue-merge-safe: Exported generic functions

Jump to:   G   M   N   P   Q  

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

A.3 Variables


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

A.4 Data types

Jump to:   P   Q   S  
Index Entry  Section

P
Package, queues: The queues package

Q
queues: The queues system
queues: The queues package

S
System, queues: The queues system

Jump to:   P   Q   S