diff options
Diffstat (limited to 'Doc/library/heapq.rst')
| -rw-r--r-- | Doc/library/heapq.rst | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/Doc/library/heapq.rst b/Doc/library/heapq.rst index 43088ad9e3..f8970bed73 100644 --- a/Doc/library/heapq.rst +++ b/Doc/library/heapq.rst @@ -47,7 +47,8 @@ The following functions are provided: .. function:: heappop(heap) Pop and return the smallest item from the *heap*, maintaining the heap - invariant. If the heap is empty, :exc:`IndexError` is raised. + invariant. If the heap is empty, :exc:`IndexError` is raised. To access the + smallest item without popping it, use ``heap[0]``. .. function:: heappushpop(heap, item) @@ -112,7 +113,8 @@ The module also offers three general purpose functions based on heaps. The latter two functions perform best for smaller values of *n*. For larger values, it is more efficient to use the :func:`sorted` function. Also, when ``n==1``, it is more efficient to use the built-in :func:`min` and :func:`max` -functions. +functions. If repeated usage of these functions is required, consider turning +the iterable into an actual heap. Basic Examples |