The pettomato-deque Reference Manual
This is the pettomato-deque Reference Manual, version 0.1.1,
generated automatically by Declt version 4.0 beta 2 "William Riker"
on Sun Sep 15 06:20:34 2024 GMT+0.
2 Systems
The main system appears first, followed by any subsystem dependency.
3 Modules
Modules are listed depth-first from the system components tree.
4 Files
Files are sorted by type and then listed depth-first from the systems
components trees.
5 Packages
Packages are listed by definition order.
5.1 pettomato-deque
- Source
package.lisp
.
- Use List
common-lisp
.
- Public Interface
-
- Internals
-
6 Definitions
Definitions are sorted by export status, category, package, and then by
lexicographic order.
6.1 Public Interface
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
.
Appendix A Indexes
A.2 Functions
| |
|
( | | |
| (setf buffer) : | | Private generic functions |
| (setf buffer) : | | Private generic functions |
| (setf head-index) : | | Private generic functions |
| (setf head-index) : | | Private generic functions |
| (setf max-index) : | | Private generic functions |
| (setf max-index) : | | Private generic functions |
| (setf min-index) : | | Private generic functions |
| (setf min-index) : | | Private generic functions |
| (setf nth-element) : | | Public generic functions |
| (setf nth-element) : | | Public generic functions |
| (setf nth-element) : | | Public generic functions |
| (setf tail-index) : | | Private generic functions |
| (setf tail-index) : | | Private generic functions |
|
B | | |
| buffer : | | Private generic functions |
| buffer : | | Private generic functions |
|
D | | |
| decf-mod : | | Private macros |
| deque->list : | | Public ordinary functions |
| deque-full-p : | | Private ordinary functions |
| do-all-elements : | | Public macros |
|
E | | |
| element-count : | | Public generic functions |
| element-count : | | Public generic functions |
| element-count : | | Public generic functions |
| empty-p : | | Public generic functions |
| empty-p : | | Public generic functions |
| expire-front-to : | | Public generic functions |
| expire-front-to : | | Public generic functions |
|
F | | |
| Function, deque->list : | | Public ordinary functions |
| Function, deque-full-p : | | Private ordinary functions |
| Function, grow-deque : | | Private ordinary functions |
| Function, move-head-back : | | Private ordinary functions |
| Function, move-head-forward : | | Private ordinary functions |
| Function, move-tail-back : | | Private ordinary functions |
| Function, move-tail-forward : | | Private ordinary functions |
|
G | | |
| Generic Function, (setf buffer) : | | Private generic functions |
| Generic Function, (setf head-index) : | | Private generic functions |
| Generic Function, (setf max-index) : | | Private generic functions |
| Generic Function, (setf min-index) : | | Private generic functions |
| Generic Function, (setf nth-element) : | | Public generic functions |
| Generic Function, (setf tail-index) : | | Private generic functions |
| Generic Function, buffer : | | Private generic functions |
| Generic Function, element-count : | | Public generic functions |
| Generic Function, empty-p : | | Public generic functions |
| Generic Function, expire-front-to : | | Public generic functions |
| Generic Function, grow-back-to : | | Public generic functions |
| Generic Function, head-index : | | Private generic functions |
| Generic Function, max-index : | | Private generic functions |
| Generic Function, min-index : | | Private generic functions |
| Generic Function, nth-element : | | Public generic functions |
| Generic Function, peek-back : | | Public generic functions |
| Generic Function, peek-front : | | Public generic functions |
| Generic Function, pop-back : | | Public generic functions |
| Generic Function, pop-front : | | Public generic functions |
| Generic Function, push-back : | | Public generic functions |
| Generic Function, push-front : | | Public generic functions |
| Generic Function, tail-index : | | Private generic functions |
| grow-back-to : | | Public generic functions |
| grow-back-to : | | Public generic functions |
| grow-deque : | | Private ordinary functions |
|
H | | |
| head-index : | | Private generic functions |
| head-index : | | Private generic functions |
|
I | | |
| incf-mod : | | Private macros |
| initialize-instance : | | Public standalone methods |
|
M | | |
| Macro, decf-mod : | | Private macros |
| Macro, do-all-elements : | | Public macros |
| Macro, incf-mod : | | Private macros |
| max-index : | | Private generic functions |
| max-index : | | Private generic functions |
| Method, (setf buffer) : | | Private generic functions |
| Method, (setf head-index) : | | Private generic functions |
| Method, (setf max-index) : | | Private generic functions |
| Method, (setf min-index) : | | Private generic functions |
| Method, (setf nth-element) : | | Public generic functions |
| Method, (setf nth-element) : | | Public generic functions |
| Method, (setf tail-index) : | | Private generic functions |
| Method, buffer : | | Private generic functions |
| Method, element-count : | | Public generic functions |
| Method, element-count : | | Public generic functions |
| Method, empty-p : | | Public generic functions |
| Method, expire-front-to : | | Public generic functions |
| Method, grow-back-to : | | Public generic functions |
| Method, head-index : | | Private generic functions |
| Method, initialize-instance : | | Public standalone methods |
| Method, max-index : | | Private generic functions |
| Method, min-index : | | Private generic functions |
| Method, nth-element : | | Public generic functions |
| Method, nth-element : | | Public generic functions |
| Method, peek-back : | | Public generic functions |
| Method, peek-front : | | Public generic functions |
| Method, pop-back : | | Public generic functions |
| Method, pop-back : | | Public generic functions |
| Method, pop-front : | | Public generic functions |
| Method, pop-front : | | Public generic functions |
| Method, print-object : | | Public standalone methods |
| Method, push-back : | | Public generic functions |
| Method, push-back : | | Public generic functions |
| Method, push-front : | | Public generic functions |
| Method, push-front : | | Public generic functions |
| Method, tail-index : | | Private generic functions |
| min-index : | | Private generic functions |
| min-index : | | Private generic functions |
| move-head-back : | | Private ordinary functions |
| move-head-forward : | | Private ordinary functions |
| move-tail-back : | | Private ordinary functions |
| move-tail-forward : | | Private ordinary functions |
|
N | | |
| nth-element : | | Public generic functions |
| nth-element : | | Public generic functions |
| nth-element : | | Public generic functions |
|
P | | |
| peek-back : | | Public generic functions |
| peek-back : | | Public generic functions |
| peek-front : | | Public generic functions |
| peek-front : | | Public generic functions |
| pop-back : | | Public generic functions |
| pop-back : | | Public generic functions |
| pop-back : | | Public generic functions |
| pop-front : | | Public generic functions |
| pop-front : | | Public generic functions |
| pop-front : | | Public generic functions |
| print-object : | | Public standalone methods |
| push-back : | | Public generic functions |
| push-back : | | Public generic functions |
| push-back : | | Public generic functions |
| push-front : | | Public generic functions |
| push-front : | | Public generic functions |
| push-front : | | Public generic functions |
|
T | | |
| tail-index : | | Private generic functions |
| tail-index : | | Private generic functions |
|