Numpy C-API: `npy_bool NpyIter_HasMultiIndex()` 関数徹底解説

引数

iter: チェック対象の NumPy イテレータ

戻り値

マルチインデックスを持っている場合は NPY_TRUE、そうでない場合は NPY_FALSE

解説

NumPy イテレータは、多次元配列を効率的にループするために使用される強力なツールです。マルチインデックスを持つ NumPy イテレータは、各次元に複数のレベルのインデックスを持つことができます。これは、複雑なデータ構造を処理する際に役立ちます。

NpyIter_HasMultiIndex() 関数は、NumPy イテレータがマルチインデックスを持っているかどうかを判断する簡単な方法を提供します。この関数は、マルチインデックスを持つ NumPy イテレータを処理する必要があるかどうかを判断する際に役立ちます。

例

#include <numpy/npyiter.h>

int main() {
  npy_intp indices[2] = {0, 1};
  npy_intp strides[2] = {1, 10};
  npy_intp shape[2] = {2, 10};

  PyArrayObject *arr = PyArray_SimpleNewFromData(NDIM(shape), shape, NPY_INT32, strides, indices);
  NpyIter *iter = NpyIter_New(arr, NPY_ITER_MULTI_INDEX | NPY_ITER_READONLY);

  if (NpyIter_HasMultiIndex(iter)) {
    printf("Iter has multi-index\n");
  } else {
    printf("Iter does not have multi-index\n");
  }

  NpyIter_Decref(iter);
  Py_DECREF(arr);

  return 0;
}

この例では、2 次元の整型配列を作成し、NumPy イテレータを作成します。その後、NpyIter_HasMultiIndex() 関数を使用して、イテレータがマルチインデックスを持っているかどうかを確認します。この例では、イテレータはマルチインデックスを持っているので、printf() 関数を使用して "Iter has multi-index" と出力します。

マルチインデックスを持つ NumPy イテレータを作成する

#include <numpy/npyiter.h>

int main() {
  npy_intp indices[2] = {0, 1};
  npy_intp strides[2] = {1, 10};
  npy_intp shape[2] = {2, 10};

  PyArrayObject *arr = PyArray_SimpleNewFromData(NDIM(shape), shape, NPY_INT32, strides, indices);
  NpyIter *iter = NpyIter_New(arr, NPY_ITER_MULTI_INDEX | NPY_ITER_READONLY);

  // ...

  NpyIter_Decref(iter);
  Py_DECREF(arr);

  return 0;
}

このコードは、2 次元の整型配列を作成し、NumPy イテレータを作成します。NPY_ITER_MULTI_INDEX フラグは、イテレータがマルチインデックスを持つように設定します。

NpyIter_HasMultiIndex() 関数を使用して、イテレータがマルチインデックスを持っているかどうかを確認する

if (NpyIter_HasMultiIndex(iter)) {
  printf("Iter has multi-index\n");
} else {
  printf("Iter does not have multi-index\n");
}

このコードは、NpyIter_HasMultiIndex() 関数を使用して、イテレータがマルチインデックスを持っているかどうかを確認します。この関数は npy_bool 型の値を返します。NPY_TRUE が返された場合は、イテレータはマルチインデックスを持っています。NPY_FALSE が返された場合は、イテレータはマルチインデックスを持っていません。

マルチインデックスを持つ NumPy イテレータをループする

while (NpyIter_Next(iter)) {
  // ...
}

このコードは、マルチインデックスを持つ NumPy イテレータをループします。NpyIter_Next() 関数は、イテレータの次の要素に進みます。この関数は成功した場合に NPY_SUCCEED を返し、失敗した場合に NPY_FAIL を返します。

マルチインデックスのレベルにアクセスする

npy_intp level = 0;
npy_intp n_ind = NpyIter_GetNumMultiIndex(iter, level);

for (npy_intp i = 0; i < n_ind; ++i) {
  npy_intp ind = NpyIter_MultiIndexGetItem(iter, level, i);
  // ...
}

このコードは、マルチインデックスのレベルにアクセスします。NpyIter_GetNumMultiIndex() 関数は、指定されたレベルのインデックスの数を出力します。NpyIter_MultiIndexGetItem() 関数は、指定されたレベルとインデックスの値を出力します。

char *str = NpyIter_MultiIndexToString(iter);
if (str) {
  printf("Multi-index: %s\n", str);
  PyArray_FreeString(str);
}

NpyIter_GetNumMultiIndex() 関数を使用する

NpyIter_GetNumMultiIndex() 関数は、指定されたレベルのインデックスの数を出力します。この関数は、イテレータがマルチインデックスを持っているかどうかを判断するために使用できます。マルチインデックスを持つ NumPy イテレータの場合は、NpyIter_GetNumMultiIndex() 関数が 0 より大きい値を返します。

#include <numpy/npyiter.h>

int main() {
  npy_intp indices[2] = {0, 1};
  npy_intp strides[2] = {1, 10};
  npy_intp shape[2] = {2, 10};

  PyArrayObject *arr = PyArray_SimpleNewFromData(NDIM(shape), shape, NPY_INT32, strides, indices);
  NpyIter *iter = NpyIter_New(arr, NPY_ITER_MULTI_INDEX | NPY_ITER_READONLY);

  npy_intp n_ind = NpyIter_GetNumMultiIndex(iter, 0);
  if (n_ind > 0) {
    printf("Iter has multi-index\n");
  } else {
    printf("Iter does not have multi-index\n");
  }

  NpyIter_Decref(iter);
  Py_DECREF(arr);

  return 0;
}

NpyIter_MultiIndexGetItem() 関数を使用する

NpyIter_MultiIndexGetItem() 関数は、指定されたレベルとインデックスの値を出力します。この関数は、イテレータがマルチインデックスを持っているかどうかを判断するために使用できます。マルチインデックスを持つ NumPy イテレータの場合は、NpyIter_MultiIndexGetItem() 関数がエラーを返しません。

#include <numpy/npyiter.h>

int main() {
  npy_intp indices[2] = {0, 1};
  npy_intp strides[2] = {1, 10};
  npy_intp shape[2] = {2, 10};

  PyArrayObject *arr = PyArray_SimpleNewFromData(NDIM(shape), shape, NPY_INT32, strides, indices);
  NpyIter *iter = NpyIter_New(arr, NPY_ITER_MULTI_INDEX | NPY_ITER_READONLY);

  npy_intp ind = NpyIter_MultiIndexGetItem(iter, 0, 0);
  if (ind != -1) {
    printf("Iter has multi-index\n");
  } else {
    printf("Iter does not have multi-index\n");
  }

  NpyIter_Decref(iter);
  Py_DECREF(arr);

  return 0;
}

PyArray_CheckFlags() マクロを使用する

PyArray_CheckFlags() マクロは、NumPy 配列が特定のフラグを持っているかどうかを確認するために使用されます。このマクロは、NPY_ARRAY_MULTIDIMENSIONALS フラグを使用して、NumPy 配列がマルチインデックスを持っているかどうかを判断するために使用できます。

#include <numpy/ndarrayobject.h>

int main() {
  npy_intp indices[2] = {0, 1};
  npy_intp strides[2] = {1, 10};
  npy_intp shape[2] = {2, 10};

  PyArrayObject *arr = PyArray_SimpleNewFromData(NDIM(shape), shape, NPY_INT32, strides, indices);

  if (PyArray_CheckFlags(arr, NPY_ARRAY_MULTIDIMENSIONALS)) {
    printf("Array has multi-index\n");
  } else {
    printf("Array does not have multi-index\n");
  }

  Py_DECREF(arr);

  return 0;
}