XLPack 6.1
C/C++ API リファレンスマニュアル
読み取り中…
検索中…
一致する文字列を見つけられません

◆ _dgesvd()

void _dgesvd ( char  jobu,
char  jobvt,
int  m,
int  n,
int  lda,
double  a[],
double  s[],
int  ldu,
double  u[],
int  ldvt,
double  vt[],
double  work[],
int  lwork,
int *  info 
)

(シンプルドライバ) 特異値分解 (SVD)

目的
本ルーチンは m x n 実行列 A の特異値分解(SVD), および, 必要により左および/または右特異ベクトルを求める. SVD は次のように表される.
A = U * SIGMA * V^T
ここで, SIGMA はmin(m, n)個の対角要素を除き 0 の m x n 行列, U は m x m 直交行列, V は n x n 直交行列である. SIGMA の対角要素が A の特異値である. 特異値は非負の実数で, 降順に返される. U および V のはじめのmin(m, n)列は A の左および右特異ベクトルである.

本ルーチンでは V ではなく V^T を返すので注意せよ.
引数
[in]jobu行列 U の全部あるいは一部を計算するか指定する.
= 'A': U の m 列全てを配列 u[][] に返す.
= 'S': U のはじめのmin(m, n)列(左特異ベクトル)を配列 u[][] に返す.
= 'O': U のはじめのmin(m, n)列(左特異ベクトル)を配列 a[][] に上書きする.
= 'N': U の列(左特異ベクトル)を計算しない.
jobvtとjobuを両方'O'にはできない.
[in]jobvt行列 V^T の全部あるいは一部を計算するか指定する.
= 'A': V^T の n 行全てを配列 vt[][] に返す.
= 'S': V^T のはじめのmin(m, n)行(右特異ベクトル)を配列 vt[][] に返す.
= 'O': V^T のはじめのmin(m, n)行(右特異ベクトル)を配列 a[][] に上書きする.
= 'N': V^T の行(右特異ベクトル)を計算しない.
jobvtとjobuを両方'O'にはできない.
[in]m入力行列 A の行数. (m >= 0) (m = 0 の場合, 処理を行わずに戻る)
[in]n入力行列 A の列数. (n >= 0) (n = 0 の場合, 処理を行わずに戻る)
[in]lda二次元配列 a[][] の整合寸法. (lda >= max(1, m))
[in,out]a[][]配列 a[la][lda] (la >= n)
[in] m x n 行列 A.
[out] jobu = 'O': a[][] は U(左特異ベクトル, 列ごとに格納)のはじめのmin(m, n)列で上書きされる.
  jobvt = 'O': a[][] は V^T(右特異ベクトル, 行ごとに格納)のはじめのmin(m, n)行で上書きされる.
  jobu != 'O' かつ jobvt != 'O': a[][] の内容は壊される.
[out]s[]配列 s[ls] (ls >= min(m, n))
A の特異値 (s[i] >= s[i+1] となるように並べ替えられる).
[in]ldu二次元配列 u[][] の整合寸法. (ldu >= 1 (jobu = 'O' または 'N' の場合), ldu >= m (jobu = 'A' または 'S' の場合))
[out]u[][]配列 u[lu][ldu] (lu >= m (jobu = 'A' の場合), lu >= min(m, n) (jobu = 'S' の場合))
jobu = 'A': u[][] に m x m 直交行列 U が入る.
jobu = 'S': u[][] に U(左特異ベクトル, 列ごとに格納)のはじめのmin(m, n)列が入る.
jobu = 'N' または 'O': u[][] は参照されない.
[in]ldvt配列 vt[][] の整合寸法. (ldvt >= 1 (jobvt = 'O' または 'N' の場合), ldvt >= n (jobvt = 'A' の場合), ldvt >= min(m, n) (jobvt = 'S' の場合))
[out]vt[][]配列 vt[lvt][ldvt] (lvt >= n)
jobvt = 'A': vt[][] に n x n 直交行列 V^T が入る.
jobvt = 'S': vt[][] に V^T(右特異ベクトル, 行ごとに格納)のはじめのmin(m, n)行が入る.
jobvt = 'N' または 'O': vt[][] は参照されない.
[out]work[]配列 work[lwork]
作業領域.
info = 0 の場合, work[0] に lwork の最適値を返す.
info > 0 の場合, work[0 〜 min(m, n)-2] に上二重対角形 B の収束しなかった上副対角要素が入る. B の対角要素(並べ替えられているとは限らない)が s[] に入る. B は A = U * B * V^T を満たすため, A と同じ特異値, および, U および V^T に関連する特異ベクトルを持つ.
[in]lwork配列 work[] のサイズ. (lwork >= max(1, 5*min(m, n)) (以下の場合: Path 1 (m が n よりかなり大きく, jobu = 'N'), Path 1t (n が m よりかなり大きく, jobvt = 'N')), lwork >= max(1, 3*min(m, n) + max(m, n), 5*min(m, n)) (その他の場合))
一般にパフォーマンスをよくするためには lwork を大きくとらなければならない.
lwork = -1 の場合, 作業領域サイズの問い合わせとみなし, 最適サイズを求める計算だけを行い, work[0] にその値を返す.
[out]info= 0: 正常終了
= -1: 入力パラメータ jobu の誤り (jobu != 'A', 'S', 'O' および 'N')
= -2: 入力パラメータ jobvt の誤り (jobvt != 'A', 'S', 'O' および 'N')
= -3: 入力パラメータ m の誤り (m < 0)
= -4: 入力パラメータ n の誤り (n < 0)
= -5: 入力パラメータ lda の誤り (lda < max(1, m))
= -8: 入力パラメータ ldu の誤り (ldu が小さすぎる)
= -10: 入力パラメータ ldvt の誤り (ldvt が小さすぎる)
= -13: 入力パラメータ lwork の誤り (lwork が小さすぎる)
> 0: dbdsqr で収束しなかった場合, info は中間結果の二重対角形 B の上副対角要素のうち何個が 0 に収束しなかったを示す. 詳細は上の work[] の説明を参照せよ.
出典
LAPACK