The bodge-queue Reference Manual

Table of Contents

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

The bodge-queue Reference Manual

This is the bodge-queue Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Nov 04 11:43:16 2020 GMT+0.


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

1 Introduction

BODGE-QUEUE

It is trivial.


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 bodge-queue

Author

Pavel Korolev

Contact

dev@borodust.org

License

MIT

Description

Simple FIFO implementation with no external dependencies

Source

bodge-queue.asd (file)

Component

bodge-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 bodge-queue.asd

Location

bodge-queue.asd

Systems

bodge-queue (system)


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

3.1.2 bodge-queue/bodge-queue.lisp

Parent

bodge-queue (system)

Location

bodge-queue.lisp

Packages

bodge-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 bodge-queue

Source

bodge-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: make-queue &key INITIAL-BUFFER-SIZE ELEMENT-TYPE EXPANSION-FACTOR
Package

bodge-queue

Source

bodge-queue.lisp (file)

Function: qref QUEUE IDX
Function: (setf qref) VALUE QUEUE IDX
Package

bodge-queue

Source

bodge-queue.lisp (file)

Function: queue-clear QUEUE
Package

bodge-queue

Source

bodge-queue.lisp (file)

Function: queue-empty-p QUEUE
Package

bodge-queue

Source

bodge-queue.lisp (file)

Function: queue-length QUEUE
Package

bodge-queue

Source

bodge-queue.lisp (file)

Function: queue-peek QUEUE
Package

bodge-queue

Source

bodge-queue.lisp (file)

Function: queue-pop QUEUE
Package

bodge-queue

Source

bodge-queue.lisp (file)

Function: queue-push QUEUE ITEM
Package

bodge-queue

Source

bodge-queue.lisp (file)


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

5.2 Internal definitions


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

5.2.1 Constants

Constant: +default-expansion-factor+
Package

bodge-queue

Source

bodge-queue.lisp (file)


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

5.2.2 Functions

Function: %make-queue ARRAY EXPANSION-FACTOR
Package

bodge-queue

Source

bodge-queue.lisp (file)

Function: %queue-extend QUEUE
Package

bodge-queue

Source

bodge-queue.lisp (file)

Function: copy-queue INSTANCE
Package

bodge-queue

Source

bodge-queue.lisp (file)

Function: next-idx QUEUE IDX
Package

bodge-queue

Source

bodge-queue.lisp (file)

Function: prev-idx QUEUE IDX
Package

bodge-queue

Source

bodge-queue.lisp (file)

Function: queue-array INSTANCE
Function: (setf queue-array) VALUE INSTANCE
Package

bodge-queue

Source

bodge-queue.lisp (file)

Function: queue-expansion-factor INSTANCE
Function: (setf queue-expansion-factor) VALUE INSTANCE
Package

bodge-queue

Source

bodge-queue.lisp (file)

Function: queue-head-idx INSTANCE
Function: (setf queue-head-idx) VALUE INSTANCE
Package

bodge-queue

Source

bodge-queue.lisp (file)

Function: queue-p OBJECT
Package

bodge-queue

Source

bodge-queue.lisp (file)

Function: queue-tail-idx INSTANCE
Function: (setf queue-tail-idx) VALUE INSTANCE
Package

bodge-queue

Source

bodge-queue.lisp (file)

Function: wrap-idx QUEUE IDX
Package

bodge-queue

Source

bodge-queue.lisp (file)


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

5.2.3 Structures

Structure: queue ()
Package

bodge-queue

Source

bodge-queue.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: array
Type

array

Initform

(make-array 0)

Readers

queue-array (function)

Writers

(setf queue-array) (function)

Slot: expansion-factor
Type

number

Initform

bodge-queue::+default-expansion-factor+

Readers

queue-expansion-factor (function)

Writers

(setf queue-expansion-factor) (function)

Slot: head-idx
Type

fixnum

Initform

-1

Readers

queue-head-idx (function)

Writers

(setf queue-head-idx) (function)

Slot: tail-idx
Type

fixnum

Initform

-1

Readers

queue-tail-idx (function)

Writers

(setf queue-tail-idx) (function)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   B   F   L  
Index Entry  Section

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

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

L
Lisp File, bodge-queue.asd: The bodge-queue․asd file
Lisp File, bodge-queue/bodge-queue.lisp: The bodge-queue/bodge-queue․lisp file

Jump to:   B   F   L  

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

A.2 Functions

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

%
%make-queue: Internal functions
%queue-extend: Internal functions

(
(setf qref): Exported functions
(setf queue-array): Internal functions
(setf queue-expansion-factor): Internal functions
(setf queue-head-idx): Internal functions
(setf queue-tail-idx): Internal functions

C
copy-queue: Internal functions

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

M
make-queue: Exported functions

N
next-idx: Internal functions

P
prev-idx: Internal functions

Q
qref: Exported functions
queue-array: Internal functions
queue-clear: Exported functions
queue-empty-p: Exported functions
queue-expansion-factor: Internal functions
queue-head-idx: Internal functions
queue-length: Exported functions
queue-p: Internal functions
queue-peek: Exported functions
queue-pop: Exported functions
queue-push: Exported functions
queue-tail-idx: Internal functions

W
wrap-idx: Internal functions

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

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

A.3 Variables

Jump to:   +  
A   C   E   H   S   T  
Index Entry  Section

+
+default-expansion-factor+: Internal constants

A
array: Internal structures

C
Constant, +default-expansion-factor+: Internal constants

E
expansion-factor: Internal structures

H
head-idx: Internal structures

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

T
tail-idx: Internal structures

Jump to:   +  
A   C   E   H   S   T  

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

A.4 Data types

Jump to:   B   P   Q   S  
Index Entry  Section

B
bodge-queue: The bodge-queue system
bodge-queue: The bodge-queue package

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

Q
queue: Internal structures

S
Structure, queue: Internal structures
System, bodge-queue: The bodge-queue system

Jump to:   B   P   Q   S