NumPy C-API プログラミング：`int NpyIter_Deallocate()` 関数で NumPy イテレータを解放

構文

int NpyIter_Deallocate(NpyIter *iter);

引数

iter: 解放する NumPy イテレータオブジェクトへのポインタ

戻り値

成功した場合には 0 を返し、失敗した場合には負の値を返します。

詳細

NpyIter_Deallocate() 関数は、以下の処理を行います。

イテレータオブジェクトに関連付けられているすべてのメモリを解放します。
イテレータオブジェクトを NULL ポインタに設定します。

メモ

イテレータオブジェクトを解放する前に、NpyIter_Finished() 関数を呼び出してイテレーションが完了していることを確認する必要があります。
NpyIter_Deallocate() 関数は、イテレータオブジェクトがまだ使用されている場合に呼び出された場合、エラーを返します。

例

NpyIter *iter;
int err;

/* ... イテレータオブジェクトを作成 ... */

/* ... イテレーションを実行 ... */

err = NpyIter_Finished(iter);
if (err != 0) {
    /* エラー処理 */
}

NpyIter_Deallocate(iter);

NpyIter_Finished()
NpyIter_Get()
NpyIter_Next()
NpyIter_Create()

NumPy C-API の詳細については、以下のリソースを参照してください。

int NpyIter_Deallocate() 関数は、NumPy イテレータオブジェクトを解放するために使用されます。この関数は、NumPy イテレータオブジェクトが不要になった場合に呼び出す必要があります。

#include <numpy/numpy.h>

int main() {
  NpyIter *iter;
  int err;

  npy_intp dims[] = {2, 3, 4};
  npy_intp strides[] = {8, 4, 1};
  NpyArray *arr1 = PyArray_NewFromDims(3, dims, strides, NPY_INT32);
  NpyArray *arr2 = PyArray_NewFromDims(3, dims, strides, NPY_INT32);

  err = NpyIter_New(2, &arr1, &arr2, NPY_ITER_MULTI_ORDER,
                   NPY_ITER_READWRITE, &iter);
  if (err != 0) {
    goto CLEANUP;
  }

  /* ... イテレーションを実行 ... */

  err = NpyIter_Finished(iter);
  if (err != 0) {
    goto CLEANUP;
  }

  NpyIter_Deallocate(iter);

  PyArray_Decref(arr1);
  PyArray_Decref(arr2);

  return 0;

CLEANUP:
  NpyIter_Deallocate(iter);
  PyArray_Decref(arr1);
  PyArray_Decref(arr2);

  return err;
}

このコードは以下の処理を行います。

2つの 3 次元 NumPy 配列 arr1 と arr2 を作成します。
NpyIter_New() 関数を使用して、arr1 と arr2 をイテレートする NumPy イテレータオブジェクト iter を作成します。
... の部分で、イテレーションを実行します。
NpyIter_Finished() 関数を呼び出して、イテレーションが完了していることを確認します。
NpyIter_Deallocate() 関数を使用して、NumPy イテレータオブジェクト iter を解放します。
arr1 と arr2 配列を解放します。

イテレータオブジェクトを解放する前に、NpyIter_Finished() 関数を呼び出してイテレーションが完了していることを確認する必要があります。
イテレータオブジェクトがまだ使用されている場合に呼び出された場合、エラーを返します。

これらの制限を回避するために、以下の代替方法を使用することができます。

Py_XDECREF() 関数を使用する

Py_XDECREF(iter);

Py_XDECREF() 関数は、Python オブジェクトがまだ使用されているかどうかを確認せずに、オブジェクトの参照カウントを 1 つ減らします。この関数は、NumPy イテレータオブジェクトが Python オブジェクトである場合に使用することができます。

PyArray_Decref() 関数を使用する

PyArray_Decref(iter);

PyArray_Decref() 関数は、NumPy 配列オブジェクトの参照カウントを 1 つ減らします。この関数は、NumPy イテレータオブジェクトが NumPy 配列オブジェクトである場合に使用することができます。

PyMem_Free(iter);

PyMem_Free() 関数は、Python によって割り当てられたメモリを解放します。この関数は、NumPy イテレータオブジェクトが Python によって割り当てられたメモリである場合に使用することができます。

メモ

PyMem_Free() 関数は、メモリブロックの参照カウントが 0 になった場合にのみメモリブロックを解放します。
PyArray_Decref() 関数は、配列オブジェクトの参照カウントが 0 になった場合にのみ配列オブジェクトを解放します。
Py_XDECREF() 関数は、オブジェクトの参照カウントが 0 になった場合にのみオブジェクトを解放します。

int NpyIter_Deallocate() 関数は、NumPy イテレータオブジェクトを解放するために使用することができます。しかし、この関数はいくつかの制限があります。これらの制限を回避するために、Py_XDECREF() 関数、PyArray_Decref() 関数、または PyMem_Free() 関数を使用することができます。