【Pythonプログラミング】型判別を使いこなす：`PyTypeNum_ISCOMPLEX()`, `PyArray_ISCOMPLEX()`, `PyComplex_Check()` の違いと使い分け

int PyTypeNum_ISCOMPLEX() は、NumPy C-API の関数の一つであり、指定された型が複素数型かどうかを判定します。

引数

type: 型オブジェクトへのポインタ

戻り値

型が複素数型でない場合: 0
型が複素数型の場合: 1

詳細

この関数は、主に NumPy の内部処理で使用されます。一般的に、ユーザーがこの関数を直接使用する必要はありません。

例

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

int main() {
  PyTypeObject *type = PyComplexDouble_Type;
  int is_complex = PyTypeNum_ISCOMPLEX(type);

  if (is_complex) {
    printf("型 %s は複素数型です\n", type->tp_name);
  } else {
    printf("型 %s は複素数型ではありません\n", type->tp_name);
  }

  return 0;
}

この例では、PyComplexDouble_Type 型が複素数型かどうかを判定しています。

PyComplexDouble_Type: 複素数の浮動小数点型
PyInt_Type: 整数型
PyFloat_Type: 浮動小数点型

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

int main() {
  PyTypeObject *types[] = {PyComplexDouble_Type, PyInt_Type, PyFloat_Type};
  int i;

  for (i = 0; i < 3; i++) {
    int is_complex = PyTypeNum_ISCOMPLEX(types[i]);

    printf("型 %s は: ", types[i]->tp_name);
    if (is_complex) {
      printf("複素数型\n");
    } else {
      printf("複素数型ではない\n");
    }
  }

  return 0;
}

出力例

型 PyComplexDouble_Type は: 複素数型
型 PyInt_Type は: 複素数型ではない
型 PyFloat_Type は: 複素数型ではない

このコードでは、PyTypeNum_ISCOMPLEX() 関数を用いて各型の判定を行っています。結果は出力の通り、PyComplexDouble_Type のみ複素数型であることが確認できます。

特定の型の配列が複素数型かどうかを判定

このコードは、PyArray_FROMPTR() 関数で作成した配列が複素数型かどうかを判定します。

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

int main() {
  double data[] = {1.0, 2.0, 3.0, 4.0};
  npy_intp dims[] = {2, 2};
  PyArrayObject *array = (PyArrayObject *)PyArray_FROMPTR(
      NPY_DOUBLE, dims, 2,
      NPY_CONTIGUOUS | NPY_FORTRANORDER, data,
      NULL, NULL, NULL);

  int is_complex = PyArray_ISCOMPLEX(array);

  if (is_complex) {
    printf("配列は複素数型です\n");
  } else {
    printf("配列は複素数型ではありません\n");
  }

  Py_DECREF(array);
  return 0;
}

NumPy 関数の引数が複素数型かどうかを判定

このコードは、NumPy 関数の引数が複素数型かどうかを判定します。

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

PyObject *my_function(PyObject *self, PyObject *args) {
  PyArrayObject *array;

  if (!PyArg_ParseTuple(args, "O!", &array)) {
    return NULL;
  }

  int is_complex = PyArray_ISCOMPLEX(array);

  if (is_complex) {
    // 複素数型の処理を行う
  } else {
    // 非複素数型の処理を行う
  }

  Py_RETURN_NONE;
}

PyTypeNum_ISCOMPLEX() 関数の代替方法としては、以下の方法が考えられます。

PyArray_ISCOMPLEX() 関数を使用する

PyArray_ISCOMPLEX() 関数は、NumPy 配列が複素数型かどうかを判定します。これは、PyTypeNum_ISCOMPLEX() 関数よりも一般的によく使用される方法です。

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

int main() {
  PyArrayObject *array = (PyArrayObject *)PyArray_ZEROS(2, NULL, NPY_DOUBLE);

  int is_complex = PyArray_ISCOMPLEX(array);

  if (is_complex) {
    printf("配列は複素数型です\n");
  } else {
    printf("配列は複素数型ではありません\n");
  }

  Py_DECREF(array);
  return 0;
}

PyComplex_Check() 関数を使用する

PyComplex_Check() 関数は、Python オブジェクトが複素数かどうかを判定します。これは、NumPy 配列だけでなく、Python で定義された任意の複素数オブジェクトを判定することができます。

#include <Python.h>

int main() {
  PyObject *complex_object = PyComplex_FromDoubles(1.0, 2.0);

  int is_complex = PyComplex_Check(complex_object);

  if (is_complex) {
    printf("オブジェクトは複素数です\n");
  } else {
    printf("オブジェクトは複素数ではありません\n");
  }

  Py_DECREF(complex_object);
  return 0;
}

型オブジェクトの tp_flags 属性を検査する

PyTypeNum_ISCOMPLEX() 関数は、Python の型オブジェクトの tp_flags 属性を検査することで動作します。この属性には、型の様々な情報がフラグとして格納されています。

#include <Python.h>

int is_complex(PyTypeObject *type) {
  return type->tp_flags & Py_TPFLAGS_COMPLEX;
}

int main() {
  PyTypeObject *types[] = {PyComplexDouble_Type, PyInt_Type, PyFloat_Type};
  int i;

  for (i = 0; i < 3; i++) {
    int is_complex = is_complex(types[i]);

    printf("型 %s は: ", types[i]->tp_name);
    if (is_complex) {
      printf("複素数型\n");
    } else {
      printf("複素数型ではない\n");
    }
  }

  return 0;
}

これらの方法はそれぞれ異なる用途に適しています。状況に応じて適切な方法を選択してください。

型オブジェクトの tp_flags 属性を直接検査する方法は、上級者向けのテクニックです。一般的には、PyArray_ISCOMPLEX() 関数または PyComplex_Check() 関数を使用することをお勧めします。
PyArray_ISCOMPLEX() 関数は、NumPy 配列のみを判定することができます。一方、PyComplex_Check() 関数は、Python で定義された任意の複素数オブジェクトを判定することができます。