zen_mapper.cover
================

.. py:module:: zen_mapper.cover


Classes
-------

.. autoapisummary::

   zen_mapper.cover.Width_Balanced_Cover


Functions
---------

.. autoapisummary::

   zen_mapper.cover.precomputed_cover
   zen_mapper.cover.rectangular_cover


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

.. py:function:: precomputed_cover(cover: zen_mapper.types.Cover) -> zen_mapper.types.CoverScheme

   A precomputed cover

   :param cover: the precomputed cover to use
   :type cover: Cover


.. py:function:: rectangular_cover(centers, widths, data, tol=1e-09)

.. py:class:: Width_Balanced_Cover(n_elements: numpy.typing.ArrayLike, percent_overlap: float)

   A cover comprised of equally sized rectangular elements

   :param n_elements: the number of covering elements along each dimension. If the data is
                      dimension d this results in d^n covering elements.
   :type n_elements: ArrayLike
   :param percent_overlap: a number between 0 and 1 representing the ammount of overlap between
                           adjacent covering elements.
   :type percent_overlap: float

   :raises Value Error: if n_elements < 1
   :raises Value Error: if percent_overlap is not in (0,1)


   .. py:attribute:: n_elements


   .. py:attribute:: percent_overlap


   .. py:method:: __call__(data)