torch.linalg.matrix_rank

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

Вычисляет числовой ранг матрицы.

Ранг матрицы вычисляется как количество сингулярных значений (или собственных значений по абсолютной величине, когда hermitian= True) превышающих порог $\max(\text{atol}, \sigma_1 * \text{rtol})$, где $\sigma_1$ — наибольшее сингулярное значение (или собственное значение).

Поддерживает входные типы данных float, double, cfloat и cdouble. Также поддерживает пакеты матриц, и если A — пакет матриц, то выходные данные имеют те же размерности пакета.

Если hermitian= True, то A предполагается эрмитовой, если комплексной, или симметричной, если вещественной, но это не проверяется внутренне. Вместо этого используется только нижняя треугольная часть матрицы в вычислениях.

Если rtol не указано и A — матрица размерности (m, n), то относительная погрешность устанавливается в $\text{rtol} = \max(m, n) \varepsilon$, и $\varepsilon$ — значение epsilon для типа данных A (см. 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 (по умолчанию) и разложения по собственным значениям torch.linalg.eigvalsh(), когда hermitian= True. Когда входные данные находятся на устройстве CUDA, эта функция синхронизирует это устройство с процессором.

Параметры

• A (Тензор) – тензор размерности (*, m, n), где * — нуль или более размерностей пакета.
• tol (float, Тензор, необязательно) – [NumPy Compat] Псевдоним для atol. Значение по умолчанию: None.

Ключевые аргументы

• atol (float, Тензор, необязательно) – абсолютная величина допуска. Если None, то считается нулевой. Значение по умолчанию: None.
• rtol (float, Тензор, необязательно) – относительная величина допуска. Смотрите выше, какое значение она принимает, если None. Значение по умолчанию: None.
• hermitian (bool) – указывает, является ли 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]])