[funds-cvs] r33 - trunk/funds/src/trees

[abaine at common-lisp.net]

Author: abaine
Date: Wed Jun 20 14:50:14 2007
New Revision: 33

Modified:
   trunk/funds/src/trees/avl-tree.lisp
Log:
Commented avl-find-value

Modified: trunk/funds/src/trees/avl-tree.lisp
==============================================================================
--- trunk/funds/src/trees/avl-tree.lisp	(original)
+++ trunk/funds/src/trees/avl-tree.lisp	Wed Jun 20 14:50:14 2007
@@ -104,6 +104,10 @@
 	      :right new-c)))
 
 (defun avl-find-value (tree key &key (order #'<) (test #'eql))
+  "The value associated with the given key in the given AVL Tree.  The function
+returns nil if the key is not found in the given tree; a second value is returned
+to indicate whether nil is returned because it is in fact the value associated with
+the given key or, instead, the key could not be found."
   (cond ((avl-empty-p tree) (values nil nil))
 	((funcall test key (avl-key tree)) (values (avl-value tree) t))
 	((funcall order key (avl-key tree))