zen_mapper.mapper
=================

.. py:module:: zen_mapper.mapper


Functions
---------

.. autoapisummary::

   zen_mapper.mapper.mapper


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

.. py:function:: mapper(data: numpy.ndarray, projection: numpy.ndarray, cover_scheme: zen_mapper.types.CoverScheme, clusterer: zen_mapper.types.Clusterer[M], dim: int | None, min_intersection: int = 1) -> zen_mapper.types.MapperResult[M]

   Constructs a simplicial complex representation of the data.

   :param data:
   :type data: np.ndarray
   :param projection: The output of the lens/filter function on the data. Must have the same
                      number of elements as data.
   :type projection: np.ndarray
   :param cover_scheme: For cover generation. Should be a callable object that takes a
                        numpy array and returns a list of list(indices).
   :type cover_scheme: CoverScheme
   :param clusterer: A callable object that takes in a dataset and returns an iterator of
                     numpy arrays which contain indices for clustered points.
   :type clusterer: Clusterer
   :param dim: The highest dimension of the mapper complex to compute.
   :type dim: int
   :param min_intersection: The minimum intersection required between clusters to make a simplex.
   :type min_intersection: int

   :returns: An object containing:
             - nodes: List of clusters where each cluster is a list of data indices.
             - nerve: A complete list of simplices.
             - cover: List of list(indices) corresponding to elements of the cover.
   :rtype: MapperResult