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 数据类型的 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（默认）），当 hermitian= True 时，使用特征值分解 torch.linalg.eigvalsh() 计算。当输入位于 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]])