torch.linalg.matrix_rank

torch.linalg.matrix_rank(A, *, atol=None, rtol=None, hermitian=False, out=None) → Tensor

計算矩陣的數值秩。

矩陣的秩計算方式為，大於閾值的奇異值（若 hermitian= True 則為絕對值中的特徵值）的數量，閾值為 $\max(\text{atol}, \sigma_1 * \text{rtol})$，其中 $\sigma_1$ 是最大的奇異值（或特徵值）。

支援 float、double、cfloat 和 cdouble 數據類型的輸入。 也支援批次矩陣，且如果 A 是一批矩陣，則輸出具有相同的批次維度。

如果 hermitian= True，則假設 A 在複數情況下為 Hermitian，在實數情況下為對稱，但內部不會進行檢查。 相反，計算中僅使用矩陣的下三角部分。

如果未指定 rtol 且 A 是維度為 (m, n) 的矩陣，則相對容差設定為 $\text{rtol} = \max(m, n) \varepsilon$，且 $\varepsilon$ 是 A 的 dtype 的 epsilon 值（請參閱 finfo）。 如果未指定 rtol 且指定 atol 大於零，則 rtol 會設定為零。

如果 atol 或 rtol 是 torch.Tensor，則其形狀必須可廣播到 torch.linalg.svdvals() 傳回的 A 的奇異值。

注意

此函式具有 NumPy 相容的變體 linalg.matrix_rank(A, tol, hermitian=False)。 但是，不建議使用位置引數 tol，建議改用 atol 和 rtol。

注意

如果 hermitian= False（預設值），則使用奇異值分解 torch.linalg.svdvals() 計算矩陣的秩，如果 hermitian= True，則使用特徵值分解 torch.linalg.eigvalsh() 計算矩陣的秩。 當輸入位於 CUDA 裝置上時，此函式會將該裝置與 CPU 同步。

參數

• A (Tensor) – 形狀為 (*, m, n) 的 tensor，其中 * 是零個或多個批次維度。

• tol (float, Tensor, optional) – [NumPy 相容] atol 的別名。 預設值：None。

關鍵字引數

• atol (float, Tensor, optional) – 絕對容差值。 當 None 時，會被視為零。 預設值：None。

• rtol (float, Tensor, optional) – 相對容差值。 有關 None 時所取的值，請參閱上文。 預設值：None。

• hermitian (bool) – 指示 A 在複數情況下是否為 Hermitian，在實數情況下是否為對稱。 預設值：False。

• out (Tensor, optional) – 輸出 tensor。 如果 None，則會被忽略。 預設值：None。

範例

>>> A = torch.eye(10)
>>> torch.linalg.matrix_rank(A)
tensor(10)
>>> B = torch.eye(10)
>>> B[0, 0] = 0
>>> torch.linalg.matrix_rank(B)
tensor(9)

>>> A = torch.randn(4, 3, 2)
>>> torch.linalg.matrix_rank(A)
tensor([2, 2, 2, 2])

>>> A = torch.randn(2, 4, 2, 3)
>>> torch.linalg.matrix_rank(A)
tensor([[2, 2, 2, 2],
        [2, 2, 2, 2]])

>>> A = torch.randn(2, 4, 3, 3, dtype=torch.complex64)
>>> torch.linalg.matrix_rank(A)
tensor([[3, 3, 3, 3],
        [3, 3, 3, 3]])
>>> torch.linalg.matrix_rank(A, hermitian=True)
tensor([[3, 3, 3, 3],
        [3, 3, 3, 3]])
>>> torch.linalg.matrix_rank(A, atol=1.0, rtol=0.0)
tensor([[3, 2, 2, 2],
        [1, 2, 1, 2]])
>>> torch.linalg.matrix_rank(A, atol=1.0, rtol=0.0, hermitian=True)
tensor([[2, 2, 2, 1],
        [1, 2, 2, 2]])