The pettomato-deque Reference Manual

Table of Contents

The pettomato-deque Reference Manual

This is the pettomato-deque Reference Manual, version 0.1.1, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:23:21 2018 GMT+0.

1 Introduction

This package contains implementations of double-ended queues (aka,
deques). See: http://en.wikipedia.org/wiki/Deque

deque is a standard double-ended queue. You can push and pop from both
ends. Other features include indexing elements from their relative
position inside the deque, iterating through the elements, and
converting the deque to a list.

ideque is a specialized deque that keeps track of the indices of the
front and back of the queue so that we may reference items by an
absolute, rather than relative, index. The idea is that you can add
elements to an ideque (push-back), pop elements off the front
(pop-front), and still reference the nth item added directly by n. It
probably doesn't make much sense to use push-front with an ideque, but
you can.

Please see the docstrings for the exported symbols for more
information.

--------------------------------
Acknowledgments

This implementation was originally based off of the deque
implementation in the arnesi package:
http://common-lisp.net/project/bese/repos/arnesi_dev/src/queue.lisp

2 Systems

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

2.1 pettomato-deque

Author

Austin Haas <austin@pettomato.com>

License

MIT

Description

A set of double-ended queue implementations.

Version

0.1.1

Source

pettomato-deque.asd (file)

Component

