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

连接矩阵。

警告bool, 可选

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

抛出bool, 可选

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

名称str, 可选

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

返回:
b布尔

如果不一致矩阵有效,则为真。

参见

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