torch.linalg.matrix_rank

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

計算矩陣的數值秩。

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

支援浮點 (float)、雙精度浮點 (double)、複數浮點 (cfloat) 和複數雙精度浮點 (cdouble) 資料型別。還支援矩陣批處理，如果 `A` 是一個矩陣批處理，則輸出具有相同的批處理維度。

如果 hermitian= True，則假設 A 是厄米矩陣（如果為複數）或對稱矩陣（如果為實數），但內部不會進行檢查。而是僅使用矩陣的下三角部分進行計算。

如果未指定 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。

注意

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

引數

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

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

關鍵字引數

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

• rtol (float, Tensor, optional) – 相對容差值。有關 None 時其取值，請參見上文。預設為 None。

• hermitian (bool) – 表明 A 是否為厄米矩陣（如果為複數）或對稱矩陣（如果為實數）。預設為 False。

• out (Tensor, optional) – 輸出張量。如果為 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]])