potrf

対称 (エルミート) 正定値行列のコレスキー分解を計算します。このルーチンは、oneapi::mkl::lapack 名前空間に属します。

説明

このルーチンは、対称正定値行列、または複素数の場合はエルミート正定値行列 A のコレスキー分解を形成します。

実数データの場合 A = UT*U、複素数データの場合 A = UH*U	uplo=mkl::uplo::upper の場合
実数データの場合 A = L*LT、複素数データの場合 A = L*LH	uplo=mkl::uplo::lower の場合

ここで、L は下三角行列、U は上三角行列です。

API

構文

namespace oneapi::mkl::lapack { 
  void potrf(sycl::queue &queue, 
  mkl::uplo uplo, 
  int64_t n, 
  sycl::buffer<T> &a, 
  int64_t lda, 
  sycl::buffer<T> &scratchpad, 
  int64_t scratchpad_size) 
}

potrf は次の精度とデバイスをサポートしています。

T	デバイスサポート
float	CPU および GPU
double	CPU および GPU
std::complex<float>	CPU および GPU
std::complex<double>	CPU および GPU

入力パラメーター

queue

計算が実行されるデバイスキュー。

uplo

A の上三角部分と下三角部分のどちらが格納されているか、また A がどのように因数分解されるかを示します。

uplo=mkl::uplo::upper の場合、配列 a には行列 A の上三角部分が格納され、行列の厳密な下三角部分は参照されません。

uplo=mkl::uplo::lower の場合、配列 a には行列 A の下三角部分が格納され、行列の厳密な上三角部分は参照されません。

n

行列 A の次数を指定します (0 ≤ n)。

a

入力行列 A を保持するバッファー。入力行列 a を保持する配列には、行列 A の上三角部分または下三角部分が含まれます (uplo を参照)。a の 2 番目の次元は max(1, n) 以上でなければなりません。

lda

a の先頭次元。

scratchpad

ルーチンが中間結果を維持するスクラッチパッド・メモリーを保持するバッファー。

scratchpad_size

T タイプの浮動小数点要素の数であるスクラッチパッド・メモリーのサイズ。サイズは、potrf_scratchpad_size 関数が返す値以下であってはなりません。

出力パラメーター

a

バッファー a は、uplo で指定されたコレスキー係数 U または L によって上書きされます。

例外

例外	説明
mkl::lapack::exception	この例外は、計算中に問題が発生した場合にスローされます。例外オブジェクトの info() メソッドを使用して、問題の情報コードを取得できます。 info = -i の場合、i 番目のパラメーターの値が不正です。 info = i で、detail() が 0 を返す場合、次数 i の先頭小行列 (つまり行列 A 自体) は正定値ではないため、因数分解を完了できませんでした。これは、行列 A の形成時にエラーが発生したことを示す可能性があります。 info がスクラッチパッドのサイズとして渡された値と等しく、detail() がゼロ以外を返す場合、渡されたスクラッチパッドのサイズが十分ではなく、必要なサイズは例外オブジェクトの detail() メソッドによって返される値以上である必要があります。