The queues Reference Manual

This is the queues Reference Manual, version 1.1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:40:59 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 queues

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

Maintainer

Eric O’Connor

Author

Eric O’Connor

License

MIT

Version

1.1.0

Source

queues.asd.

Child Component

interface.lisp (file).


3 Files

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


3.1 Lisp


3.1.1 queues/queues.asd

Source

queues.asd.

Parent Component

queues (system).

ASDF Systems

queues.


3.1.2 queues/interface.lisp

Source

queues.asd.

Parent Component

queues (system).

Packages

queues.

Public Interface

4 Packages

Packages are listed by definition order.


4.1 queues

Source

interface.lisp.

Nickname

q

Use List

common-lisp.

Public Interface

5 Definitions

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


5.1 Public Interface


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.

Methods
Method: make-queue (type &rest args)
Generic Function: map-queue (fn queue)
Package

queues.

Source

interface.lisp.

Generic Function: node-active-p (queue node)
Package

queues.

Source

interface.lisp.

Generic Function: print-queue (queue &optional stream)
Package

queues.

Source

interface.lisp.

Generic Function: qclear (queue)
Package

queues.

Source

interface.lisp.

Generic Function: qpop (queue &optional empty)
Package

queues.

Source

interface.lisp.

Generic Function: qpush (queue element)
Package

queues.

Source

interface.lisp.

Generic Function: qsize (queue)
Package

queues.

Source

interface.lisp.

Generic Function: qtop (queue &optional empty)
Package

queues.

Source

interface.lisp.

Generic Function: queue-change (queue node new-value)
Package

queues.

Source

interface.lisp.

Generic Function: queue-comparison (queue)
Package

queues.

Source

interface.lisp.

Generic Function: queue-delete (queue node)
Package

queues.

Source

interface.lisp.

Generic Function: queue-find (queue predicate-or-key)
Package

queues.

Source

interface.lisp.

Generic Function: queue-merge (queue-1 queue-2)
Package

queues.

Source

interface.lisp.

Generic Function: queue-merge-safe (queue-1 queue-2)
Package

queues.

Source

interface.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   G   M   N   P   Q  
Index Entry  Section

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

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

N
node-active-p: Public generic functions

P
print-queue: Public generic functions

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


A.3 Variables