NumPy C-API: Python 数値判定関数 PyArray_IsPythonNumber() の詳細解説

NumPy C-API: int PyArray_IsPythonNumber() 関数解説

関数宣言

int PyArray_IsPythonNumber(PyObject *obj);

引数

• obj: 検査対象のオブジェクト

戻り値

• 1: オブジェクトが Python 数値である

使用例

PyObject *obj = PyFloat_FromDouble(3.14);

if (PyArray_IsPythonNumber(obj)) {
  // オブジェクトは Python 数値です
  printf("オブジェクトは数値です\n");
} else {
  // オブジェクトは Python 数値ではありません
  printf("オブジェクトは数値ではありません\n");
}

Py_DECREF(obj);

• PyArray_IsPythonNumber() 関数は、PyNumber_Check() 関数と似ていますが、NumPy 配列で使用するために特別に設計されています。
• オブジェクトが Python 数値であるかどうかを判断するには、PyNumber_Check() 関数を使用することもできます。

補足

• PyArray_IsPythonNumber() 関数は、オブジェクトが Python 数値であるかどうかのみを判断します。オブジェクトが特定の種類の Python 数値であるかどうかを判断するには、他の関数を使用する必要があります。
• 例えば、オブジェクトが整数であるかどうかを判断するには、PyLong_Check() 関数を使用できます。

関連関数

• PyNumber_Check()
• PyLong_Check()

応用例

• NumPy 配列にオブジェクトを追加する前に、オブジェクトが Python 数値であるかどうかを確認する
• オブジェクトが数値演算で使用できるかどうかを確認する

NumPy C-API: PyArray_IsPythonNumber() 関数 サンプルコード

オブジェクトが Python 数値であるかどうかを確認する

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

int main() {
  // オブジェクトの作成
  PyObject *obj1 = PyFloat_FromDouble(3.14);
  PyObject *obj2 = PyList_New(0);

  // `PyArray_IsPythonNumber()` 関数の使用
  if (PyArray_IsPythonNumber(obj1)) {
    printf("obj1は Python 数値です\n");
  } else {
    printf("obj1は Python 数値ではありません\n");
  }

  if (PyArray_IsPythonNumber(obj2)) {
    printf("obj2は Python 数値です\n");
  } else {
    printf("obj2は Python 数値ではありません\n");
  }

  // オブジェクトの解放
  Py_DECREF(obj1);
  Py_DECREF(obj2);

  return 0;
}

NumPy 配列にオブジェクトを追加する前に、オブジェクトが Python 数値であるかどうかを確認する

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

int main() {
  // NumPy 配列の作成
  npy_intp dims[] = {3};
  PyArrayObject *arr = PyArray_SimpleNew(1, dims, NPY_FLOAT64);

  // オブジェクトの作成
  PyObject *obj = PyFloat_FromDouble(3.14);

  // オブジェクトが Python 数値であるか確認
  if (PyArray_IsPythonNumber(obj)) {
    // オブジェクトを NumPy 配列に追加
    PyArray_SETITEM(arr, (Py_ssize_t)0, obj);
  } else {
    printf("オブジェクトは Python 数値ではないため、NumPy 配列に追加できません\n");
  }

  // オブジェクトの解放
  Py_DECREF(obj);
  Py_DECREF(arr);

  return 0;
}

オブジェクトが数値演算で使用できるかどうかを確認する

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

int main() {
  // オブジェクトの作成
  PyObject *obj1 = PyFloat_FromDouble(3.14);
  PyObject *obj2 = PyList_New(0);

  // オブジェクトが数値演算で使用できるかどうかを確認
  if (PyArray_IsPythonNumber(obj1)) {
    printf("obj1は数値演算で使用できます\n");
  } else {
    printf("obj1は数値演算で使用できません\n");
  }

  if (PyArray_IsPythonNumber(obj2)) {
    printf("obj2は数値演算で使用できます\n");
  } else {
    printf("obj2は数値演算で使用できません\n");
  }

  // オブジェクトの解放
  Py_DECREF(obj1);
  Py_DECREF(obj2);

  return 0;
}

その他のサンプルコード

• NumPy 配列の要素をすべて検査し、数値ではない要素をすべて削除する
• NumPy 配列の要素の平均値、最大値、最小値を計算する

PyArray_IsPythonNumber() 関数以外の方法

PyNumber_Check() 関数は、オブジェクトが Python 数値であるかどうかを判断するために使用できます。これは、PyArray_IsPythonNumber() 関数よりも汎用的な関数です。

#include <Python.h>

int main() {
  // オブジェクトの作成
  PyObject *obj1 = PyFloat_FromDouble(3.14);
  PyObject *obj2 = PyList_New(0);

  // `PyNumber_Check()` 関数の使用
  if (PyNumber_Check(obj1)) {
    printf("obj1は Python 数値です\n");
  } else {
    printf("obj1は Python 数値ではありません\n");
  }

  if (PyNumber_Check(obj2)) {
    printf("obj2は Python 数値です\n");
  } else {
    printf("obj2は Python 数値ではありません\n");
  }

  // オブジェクトの解放
  Py_DECREF(obj1);
  Py_DECREF(obj2);

  return 0;
}

isinstance() 関数は、オブジェクトが特定の型であるかどうかを判断するために使用できます。

#include <Python.h>

int main() {
  // オブジェクトの作成
  PyObject *obj1 = PyFloat_FromDouble(3.14);
  PyObject *obj2 = PyList_New(0);

  // `isinstance()` 関数の使用
  if (isinstance(obj1, (PyObject *)&PyFloat_Type)) {
    printf("obj1は float 型です\n");
  } else {
    printf("obj1は float 型ではありません\n");
  }

  if (isinstance(obj2, (PyObject *)&PyList_Type)) {
    printf("obj2は list 型です\n");
  } else {
    printf("obj2は list 型ではありません\n");
  }

  // オブジェクトの解放
  Py_DECREF(obj1);
  Py_DECREF(obj2);

  return 0;
}

型情報の取得

オブジェクトの型情報は、Py_TYPE() マクロを使用して取得できます。

#include <Python.h>

int main() {
  // オブジェクトの作成
  PyObject *obj1 = PyFloat_FromDouble(3.14);
  PyObject *obj2 = PyList_New(0);

  // 型情報の取得
  if (Py_TYPE(obj1) == &PyFloat_Type) {
    printf("obj1は float 型です\n");
  } else {
    printf("obj1は float 型ではありません\n");
  }

  if (Py_TYPE(obj2) == &PyList_Type) {
    printf("obj2は list 型です\n");
  } else {
    printf("obj2は list 型ではありません\n");
  }

  // オブジェクトの解放
  Py_DECREF(obj1);
  Py_DECREF(obj2);

  return 0;
}

PyArray_IsPythonNumber() 関数以外にも、オブジェクトが Python 数値であるかどうかを確認するにはいくつかの方法があります。どの方法を使用するかは、状況によって異なります。