skbio.stats.distance.DistanceMatrix.from_iterable

classmethod DistanceMatrix.from_iterable(iterable, metric, key=None, keys=None, validate=True)[源代码]

从给定度量的迭代数中的所有对创建距离矩阵。

状态:从0.4.1开始试验。

参数:
  • iterable (iterable) -- 包含要计算成对距离的对象的Iterable。

  • metric (callable) -- 接受两个参数并返回表示两个参数之间距离的浮点数的函数。

  • key (callable or metadata key, optional) -- 接受一个参数并返回表示距离矩阵中元素ID的字符串的函数。或者,还可以使用 metadata 属性中的每个元素都存在 iterable 。如果无,则将使用默认ID。

  • keys (iterable, optional) -- 与的长度相同的迭代数 iterable 。每个元素都将用作各自的密钥。

  • validate (boolean, optional) -- 如果 True ,将计算所有成对距离,包括上、下三角形和对角线,并验证生成的矩阵的对称性和中空性。如果 Falsemetric 假定为中空和对称,并且只计算下三角形(不包括对角线)。经过 validate=False 如果你确定 metric 是中空和对称的,以提高性能。

返回:

这个 metric 中的成对元素。 iterable

返回类型:

DistanceMatrix

抛出:

ValueError -- 如果 keykeys 两者都提供了。