NumPy C-API の npy_uint32 iter_flags を使ってイテレーションを自在に操る

NumPy C-API における npy_uint32 iter_flags プログラミング解説

利用可能なフラグ:

• NPY_ITER_READONLY: イテレーション中に配列要素の書き込みを許可しない
• NPY_ITER_CONTIGUOUS: イテレーション中にメモリが連続していることを保証
• NPY_ITER_FORTRAN: イテレーション順序が Fortran 順序であることを保証
• NPY_ITER_CORDER: イテレーション順序が C 順序であることを保証
• NPY_ITER_NATIVE: イテレーション順序がネイティブ順序であることを保証
• NPY_ITER_NWHIMPER: エラーが発生してもイテレーションを継続
• NPY_ITER_EXTERNAL: イテレーション中に外部メモリを使用

フラグの組み合わせ:

複数のフラグをビット演算 (|) で組み合わせることができます。例えば、読み取り専用かつ連続したイテレーションを行うには、NPY_ITER_READONLY | NPY_ITER_CONTIGUOUS を使用します。

例:

npy_ndarray *arr = ...;
npy_iter *iter;

npy_iter_init(iter, arr, NPY_ITER_READONLY | NPY_ITER_CONTIGUOUS);

while (npy_iter_has_more(iter)) {
    npy_intp indices[NPY_MAXDIMS];
    npy_intp *ptr;

    npy_iter_get_coords(iter, indices);
    ptr = npy_iter_get_ptr(iter);

    // 現在の要素にアクセス
    printf("%d\n", *(ptr + 0));

    npy_iter_advance(iter);
}

npy_iter_cleanup(iter);

この例では、npy_ndarray arr を読み取り専用かつ連続した方法でイテレーションしています。各イテレーションで、現在の要素のインデックスとポインタを取得し、要素値を出力しています。

注意事項:

• NPY_ITER_CONTIGUOUS フラグを使用する場合は、arr が連続したメモリに格納されていることを確認する必要があります。
• NPY_ITER_FORTRAN または NPY_ITER_CORDER フラグを使用する場合は、arr の順序が対応する順序であることを確認する必要があります。
• NPY_ITER_NWHIMPER フラグを使用する場合は、エラーが発生してもイテレーションが継続されますが、エラー情報は見逃される可能性があります。

詳細については、NumPy C-API のドキュメントを参照してください: https://numpy.org/doc/stable/reference/c-api/index.html

NumPy C-API を用いたサンプルコード集

配列の作成と初期化

#include <numpy/ndarray.h>

int main() {
  // 10 要素を持つ 1 次元配列を作成
  npy_intp dims[] = {10};
  npy_dtype *dtype = NPY_FLOAT64;
  npy_ndarray *arr = PyArray_SimpleNewFromData(NDIM(dims), dims, dtype, NULL);

  // 配列要素に値を設定
  for (int i = 0; i < 10; i++) {
    ((double *)arr->data)[i] = i * 0.1;
  }

  // 配列の内容を出力
  for (int i = 0; i < 10; i++) {
    printf("%f ", ((double *)arr->data)[i]);
  }

  PyArray_DECREF(arr);
  return 0;
}

配列へのアクセス

#include <numpy/ndarray.h>

int main() {
  // 2 次元配列を作成
  npy_intp dims[] = {2, 3};
  npy_dtype *dtype = NPY_INT32;
  npy_ndarray *arr = PyArray_SimpleNewFromData(NDIM(dims), dims, dtype, NULL);

  // 配列要素にアクセス
  int i, j;
  for (i = 0; i < 2; i++) {
    for (j = 0; j < 3; j++) {
      ((int *)arr->data)[i * 3 + j] = i * 3 + j;
    }
  }

  // 配列の内容を出力
  for (i = 0; i < 2; i++) {
    for (j = 0; j < 3; j++) {
      printf("%d ", ((int *)arr->data)[i * 3 + j]);
    }
    printf("\n");
  }

  PyArray_DECREF(arr);
  return 0;
}

配列の演算

#include <numpy/ndarray.h>

int main() {
  // 2 つの 1 次元配列を作成
  npy_intp dims[] = {10};
  npy_dtype *dtype = NPY_FLOAT64;
  npy_ndarray *arr1 = PyArray_SimpleNewFromData(NDIM(dims), dims, dtype, NULL);
  npy_ndarray *arr2 = PyArray_SimpleNewFromData(NDIM(dims), dims, dtype, NULL);

  // 配列要素に値を設定
  for (int i = 0; i < 10; i++) {
    ((double *)arr1->data)[i] = i * 0.1;
    ((double *)arr2->data)[i] = i * 0.2;
  }

  // 要素ごとの和を求める
  npy_ndarray *sum = PyArray_PyArithmeticBinary(arr1, arr2, NPY_FLOAT64, NULL);

  // 結果を出力
  for (int i = 0; i < 10; i++) {
    printf("%f ", ((double *)sum->data)[i]);
  }

  PyArray_DECREF(arr1);
  PyArray_DECREF(arr2);
  PyArray_DECREF(sum);
  return 0;
}

配列の形状とストライド

#include <numpy/ndarray.h>

int main() {
  // 3 次元配列を作成
  npy_intp dims[] = {2, 3, 4};
  npy_dtype *dtype = NPY_INT32;
  npy_ndarray *arr = PyArray_SimpleNewFromData(NDIM(dims), dims, dtype, NULL);

  // 配列の形状とストライドを取得
  npy_intp *shape = PyArray_SHAPE(arr);
  npy_intp *strides = PyArray_STRIDES(arr);

  // 形状とストライドを出力
  printf("形状: ");
  for (int i = 0; i < NDIM(arr); i++) {
    printf("%d ", shape

高度な配列操作:

• 特定の条件を満たす要素のみを抽出する
• 複数の配列を結合する
• 配列を転置する
• 特定の軸に沿って配列を合計または平均化する

UFunc との連携:

• NumPy の UFunc を用いた配列演算を実行する
• カスタム UFunc を作成して配列に適用する

メモリ管理:

• NumPy 配列のメモリ割り当てと解放を明示的に制御する
• 共有メモリを使用して複数のプロセス間で配列を共有する

性能の向上:

• イテレータを使用して配列を効率的に処理する
• キャッシュを使用してメモリアクセスを最適化する
• SIMD 命令を使用して計算を高速化する

これらの例はほんの一例であり、NumPy C-API の可能性は無限大です。