This is documentation for an old release of SciPy (version 0.10.0). Read this page Search for this page in the documentation of the latest stable release (version 1.15.1).

scipy.spatial.distance.correlation¶

scipy.spatial.distance.correlation(u, v)¶

Computes the correlation distance between two n-vectors u and v, which is defined as

$1 - frac{(u - \bar{u}){(v - \bar{v})}^T} {{||(u - \bar{u})||}_2 {||(v - \bar{v})||}_2^T}$

where $\bar{u}$ is the mean of a vectors elements and n is the common dimensionality of u and v.

Parameters :

u : ndarray

An $n$ -dimensional vector.

v : ndarray

An $n$ -dimensional vector.

Returns :

d : double

The correlation distance between vectors u and v.