Skip to content

GH-112498 Add heapremove and heapfix #112550

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
kristjanvalur wants to merge 15 commits into from
Closed

GH-112498 Add heapremove and heapfix #112550

Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
d1d7b6a
Add the heapremove() function
kristjanvalur Nov 28, 2023
344a35a
fixes
kristjanvalur Nov 28, 2023
5b79953
whitespace
kristjanvalur Nov 28, 2023
e4ffa87
Add operations count test
kristjanvalur Nov 28, 2023
2af67d7
documentation
kristjanvalur Nov 28, 2023
9a83767
fix doc
kristjanvalur Nov 28, 2023
c646dc3
use heapremove/heapfix as separate functions
kristjanvalur Nov 30, 2023
acd9e06
docs
kristjanvalur Nov 30, 2023
5cdb92a
whitespace
kristjanvalur Nov 30, 2023
b297445
fixup
kristjanvalur Dec 1, 2023
08cc0f6
Fix negative index heapremove
kristjanvalur Dec 1, 2023
352764b
heapremove now performs a comparison to do either "siftup" _or_ "sift…
kristjanvalur Jan 2, 2024
bbd45a7
remove heapq.heapfix()
kristjanvalur Jan 3, 2024
11dc5f9
Rename heapremove() to heapremove_index()
kristjanvalur Jan 3, 2024
7dbceb0
Add heapremove()
kristjanvalur Jan 3, 2024
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
Prev Previous commit
Next Next commit
docs
  • Loading branch information
@kristjanvalur
kristjanvalur committed Jan 5, 2024
commit acd9e06dea298b7b79fe6de715821459fe9a089e
19 changes: 11 additions & 8 deletions Doc/library/heapq.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ The following functions are provided:
invariant. If the heap is empty, :exc:`IndexError` is raised. To access the
smallest item without popping it, use ``heap[0]``.

This is equivalent to performing ``heapremove(heap, 0)``.


.. function:: heappushpop(heap, item)

Expand Down Expand Up @@ -80,17 +82,18 @@ The following functions are provided:
on the heap.


.. function:: heapremove(heap, index, item=None):
.. function:: heapremove(heap, index):

Remove the item at ``heap[index]`` while maintaining the heap invariant.

Returns the removed item.

.. versionadded:: 3.13

@StanFromIreland StanFromIreland Sep 27, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please change these to next


Remove the item at ``heap[index]``, optionally replacing it with *item*,
while maintaining the heap invariant.

This is more efficient than performing ``del heap[index]`` followed
by :func:`heapify`.
.. function:: heapfix(heap, index):

In case an items *value* has changed and its index is known, this
function can be used to restore the heap invariant:
``heapremove(heap, item_index, item)``
Restore the heap invariant after the object at ``heap[index]`` has been modified.

.. versionadded:: 3.13

Expand Down