:py:mod:`nessai.utils.distance`
===============================

.. py:module:: nessai.utils.distance

.. autoapi-nested-parse::

   Utilities for computing distances.

   ..
       !! processed by numpydoc !!


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


Functions
~~~~~~~~~

.. autoapisummary::

   nessai.utils.distance.compute_minimum_distances



.. py:function:: compute_minimum_distances(samples, metric='euclidean')

   
   Compute the distance to the nearest neighbour of each sample


   :Parameters:

       **samples** : array_like
           Array of samples.

       **metric** : str, optional
           Metric to use. See scipy docs for list of metrics:
           https://docs.scipy.org/doc/scipy/reference/generated/scipy.spatial.distance.cdist.html

   :Returns:

       array_like
           Distance to nearest neighbour for each sample.













   ..
       !! processed by numpydoc !!