The cl-speedy-queue Reference Manual

Table of Contents

The cl-speedy-queue Reference Manual

This is the cl-speedy-queue Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Mar 25 17:38:30 2020 GMT+0.

1 Introduction

About

cl-speedy-queue is a portable, non-consing, optimized queue implementation. It was originally written by Adlai Chandrasekhar for use in ChanL.

API

[function] make-queue size

Creates a new queue of SIZE.

[function] enqueue object queue

Enqueues OBJECT in QUEUE.

[function] dequeue queue

Dequeues QUEUE.

[function] queue-count queue

Returns the current size of QUEUE.

[function] queue-length queue

Returns the maximum size of QUEUE.

[function] queue-peek queue

Returns the next item that would be dequeued without dequeueing it.

[function] queue-full-p queue

Returns NIL if more items can be enqueued.

[function] queue-empty-p queue

Returns NIL if there are still items in the queue.

2 Systems

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

2.1 cl-speedy-queue

Author

Adlai Chandrasekhar <munchking@gmail.com>

License

MIT

Description

cl-speedy-queue is a portable, non-consing, optimized queue implementation.

Source

cl-speedy-queue.asd (file)

Component

cl-speedy-queue.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 cl-speedy-queue.asd

Location

cl-speedy-queue.asd

Systems

cl-speedy-queue (system)

3.1.2 cl-speedy-queue/cl-speedy-queue.lisp

Parent

cl-speedy-queue (system)

Location

cl-speedy-queue.lisp

Packages

cl-speedy-queue

Exported Definitions

• dequeue (function)
• enqueue (function)
• make-queue (function)
• queue-count (function)
• queue-empty-p (function)
• queue-full-p (function)
• queue-length (function)
• queue-peek (function)

Internal Definitions

• %dequeue (function)
• %enqueue (function)
• %make-queue (function)
• %next-index (function)
• %queue-count (function)
• %queue-empty-p (function)
• %queue-full-p (function)
• %queue-in (function)
• %queue-length (function)
• %queue-out (function)
• %queue-peek (function)
• %queue-zero-p (function)
• define-speedy-function (macro)
• queue-condition (condition)
• queue-condition-queue (method)
• queue-error-attempted-length (method)
• queue-length-error (condition)
• queue-overflow-error (condition)
• queue-overflow-extra-item (method)
• queue-sentinel (special variable)
• queue-underflow-error (condition)
• queuep (function)

4 Packages

Packages are listed by definition order.

4.1 cl-speedy-queue

Source

cl-speedy-queue.lisp (file)

Use List

common-lisp

Exported Definitions

• dequeue (function)
• enqueue (function)
• make-queue (function)
• queue-count (function)
• queue-empty-p (function)
• queue-full-p (function)
• queue-length (function)
• queue-peek (function)

Internal Definitions

