[Python-checkins] r86708 - python/branches/py3k/Doc/library/heapq.rst
georg.brandl
python-checkins at python.org
Tue Nov 23 09:37:54 CET 2010
Author: georg.brandl
Date: Tue Nov 23 09:37:54 2010
New Revision: 86708
Log:
#10511: clarification of what heaps are; suggested by Jonathan Hoff.
Modified:
python/branches/py3k/Doc/library/heapq.rst
Modified: python/branches/py3k/Doc/library/heapq.rst
==============================================================================
--- python/branches/py3k/Doc/library/heapq.rst (original)
+++ python/branches/py3k/Doc/library/heapq.rst Tue Nov 23 09:37:54 2010
@@ -16,11 +16,12 @@
Latest version of the :source:`heapq Python source code
<Lib/heapq.py>`
-Heaps are arrays for which ``heap[k] <= heap[2*k+1]`` and ``heap[k] <=
-heap[2*k+2]`` for all *k*, counting elements from zero. For the sake of
-comparison, non-existing elements are considered to be infinite. The
-interesting property of a heap is that ``heap[0]`` is always its smallest
-element.
+Heaps are binary trees for which every parent node has a value less than or
+equal to any of its children. This implementation uses arrays for which
+``heap[k] <= heap[2*k+1]`` and ``heap[k] <= heap[2*k+2]`` for all *k*, counting
+elements from zero. For the sake of comparison, non-existing elements are
+considered to be infinite. The interesting property of a heap is that its
+smallest element is always the root, ``heap[0]``.
The API below differs from textbook heap algorithms in two aspects: (a) We use
zero-based indexing. This makes the relationship between the index for a node
More information about the Python-checkins
mailing list