Module « scipy.spatial.distance »

Fonction correlation - module scipy.spatial.distance

Signature de la fonction correlation

def correlation(u, v, w=None, centered=True) 

Description

correlation.__doc__

    Compute the correlation distance between two 1-D arrays.

    The correlation distance between `u` and `v`, is
    defined as

    .. math::

        1 - \frac{(u - \bar{u}) \cdot (v - \bar{v})}
                  {{||(u - \bar{u})||}_2 {||(v - \bar{v})||}_2}

    where :math:`\bar{u}` is the mean of the elements of `u`
    and :math:`x \cdot y` is the dot product of :math:`x` and :math:`y`.

    Parameters
    ----------
    u : (N,) array_like
        Input array.
    v : (N,) array_like
        Input array.
    w : (N,) array_like, optional
        The weights for each value in `u` and `v`. Default is None,
        which gives each value a weight of 1.0
    centered : bool, optional
        If True, `u` and `v` will be centered. Default is True.

    Returns
    -------
    correlation : double
        The correlation distance between 1-D array `u` and `v`.