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

◆ _dgesvdx()

void _dgesvdx ( char  jobu,
char  jobvt,
char  range,
int  m,
int  n,
int  lda,
double  a[],
double  vl,
double  vu,
int  il,
int  iu,
int *  ns,
double  s[],
int  ldu,
double  u[],
int  ldvt,
double  vt[],
double  work[],
int  lwork,
int  iwork[],
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 の左および右特異ベクトルである.

本ルーチンは, SVD を求めるのに固有値問題を使用する. これにより, 特異値およびベクトルの一部だけを計算することができる.

本ルーチンでは V ではなく V~T を返すので注意せよ.
引数
[in]jobu行列 U の全部あるいは一部を計算するか指定する.
= 'V': U(左特異ベクトル)のはじめのmin(m, n)列, または, range で指定された一部の特異値に対応する列を配列 u[][] に返す.
= 'N': U(左特異ベクトル)を計算しない.
[in]jobvt行列V^Tの全部あるいは一部を計算するか指定する.
= 'V': V^T(右特異ベクトル)のはじめのmin(m, n)行, または, range で指定された一部の特異値に対応する行を配列 vt[][] に返す.
= 'N': V^T(右特異ベクトル)を計算しない.
[in]range= 'A': すべての特異値を求める.
= 'V': 半開区間 (vl, vu] のすべての特異値を求める.
= 'I': il番目からiu番目までの特異値を求める.
[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] a[][] の内容は壊される.
[in]vlrange = 'V': 求める特異値の範囲の下限. (vu > vl)
range = 'A' または 'I': 参照されない.
[in]vurange = 'V': 求める特異値の範囲の上限. (vu > vl)
range = 'A' または 'I': 参照されない.
[in]ilrange = 'I': 求める最小特異値のインデックス. (1 <= il <= iu <= min(m, n), ただし min(m, n) > 0)
range = 'A' または 'V': 参照されない
[in]iurange = 'I': 求める最大特異値のインデックス. (1 <= il <= iu <= min(m, n), ただし min(m, n) > 0)
range = 'A' または 'V': 参照されない.
[out]ns求められた特異値の総数. (0 <= ns <= min(m, n))
range = 'A': ns = min(m, n).
range = 'I': ns = iu - il + 1.
[out]s[]配列 s[ls] (ls >= min(m, n))
Aの特異値 (s[i] >= s[i+1] となるように並べ替えられる).
[in]ldu二次元配列 u[][] の整合寸法. (ldu >= 1 (jobu = 'N' の場合), ldu >= m (jobu = 'V' の場合))
[out]u[][]配列 u[lu][ldu] (lu >= ns)
jobu = 'V': rangeで指定された特異値に対応するU(左特異ベクトル, 列ごとに格納)の列が u[][] に入る.
jobu = 'N': u[][] は参照されない.
注: lu >= ns となるようにすること. range = 'V' の場合, ns の正確な値は前もってわからないが上限値を使用しなければならない.
[in]ldvt二次元配列 vt[][] の整合寸法. (ldvt >= 1 (jobvt = 'N' の場合), ldvt >= ns (jobvt = 'V' の場合))
[out]vt[][]配列 vt[lvt][ldvt] (lvt >= n)
jobvt = 'V': range で指定された特異値に対応する V^T(右特異ベクトル, 行方向に格納)の行が vt[][] に入る.
jobvt = 'N': vt[][] は参照されない.
注: ldvt >= ns となるようにすること. range = 'V' の場合, ns の正確な値は前もってわからないが上限値を使用しなければならない.
[out]work[]配列 work[lwork]
作業領域.
info = 0 の場合, work[0] に lwork の最適値を返す.
[in]lwork配列 work[]のサイズ. (lwork >= max(1, min(m, n)*(min(m, n)+4)) (以下の場合: Path 1 (m が n よりかなり大きい), Path 1t (n が m よりかなり大きい)), lwork >= max(1, min(m, n)*2+max(m, n)) (その他の場合))
一般にパフォーマンスをよくするためには lwork を大きくとらなければならない.
lwork = -1 の場合, 作業領域サイズの問い合わせとみなし, 最適サイズを求める計算だけを行い, work[0] にその値を返す.
[out]iwork[]配列 iwork[liwork] (liwork >= 12*min(m, n))
作業領域.
info = 0 の場合, iwork[] のはじめの ns 要素は 0 である.
info > 0 の場合, iwork[] に収束しなかった固有ベクトルのインデックスが入る.
[out]info= 0: 正常終了
= -1: 入力パラメータ jobu の誤り (jobu != 'V' および 'N')
= -2: 入力パラメータ jobvt の誤り (jobvt != 'V' および 'N')
= -3: 入力パラメータ range の誤り (range != 'A', 'V' および 'I')
= -4: 入力パラメータ m の誤り (m < 0)
= -5: 入力パラメータ n の誤り (n < 0)
= -6: 入力パラメータ lda の誤り (lda < m)
= -8: 入力パラメータ vl の誤り (vl < 0)
= -9: 入力パラメータ vu の誤り (vu < vl)
= -10: 入力パラメータ il の誤り (il < 1 または il > max(1, min(m, n)))
= -11: 入力パラメータ iu の誤り (iu < min(min(m, n), il) または iu > min(m, n))
= -14: 入力パラメータ ldu の誤り (ldu が小さすぎる)
= -16: 入力パラメータ ldvt の誤り (ldvt が小さすぎる)
= -19: 入力パラメータ lwork の誤り (lwork が小さすぎる)
= i > 0: dbdsvdx/dstevx において i 個の固有ベクトルが収束しなかった.
= 2*n + 1: dbdsvdx において内部エラーが起きた.
出典
LAPACK