getrf (USM バージョン)#

m 行 n 列の一般行列の LU 分解を計算します。このルーチンは、oneapi::mkl::lapack 名前空間に属します。

説明 #

このルーチンは、 m 行 n 列の一般行列 A の LU 分解次のようにを形成します。

\[A = P*L*U,\]

ここで、P は順列行列、L は単位対角要素を持つ下三角行列 (m > n の場合は下台形行列) であり、U は上三角行列 m < n の場合は上台形行列) です。このルーチンは、行の交換を伴う部分ピボットを使用します。

API #

構文#

namespace oneapi::mkl::lapack { 
  sycl::event getrf(sycl::queue &queue, 
  int64_t m, 
  int64_t n, 
  T *a, 
  int64_t lda, 
  int64_t *ipiv, 
  T *scratchpad, 
  int64_t scratchpad_size, 
  const std::vector<sycl::event> &events = {}) 
}

getrf (USM バージョン) は、次の精度とデバイスをサポートします。

T	デバイスサポート
`float`	CPU、GPU*
`double`	CPU、GPU*
`std::complex<float>`	CPU、GPU*
`std::complex<double>`	CPU、GPU*

* ハイブリッドのサポート。計算の一部は CPU 上で実行されます。

入力パラメーター#

queue: 計算が実行されるデバイスキュー。
m: 行列 A の行数 (0 ≤ m)。
n: 行列 A の列数 (0 ≤ n)。
a: 入力行列 A を保持する配列へのポインター。配列のサイズは lda * max(1, n) 以上である必要があります。
lda: a の先頭次元 (lda ≥ max(1, m))。
scratchpad: ルーチンが中間結果を保存するスクラッチパッド・メモリーへのポインター。
scratchpad_size: T タイプの浮動小数点要素の数であるスクラッチパッド・メモリーのサイズ。サイズは、getrf_scratchpad_size 関数が返す値以下であってはなりません。
events: 計算を開始する前に待機するイベントのリスト。デフォルトでは空のリストになります。

出力パラメーター#

a

L と U によって上書きされます。L の単位対角要素は保存されません。

ipiv

配列、サイズは max(1,min(m,n)) 以上。

ピボット・インデックスが含まれます。1 ≤ i ≤ min(m,n) の場合、行 i は行 ipiv(i) と交換されます。

例外#

例外	説明
`mkl::lapack::exception`	この例外は、計算中に問題が発生した場合にスローされます。例外オブジェクトの info() メソッドを使用して、問題の情報コードを取得できます。 `info = -i` の場合、`i` 番目のパラメーターの値が不正です。 `info = i` の場合、`uii` は 0 になります。因数分解は完了しましたが、`U` は特異です。連立一次方程式を解く際に係数 `U` を使用すると、0 除算が発生します。 `info` がスクラッチパッドのサイズとして渡された値と等しく、detail() がゼロ以外を返す場合、渡されたスクラッチパッドのサイズが十分ではなく、必要なサイズは例外オブジェクトの detail() メソッドによって返される値以上である必要があります。

例外

説明

mkl::lapack::exception

この例外は、計算中に問題が発生した場合にスローされます。例外オブジェクトの info() メソッドを使用して、問題の情報コードを取得できます。

info = -i の場合、i 番目のパラメーターの値が不正です。

info = i の場合、uii は 0 になります。因数分解は完了しましたが、U は特異です。連立一次方程式を解く際に係数 U を使用すると、0 除算が発生します。

info がスクラッチパッドのサイズとして渡された値と等しく、detail() がゼロ以外を返す場合、渡されたスクラッチパッドのサイズが十分ではなく、必要なサイズは例外オブジェクトの detail() メソッドによって返される値以上である必要があります。

戻り値#

計算が完了したことを確認するために待機する出力イベント。

getrf (USM バージョン)

目次