`scipy.cluster.hierarchy:inconsistent`

source: /scipy/cluster/hierarchy.py :1719

Signature

def inconsistent ( Z , d = 2 )

Summary

Calculate inconsistency statistics on a linkage matrix.

Parameters

Z : ndarray: The $(n - 1)$ by 4 matrix encoding the linkage (hierarchical clustering). See linkage documentation for more information on its form.
d : int, optional: The number of links up to d levels below each non-singleton cluster.

Returns

R : ndarray: A $(n - 1)$ by 4 matrix where the i'th row contains the link statistics for the non-singleton cluster i. The link statistics are computed over the link heights for links $d$ levels below the cluster i. R[i,0] and R[i,1] are the mean and standard deviation of the link heights, respectively; R[i,2] is the number of links included in the calculation; and R[i,3] is the inconsistency coefficient,
$\frac{Z [ i , 2 ] - R [ i , 0 ]}{R [ i , 1 ]}$

Notes

This function behaves similarly to the MATLAB(TM) inconsistent function.

Array API Standard Support

inconsistent has experimental support for Python Array API Standard compatible backends in addition to NumPy. Please consider testing these features by setting an environment variable SCIPY_ARRAY_API=1 and providing CuPy, PyTorch, JAX, or Dask arrays as array arguments. The following combinations of backend and device (or other capability) are supported.

====================  ====================  ====================
Library               CPU                   GPU
====================  ====================  ====================
NumPy                 ✅                     n/a                 
CuPy                  n/a                   ⛔                   
PyTorch               ✅                     ⛔                   
JAX                   ✅                     ⛔                   
Dask                  ⚠️ merges chunks      n/a                 
====================  ====================  ====================

See dev-arrayapi for more information.

Examples

from scipy.cluster.hierarchy import inconsistent, linkage
from matplotlib import pyplot as plt
X = [[i] for i in [2, 8, 0, 4, 1, 9, 9, 0]]
Z = linkage(X, 'ward')

✓

print(Z)
inconsistent(Z)

✗

Aliases

scipy.cluster.hierarchy.inconsistent