Skip to content

gh-133530: Differentiate between min/max heaps more #133613

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed

gh-133530: Differentiate between min/max heaps more #133613

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0861080
min/max heaps
StanFromIreland May 7, 2025
ede66b9
Fixup
StanFromIreland May 8, 2025
355c1d2
Merge branch 'main' into heapq-doc-2
StanFromIreland Jul 13, 2025
01348b4
Fixup merge
StanFromIreland Jul 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions Doc/library/heapq.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,12 +306,12 @@ entry as removed and add a new entry with the revised priority::
Theory
------

Heaps are arrays for which ``a[k] <= a[2*k+1]`` and ``a[k] <= a[2*k+2]`` for all
Min-heaps are arrays for which ``a[k] <= a[2*k+1]`` and ``a[k] <= a[2*k+2]`` for all
*k*, counting elements from 0. For the sake of comparison, non-existing
elements are considered to be infinite. The interesting property of a heap is
that ``a[0]`` is always its smallest element.
elements are considered to be infinite. The interesting property of a min-heap is
that ``a[0]`` is always its smallest element. Max-heaps satisfy the reverse invariant.

The strange invariant above is meant to be an efficient memory representation
The strange min-heap invariant is meant to be an efficient memory representation
for a tournament. The numbers below are *k*, not ``a[k]``:

.. figure:: heapq-binary-tree.svg
Expand Down
Loading