ungqr

geqrf で形成される QR 因数分解の複素ユニタリー行列 Q を生成します。このルーチンは、oneapi::mkl::lapack 名前空間に属します。

説明

このルーチンは、geqrf ルーチンによって形成された QR 分解の m 行 m 列のユニタリー行列 Q の全体または一部を生成します。

通常、Q は、m ≥ p の m 行 p 列nの行列 A の QR 分解から決定されます。行列 Q 全体を計算するには、次を使用します。

mkl::ungqr(queue, m, m, p, a, lda, tau, ...)

Q の先頭の p 列 (A の列によってスパンされる空間の正規直交基底を形成する) を計算するには、次のようにします。

mkl::ungqr(queue, m, p, p, a, lda, tau, ...)

行列 A の先頭 k 列の QR 分解の行列 Q^k を計算するには、次のようにします。

mkl::ungqr(queue, m, m, k, a, lda, tau, ...)

Q^k の先頭の k 列 (A の先頭 k 列によってスパンされる空間の正規直交基底を形成する) を計算するには、次のようにします。

mkl::ungqr(queue, m, k, k, a, lda, tau, ...)

API

構文

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

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

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

*インターフェイスのサポートのみ。すべての計算は CPU 上で実行されます。

入力パラメーター

queue

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

m

行列 A の行数 (0 ≤ m)。

n

行列 A の列数 (0 ≤ n)。

k

積が行列 Q を定義する基本反射体の数 (0 ≤ k ≤ n)。

a

geqrf の結果を保持するバッファー。

lda

A の先頭次元 (lda ≥ m)。

tau

geqrf の結果を保持するバッファー。

scratchpad

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

scratchpad_size

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

出力パラメーター

a

m 行 m 列のユニタリー行列 Q の先頭の n 列で上書きされます。

例外

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