評價此頁

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=Trueinfo 包含正整數,則會丟擲 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)