torch.linalg.matrix_rank

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

计算矩阵的数值秩。

矩阵秩是大于阈值的奇异值（或当 hermitian 为真时，绝对值大于阈值的特征值）的数量，其中 $\sigma_1$ 是最大的奇异值（或特征值）。

支持输入 float、double、cfloat 和 cdouble 数据类型。也支持矩阵批处理，如果 A 是矩阵批，则输出具有相同的批维度。

如果 hermitian 为真，则假设 A 是复数时的厄米矩阵或实数时的对称矩阵，但内部并不进行检查。相反，仅使用矩阵的下三角部分进行计算。

如果未指定 rtol 且 A 是一个维度为（m，n）的矩阵，则相对容差设置为 $\text{rtol} = \max(m, n) \varepsilon$ ， $\varepsilon$ 是 A 数据类型的 epsilon 值（参见 finfo ）。如果未指定 rtol 且 atol 指定为大于零，则 rtol 设置为零。

如果 atol 或 rtol 是 torch.Tensor ，则其形状必须可以广播到 A 的奇异值形状，由 torch.linalg.svdvals() 返回。

注意

此函数有 NumPy 兼容的变体 linalg.matrix_rank(A, tol, hermitian=False)。但是，使用位置参数 tol 已被弃用，改为使用 atol 和 rtol 。

注意

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

参数:

• A（张量）- 形状为(*, m, n)的张量，其中*表示零个或多个批处理维度。

• tol（float，Tensor，可选）- [NumPy 兼容] atol 的别名。默认：None。

关键字参数:

• atol（float，Tensor，可选）- 绝对容差值。当为 None 时，视为零。默认：None。

• rtol（浮点数，张量，可选）- 相对容差值。参见上方，了解 None 时取的值。默认：None。

• hermitian（布尔值）- 表示 A 是否为复数的厄米特或实数的对称。默认：False。

• out（张量，可选）- 输出张量。如果为 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]])