PARCEL SYCL v1.2 / API リファレンス 利用者ガイド API リファレンス 検索 ダウンロード English

6 parcel::matrix

 疎行列を保持するクラスである. 行列は CRS 形式で登録する (set_crsMat()). DIA 形式の登録関数 set_diaMat() も公開されているが, 本版では使えない (登録した行列を solver() に渡すと std::runtime_error を投げる).

6.1 コンストラクタ

概要 空の行列オブジェクトを作る.

書式

template< class parceltype = parcel_double >
class matrix;

parcel::matrix<parceltype>::matrix(sycl::queue *q);

引数

名前 入出力 型 説明 既定値
parceltype 入力 (テンプレート) PARCELデータ型 行列要素を保持する精度 parcel_double
q 入力 sycl::queue * 行列を置くデバイスのキュー なし

前提条件 q は in-order キューとする. ここでは検査せず, set_crsMat() が検査する (q が NULL の場合も含めて std::invalid_argument). キューは行列を使い終わるまで破棄してはならない.

MPI 局所操作.

関連項目 set_crsMat()

例

parcel::matrix<parcel_double> A(&q);   // parcel::matrix<> A(&q); と同じ

6.2 set_crsMat()

概要 各ランクが担当する行ブロックの CRS 行列を登録し, MPI の袖通信表を作る.

書式

template< class Ttype >
void set_crsMat(parcel::comm *comm, PARCEL_INT nstart, PARCEL_INT nend,
                size_t n, size_t nnz,
                PARCEL_INT *rowptr, PARCEL_INT *crsCol, Ttype *mem);

引数

名前 入出力 型 説明 既定値
Ttype 入力 (テンプレート) 浮動小数点型 入力配列 mem の型 (double など). 登録時に行列の parceltype へ変換する なし
comm 入力 parcel::comm * SYCL版PARCEL用 MPI コミュニケータ なし
nstart 入力 PARCEL_INT 担当する最初の行の大域行番号 (0 始まり) なし
nend 入力 PARCEL_INT 担当する最後の行の大域行番号 (両端を含む) なし
n 入力 size_t 担当行数 (= nend - nstart + 1) なし
nnz 入力 size_t 担当行の非零要素数 なし
rowptr 入力 PARCEL_INT * 長さ n + 1 の行ポインタ. 担当行の先頭を 0 とする局所の値 なし
crsCol 入出力 PARCEL_INT * 長さ nnz の列番号. 入力は大域の 0 始まり列番号. 出力は局所番号に書き換えられる なし
mem 入出力 Ttype * 長さ nnz の行列要素. 出力は各行で並べ替えられる なし

前提条件 次を検査し, 違反すると例外を投げる.

 最後の条件群は各ランクの判定を集団通信で集め, 違反があれば全ランクが同じ std::invalid_argument を投げる. -DPARCEL_NO_CRS_CHECK=1 でこの検査を外せる. 外した場合, 条件を満たさないときの動作は不定である (誤った結果, 異常終了, デッドロック). デバイスメモリの確保に失敗すると util_sycl::device_bad_alloc を投げる (設定の扱いと例外).

MPI 集団操作 (検査の MPI_Allgather・MPI_Allreduce, MPI_Alltoall, MPI_Isend / MPI_Irecv, MPI_Barrier). comm の全ランクが呼ぶ.

注意 crsCol と mem はその場で書き換えられる (列番号を局所番号に変換し, 各行で自ランクの列を前, 袖の列を後に並べ替える). rowptr は変更されない. std::invalid_argument で戻った場合は書き換える前であるが, PARCEL_LINT の範囲または袖のバイト数の std::overflow_error で戻った場合は, crsCol と mem はすでに書き換わっている. 配列の型は PARCEL_INT のままで, デバイスへ送る前に PARCEL_LINT の配列に写す (既定ではホスト側で一時的に 4 (n + nnz) バイトを余分に使う). 同じ配列から 2 つ目の行列 (例: shift-invert 用の A−σIA-\sigma I) を作ると列番号が二重に変換され, MPI 実行時に袖通信が壊れる. 複数の行列を作る場合は, 最初の set_crsMat() の前に配列を複製しておく. double-double の上位・下位を別配列で渡す多重定義 set_crsMat(comm, nstart, nend, n, nnz, rowptr, crsCol, double *hi, double *lo) もあり, テンプレート版と同じくコミュニケータと袖通信表を登録し, 同じ検査を行う (crsCol, hi, lo はその場で並べ替えられる).

 MPI なしのビルド (-DPARCEL_MPI=0) でも同じ書式で呼べる. 1 プロセスが行列の全体を持つので, nstart = 0 かつ n = nend - nstart + 1 (全体の行数) でなければ std::invalid_argument を投げる (-DPARCEL_NO_CRS_CHECK=1 でも調べる). 袖は無く, 集団通信も行わない. コミュニケータを取らない set_crsMat(n, nnz, rowptr, crsCol, mem) も使える (MPI なしのビルドだけ).

関連項目 parcel::comm, データ構造の節 (CRS 形式), 使用方法の章の「行列の設定」「MPI 分割」

例

parcel::matrix<parcel_double> A(&q);
A.set_crsMat<double>(&comm, nstart, nend, n, col.size(), rowptr.data(), col.data(), val.data());

6.3 n_local()

概要 行列の局所行数 (このランクが担当する行数) を返す.

書式

size_t n_local();

戻り値 CRS 形式では set_crsMat() に渡した n (nend - nstart + 1).

前提条件 set_crsMat() で行列を登録した後に呼ぶ. 未登録の行列では std::runtime_error を投げる.

MPI 局所操作.

注意 ks_arnoldi は局所行数を EigenVec の長さではなくこの値から取る.

例

std::vector<double> evec_h(A.n_local() * k_keep);