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 次 n 矩陣或大小為 (*, n, n) 的此類矩陣的批次，其中 * 是一個或多個批次維度。

關鍵字參數

• upper (bool, optional) – 是否傳回上三角矩陣。 以 upper=True 傳回的 tensor 是以 upper=False 傳回的 tensor 的共軛轉置。

• check_errors (bool, optional) – 控制是否檢查 infos 的內容。 預設值：False。

• out (tuple, optional) – 用於將輸出寫入的兩個 tensor 的元組。 如果為 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)