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

The bodge-queue Reference Manual

This is the bodge-queue Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 14:46:07 2024 GMT+0.

Table of Contents

Next: Systems, Previous: The bodge-queue Reference Manual, Up: The bodge-queue Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The bodge-queue Reference Manual [Contents][Index]

2 Systems

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

bodge-queue

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

2.1 `bodge-queue`

Simple FIFO implementation with no external dependencies

Author: Pavel Korolev
Contact: dev@borodust.org
License: MIT
Source: bodge-queue.asd.
Child Component: bodge-queue.lisp (file).

Next: Packages, Previous: Systems, Up: The bodge-queue Reference Manual [Contents][Index]

3 Files

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

Lisp

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

3.1 Lisp

bodge-queue/bodge-queue.asd
bodge-queue/bodge-queue.lisp

Next: bodge-queue/bodge-queue.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `bodge-queue/bodge-queue.asd`

Source: bodge-queue.asd.
Parent Component: bodge-queue (system).
ASDF Systems: bodge-queue.

Previous: bodge-queue/bodge-queue.asd, Up: Lisp [Contents][Index]

3.1.2 `bodge-queue/bodge-queue.lisp`

Source

bodge-queue.asd.

Parent Component

bodge-queue (system).

Packages

Public Interface

make-queue (function).
qref (function).
(setf qref) (function).
queue-clear (function).
queue-empty-p (function).
queue-length (function).
queue-peek (function).
queue-pop (function).
queue-push (function).

Internals

%make-queue (function).
%queue-extend (function).
+default-expansion-factor+ (constant).
copy-queue (function).
next-idx (function).
prev-idx (function).
queue (structure).
queue-array (reader).
(setf queue-array) (writer).
queue-expansion-factor (reader).
(setf queue-expansion-factor) (writer).
queue-head-idx (reader).
(setf queue-head-idx) (writer).
queue-p (function).
queue-tail-idx (reader).
(setf queue-tail-idx) (writer).
wrap-idx (function).

Next: Definitions, Previous: Files, Up: The bodge-queue Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

bodge-queue

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

4.1 `bodge-queue`

Source

bodge-queue.lisp.

Use List

common-lisp.

Public Interface

make-queue (function).
qref (function).
(setf qref) (function).
queue-clear (function).
queue-empty-p (function).
queue-length (function).
queue-peek (function).
queue-pop (function).
queue-push (function).

Internals

%make-queue (function).
%queue-extend (function).
+default-expansion-factor+ (constant).
copy-queue (function).
next-idx (function).
prev-idx (function).
queue (structure).
queue-array (reader).
(setf queue-array) (writer).
queue-expansion-factor (reader).
(setf queue-expansion-factor) (writer).
queue-head-idx (reader).
(setf queue-head-idx) (writer).
queue-p (function).
queue-tail-idx (reader).
(setf queue-tail-idx) (writer).
wrap-idx (function).

Next: Indexes, Previous: Packages, Up: The bodge-queue Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

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

5.1 Public Interface

Ordinary functions

Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Ordinary functions

Function: make-queue (&key initial-buffer-size element-type expansion-factor) ¶

Package: bodge-queue.
Source: bodge-queue.lisp.

Function: qref (queue idx) ¶

Package: bodge-queue.
Source: bodge-queue.lisp.

Function: (setf qref) (queue idx) ¶

Package: bodge-queue.
Source: bodge-queue.lisp.

Function: queue-clear (queue) ¶

Package: bodge-queue.
Source: bodge-queue.lisp.

Function: queue-empty-p (queue) ¶

Package: bodge-queue.
Source: bodge-queue.lisp.

Function: queue-length (queue) ¶

Package: bodge-queue.
Source: bodge-queue.lisp.

Function: queue-peek (queue) ¶

Package: bodge-queue.
Source: bodge-queue.lisp.

Function: queue-pop (queue) ¶

Package: bodge-queue.
Source: bodge-queue.lisp.

Function: queue-push (queue item) ¶

Package: bodge-queue.
Source: bodge-queue.lisp.

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

5.2 Internals

Constants
Ordinary functions
Structures

Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]

5.2.1 Constants

Constant: +default-expansion-factor+ ¶

Package: bodge-queue.
Source: bodge-queue.lisp.

Next: Structures, Previous: Constants, Up: Internals [Contents][Index]

5.2.2 Ordinary functions

Function: %make-queue (array expansion-factor) ¶

Package: bodge-queue.
Source: bodge-queue.lisp.

Function: %queue-extend (queue) ¶

Package: bodge-queue.
Source: bodge-queue.lisp.

Function: copy-queue (instance) ¶

Package: bodge-queue.
Source: bodge-queue.lisp.

Function: next-idx (queue idx) ¶

Package: bodge-queue.
Source: bodge-queue.lisp.

Function: prev-idx (queue idx) ¶

Package: bodge-queue.
Source: bodge-queue.lisp.

Reader: queue-array (instance) ¶

Writer: (setf queue-array) (instance) ¶

Package: bodge-queue.
Source: bodge-queue.lisp.
Target Slot: array.

Reader: queue-expansion-factor (instance) ¶

Writer: (setf queue-expansion-factor) (instance) ¶

Package: bodge-queue.
Source: bodge-queue.lisp.
Target Slot: expansion-factor.

Reader: queue-head-idx (instance) ¶

Writer: (setf queue-head-idx) (instance) ¶

