复数对象

Python 的复数对象在 C API 中被视为两种不同的类型实现：一种是暴露给 Python 程序的 Python 对象，另一种是表示实际复数值的 C 结构。该 API 提供了用于处理这两种类型的功能。

作为 C 结构的复数

请注意，接受这些结构作为参数并将其作为结果返回的函数是“按值”而不是通过指针解引用来执行此操作的。这在整个 API 中保持一致。

type Py_complex

对应于 Python 复数对象的数值部分的 C 结构。大多数处理复数对象的函数都将此类型的结构用作输入或输出值，视情况而定。

double real

double imag

该结构定义如下

typedef struct {
    double real;
    double imag;
} Py_complex;

Py_complex _Py_c_sum(Py_complex left, Py_complex right)

使用 C Py_complex 表示返回两个复数的和。

Py_complex _Py_c_diff(Py_complex left, Py_complex right)

使用 C Py_complex 表示返回两个复数之间的差。

Py_complex _Py_c_neg(Py_complex num)

使用 C Py_complex 表示返回复数 num 的负数。

Py_complex _Py_c_prod(Py_complex left, Py_complex right)

使用 C Py_complex 表示返回两个复数的积。

Py_complex _Py_c_quot(Py_complex dividend, Py_complex divisor)

使用 C Py_complex 表示返回两个复数的商。

如果 divisor 为空，此方法返回零并将 errno 设置为 EDOM。

Py_complex _Py_c_pow(Py_complex num, Py_complex exp)

使用 C Py_complex 表示返回 num 的 exp 次幂。

如果 num 为空且 exp 不是正实数，此方法返回零并将 errno 设置为 EDOM。

溢出时将 errno 设置为 ERANGE。

作为 Python 对象的复数

type PyComplexObject

PyObject 的这个子类型表示一个 Python 复数对象。

PyTypeObject PyComplex_Type

作为 稳定 ABI 的一部分。

PyTypeObject 的这个实例表示 Python 复数类型。它与 Python 层中的 complex 是同一个对象。

int PyComplex_Check(PyObject *p)

如果其参数是 PyComplexObject 或 PyComplexObject 的子类型，则返回 true。此函数始终成功。

int PyComplex_CheckExact(PyObject *p)

如果其参数是 PyComplexObject，但不是 PyComplexObject 的子类型，则返回 true。此函数始终成功。

PyObject *PyComplex_FromCComplex(Py_complex v)

返回值：新引用。

从 C Py_complex 值创建一个新的 Python 复数对象。失败时返回 NULL 并设置一个异常。

PyObject *PyComplex_FromDoubles(double real, double imag)

返回值: 新引用。 稳定ABI 的一部分。

从 real 和 imag 返回一个新的 PyComplexObject 对象。失败时返回 NULL 并设置一个异常。

double PyComplex_RealAsDouble(PyObject *op)

作为 稳定 ABI 的一部分。

将 op 的实部作为 C double 返回。

如果 op 不是 Python 复数对象但具有 __complex__() 方法，则首先调用此方法将 op 转换为 Python 复数对象。如果未定义 __complex__()，则回退调用 PyFloat_AsDouble() 并返回其结果。

失败时，此方法返回 -1.0 并设置一个异常，因此应调用 PyErr_Occurred() 来检查错误。

3.13 版本中已更改: 如果可用，使用 __complex__()。

double PyComplex_ImagAsDouble(PyObject *op)

作为 稳定 ABI 的一部分。

将 op 的虚部作为 C double 返回。

如果 op 不是 Python 复数对象但具有 __complex__() 方法，则首先调用此方法将 op 转换为 Python 复数对象。如果未定义 __complex__()，则回退调用 PyFloat_AsDouble() 并在成功时返回 0.0。

失败时，此方法返回 -1.0 并设置一个异常，因此应调用 PyErr_Occurred() 来检查错误。

3.13 版本中已更改: 如果可用，使用 __complex__()。

Py_complex PyComplex_AsCComplex(PyObject *op)

返回复数 op 的 Py_complex 值。

如果 op 不是 Python 复数对象但具有 __complex__() 方法，则首先调用此方法将 op 转换为 Python 复数对象。如果未定义 __complex__()，则回退到 __float__()。如果未定义 __float__()，则回退到 __index__()。

失败时，此方法返回 Py_complex，其中 real 设置为 -1.0 并设置一个异常，因此应调用 PyErr_Occurred() 来检查错误。

3.8 版本发生变更: 使用 __index__()（如果可用）。