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 时为特征值绝对值）的数量。

支持 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。

注意

当 hermitian= False（默认）时，矩阵秩通过奇异值分解 torch.linalg.svdvals() 计算；当 hermitian= True 时，通过特征值分解 torch.linalg.eigvalsh() 计算。当输入在 CUDA 设备上时，此函数会同步该设备与 CPU。

参数

• A (Tensor) – 形状为 (*, m, n) 的张量，其中 * 是零个或多个批处理维度。

• tol (float, Tensor, optional) – [NumPyCompat] atol 的别名。默认值：None。

关键字参数

• atol (float, Tensor, optional) – 绝对容差值。当值为 None 时，视为零。默认值：None。

• rtol (float, Tensor, optional) – 相对容差值。有关 None 值的情况，请参见上文。默认值：None。

• hermitian (bool) – 指示当 A 为复数时是否为厄米矩阵，或当 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]])