The cl-speedy-queue Reference Manual

Table of Contents

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

The cl-speedy-queue Reference Manual

This is the cl-speedy-queue Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:24:07 2018 GMT+0.


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

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.


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 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)


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

Location

cl-speedy-queue.asd

Systems

cl-speedy-queue (system)


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

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
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 cl-speedy-queue

Source

cl-speedy-queue.lisp (file)

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: 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)


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

5.2 Internal definitions


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

5.2.1 Special variables

Special Variable: queue-sentinel
Package

cl-speedy-queue

Source

cl-speedy-queue.lisp (file)


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

5.2.2 Macros

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

cl-speedy-queue

Source

cl-speedy-queue.lisp (file)


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

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)


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

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)


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

5.2.5 Conditions

Condition: queue-condition ()
Package

cl-speedy-queue

Source

cl-speedy-queue.lisp (file)

Direct superclasses

error (condition)

Direct subclasses
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)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-speedy-queue.asd: The cl-speedy-queue<dot>asd file
cl-speedy-queue/cl-speedy-queue.lisp: The cl-speedy-queue/cl-speedy-queue<dot>lisp file

F
File, Lisp, cl-speedy-queue.asd: The cl-speedy-queue<dot>asd file
File, Lisp, cl-speedy-queue/cl-speedy-queue.lisp: The cl-speedy-queue/cl-speedy-queue<dot>lisp file

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

Jump to:   C   F   L  

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

A.2 Functions

Jump to:   %  
D   E   F   G   M   Q  
Index Entry  Section

%
%dequeue: Internal functions
%enqueue: Internal functions
%make-queue: Internal functions
%next-index: Internal functions
%queue-count: Internal functions
%queue-empty-p: Internal functions
%queue-full-p: Internal functions
%queue-in: Internal functions
%queue-length: Internal functions
%queue-out: Internal functions
%queue-peek: Internal functions
%queue-zero-p: Internal functions

D
define-speedy-function: Internal macros
dequeue: Exported functions

E
enqueue: Exported functions

F
Function, %dequeue: Internal functions
Function, %enqueue: Internal functions
Function, %make-queue: Internal functions
Function, %next-index: Internal functions
Function, %queue-count: Internal functions
Function, %queue-empty-p: Internal functions
Function, %queue-full-p: Internal functions
Function, %queue-in: Internal functions
Function, %queue-length: Internal functions
Function, %queue-out: Internal functions
Function, %queue-peek: Internal functions
Function, %queue-zero-p: Internal functions
Function, dequeue: Exported functions
Function, enqueue: Exported functions
Function, make-queue: Exported functions
Function, queue-count: Exported functions
Function, queue-empty-p: Exported functions
Function, queue-full-p: Exported functions
Function, queue-length: Exported functions
Function, queue-peek: Exported functions
Function, queuep: Internal functions

G
Generic Function, queue-condition-queue: Internal generic functions
Generic Function, queue-error-attempted-length: Internal generic functions
Generic Function, queue-overflow-extra-item: Internal generic functions

M
Macro, define-speedy-function: Internal macros
make-queue: Exported functions
Method, queue-condition-queue: Internal generic functions
Method, queue-error-attempted-length: Internal generic functions
Method, queue-overflow-extra-item: Internal generic functions

Q
queue-condition-queue: Internal generic functions
queue-condition-queue: Internal generic functions
queue-count: Exported functions
queue-empty-p: Exported functions
queue-error-attempted-length: Internal generic functions
queue-error-attempted-length: Internal generic functions
queue-full-p: Exported functions
queue-length: Exported functions
queue-overflow-extra-item: Internal generic functions
queue-overflow-extra-item: Internal generic functions
queue-peek: Exported functions
queuep: Internal functions

Jump to:   %  
D   E   F   G   M   Q  

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

A.3 Variables

Jump to:   A   I   Q   S  
Index Entry  Section

A
attempted-length: Internal conditions

I
item: Internal conditions

Q
queue: Internal conditions
queue-sentinel: Internal special variables

S
Slot, attempted-length: Internal conditions
Slot, item: Internal conditions
Slot, queue: Internal conditions
Special Variable, queue-sentinel: Internal special variables

Jump to:   A   I   Q   S  

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

A.4 Data types

Jump to:   C   P   Q   S  
Index Entry  Section

C
cl-speedy-queue: The cl-speedy-queue system
cl-speedy-queue: The cl-speedy-queue package
Condition, queue-condition: Internal conditions
Condition, queue-length-error: Internal conditions
Condition, queue-overflow-error: Internal conditions
Condition, queue-underflow-error: Internal conditions

P
Package, cl-speedy-queue: The cl-speedy-queue package

Q
queue-condition: Internal conditions
queue-length-error: Internal conditions
queue-overflow-error: Internal conditions
queue-underflow-error: Internal conditions

S
System, cl-speedy-queue: The cl-speedy-queue system

Jump to:   C   P   Q   S