scipy.spatial.distance.

is_valid_y#

scipy.spatial.distance.is_valid_y(y, warning=False, throw=False, name=None)[source]#

如果輸入陣列是有效的壓縮距離矩陣,則返回 True。

壓縮距離矩陣必須是 1 維 numpy 陣列。它們的長度必須是某個正整數 n 的二項式係數 \({n \choose 2}\)

參數:
yarray_like

壓縮距離矩陣。

warningbool, optional

如果傳遞的變數不是有效的壓縮距離矩陣,則調用警告。警告訊息會解釋距離矩陣無效的原因。name 用於引用違規變數。

throwbool, optional

如果傳遞的變數不是有效的壓縮距離矩陣,則拋出例外。

namebool, optional

用於在警告或例外訊息中引用違規變數。

返回:
bool

如果輸入陣列是有效的壓縮距離矩陣,則為 True,否則為 False。

範例

>>> from scipy.spatial.distance import is_valid_y

這個向量是有效的壓縮距離矩陣。長度為 6,對應於 n = 4,因為 4*(4 - 1)/2 是 6。

>>> v = [1.0, 1.2, 1.0, 0.5, 1.3, 0.9]
>>> is_valid_y(v)
True

長度為 7 的輸入向量不是有效的壓縮距離矩陣。

>>> is_valid_y([1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7])
False