The pettomato-deque Reference Manual

4.1.1 pettomato-deque/pettomato-deque.asd

Source

pettomato-deque.asd.

Parent Component

pettomato-deque (system).

ASDF Systems

pettomato-deque.

---

4.1.2 pettomato-deque/src/package.lisp

Source

pettomato-deque.asd.

Parent Component

src (module).

Packages

pettomato-deque.

---

4.1.3 pettomato-deque/src/deque.lisp

Dependency

package.lisp (file).

Source

pettomato-deque.asd.

Parent Component

src (module).

Public Interface

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

Internals

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

---

4.1.4 pettomato-deque/src/ideque.lisp

Dependency

deque.lisp (file).

Source

pettomato-deque.asd.

Parent Component

src (module).

Public Interface

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

Internals

• max-index (reader method).
• (setf max-index) (writer method).
• min-index (reader method).
• (setf min-index) (writer method).

---

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.

---

6.1.2 Ordinary 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.

---

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.

Methods

Method: element-count ((deque ideque)) ¶

Source

ideque.lisp.

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.

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.

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.

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.

Methods

Method: nth-element ((deque ideque) index) ¶

Source

ideque.lisp.

Method: nth-element ((deque deque) index) ¶

Generic Function: (setf nth-element) (queue index) ¶

Package

pettomato-deque.

Source

deque.lisp.

Methods

Method: (setf nth-element) ((deque ideque) index) ¶

Source

ideque.lisp.

Method: (setf nth-element) ((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.

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.

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.

Methods

Method: pop-back :after ((deque ideque)) ¶

Source

ideque.lisp.

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.

Methods

Method: pop-front :after ((deque ideque)) ¶

Source

ideque.lisp.

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.

Methods

Method: push-back :after ((deque ideque) value) ¶

Source

ideque.lisp.

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.

Methods

Method: push-front :after ((deque ideque) value) ¶

Source

ideque.lisp.

Method: push-front ((deque deque) value) ¶

---

6.1.4 Standalone methods

Method: initialize-instance :after ((deque deque) &key size element-type &allow-other-keys) ¶

Source

deque.lisp.

Method: print-object ((deque deque) stream) ¶

Source

deque.lisp.

---

6.1.5 Classes

Class: deque ¶

A double ended queue.

Package

pettomato-deque.

Source

deque.lisp.

Direct subclasses

ideque.

Direct methods

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

Direct slots

Slot: head-index ¶

Readers

head-index.

Writers

(setf head-index).

Slot: tail-index ¶

Readers

tail-index.

Writers

(setf tail-index).

Slot: buffer ¶

Readers

buffer.

Writers

(setf buffer).

Class: ideque ¶

A double ended queue that allows indexing.

Package

pettomato-deque.

Source

ideque.lisp.

Direct superclasses

deque.

Direct methods

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

Direct slots

Slot: min-index ¶

Initform

0

Readers

min-index.

Writers

(setf min-index).

Slot: max-index ¶

Initform

0

Readers

max-index.

Writers

(setf max-index).

---

6.2.1 Macros

Macro: decf-mod (place divisor) ¶

Package

pettomato-deque.

Source

deque.lisp.

Macro: incf-mod (place divisor) ¶

Package

pettomato-deque.

Source

deque.lisp.

---

6.2.2 Ordinary functions

Function: deque-full-p (deque) ¶

Package

pettomato-deque.

Source

deque.lisp.

Function: grow-deque (deque) ¶

Package

pettomato-deque.

Source

deque.lisp.

Function: move-head-back (deque) ¶

Package

pettomato-deque.

Source

deque.lisp.

Function: move-head-forward (deque) ¶

Package

pettomato-deque.

Source

deque.lisp.

Function: move-tail-back (deque) ¶

Package

pettomato-deque.

Source

deque.lisp.

Function: move-tail-forward (deque) ¶

Package

pettomato-deque.

Source

deque.lisp.

---

6.2.3 Generic functions

Generic Reader: buffer (object) ¶

Package

pettomato-deque.

Methods

Reader Method: buffer ((deque deque)) ¶

automatically generated reader method

Source

deque.lisp.

Target Slot

buffer.

Generic Writer: (setf buffer) (object) ¶

Package

pettomato-deque.

Methods

Writer Method: (setf buffer) ((deque deque)) ¶

automatically generated writer method

Source

deque.lisp.

Target Slot

buffer.

Generic Reader: head-index (object) ¶

Package

pettomato-deque.

Methods

Reader Method: head-index ((deque deque)) ¶

automatically generated reader method

Source

deque.lisp.

Target Slot

head-index.

Generic Writer: (setf head-index) (object) ¶

Package

pettomato-deque.

Methods

Writer Method: (setf head-index) ((deque deque)) ¶

automatically generated writer method

Source

deque.lisp.

Target Slot

head-index.

Generic Reader: max-index (object) ¶

Package

pettomato-deque.

Methods

Reader Method: max-index ((ideque ideque)) ¶

automatically generated reader method

Source

ideque.lisp.

Target Slot

max-index.

Generic Writer: (setf max-index) (object) ¶

Package

pettomato-deque.

Methods

Writer Method: (setf max-index) ((ideque ideque)) ¶

automatically generated writer method

Source

ideque.lisp.

Target Slot

max-index.

Generic Reader: min-index (object) ¶

Package

pettomato-deque.

Methods

Reader Method: min-index ((ideque ideque)) ¶

automatically generated reader method

Source

ideque.lisp.

Target Slot

min-index.

Generic Writer: (setf min-index) (object) ¶

Package

pettomato-deque.

Methods

Writer Method: (setf min-index) ((ideque ideque)) ¶

automatically generated writer method

Source

ideque.lisp.

Target Slot

min-index.

Generic Reader: tail-index (object) ¶

Package

pettomato-deque.

Methods

Reader Method: tail-index ((deque deque)) ¶

automatically generated reader method

Source

deque.lisp.

Target Slot

tail-index.

Generic Writer: (setf tail-index) (object) ¶

Package

pettomato-deque.

Methods

Writer Method: (setf tail-index) ((deque deque)) ¶

automatically generated writer method

Source

deque.lisp.

Target Slot

tail-index.

---