torch.linalg.matrix_rank¶

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

计算矩阵的数值秩。

矩阵的秩计算为大于 $\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同步该设备。

Parameters

A (张量) – 形状为 (*, m, n) 的张量，其中 * 表示零个或多个批次维度。
tol (浮点数, 张量, 可选) – [NumPy 兼容] atol 的别名。默认值: 无。

Keyword Arguments

atol (float, Tensor, 可选) – 绝对容差值。当为None时，视为零。默认值: None。
rtol (float, Tensor, 可选) – 相对容差值。参见上文以了解当 None 时的取值。默认值: None。
hermitian (bool) – 指示 A 是否为复数时的Hermitian或实数时的对称。默认值：False。
输出 (张量, 可选) – 输出张量。如果为无，则忽略。默认值：无。

示例：

>>> 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]])