[funds-cvs] r163 - trunk/funds/src/heap

[abaine at common-lisp.net]

Author: abaine
Date: Sun Aug 19 12:22:02 2007
New Revision: 163

Modified:
   trunk/funds/src/heap/heap-insert.lisp
Log:
Documented heap-insert.

Modified: trunk/funds/src/heap/heap-insert.lisp
==============================================================================
--- trunk/funds/src/heap/heap-insert.lisp	(original)
+++ trunk/funds/src/heap/heap-insert.lisp	Sun Aug 19 12:22:02 2007
@@ -25,6 +25,9 @@
 	     :value value))
 
 (defmethod heap-insert (heap value priority &key (order #'<))
+  "A new heap, similar to the given heap, except that the priority-value
+pair is inserted into the retured heap according to the standard heap
+insertion algorithm."
   (let* ((side (next-direction heap))
 	 (other-side (other-side side))
 	 (h1 (heap-insert (tree-child heap :side side) value priority