scipy.cluster.hierarchy.

is_valid_linkage#

scipy.cluster.hierarchy.is_valid_linkage(Z, warning=False, throw=False, name=None)[源代码]#

检查链接矩阵的有效性。

如果链接矩阵是具有 \(n\) 行和 4 列的二维数组(类型为 double),则该矩阵有效。前两列必须包含 0 到 \(2n-1\) 之间的索引。对于给定的行 i,以下两个表达式必须成立

\[0 \leq \mathtt{Z[i,0]} \leq i+n-1 0 \leq Z[i,1] \leq i+n-1\]

也就是说,除非被连接的集群已经生成,否则集群不能加入另一个集群。

参数:
Zarray_like

链接矩阵。

warningbool, 可选

当为 True 时,如果传递的链接矩阵无效,则发出 Python 警告。

throwbool, 可选

当为 True 时,如果传递的链接矩阵无效,则抛出 Python 异常。

namestr, 可选

此字符串指的是无效链接矩阵的变量名。

返回:
bbool

如果一致性矩阵有效,则为 True。

另请参阅

linkage

有关链接矩阵的描述。

示例

>>> from scipy.cluster.hierarchy import ward, is_valid_linkage
>>> from scipy.spatial.distance import pdist

此模块中聚类方法生成的所有链接矩阵都是有效的(即,它们将具有适当的维度,并且所有行都将满足两个必需的表达式)。

我们可以使用 scipy.cluster.hierarchy.is_valid_linkage 来检查这一点

>>> X = [[0, 0], [0, 1], [1, 0],
...      [0, 4], [0, 3], [1, 4],
...      [4, 0], [3, 0], [4, 1],
...      [4, 4], [3, 4], [4, 3]]
>>> Z = ward(pdist(X))
>>> Z
array([[ 0.        ,  1.        ,  1.        ,  2.        ],
       [ 3.        ,  4.        ,  1.        ,  2.        ],
       [ 6.        ,  7.        ,  1.        ,  2.        ],
       [ 9.        , 10.        ,  1.        ,  2.        ],
       [ 2.        , 12.        ,  1.29099445,  3.        ],
       [ 5.        , 13.        ,  1.29099445,  3.        ],
       [ 8.        , 14.        ,  1.29099445,  3.        ],
       [11.        , 15.        ,  1.29099445,  3.        ],
       [16.        , 17.        ,  5.77350269,  6.        ],
       [18.        , 19.        ,  5.77350269,  6.        ],
       [20.        , 21.        ,  8.16496581, 12.        ]])
>>> is_valid_linkage(Z)
True

但是,如果我们以错误的方式创建链接矩阵 - 或者如果我们以任何所需表达式不再成立的方式修改有效的链接矩阵,则检查将失败

>>> Z[3][1] = 20    # the cluster number 20 is not defined at this point
>>> is_valid_linkage(Z)
False