naginterfaces.library.mv.distance_​mat

naginterfaces.library.mv.distance_mat(update, dist, scal, x, isx, s, d)

distance_mat computes a distance (dissimilarity) matrix.

For full information please refer to the NAG Library document for g03ea

https://support.nag.com/numeric/nl/nagdoc_30.3/flhtml/g03/g03eaf.html

Parameters

updatestr, length 1

Indicates whether or not an existing matrix is to be updated.

$update=\text{'U'}$

The matrix $D$ is updated and distances are added to $D$.

$update=\text{'I'}$

The matrix $D$ is initialized to zero before the distances are added to $D$.

diststr, length 1

Indicates which type of distances are computed.

$dist=\text{'A'}$

Absolute distances.

$dist=\text{'E'}$

Euclidean distances.

$dist=\text{'S'}$

Euclidean squared distances.

scalstr, length 1

Indicates the standardization of the variables to be used.

$scal=\text{'S'}$

Standard deviation.

$scal=\text{'R'}$

Range.

$scal=\text{'G'}$

Standardizations given in array $s$.

$scal=\text{'U'}$

Unscaled.

xfloat, array-like, shape $(n,m)$

$x[\text{i}-1,\text{j}-1]$ must contain the value of the $\text{j}$th variable for the $\text{i}$th object, for $\text{j}=1,2,\dots ,m$, for $\text{i}=1,2,\dots ,n$.

isxint, array-like, shape $\left(m\right)$

$isx[j-1]$ indicates whether or not the $j$th variable in $x$ is to be included in the distance computations.

If $isx[\text{j}-1]>0$ the $\text{j}$th variable is included, for $\text{j}=1,2,\dots ,m$; otherwise it is not referenced.

sfloat, array-like, shape $\left(m\right)$

If $scal=\text{'G'}$ and $isx[\text{j}-1]>0$ then $s[\text{j}-1]$ must contain the scaling for variable $\text{j}$, for $\text{j}=1,2,\dots ,m$.

dfloat, array-like, shape $(n\times (n-1)/2)$

If $update=\text{'U'}$, $d$ must contain the strictly lower triangle of the distance matrix $D$ to be updated. $D$ must be stored packed by rows, i.e., $d[(i-1)(i-2)/2+j-1]$, $i>j$ must contain $d_{ij}$.

If $update=\text{'I'}$, $d$ need not be set.

Returns

sfloat, ndarray, shape $\left(m\right)$

If $scal=\text{'S'}$ and $isx[j-1]>0$ then $s[j-1]$ contains the standard deviation of the variable in the $j$th column of $x$.

If $scal=\text{'R'}$ and $isx[j-1]>0$, $s[j-1]$ contains the range of the variable in the $j$th column of $x$.

If $scal=\text{'U'}$ and $isx[j-1]>0$, $s[j-1]=1.0$.

If $scal=\text{'G'}$, $s$ is unchanged.

dfloat, ndarray, shape $(n\times (n-1)/2)$

The strictly lower triangle of the distance matrix $D$ stored packed by rows, i.e., $d_{ij}$ is contained in $d[(i-1)(i-2)/2+j-1]$, $i>j$.

Raises

NagValueError

(errno $1$)

On entry, $scal=⟨value⟩$.

Constraint: $scal=\text{'S'}$, $\text{'R'}$, $\text{'G'}$ or $\text{'U'}$.

(errno $1$)

On entry, $update=⟨value⟩$.

Constraint: $update=\text{'U'}$ or $\text{'I'}$.

(errno $1$)

On entry, $dist=⟨value⟩$.

Constraint: $dist=\text{'A'}$, $\text{'E'}$ or $\text{'S'}$

(errno $1$)

On entry, $m=⟨value⟩$.

Constraint: $m>0$.

(errno $1$)

On entry, $n=⟨value⟩$.

Constraint: $n\ge 2$.

(errno $2$)

On entry, at least one element of $s\le 0.0$.

(errno $2$)

Variable $⟨value⟩$ is constant.

(errno $2$)

On entry, at least one element of $d<0.0$.

(errno $2$)

On entry, $isx$ does not contain a positive element.

Notes

In the NAG Library the traditional C interface for this routine uses a different algorithmic base. Please contact NAG if you have any questions about compatibility.

Given $n$ objects, a distance or dissimilarity matrix is a symmetric matrix with zero diagonal elements such that the $ij$th element represents how far apart or how dissimilar the $i$th and $j$th objects are.

Let $X$ be an $n\times p$ data matrix of observations of $p$ variables on $n$ objects, then the distance between object $j$ and object $k$, $d_{jk}$, can be defined as:

$$d_{jk}={\left\{\sum _{i=1}^{p}D(x_{ji}/s_i,x_{ki}/s_i)\right\}}^{\alpha }\text{,}$$

where $x_{ji}$ and $x_{ki}$ are the $ji$th and $ki$th elements of $X$, $s_i$ is a standardization for the $i$th variable and $D(u,v)$ is a suitable function. Three functions are provided in distance_mat.

1. Euclidean distance: $D(u,v)={(u-v)}^2$ and $\alpha =\frac{1}{2}$.

2. Euclidean squared distance: $D(u,v)={(u-v)}^2$ and $\alpha =1$.

3. Absolute distance (city block metric): $D(u,v)=|u-v|$ and $\alpha =1$.

Three standardizations are available.

1. Standard deviation: $s_i=\sqrt{{\sum }_{j=1}^n{(x_{ji}-\overline{x})}^2/(n-1)}$

2. Range: $s_i=max(x_{1i},x_{2i},\dots ,x_{ni})-min(x_{1i},x_{2i},\dots ,x_{ni})$

3. User-supplied values of $s_i$.

In addition to the above distances there are a large number of other dissimilarity measures, particularly for dichotomous variables (see Krzanowski (1990) and Everitt (1974)). For the dichotomous case these measures are simple to compute and can, if suitable scaling is used, be combined with the distances computed by distance_mat using the updating option.

Dissimilarity measures for variables can be based on the correlation coefficient for continuous variables and contingency table statistics for dichotomous data, see submodule correg and submodule contab respectively.

distance_mat returns the strictly lower triangle of the distance matrix.

References

Everitt, B S, 1974, Cluster Analysis, Heinemann

Krzanowski, W J, 1990, Principles of Multivariate Analysis, Oxford University Press