orgqr (USM バージョン)#

geqrf (USM のバージョン) 関数によって形成された QR 分解の直交行列 Q を実行列に乗算します。このルーチンは、oneapi::mkl::lapack 名前空間に属します。

説明#

このルーチンは、geqrf (USM バージョン) :ref:`geqrf-usm-version 関数によって形成された QR 分解の mm 列の直交行列 Q の全体または一部を生成します。

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

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

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

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

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

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

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

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

API#

構文#

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

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

T

デバイスサポート

float

CPU および GPU*

double

CPU および GPU*

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

入力パラメーター#

queue

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

m

行列 A の行数 (0 m)。

n

行列 A の列数 (0 n)。

k

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

a

geqrf (USM バージョン) によって返される結果へのポインター。

lda

a の先頭次元 (lda m)。

tau

geqrf (USM バージョン) によって返される結果へのポインター。

scratchpad

ルーチンが中間結果を保存するスクラッチパッド・メモリーへのポインター。

scratchpad_size

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

events

計算を開始する前に待機するイベントのリスト。デフォルトでは空のリストになります。

出力パラメーター#

a

m 行 m 列の直交行列 Q の先頭の n 列で上書きされます。

例外#

例外

説明

mkl::lapack::exception

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

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

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

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

戻り値#

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