oasislmf.pytools.aal.utils
==========================

.. py:module:: oasislmf.pytools.aal.utils


Functions
---------

.. autoapisummary::

   oasislmf.pytools.aal.utils.heap_push
   oasislmf.pytools.aal.utils.heap_pop
   oasislmf.pytools.aal.utils.init_heap
   oasislmf.pytools.aal.utils.exact_binary_search


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)

   Initialise heap


.. py:function:: exact_binary_search(arr, value)

   if no match is found return len(arr) instead of the insert index like in normal binary search
   >>> exact_binary_search(np.array([1,3,5,7,9]), 3)
   1

   >>> exact_binary_search(np.array([1,3,5,7,9]), 0)
   5

   >>> exact_binary_search(np.array([1,3,5,7,9]), 4)
   5

   >>> exact_binary_search(np.array([1,3,5,7,9]), 9)
   4