syevx (USM バージョン)#
実対称行列 A の選択された固有値と、オプションで固有ベクトルを計算します。このルーチンは、oneapi::mkl::lapack 名前空間に属します。
説明#
このルーチンは、実対称行列 A の選択された固有値、およびオプションで固有ベクトルを計算します。固有値と固有ベクトルは、目的の固有値の値の範囲またはインデックスの範囲を指定して選択できます。言い換えれば、A*z = z*λ となるような A の選択された固有対 (λ, z) を計算できます。
このルーチンは、二分アルゴリズムを使用して選択された固有値を計算します。
固有ベクトルが要求された場合、このルーチンは、インドラジット・ディヨン氏とベレスフォード・パーレット氏の研究に基づく修正ツイスト因数分解アルゴリズムと、逆反復アルゴリズムに続くグラムシュミット直交化の組み合わせを使用します。
API#
構文#
namespace oneapi::mkl::lapack {
sycl::event syevx(sycl::queue &queue,
mkl::job jobz,
mkl::rangev range,
mkl::uplo uplo,
int64_t n,
T *a,
int64_t lda,
T vl,
T vu,
int64_t il,
int64_t iu,
T abstol,
int64_t *m, T *w,
T *z,
int64_t ldz,
T *scratchpad,
int64_t scratchpad_size,
const std::vector<sycl::event> &events = {})
}syevx (USM バージョン) は、次の精度とデバイスをサポートします。
T |
サポートされるデバイス |
|---|---|
|
CPU および GPU* |
|
CPU および GPU^ |
*インターフェイスのサポートのみ。すべての計算は CPU 上で実行されます。
^ハイブリッドのサポート。計算の一部は CPU 上で実行されます。
入力パラメーター#
- queue
計算が実行されるデバイスキュー。
- jobz
job::novecまたはjob::vecである必要があります。jobz = job::novecの場合、固有値のみが計算されます。jobz = job::vecの場合、固有値と固有ベクトルが計算されます。- range
rangev::all、rangev::valuesまたはrangev::indicesである必要があります。range = rangev::allの場合、すべての固有値と固有ベクトル (jobzパラメーターによって要求された場合) が計算されます。range = rangev::valuesの場合、区間(vl, vu]内の固有値と対応する固有ベクトル (jobzパラメーターで要求された場合) が計算されます。range = rangev::indicesの場合、il番目からiu番目の固有値と対応する固有ベクトル (jobzパラメーターによって要求された場合) が計算されます。- uplo
uplo::upperまたはuplo::lowerである必要があります。uplo = uplo::upperの場合、a はAの上三角部分を格納します。uplo = uplo::lowerの場合、a はAの下三角部分を格納します。- n
行列
Aの次数 (0 ≤ n)。- a
uplo で指定された対称行列
Aの上三角形または下三角形を含むサイズa(lda,*)の配列へのポインター。a の 2 番目の次元は
max(1, n)以上でなければなりません。- lda
a の先頭次元;
max(1,n)以上である必要があります。- vl
range = rangev::valuesの場合、固有値を検索する間隔の下限。vlはvuより小さくなければなりません。range = rangev::allまたはrange = rangev::indicesの場合は参照されません。- vu
range = rangev::valuesの場合、固有値を検索する間隔の上限。vlはvuより小さくなければなりません。range = rangev::allまたはrange = rangev::indicesの場合は参照されません。- il
range = rangev::indicesの場合、返される最小固有値の 1 ベースのインデックス。n > 0の場合は1 ≤ il ≤ iu ≤ nで、n = 0の場合はil = 1およびiu = 0でなければなりません。range = rangev::allまたはrange = rangev::valuesの場合は参照されません。- iu
range = rangev::indicesの場合、返される最大固有値の 1 ベースのインデックス。n > 0の場合は1 ≤ il ≤ iu ≤ nで、n = 0の場合はil = 1およびiu = 0でなければなりません。range = rangev::allまたはrange = rangev::valuesの場合は参照されません。- abstol
固有値の絶対誤差許容値。近似固有値は、
abstol + eps * max( |a|,|b| )以下の幅の区間[a,b]内にあると判断されたときに収束したとみなされます。ここで、epsはマシン精度です。abstolが 0 以下の場合、代わりにeps*|T|が使用されます。ここで、|T|は、A を三角形式に縮小することによって得られる三角行列の 1 ノルムです。- ldz
z の先頭次元。
max(1,n)以上である必要があります。- scratchpad
ルーチンが中間結果を保存するスクラッチパッド・メモリーへのポインター。
- scratchpad_size
Tタイプの浮動小数点要素の数であるスクラッチパッド・メモリーのサイズ。サイズは、syevx_scratchpad_size 関数が返す値以下であってはなりません。- events
計算を開始する前に待機するイベントのリスト。デフォルトでは空のリストになります。
出力パラメーター#
- a
終了時に、対角線を含む
Aの上三角形 (uplo = uplo::upperの場合) または下三角形 (uplo = uplo::lowerの場合) が破棄されます。- m
検出されの固有値の総数、
0 ≤ m ≤ n。- w
n サイズ以上の配列へのポインター。正常終了時には、最初の m 要素に行列
Aの選択された固有値が昇順で格納されます。- z
jobz = job::vecの場合、通常の終了時に、Z の最初の m 列には、選択された固有値に対応する行列 A の直交固有ベクトルが含まれ、Z のi番目の列には、w(i)に関連付けられた固有ベクトルが保持されます。jobz = job::novecの場合、Z は参照されません。注: ユーザーは配列 Z に少なくともmax(1, m)列が指定されていることを確認する必要があります。range = rangev::valuesの場合、m の正確な値は事前に不明であるため、上限を使用する必要があります。
例外#
例外 |
説明 |
|---|---|
|
この例外は、計算中に問題が発生した場合にスローされます。例外オブジェクトの info() メソッドを使用して、問題の情報コードを取得できます。
|
戻り値#
計算が完了したことを確認するために待機する出力イベント。