• %dequeue (function)
• %enqueue (function)
• %make-queue (function)
• %next-index (function)
• %queue-count (function)
• %queue-empty-p (function)
• %queue-full-p (function)
• %queue-in (function)
• %queue-length (function)
• %queue-out (function)
• %queue-peek (function)
• %queue-zero-p (function)
• define-speedy-function (macro)
• queue-condition (condition)
• queue-condition-queue (generic function)
• queue-condition-queue (method)
• queue-error-attempted-length (generic function)
• queue-error-attempted-length (method)
• queue-length-error (condition)
• queue-overflow-error (condition)
• queue-overflow-extra-item (generic function)
• queue-overflow-extra-item (method)
• queue-sentinel (special variable)
• queue-underflow-error (condition)
• queuep (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: dequeue QUEUE

Dequeues QUEUE

Package

cl-speedy-queue

Source

cl-speedy-queue.lisp (file)

Function: enqueue OBJECT QUEUE

Enqueues OBJECT in QUEUE

Package

cl-speedy-queue

Source

cl-speedy-queue.lisp (file)

Function: make-queue SIZE

Makes a queue of maximum size SIZE

Package

cl-speedy-queue

Source

cl-speedy-queue.lisp (file)

Function: queue-count QUEUE

Returns the current size of QUEUE

Package

cl-speedy-queue

Source

cl-speedy-queue.lisp (file)

Function: queue-empty-p QUEUE

Tests whether QUEUE is empty

Package

cl-speedy-queue

Source

cl-speedy-queue.lisp (file)

Function: queue-full-p QUEUE

Returns NIL if more items can be enqueued.

Package

cl-speedy-queue

Source

cl-speedy-queue.lisp (file)

Function: queue-length QUEUE

Returns the maximum size of QUEUE

Package

cl-speedy-queue

Source

cl-speedy-queue.lisp (file)

Function: queue-peek QUEUE

Returns the next item that would be dequeued without dequeueing it.

Package

cl-speedy-queue

Source

cl-speedy-queue.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: queue-sentinel

Package

cl-speedy-queue

Source

cl-speedy-queue.lisp (file)

5.2.2 Macros

Macro: define-speedy-function NAME ARGS &body BODY

Package

cl-speedy-queue

Source

cl-speedy-queue.lisp (file)

5.2.3 Functions

Function: %dequeue ()

Sets QUEUE’s tail to QUEUE, increments QUEUE’s tail pointer, and returns the previous tail ref

Package

cl-speedy-queue

Source

cl-speedy-queue.lisp (file)

Function: %enqueue ()

Enqueue OBJECT and increment QUEUE’s entry pointer

Package

cl-speedy-queue

Source

cl-speedy-queue.lisp (file)

Function: %make-queue ()

Creates a new queue of maximum size LENGTH

Package

cl-speedy-queue

Source

cl-speedy-queue.lisp (file)

Function: %next-index ()

Package

cl-speedy-queue

Source

cl-speedy-queue.lisp (file)

Function: %queue-count ()

Returns QUEUE’s effective length

Package

cl-speedy-queue

Source

cl-speedy-queue.lisp (file)

Function: %queue-empty-p ()

Checks whether QUEUE is effectively empty

Package

cl-speedy-queue

Source

cl-speedy-queue.lisp (file)

Function: %queue-full-p ()

Checks whether QUEUE is effectively full

Package

cl-speedy-queue

Source

cl-speedy-queue.lisp (file)

Function: %queue-in ()

QUEUE’s entry pointer

Package

cl-speedy-queue

Source

cl-speedy-queue.lisp (file)

Function: %queue-length ()

Returns QUEUE’s maximum length

Package

cl-speedy-queue

Source

cl-speedy-queue.lisp (file)

Function: %queue-out ()

QUEUE’s exit pointer

Package

cl-speedy-queue

Source

cl-speedy-queue.lisp (file)

Function: %queue-peek ()

Dereference QUEUE’s exit pointer

Package

cl-speedy-queue

Source

cl-speedy-queue.lisp (file)

Function: %queue-zero-p ()

Checks whether QUEUE’s theoretical length is zero

Package

cl-speedy-queue

Source

cl-speedy-queue.lisp (file)

Function: queuep ()

If this returns NIL, X is not a queue

Package

cl-speedy-queue

Source

cl-speedy-queue.lisp (file)

5.2.4 Generic functions

Generic Function: queue-condition-queue CONDITION

Package

cl-speedy-queue

Methods

Method: queue-condition-queue (CONDITION queue-condition)

Source

cl-speedy-queue.lisp (file)

Generic Function: queue-error-attempted-length CONDITION

Package

cl-speedy-queue

Methods

Method: queue-error-attempted-length (CONDITION queue-length-error)

Source

cl-speedy-queue.lisp (file)

Generic Function: queue-overflow-extra-item CONDITION

Package

cl-speedy-queue

Methods

Method: queue-overflow-extra-item (CONDITION queue-overflow-error)

Source

cl-speedy-queue.lisp (file)

5.2.5 Conditions

Condition: queue-condition ()

Package

cl-speedy-queue

Source

cl-speedy-queue.lisp (file)

Direct superclasses

error (condition)

Direct subclasses

• queue-length-error (condition)
• queue-overflow-error (condition)
• queue-underflow-error (condition)

Direct methods

queue-condition-queue (method)

Direct slots

Slot: queue

Initargs

:queue

Readers

queue-condition-queue (generic function)

Condition: queue-length-error ()

Package

cl-speedy-queue

Source

cl-speedy-queue.lisp (file)

Direct superclasses

queue-condition (condition)

Direct methods

queue-error-attempted-length (method)

Direct slots

Slot: attempted-length

Initargs

:attempted-length

Readers

queue-error-attempted-length (generic function)

Condition: queue-overflow-error ()

Package

cl-speedy-queue

Source

cl-speedy-queue.lisp (file)

Direct superclasses

queue-condition (condition)

Direct methods

queue-overflow-extra-item (method)

Direct slots

Slot: item

Initargs

:item

Readers

queue-overflow-extra-item (generic function)

Condition: queue-underflow-error ()

Package

cl-speedy-queue

Source

cl-speedy-queue.lisp (file)

Direct superclasses

queue-condition (condition)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types