circuitpython/docs/library/heapq.rst

:mod:`heapq` -- heap queue algorithm
====================================

.. include:: ../templates/unsupported_in_circuitpython.inc

.. module:: heapq
   :synopsis: heap queue algorithm

|see_cpython_module| :mod:`python: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.
docs: Replace ufoo with foo in all docs. Anywhere a module is mentioned, use its "non-u" name for consistency. The "import module" vs "import umodule" is something of a FAQ, and this commit intends to help clear that up. As a first approximation MicroPython is Python, and so imports should work the same as Python and use the same name, to a first approximation. The u-version of a module is a detail that can be learned later on, when the user wants to understand more and have finer control over importing. Existing Python code should just work, as much as it is possible to do that within the constraints of embedded systems, and the MicroPython documentation should match the idiomatic way to write Python code. With universal weak links for modules (via MICROPY_MODULE_WEAK_LINKS) users can consistently use "import foo" across all ports (with the exception of the minimal ports). And the ability to override/extend via "foo.py" continues to work well. Signed-off-by: Jim Mussared <jim.mussared@gmail.com> 2021-08-11 23:59:29 -04:00			:mod:`heapq` -- heap queue algorithm
			`====================================`
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory. 2014-10-30 21:37:19 -04:00
Delete a bunch of docs, drivers and examples not relevant to CircuitPython. This fixes #345 and fixes #215. 2018-02-20 20:34:59 -05:00			`.. include:: ../templates/unsupported_in_circuitpython.inc`

docs: Replace ufoo with foo in all docs. Anywhere a module is mentioned, use its "non-u" name for consistency. The "import module" vs "import umodule" is something of a FAQ, and this commit intends to help clear that up. As a first approximation MicroPython is Python, and so imports should work the same as Python and use the same name, to a first approximation. The u-version of a module is a detail that can be learned later on, when the user wants to understand more and have finer control over importing. Existing Python code should just work, as much as it is possible to do that within the constraints of embedded systems, and the MicroPython documentation should match the idiomatic way to write Python code. With universal weak links for modules (via MICROPY_MODULE_WEAK_LINKS) users can consistently use "import foo" across all ports (with the exception of the minimal ports). And the ability to override/extend via "foo.py" continues to work well. Signed-off-by: Jim Mussared <jim.mussared@gmail.com> 2021-08-11 23:59:29 -04:00			`.. module:: heapq`
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory. 2014-10-30 21:37:19 -04:00			`:synopsis: heap queue algorithm`

docs/library: Add CPython docs xref to each pertinent module. Cross-reference text/link is implemented as RST substitution, so easy to consistently. 2017-07-02 08:37:31 -04:00			\|see_cpython_module\| :mod:`python:heapq`.

docs/library: Clarify what type of algorithm is implemented in heapq. 2021-05-16 23:11:44 -04:00			`This module implements the`
			`min heap queue algorithm <https://en.wikipedia.org/wiki/Heap_%28data_structure%29>`_.
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory. 2014-10-30 21:37:19 -04:00
docs/library: Clarify what type of algorithm is implemented in heapq. 2021-05-16 23:11:44 -04:00			`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.`
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory. 2014-10-30 21:37:19 -04:00
			`Functions`
			`---------`

			`.. function:: heappush(heap, item)`

			Push the ``item`` onto the ``heap``.

			`.. function:: heappop(heap)`

docs/library: Clarify what type of algorithm is implemented in heapq. 2021-05-16 23:11:44 -04:00			Pop the first item from the ``heap``, and return it. Raise ``IndexError`` if
			``heap`` is empty.
Merge tag 'v1.16' 2021-06-18 11:54:19 -04:00
docs/library: Clarify what type of algorithm is implemented in heapq. 2021-05-16 23:11:44 -04:00			The returned item will be the smallest item in the ``heap``.
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory. 2014-10-30 21:37:19 -04:00
			`.. function:: heapify(x)`

			Convert the list ``x`` into a heap. This is an in-place operation.