Import Upstream version 3a1upstream/3a1

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