torch.lu_unpack

torch.lu_unpack(LU_data, LU_pivots, unpack_data=True, unpack_pivots=True, *, out=None)

将 lu_factor() 返回的 LU 分解结果解包为 P, L, U 矩阵。

另请参阅

lu() 返回 LU 分解得到的矩阵。它的梯度公式比先执行 lu_factor() 再执行 lu_unpack() 的方式更高效。

参数

• LU_data (Tensor) – 打包的 LU 分解数据

• LU_pivots (Tensor) – 打包的 LU 分解枢轴信息

• unpack_data (bool) – 指示是否应解包数据的标志。如果为 False，则返回的 L 和 U 是空张量。默认值：True

• unpack_pivots (bool) – 指示是否应将枢轴信息解包为置换矩阵 P 的标志。如果为 False，则返回的 P 是空张量。默认值：True

关键字参数

out (tuple, optional) – 包含三个张量的输出元组。如果为 None 则忽略。

返回值

一个命名元组 (P, L, U)

示例

>>> A = torch.randn(2, 3, 3)
>>> LU, pivots = torch.linalg.lu_factor(A)
>>> P, L, U = torch.lu_unpack(LU, pivots)
>>> # We can recover A from the factorization
>>> A_ = P @ L @ U
>>> torch.allclose(A, A_)
True

>>> # LU factorization of a rectangular matrix:
>>> A = torch.randn(2, 3, 2)
>>> LU, pivots = torch.linalg.lu_factor(A)
>>> P, L, U = torch.lu_unpack(LU, pivots)
>>> # P, L, U are the same as returned by linalg.lu
>>> P_, L_, U_ = torch.linalg.lu(A)
>>> torch.allclose(P, P_) and torch.allclose(L, L_) and torch.allclose(U, U_)
True