src (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 pettomato-deque/src

Parent

pettomato-deque (system)

Location

src/

Components

• package.lisp (file)
• deque.lisp (file)
• ideque.lisp (file)

4 Files

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

4.1 Lisp

4.1.1 pettomato-deque.asd

Location

pettomato-deque.asd

Systems

pettomato-deque (system)

4.1.2 pettomato-deque/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

pettomato-deque

4.1.3 pettomato-deque/src/deque.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/deque.lisp

Exported Definitions

• deque (class)
• deque->list (function)
• do-all-elements (macro)
• element-count (generic function)
• element-count (method)
• empty-p (generic function)
• empty-p (method)
• nth-element (generic function)
• nth-element (method)
• (setf nth-element) (method)
• (setf nth-element) (generic function)
• peek-back (generic function)
• peek-back (method)
• peek-front (generic function)
• peek-front (method)
• pop-back (generic function)
• pop-back (method)
• pop-front (generic function)
• pop-front (method)
• push-back (generic function)
• push-back (method)
• push-front (generic function)
• push-front (method)

Internal Definitions

• buffer (method)
• (setf buffer) (method)
• decf-mod (macro)
• deque-full-p (function)
• grow-deque (function)
• head-index (method)
• (setf head-index) (method)
• incf-mod (macro)
• move-head-back (function)
• move-head-forward (function)
• move-tail-back (function)
• move-tail-forward (function)
• tail-index (method)
• (setf tail-index) (method)

4.1.4 pettomato-deque/src/ideque.lisp

Dependency

deque.lisp (file)

Parent

src (module)

Location

src/ideque.lisp

Exported Definitions

• element-count (method)
• expire-front-to (generic function)
• expire-front-to (method)
• grow-back-to (generic function)
• grow-back-to (method)
• ideque (class)
• nth-element (method)
• (setf nth-element) (method)
• pop-back (method)
• pop-front (method)
• push-back (method)
• push-front (method)

Internal Definitions

• max-index (method)
• (setf max-index) (method)
• min-index (method)
• (setf min-index) (method)

5 Packages

Packages are listed by definition order.

5.1 pettomato-deque

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• deque (class)
• deque->list (function)
• do-all-elements (macro)
• element-count (generic function)
• element-count (method)
• element-count (method)
• empty-p (generic function)
• empty-p (method)
• expire-front-to (generic function)
• expire-front-to (method)
• grow-back-to (generic function)
• grow-back-to (method)
• ideque (class)
• nth-element (generic function)
• nth-element (method)
• (setf nth-element) (method)
• nth-element (method)
• (setf nth-element) (method)
• (setf nth-element) (generic function)
• peek-back (generic function)
• peek-back (method)
• peek-front (generic function)
• peek-front (method)
• pop-back (generic function)
• pop-back (method)
• pop-back (method)
• pop-front (generic function)
• pop-front (method)
• pop-front (method)
• push-back (generic function)
• push-back (method)
• push-back (method)
• push-front (generic function)
• push-front (method)
• push-front (method)

Internal Definitions

• buffer (generic function)
• buffer (method)
• (setf buffer) (method)
• (setf buffer) (generic function)
• decf-mod (macro)
• deque-full-p (function)
• grow-deque (function)
• head-index (generic function)
• head-index (method)
• (setf head-index) (method)
• (setf head-index) (generic function)
• incf-mod (macro)
• max-index (generic function)
• max-index (method)
• (setf max-index) (method)
• (setf max-index) (generic function)
• min-index (generic function)
• min-index (method)
• (setf min-index) (method)
• (setf min-index) (generic function)
• move-head-back (function)
• move-head-forward (function)
• move-tail-back (function)
• move-tail-forward (function)
• tail-index (generic function)
• tail-index (method)
• (setf tail-index) (method)
• (setf tail-index) (generic function)

6 Definitions

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

6.1 Exported definitions

6.1.1 Macros

Macro: do-all-elements (ELEMENT DEQUE) &body BODY

Iterate through deque in the order that pop-front would return elements, and bind each element to element in body. element is bound using a symbol-macrolet so that the value referenced by element can be changed using setf.

Package

pettomato-deque

Source

deque.lisp (file)

6.1.2 Functions

Function: deque->list DEQUE

Returns the elements of the queue as a list. The original queue is not modified.

Package

pettomato-deque

Source

deque.lisp (file)

6.1.3 Generic functions

Generic Function: element-count QUEUE

Returns the number of elements currently in the queue.

Package

pettomato-deque

Source

deque.lisp (file)

Methods

Method: element-count (DEQUE ideque)

Source

ideque.lisp (file)

Method: element-count (DEQUE deque)

Generic Function: empty-p QUEUE

Returns a generalized boolean: true if the queue is empty, otherwise false.

Package

pettomato-deque

Source

deque.lisp (file)

Methods

Method: empty-p (DEQUE deque)

Generic Function: expire-front-to DEQUE INDEX

Move front up to index. It is permissible for index
to be greater than max-index; the queue will be cleared and min-index and max-index will be set to index. Returns deque.

Package

pettomato-deque

Source

ideque.lisp (file)

Methods

Method: expire-front-to (DEQUE ideque) INDEX

Generic Function: grow-back-to DEQUE INDEX VALUE

Ensure that deque is large enough to be indexed at
index. If not, value will be pushed on until it is. If value is a function, the function will be called and the returned value will be used. Returns deque.

Package

pettomato-deque

Source

ideque.lisp (file)

Methods

Method: grow-back-to (DEQUE ideque) INDEX VALUE

Generic Function: nth-element QUEUE INDEX

Accesses the element of the queue specified by index.

Package

pettomato-deque

Source

deque.lisp (file)

Writer

(setf nth-element) (generic function)

Methods

Method: nth-element (DEQUE ideque) INDEX

Source

ideque.lisp (file)

Method: nth-element (DEQUE deque) INDEX

Generic Function: (setf nth-element) VAL QUEUE INDEX

Package

pettomato-deque

Source

deque.lisp (file)

Reader

nth-element (generic function)

Methods

Method: (setf nth-element) VAL (DEQUE ideque) INDEX

Source

ideque.lisp (file)

Method: (setf nth-element) VAL (DEQUE deque) INDEX

Generic Function: peek-back QUEUE

Returns the element at the back of the queue without removing it from the queue.

Package

pettomato-deque

Source

deque.lisp (file)

Methods

Method: peek-back (DEQUE deque)

Generic Function: peek-front QUEUE

Returns the element at the front of the queue without removing it from the queue.

Package

pettomato-deque

Source

deque.lisp (file)

Methods

Method: peek-front (DEQUE deque)

Generic Function: pop-back QUEUE

Removes the element at the back of the queue and returns it.

Package

pettomato-deque

Source

deque.lisp (file)

Methods

Method: pop-back (DEQUE ideque) after

Source

ideque.lisp (file)

Method: pop-back (DEQUE deque)

Generic Function: pop-front QUEUE

Removes the element at the front of the queue and returns it.

Package

pettomato-deque

Source

deque.lisp (file)

Methods

Method: pop-front (DEQUE ideque) after

Source

ideque.lisp (file)

Method: pop-front (DEQUE deque)

Generic Function: push-back QUEUE VALUE

Push value on to the back of queue. Returns queue.

Package

pettomato-deque

Source

deque.lisp (file)

Methods

Method: push-back (DEQUE ideque) VALUE after

Source

ideque.lisp (file)

Method: push-back (DEQUE deque) VALUE

Generic Function: push-front QUEUE VALUE

Push value on to the front of queue. Returns queue.

Package

pettomato-deque

Source

deque.lisp (file)

Methods

Method: push-front (DEQUE ideque) VALUE after

Source

ideque.lisp (file)

Method: push-front (DEQUE deque) VALUE

6.1.4 Classes

Class: deque ()

A double ended queue.

Package

pettomato-deque

Source

deque.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

ideque (class)

Direct methods

• print-object (method)
• nth-element (method)
• nth-element (method)
• element-count (method)
• empty-p (method)
• peek-back (method)
• peek-front (method)
• pop-back (method)
• pop-front (method)
• push-back (method)
• push-front (method)
• initialize-instance (method)
• buffer (method)
• buffer (method)
• tail-index (method)
• tail-index (method)
• head-index (method)
• head-index (method)

Direct slots

Slot: head-index

Readers

head-index (generic function)

Writers

(setf head-index) (generic function)

Slot: tail-index

Readers

tail-index (generic function)

Writers

(setf tail-index) (generic function)

Slot: buffer

Readers

buffer (generic function)

Writers

(setf buffer) (generic function)

Class: ideque ()

A double ended queue that allows indexing.

Package

pettomato-deque

Source

ideque.lisp (file)

Direct superclasses

deque (class)

Direct methods

• expire-front-to (method)
• grow-back-to (method)
• nth-element (method)
• nth-element (method)
• element-count (method)
• pop-back (method)
• pop-front (method)
• push-back (method)
• push-front (method)
• max-index (method)
• max-index (method)
• min-index (method)
• min-index (method)

Direct slots

Slot: min-index

Initform

0

Readers

min-index (generic function)

Writers

(setf min-index) (generic function)

Slot: max-index

Initform

0

Readers

max-index (generic function)

Writers

(setf max-index) (generic function)

6.2 Internal definitions

6.2.1 Macros

Macro: decf-mod PLACE DIVISOR

Package

pettomato-deque

Source

deque.lisp (file)

Macro: incf-mod PLACE DIVISOR

Package

pettomato-deque

Source

deque.lisp (file)

6.2.2 Functions

Function: deque-full-p DEQUE

Package

pettomato-deque

Source

deque.lisp (file)

Function: grow-deque DEQUE

Package

pettomato-deque

Source

deque.lisp (file)

Function: move-head-back DEQUE

Package

pettomato-deque

Source

deque.lisp (file)

Function: move-head-forward DEQUE

Package

pettomato-deque

Source

deque.lisp (file)

Function: move-tail-back DEQUE

Package

pettomato-deque

Source

deque.lisp (file)

Function: move-tail-forward DEQUE

Package

pettomato-deque

Source

deque.lisp (file)

6.2.3 Generic functions

Generic Function: buffer OBJECT

Generic Function: (setf buffer) NEW-VALUE OBJECT

Package

pettomato-deque

Methods

Method: buffer (DEQUE deque)

automatically generated reader method

Source

deque.lisp (file)

Method: (setf buffer) NEW-VALUE (DEQUE deque)

automatically generated writer method

Source

deque.lisp (file)

Generic Function: head-index OBJECT

Generic Function: (setf head-index) NEW-VALUE OBJECT

Package

pettomato-deque

Methods

Method: head-index (DEQUE deque)

automatically generated reader method

Source

deque.lisp (file)

Method: (setf head-index) NEW-VALUE (DEQUE deque)

automatically generated writer method

Source

deque.lisp (file)

Generic Function: max-index OBJECT

Generic Function: (setf max-index) NEW-VALUE OBJECT

Package

pettomato-deque

Methods

Method: max-index (IDEQUE ideque)

automatically generated reader method

Source

ideque.lisp (file)

Method: (setf max-index) NEW-VALUE (IDEQUE ideque)

automatically generated writer method

Source

ideque.lisp (file)

Generic Function: min-index OBJECT

Generic Function: (setf min-index) NEW-VALUE OBJECT

Package

pettomato-deque

Methods

Method: min-index (IDEQUE ideque)

automatically generated reader method

Source

ideque.lisp (file)

Method: (setf min-index) NEW-VALUE (IDEQUE ideque)

automatically generated writer method

Source

ideque.lisp (file)

Generic Function: tail-index OBJECT

Generic Function: (setf tail-index) NEW-VALUE OBJECT

Package

pettomato-deque

Methods

Method: tail-index (DEQUE deque)

automatically generated reader method

Source

deque.lisp (file)

Method: (setf tail-index) NEW-VALUE (DEQUE deque)

automatically generated writer method

Source

deque.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types