34 lines
876 B
ReStructuredText
34 lines
876 B
ReStructuredText
:mod:`heapq` -- heap queue algorithm
|
|
====================================
|
|
|
|
.. include:: ../templates/unsupported_in_circuitpython.inc
|
|
|
|
.. module:: heapq
|
|
:synopsis: heap queue algorithm
|
|
|
|
|see_cpython_module| :mod:`cpython:heapq`.
|
|
|
|
This module implements the
|
|
`min heap queue algorithm <https://en.wikipedia.org/wiki/Heap_%28data_structure%29>`_.
|
|
|
|
A heap queue is essentially a list that has its elements stored in such a way
|
|
that the first item of the list is always the smallest.
|
|
|
|
Functions
|
|
---------
|
|
|
|
.. function:: heappush(heap, item)
|
|
|
|
Push the ``item`` onto the ``heap``.
|
|
|
|
.. function:: heappop(heap)
|
|
|
|
Pop the first item from the ``heap``, and return it. Raise ``IndexError`` if
|
|
``heap`` is empty.
|
|
|
|
The returned item will be the smallest item in the ``heap``.
|
|
|
|
.. function:: heapify(x)
|
|
|
|
Convert the list ``x`` into a heap. This is an in-place operation.
|