summaryrefslogtreecommitdiffstats
path: root/priorque.txi
diff options
context:
space:
mode:
authorBryan Newbold <bnewbold@robocracy.org>2017-02-20 00:05:29 -0800
committerBryan Newbold <bnewbold@robocracy.org>2017-02-20 00:05:29 -0800
commit8466d8cfa486fb30d1755c4261b781135083787b (patch)
treec8c12c67246f543c3cc4f64d1c07e003cb1d45ae /priorque.txi
parent87b82b5822ca54228cfa6df29be3ad9d4bc47d16 (diff)
downloadslib-8466d8cfa486fb30d1755c4261b781135083787b.tar.gz
slib-8466d8cfa486fb30d1755c4261b781135083787b.zip
Import Upstream version 3a1upstream/3a1
Diffstat (limited to 'priorque.txi')
-rw-r--r--priorque.txi33
1 files changed, 33 insertions, 0 deletions
diff --git a/priorque.txi b/priorque.txi
new file mode 100644
index 0000000..a1cd195
--- /dev/null
+++ b/priorque.txi
@@ -0,0 +1,33 @@
+@code{(require 'priority-queue)}
+@ftindex priority-queue
+
+@noindent
+This algorithm for priority queues is due to
+@cite{Introduction to Algorithms}
+by T. Cormen, C. Leiserson, R. Rivest.
+1989 MIT Press.
+
+
+@defun make-heap pred<?
+
+Returns a binary heap suitable which can be used for priority queue
+operations.
+@end defun
+
+@defun heap-length heap
+
+Returns the number of elements in @var{heap}.
+@end defun
+
+@deffn {Procedure} heap-insert! heap item
+
+Inserts @var{item} into @var{heap}. @var{item} can be inserted multiple
+times. The value returned is unspecified.
+@end deffn
+
+@deffn {Procedure} heap-extract-max! heap
+
+Returns the item which is larger than all others according to the
+@var{pred<?} argument to @code{make-heap}. If there are no items in
+@var{heap}, an error is signaled.
+@end deffn