Документация Python неофициальный перевод
Содержание страницы

Объекты комплексных чиселComplex Number Objects

type PyComplexObject

Этот подтип PyObject представляет объект комплексного числа Python.

Py_complex cval

Значение комплексного числа, использующее представление C Py_complex.

Устарело с версии 3.15, будет удалено в версии 3.20: Используйте PyComplex_AsCComplex() и PyComplex_FromCComplex() для преобразования комплексного числа Python в представление C Py_complex и обратно.

PyTypeObject PyComplex_Type
Часть Stable ABI.

Этот экземпляр PyTypeObject представляет тип комплексного числа Python. Это тот же объект, что и complex в слое Python.

int PyComplex_Check(PyObject *p)

Возвращает истину, если аргумент является PyComplexObject или подтипом PyComplexObject. Эта функция всегда завершается успешно.

int PyComplex_CheckExact(PyObject *p)

Возвращает истину, если аргумент является PyComplexObject, но не подтипом PyComplexObject. Эта функция всегда завершается успешно.

PyObject *PyComplex_FromDoubles(double real, double imag)
Возвращаемое значение: новая ссылка. Часть Stable ABI.

Возвращает новый объект PyComplexObject из real и imag. В случае ошибки возвращает NULL с установленным исключением.

double PyComplex_RealAsDouble(PyObject *op)
Часть Stable ABI.

Возвращает действительную часть op как C double.

Если op не является объектом комплексного числа Python, но имеет метод __complex__(), этот метод будет сначала вызван для преобразования op в объект комплексного числа Python. Если __complex__() не определён, то выполняется вызов PyFloat_AsDouble() и возвращается его результат.

При сбое этот метод возвращает -1.0 с установленным исключением, поэтому следует вызвать PyErr_Occurred() для проверки ошибок.

Изменено в версии 3.13: Используйте __complex__(), если доступно.

double PyComplex_ImagAsDouble(PyObject *op)
Часть Stable ABI.

Возвращает мнимую часть op как C double.

Если op не является объектом комплексного числа Python, но имеет метод __complex__(), этот метод будет сначала вызван для преобразования op в объект комплексного числа Python. Если __complex__() не определён, то выполняется вызов PyFloat_AsDouble() и в случае успеха возвращается 0.0.

При сбое этот метод возвращает -1.0 с установленным исключением, поэтому следует вызвать PyErr_Occurred() для проверки ошибок.

Изменено в версии 3.13: Используйте __complex__(), если доступно.

type Py_complex

Эта структура C определяет формат экспорта для объекта комплексного числа Python.

double real
double imag

Структура определяется как:

typedef struct {
    double real;
    double imag;
} Py_complex;
PyObject *PyComplex_FromCComplex(Py_complex v)
Возвращаемое значение: новая ссылка.

Создаёт новый объект комплексного числа Python из значения C Py_complex. Возвращает NULL с установленным исключением в случае ошибки.

Py_complex PyComplex_AsCComplex(PyObject *op)

Возвращает значение Py_complex комплексного числа op.

Если op не является объектом комплексного числа Python, но имеет метод __complex__(), сначала вызывается этот метод для преобразования op в объект комплексного числа Python. Если __complex__() не определён, используется __float__(). Если __float__() не определён, используется __index__().

В случае ошибки метод возвращает Py_complex с real, установленным в -1.0, и с установленным исключением, поэтому для проверки ошибок следует вызвать PyErr_Occurred().

Изменено в версии 3.8: Используйте __index__(), если доступно.

Комплексные числа как C-структурыComplex Numbers as C Structures

API также предоставляет функции для работы с комплексными числами, использующие представление Py_complex. Обратите внимание, что функции, принимающие эти структуры в качестве параметров и возвращающие их как результаты, делают это по значению, а не через разыменование указателей.

Обратите внимание, что эти функции мягко устарели начиная с Python 3.15. Избегайте использования этого API в новом коде для арифметики комплексных чисел: используйте либо API протокол Number, либо встроенные комплексные типы, такие как double complex.

Py_complex _Py_c_sum(Py_complex left, Py_complex right)

Возвращает сумму двух комплексных чисел, используя C-представление Py_complex.

Устарело с версии 3.15.

Py_complex _Py_c_diff(Py_complex left, Py_complex right)

Возвращает разность двух комплексных чисел, используя C-представление Py_complex.

Устарело с версии 3.15.

Py_complex _Py_c_neg(Py_complex num)

Возвращает отрицание комплексного числа num, используя C-представление Py_complex.

Устарело с версии 3.15.

Py_complex _Py_c_prod(Py_complex left, Py_complex right)

Возвращает произведение двух комплексных чисел, используя C-представление Py_complex.

Устарело с версии 3.15.

Py_complex _Py_c_quot(Py_complex dividend, Py_complex divisor)

Возвращает частное двух комплексных чисел, используя C-представление Py_complex.

Если divisor равен нулю, метод возвращает ноль и устанавливает errno в EDOM.

Устарело с версии 3.15.

Py_complex _Py_c_pow(Py_complex num, Py_complex exp)

Возвращает возведение num в степень exp, используя C-представление Py_complex.

Если num равен нулю, а exp не является положительным действительным числом, метод возвращает ноль и устанавливает errno в EDOM.

Устанавливает errno в ERANGE при переполнениях.

Устарело с версии 3.15.

double _Py_c_abs(Py_complex num)

Возвращает абсолютное значение комплексного числа num.

Устанавливает errno в ERANGE при переполнениях.

Устарело с версии 3.15.