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 不是 Hermitian 正定矩阵，或者如果它是批处理矩阵且其中一个或多个不是 Hermitian 正定矩阵，则 info 会为相应的矩阵存储一个正整数。该正整数表示不是正定的主子式的阶数，并且分解无法完成。 info 中填充零表示分解成功。如果 check_errors=True 且 info 包含正整数，则会引发 RuntimeError。

注意

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

警告

此函数是“实验性”的，它可能会在将来的 PyTorch 版本中更改。

另请参阅

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

参数

A (Tensor) – Hermitian n times n 矩阵或尺寸为 (*, n, n) 的批处理矩阵，其中 * 表示一个或多个批处理维度。

关键字参数

• upper (bool, 可选) – 是否返回上三角矩阵。当 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()  # 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)