NumPy C-API: int PyDataType_ISINTEGER(PyArray_Descr *dtype) 関数徹底解説

NumPy C-API: int PyDataType_ISINTEGER(PyArray_Descr *dtype) 関数解説

関数概要

引数

• dtype - NumPyデータ型を表す PyArray_Descr 構造体へのポインタ

戻り値

• 1 - データ型が整数型
• 0 - データ型が整数型でない

使用例

#include <numpy/arrayobject.h>

int main() {
  PyArray_Descr *dtype;
  int is_integer;

  // 浮動小数点型
  dtype = PyArray_DescrFromType(NPY_FLOAT64);
  is_integer = PyDataType_ISINTEGER(dtype);
  printf("dtype 'NPY_FLOAT64' is integer? %d\n", is_integer); // 出力: 0

  // 整数型
  dtype = PyArray_DescrFromType(NPY_INT32);
  is_integer = PyDataType_ISINTEGER(dtype);
  printf("dtype 'NPY_INT32' is integer? %d\n", is_integer); // 出力: 1

  PyArray_Descr_Free(dtype);
  return 0;
}

補足

• PyDataType_ISBOOL 関数は、ブール型かどうかを判定します。
• PyDataType_ISSTRING 関数は、文字列型かどうかを判定します。
• PyDataType_ISNUMBER 関数は、数値型かどうかを判定します。

NumPy C-API: int PyDataType_ISINTEGER(PyArray_Descr *dtype) 関数サンプルコード

サンプルコード1: 整数型と非整数型の判定

#include <numpy/arrayobject.h>

int main() {
  PyArray_Descr *dtype;
  int is_integer;

  // 浮動小数点型
  dtype = PyArray_DescrFromType(NPY_FLOAT64);
  is_integer = PyDataType_ISINTEGER(dtype);
  printf("dtype 'NPY_FLOAT64' is integer? %d\n", is_integer);

  // 整数型
  dtype = PyArray_DescrFromType(NPY_INT32);
  is_integer = PyDataType_ISINTEGER(dtype);
  printf("dtype 'NPY_INT32' is integer? %d\n", is_integer);

  PyArray_Descr_Free(dtype);
  return 0;
}

サンプルコード2: NumPy配列の要素型判定

#include <numpy/arrayobject.h>

int main() {
  PyArrayObject *arr;
  PyArray_Descr *dtype;
  int is_integer;

  // NumPy配列の作成
  arr = PyArray_Zeros(2, NPY_INT64);

  // 配列の要素型を取得
  dtype = PyArray_DescrFromObject(arr);

  // 要素型が整数型かどうかを判定
  is_integer = PyDataType_ISINTEGER(dtype);
  printf("Array element type is integer? %d\n", is_integer);

  PyArray_Destroy(arr);
  PyArray_Descr_Free(dtype);
  return 0;
}

サンプルコード3: 複数のデータ型の判定

#include <numpy/arrayobject.h>

int main() {
  PyArray_Descr *dtypes[] = {
    PyArray_DescrFromType(NPY_BOOL),
    PyArray_DescrFromType(NPY_INT8),
    PyArray_DescrFromType(NPY_FLOAT32),
    PyArray_DescrFromType(NPY_STRING),
  };

  for (int i = 0; i < 4; i++) {
    int is_integer = PyDataType_ISINTEGER(dtypes[i]);
    printf("dtype '%s' is integer? %d\n", dtypes[i]->typeobj->name, is_integer);
    PyArray_Descr_Free(dtypes[i]);
  }

  return 0;
}

サンプルコード4: 型名の取得

#include <numpy/arrayobject.h>

int main() {
  PyArray_Descr *dtype;
  int is_integer;

  dtype = PyArray_DescrFromType(NPY_INT32);
  is_integer = PyDataType_ISINTEGER(dtype);

  if (is_integer) {
    printf("dtype 'NPY_INT32' is integer. Type name: %s\n", dtype->typeobj->name);
  } else {
    printf("dtype 'NPY_INT32' is not integer.\n");
  }

  PyArray_Descr_Free(dtype);
  return 0;
}

NumPy C-API: int PyDataType_ISINTEGER(PyArray_Descr *dtype) 関数の代替方法

PyArray_Descr->kind フィールドを使用

PyArray_Descr 構造体には kind フィールドがあり、データ型の種別を表します。以下のコードは、kind フィールドを使用して、データ型が整数型かどうかを判定します。

#include <numpy/arrayobject.h>

int main() {
  PyArray_Descr *dtype;
  int is_integer;

  dtype = PyArray_DescrFromType(NPY_INT32);

  // 'c' は整数型を表す
  is_integer = (dtype->kind == 'c');
  printf("dtype 'NPY_INT32' is integer? %d\n", is_integer);

  PyArray_Descr_Free(dtype);
  return 0;
}

PyType_IsSubtype 関数は、ある型が別の型のサブタイプかどうかを判定します。以下のコードは、PyType_IsSubtype 関数を使用して、データ型が NPY_INTP 型のサブタイプかどうかを判定します。

#include <numpy/arrayobject.h>
#include <Python.h>

int main() {
  PyArray_Descr *dtype;
  int is_integer;

  dtype = PyArray_DescrFromType(NPY_INT32);

  // NPY_INTP型はすべての整数型の基底型
  is_integer = PyType_IsSubtype(dtype->typeobj, &PyInt_Type);
  printf("dtype 'NPY_INT32' is integer? %d\n", is_integer);

  PyArray_Descr_Free(dtype);
  return 0;
}

マクロを使用

NumPyには、データ型判定用のマクロがいくつか定義されています。以下のコードは、NPY_ISINTEGER マクロを使用して、データ型が整数型かどうかを判定します。

#include <numpy/arrayobject.h>

int main() {
  PyArray_Descr *dtype;
  int is_integer;

  dtype = PyArray_DescrFromType(NPY_INT32);

  is_integer = NPY_ISINTEGER(dtype);
  printf("dtype 'NPY_INT32' is integer? %d\n", is_integer);

  PyArray_Descr_Free(dtype);
  return 0;
}

• 1番目の方法は最もシンプルですが、すべてのデータ型に対応しているわけではありません。
• 2番目の方法は、すべてのデータ型に対応していますが、少し複雑です。
• 3番目の方法は、最も簡潔ですが、NumPyのバージョンによってマクロの定義が異なる場合があります。

その他の代替方法

• dtype->typeobj->flags & NPY_INT フラグをチェックする
• PyArray_IsIntegerScalar 関数を使用する (NumPy 1.17以降)

PyDataType_ISINTEGER 関数は、データ型が整数型かどうかを判定する便利な関数です。しかし、他の方法でも同様の機能を実現できます。どの方法を使用するかは、状況によって異なります。