Package: bodge-queue.
Source: bodge-queue.lisp.
Target Slot: head-idx.

Function: queue-p (object) ¶

Package: bodge-queue.
Source: bodge-queue.lisp.

Reader: queue-tail-idx (instance) ¶

Writer: (setf queue-tail-idx) (instance) ¶

Package: bodge-queue.
Source: bodge-queue.lisp.
Target Slot: tail-idx.

Function: wrap-idx (queue idx) ¶

Package: bodge-queue.
Source: bodge-queue.lisp.

Previous: Ordinary functions, Up: Internals [Contents][Index]

5.2.3 Structures

Structure: queue ¶

Package

Source

bodge-queue.lisp.

Direct superclasses

structure-object.

Direct slots

Slot: array ¶

Package: common-lisp.
Type: array
Initform: (make-array 0)
Readers: queue-array.
Writers: (setf queue-array).

Slot: expansion-factor ¶

Type: number
Initform: bodge-queue::+default-expansion-factor+
Readers: queue-expansion-factor.
Writers: (setf queue-expansion-factor).

Slot: head-idx ¶

Type: fixnum
Initform: -1
Readers: queue-head-idx.
Writers: (setf queue-head-idx).

Slot: tail-idx ¶

Type: fixnum
Initform: -1
Readers: queue-tail-idx.
Writers: (setf queue-tail-idx).

Previous: Definitions, Up: The bodge-queue Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

A.2 Functions

Jump to:	% ( C F M N P Q W

	Index Entry		Section

%
	`%make-queue`:		Private ordinary functions
	`%queue-extend`:		Private ordinary functions

(
	`(setf qref)`:		Public ordinary functions
	`(setf queue-array)`:		Private ordinary functions
	`(setf queue-expansion-factor)`:		Private ordinary functions
	`(setf queue-head-idx)`:		Private ordinary functions
	`(setf queue-tail-idx)`:		Private ordinary functions

C
	`copy-queue`:		Private ordinary functions

F
	`Function, %make-queue`:		Private ordinary functions
	`Function, %queue-extend`:		Private ordinary functions
	`Function, (setf qref)`:		Public ordinary functions
	`Function, (setf queue-array)`:		Private ordinary functions
	`Function, (setf queue-expansion-factor)`:		Private ordinary functions
	`Function, (setf queue-head-idx)`:		Private ordinary functions
	`Function, (setf queue-tail-idx)`:		Private ordinary functions
	`Function, copy-queue`:		Private ordinary functions
	`Function, make-queue`:		Public ordinary functions
	`Function, next-idx`:		Private ordinary functions
	`Function, prev-idx`:		Private ordinary functions
	`Function, qref`:		Public ordinary functions
	`Function, queue-array`:		Private ordinary functions
	`Function, queue-clear`:		Public ordinary functions
	`Function, queue-empty-p`:		Public ordinary functions
	`Function, queue-expansion-factor`:		Private ordinary functions
	`Function, queue-head-idx`:		Private ordinary functions
	`Function, queue-length`:		Public ordinary functions
	`Function, queue-p`:		Private ordinary functions
	`Function, queue-peek`:		Public ordinary functions
	`Function, queue-pop`:		Public ordinary functions
	`Function, queue-push`:		Public ordinary functions
	`Function, queue-tail-idx`:		Private ordinary functions
	`Function, wrap-idx`:		Private ordinary functions

M
	`make-queue`:		Public ordinary functions

N
	`next-idx`:		Private ordinary functions

P
	`prev-idx`:		Private ordinary functions

Q
	`qref`:		Public ordinary functions
	`queue-array`:		Private ordinary functions
	`queue-clear`:		Public ordinary functions
	`queue-empty-p`:		Public ordinary functions
	`queue-expansion-factor`:		Private ordinary functions
	`queue-head-idx`:		Private ordinary functions
	`queue-length`:		Public ordinary functions
	`queue-p`:		Private ordinary functions
	`queue-peek`:		Public ordinary functions
	`queue-pop`:		Public ordinary functions
	`queue-push`:		Public ordinary functions
	`queue-tail-idx`:		Private ordinary functions

W
	`wrap-idx`:		Private ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	+ A C E H S T

	Index Entry		Section

+
	`+default-expansion-factor+`:		Private constants

A
	`array`:		Private structures

C
	`Constant, +default-expansion-factor+`:		Private constants

E
	`expansion-factor`:		Private structures

H
	`head-idx`:		Private structures

S
	`Slot, array`:		Private structures
	`Slot, expansion-factor`:		Private structures
	`Slot, head-idx`:		Private structures
	`Slot, tail-idx`:		Private structures

T
	`tail-idx`:		Private structures

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

A.4 Data types

Jump to:	B F P Q S

	Index Entry		Section

B
	`bodge-queue`:		The bodge-queue system
	`bodge-queue`:		The bodge-queue package
	`bodge-queue.asd`:		The bodge-queue/bodge-queue․asd file
	`bodge-queue.lisp`:		The bodge-queue/bodge-queue․lisp file

F
	`File, bodge-queue.asd`:		The bodge-queue/bodge-queue․asd file
	`File, bodge-queue.lisp`:		The bodge-queue/bodge-queue․lisp file

P
	`Package, bodge-queue`:		The bodge-queue package

Q
	`queue`:		Private structures

S
	`Structure, queue`:		Private structures
	`System, bodge-queue`:		The bodge-queue system