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

7 parcel::vector

 デバイス上のベクトルを保持するクラスである. 領域は SYCL の USM (Unified Shared Memory) のデバイスメモリに確保する. ホストとの転送関数 (setValue / getValue 系) はいずれも転送の完了を待ってから戻る.

7.1 コンストラクタ / resize()

概要 長さ n のベクトルをデバイス上に確保する. resize() は長さとキューを変えて確保し直す.

書式

template< class parceltype = parcel_double >
class vector;

parcel::vector<parceltype>::vector(size_t n, sycl::queue *q);
void resize(size_t n, sycl::queue *q);

引数

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

前提条件 引数は検査しない. デバイスメモリの確保に失敗すると util_sycl::device_bad_alloc (std::bad_alloc の派生) を投げる (設定の扱いと例外).

MPI 局所操作.

注意 確保した領域は 0 で初期化される. resize() はそれまでの内容を捨てる. ソルバに渡すベクトルの長さは担当行数 (固有値ソルバでは各ソルバの項に示す長さ) とする.

例

parcel::vector<parcel_double> x(n, &q), b(n, &q);

7.2 queue() / size()

概要 キューへのポインタと要素数を返す.

書式

sycl::queue *queue();
size_t       size();

戻り値 確保に使った sycl::queue のポインタ, 要素数.

MPI 局所操作.

7.3 setValue()

概要 ホスト配列の値をベクトルに写す.

書式

template< class T > void setValue(T *mem);
template< class T > void setValue(std::vector<T> &mem);
void setValue(parcel::scalar val);
void setValue(double *mem_hi, double *mem_lo);
void setValue(std::vector<double> &mem_hi, std::vector<double> &mem_lo);

引数

名前 入出力 型 説明 既定値
T 入力 (テンプレート) 数値型 ホスト配列の型. parceltype の精度へ変換する なし
mem 入力 T * 長さ size() のホスト配列 なし
val 入力 parcel::scalar 全要素に設定する値. double または float を渡せる (b.setValue(1.0)) なし
mem_hi, mem_lo 入力 double * double-double の上位・下位 (長さ size()) なし

前提条件 検査しない. 配列は size() 要素以上なければならない.

MPI 局所操作.

注意 parcel_doubledouble に setValue(mem) で写すと下位は 0 になる. double-double 以外に setValue(mem_hi, mem_lo) で写すと mem_hi + mem_lo を丸めた値になる.

関連項目 getValue(), setValue_hi()

例

x.setValue(x_h.data());

7.4 setValue_hi() / setValue_lo()

概要 double-double 型ベクトルの上位 / 下位の配列だけにホスト配列の値を写す.

書式

void setValue_hi(double *mem_hi);
void setValue_lo(double *mem_lo);

引数

名前 入出力 型 説明 既定値
mem_hi / mem_lo 入力 double * 長さ size() のホスト配列 なし

前提条件 parcel::vector<parcel_doubledouble> 専用である. 他の型で呼ぶとコンパイルエラーになる.

MPI 局所操作.

7.5 getValue()

概要 ベクトルの値をホスト配列に写す.

書式

template< class T > void getValue(T *mem);
template< class T > void getValue(T *mem_hi, T *mem_lo);
void getValue(double *mem_hi, double *mem_lo);

引数

名前 入出力 型 説明 既定値
T 入力 (テンプレート) 数値型 ホスト配列の型 なし
mem 出力 T * 長さ size() のホスト配列 なし
mem_hi, mem_lo 出力 T * double-double の上位・下位 (長さ size()) なし

前提条件 検査しない. 配列は size() 要素以上なければならない.

MPI 局所操作.

注意 double-double から getValue(mem) で受け取ると上位と下位の和を T に丸めた値になる. double-double 以外で getValue(mem_hi, mem_lo) を呼ぶと mem_hi に値が入り, mem_lo には何も書かない.

例

x.getValue(x_h.data());

7.6 getValue_hi() / getValue_lo()

概要 double-double 型ベクトルの上位 / 下位の配列をホスト配列に写す.

書式

template< class T > void getValue_hi(T *mem_hi);
template< class T > void getValue_lo(T *mem_lo);
template< class T > void getValue_hi(std::vector<T> &mem_hi);
template< class T > void getValue_lo(std::vector<T> &mem_lo);

引数

名前 入出力 型 説明 既定値
mem_hi / mem_lo 出力 T * 長さ size() のホスト配列 なし

前提条件 検査しない. double-double 以外では T は要素型と同じ型に限る (異なるとコンパイルエラー).

MPI 局所操作.

注意 double-double 以外では getValue_hi() は getValue() と同じであり, getValue_lo() は何も書かない.

7.7 data() / data_hi() / data_lo()

概要 デバイス上の配列の先頭ポインタを返す.

書式

auto *data();
auto *data_hi();
auto *data_lo();

戻り値 USM デバイスメモリの先頭ポインタ. double-double では data() と data_hi() が上位, data_lo() が下位の double * である. double-double 以外では data() と data_hi() が同じ配列を指し, data_lo() は nullptr である.

MPI 局所操作.

注意 デバイスメモリなので, ホストから直接参照してはならない (SYCL カーネルの中で使う).