Shortcuts

torch.linalg.cholesky_ex

torch.linalg.cholesky_ex(A, *, upper=False, check_errors=False, out=None)

计算复数埃尔米特矩阵或实对称正定矩阵的Cholesky分解。

此函数跳过(慢速)错误检查和错误消息构造 的 torch.linalg.cholesky(),而是直接返回 LAPACK 错误代码作为命名元组 (L, info) 的一部分。这使得此函数 成为检查矩阵是否为正定矩阵的更快方法,并且它提供了 比 torch.linalg.cholesky() 更优雅或更高效地处理分解错误的机会。

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

如果 A 不是 Hermitian 正定矩阵,或者它是一个矩阵批次并且其中有一个或多个不是 Hermitian 正定矩阵, 那么 info 会为相应的矩阵存储一个正整数。 这个正整数表示不是正定矩阵的主子式的阶数, 并且分解无法完成。 info 填充为零表示分解成功。 如果 check_errors=True 并且 info 包含正整数,则会抛出 RuntimeError。

注意

当输入在CUDA设备上时,此函数仅在check_errors= True时同步。

警告

此函数是“实验性”的,它可能会在未来的 PyTorch 版本中发生变化。

另请参阅

torch.linalg.cholesky() 是一个与 NumPy 兼容的变体,始终检查错误。

Parameters

A (张量) – 厄米特 n 乘 n 矩阵或大小为 (*, n, n) 的此类矩阵的批次,其中 * 是一个或多个批次维度。

Keyword Arguments
  • upper (bool, optional) – 是否返回一个上三角矩阵。 当 upper=True 时返回的张量是当 upper=False 时返回的张量的共轭转置。

  • check_errors (bool, 可选) – 控制是否检查infos的内容。默认值:False

  • out (tuple, 可选) – 用于写入输出的两个张量的元组。如果为None,则忽略。默认值:None

示例:

>>> A = torch.randn(2, 2, dtype=torch.complex128)
>>> A = A @ A.t().conj()  # 创建一个厄米特正定矩阵
>>> L, info = torch.linalg.cholesky_ex(A)
>>> A
tensor([[ 2.3792+0.0000j, -0.9023+0.9831j],
        [-0.9023-0.9831j,  0.8757+0.0000j]], dtype=torch.complex128)
>>> L
tensor([[ 1.5425+0.0000j,  0.0000+0.0000j],
        [-0.5850-0.6374j,  0.3567+0.0000j]], dtype=torch.complex128)
>>> info
tensor(0, dtype=torch.int32)
优云智算