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

Комплексные числа как структуры C

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

type Py_complex

Структура C, которая соответствует значению части объекта комплексного числа Python. Большинство функций для работы с объектами комплексных чисел используют структуры этого типа в качестве входных или выходных значений, в зависимости от ситуации.

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)

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

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)

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

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

Комплексные числа как объекты Python

type PyComplexObject

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

PyTypeObject PyComplex_Type

Часть Стабильной ABI.

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

int PyComplex_Check(PyObject *p)

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

int PyComplex_CheckExact(PyObject *p)

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

PyObject *PyComplex_FromCComplex(Py_complex v)

Возвращаемое значение: новая ссылка.

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

PyObject *PyComplex_FromDoubles(double real, double imag)

Возвращаемое значение: новая ссылка. Часть Стабильной ABI.

Возвращает новый объект PyComplexObject из real и imag. Возвращает 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)

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

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

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

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