nb_heapq
========

.. py:module:: nb_heapq


Functions
---------

.. autoapisummary::

   nb_heapq.heap_push
   nb_heapq.heap_pop
   nb_heapq.init_heap


Module Contents
---------------

.. py:function:: heap_push(heap, size, element)

   Heapq heappush


.. py:function:: heap_pop(heap, size)

   Heapq heappop


.. py:function:: init_heap(num_rows=4, num_compare=1)

   Initialise heap with (num_compare + 2) * num_rows elements, where
   num_compare is the number of elements to order by in lexicographical
   order, and the remaining two elements are the file and row idxs

   Currently limited to dtype np.int32 as it is tricky to use custom dtypes