torch.linalg.cholesky_ex

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

计算复数 Hermitian 或实数对称正定矩阵的 Cholesky 分解。

此函数跳过了 torch.linalg.cholesky() 中（耗时的）错误检查和错误消息构建，而是直接将 LAPACK 错误码作为命名元组 (L, info) 的一部分返回。这使得该函数成为检查矩阵是否为正定矩阵的更快捷方式，并提供了比 torch.linalg.cholesky() 更优雅或更高效地处理分解错误的机会。

支持浮点 (float)、双精度浮点 (double)、复数浮点 (cfloat) 和复数双精度浮点 (cdouble) 数据类型。还支持矩阵批处理，如果 `A` 是一个矩阵批处理，则输出具有相同的批处理维度。

如果 A 不是厄米正定矩阵，或者它是一个矩阵批次，其中一个或多个不是厄米正定矩阵，那么 info 会存储对应矩阵的一个正整数。该正整数表示未正定的主子式顺序，并且分解未能完成。info 填充零表示分解成功。如果 check_errors=True 且 info 包含正整数，则会抛出 RuntimeError。

注意

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

警告

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

另请参阅

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

参数

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

关键字参数

• upper (bool, optional) – 是否返回上三角矩阵。使用 upper=True 返回的张量是使用 upper=False 返回的张量的共轭转置。

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

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

示例

>>> A = torch.randn(2, 2, dtype=torch.complex128)
>>> A = A @ A.t().conj()  # creates a Hermitian positive-definite matrix
>>> 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)