summaryrefslogtreecommitdiffstats
path: root/queue.txi
diff options
context:
space:
mode:
authorBryan Newbold <bnewbold@robocracy.org>2017-02-20 00:05:31 -0800
committerBryan Newbold <bnewbold@robocracy.org>2017-02-20 00:05:31 -0800
commit5145dd3aa0c02c9fc496d1432fc4410674206e1d (patch)
tree540afc30c51da085f5bd8ec3f4c89f6496e7900d /queue.txi
parent8466d8cfa486fb30d1755c4261b781135083787b (diff)
downloadslib-5145dd3aa0c02c9fc496d1432fc4410674206e1d.tar.gz
slib-5145dd3aa0c02c9fc496d1432fc4410674206e1d.zip
Import Upstream version 3a2upstream/3a2
Diffstat (limited to 'queue.txi')
-rw-r--r--queue.txi9
1 files changed, 9 insertions, 0 deletions
diff --git a/queue.txi b/queue.txi
index 4590f34..efa6411 100644
--- a/queue.txi
+++ b/queue.txi
@@ -13,26 +13,31 @@ called @dfn{dequeues}). A queue may also be used like a stack.
Returns a new, empty queue.
@end defun
+
@defun queue? obj
Returns @code{#t} if @var{obj} is a queue.
@end defun
+
@defun queue-empty? q
Returns @code{#t} if the queue @var{q} is empty.
@end defun
+
@deffn {Procedure} queue-push! q datum
Adds @var{datum} to the front of queue @var{q}.
@end deffn
+
@deffn {Procedure} enqueue! q datum
Adds @var{datum} to the rear of queue @var{q}.
@end deffn
+
@deffn {Procedure} dequeue! q
@deffnx {Procedure} queue-pop! q
@@ -40,6 +45,7 @@ Both of these procedures remove and return the datum at the front of
the queue. @code{queue-pop!} is used to suggest that the queue is
being used like a stack.
@end deffn
+
All of the following functions raise an error if the queue @var{q}
is empty.
@@ -49,12 +55,15 @@ is empty.
Removes and returns (the list) of all contents of queue @var{q}.
@end deffn
+
@defun queue-front q
Returns the datum at the front of the queue @var{q}.
@end defun
+
@defun queue-rear q
Returns the datum at the rear of the queue @var{q}.
@end defun
+