اشیاء عدد مختلط¶

اشیاء عدد مختلط پایتون از دید API زبان C به‌صورت دو نوع متمایز پیاده‌سازی شده‌اند: یکی شیء پایتونی است که در اختیار برنامه‌های پایتون قرار می‌گیرد، و دیگری ساختاری در C است که مقدار واقعی عدد مختلط را نمایندگی می‌کند. این API توابعی برای کار با هر دو فراهم می‌کند.

اعداد مختلط به‌عنوان ساختارهای C¶

توجه داشته باشید که توابعی که این ساختارها را به‌عنوان پارامتر می‌پذیرند و آن‌ها را به‌عنوان نتیجه برمی‌گردانند، این کار را به‌صورت مقدار انجام می‌دهند، نه با ارجاع‌زدایی (dereferencing) آن‌ها از طریق اشاره‌گرها. این موضوع در سراسر API یکسان است.

type Py_complex¶

ساختار 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)¶: نقیض عدد مختلط num را با استفاده از نمایش C Py_complex برمی‌گرداند.

Py_complex _Py_c_prod(Py_complex left, Py_complex right)¶: حاصل‌ضرب دو عدد مختلط را با استفاده از نمایش Py_complex در C برمی‌گرداند.

Py_complex _Py_c_quot(Py_complex dividend, Py_complex divisor)¶

خارج قسمت دو عدد مختلط را با استفاده از نمایش Py_complex در C برمی‌گرداند.

اگر divisor تهی باشد، این متد صفر را برمی‌گرداند و errno را برابر EDOM قرار می‌دهد.

Py_complex _Py_c_pow(Py_complex num, Py_complex exp)¶

توان num به exp را با استفاده از نمایش C Py_complex برمی‌گرداند.

اگر num صفر باشد و exp عدد حقیقی مثبت نباشد، این متد صفر را برمی‌گرداند و مقدار errno را برابر EDOM قرار می‌دهد.

در صورت سرریز، errno را برابر ERANGE قرار می‌دهد.

اعداد مختلط به‌عنوان اشیاء پایتون¶

type PyComplexObject¶: این زیرنوع از PyObject نمایانگر یک شیء عدد مختلط پایتون است.

PyTypeObject PyComplex_Type¶: قسمتی از ABI پایدار.
این نمونه از PyTypeObject نوع عدد مختلط پایتون را نشان می‌دهد. این همان شیء complex در لایه‌ی پایتون است.

int PyComplex_Check(PyObject *p)¶: اگر آرگومان آن یک PyComplexObject یا زیرنوعی از PyComplexObject باشد، مقدار درست را برمی‌گرداند. این تابع همیشه موفق می‌شود.

int PyComplex_CheckExact(PyObject *p)¶: در صورتی که آرگومان آن یک PyComplexObject باشد، اما زیرنوعی از PyComplexObject نباشد، مقدار true را برمی‌گرداند. این تابع همیشه موفق می‌شود.

PyObject *PyComplex_FromCComplex(Py_complex v)¶: مقدار بازگشتی: مرجع جدید.
یک شیء عدد مختلط جدید پایتون را از یک مقدار Py_complex در C ایجاد می‌کند. در صورت خطا، NULL به همراه یک استثنای تنظیم‌شده برگردانده می‌شود.

PyObject *PyComplex_FromDoubles(double real, double imag)¶: مقدار بازگشتی: مرجع جدید. قسمتی از ABI پایدار.
یک شیء جدید PyComplexObject از real و imag برمی‌گرداند. در صورت خطا، NULL به همراه یک استثنای تنظیم‌شده برمی‌گرداند.

double PyComplex_RealAsDouble(PyObject *op)¶

قسمتی از ABI پایدار.

بخش حقیقی op را به‌صورت یک double در C برمی‌گرداند.

اگر op یک شیء عدد مختلط پایتون نباشد اما متد __complex__() را داشته باشد، این متد ابتدا برای تبدیل op به یک شیء عدد مختلط پایتون فراخوانی می‌شود. اگر __complex__() تعریف نشده باشد، به فراخوانی PyFloat_AsDouble() بازمی‌گردد و نتیجه‌ی آن را برمی‌گرداند.

در صورت شکست، این متد -1.0 را همراه با یک استثنای تنظیم‌شده برمی‌گرداند، بنابراین برای بررسی خطاها باید PyErr_Occurred() را فراخوانی کنید.

تغییر یافته در نسخه‌ی 3.13: در صورت وجود، از __complex__() استفاده کنید.

double PyComplex_ImagAsDouble(PyObject *op)¶

قسمتی از ABI پایدار.

بخش موهومی op را به‌صورت یک double در C برمی‌گرداند.

اگر op یک شیء عدد مختلط پایتون نباشد اما متد __complex__() را داشته باشد، این متد ابتدا برای تبدیل op به یک شیء عدد مختلط پایتون فراخوانی می‌شود. اگر __complex__() تعریف نشده باشد، به فراخوانی PyFloat_AsDouble() روی می‌آورد و در صورت موفقیت مقدار 0.0 را برمی‌گرداند.

در صورت شکست، این متد -1.0 را همراه با یک استثنای تنظیم‌شده برمی‌گرداند، بنابراین برای بررسی خطاها باید PyErr_Occurred() را فراخوانی کنید.

تغییر یافته در نسخه‌ی 3.13: در صورت وجود، از __complex__() استفاده کنید.

Py_complex PyComplex_AsCComplex(PyObject *op)¶

مقدار Py_complex عدد مختلط op را برمی‌گرداند.

اگر op یک شیء عدد مختلط پایتون نباشد اما متد __complex__() را داشته باشد، این متد ابتدا فراخوانی می‌شود تا op را به یک شیء عدد مختلط پایتون تبدیل کند. اگر __complex__() تعریف‌نشده باشد، به جای آن از __float__() استفاده می‌شود. اگر __float__() تعریف‌نشده باشد، به جای آن از __index__() استفاده می‌شود.

در صورت شکست، این متد یک Py_complex برمی‌گرداند که real آن روی -1.0 تنظیم شده و یک استثنا نیز تنظیم شده است؛ بنابراین برای بررسی خطاها باید PyErr_Occurred() را فراخوانی کرد.

تغییر یافته در نسخه‌ی 3.8: در صورت وجود، از __index__() استفاده کنید.

اشیاء عدد مختلط¶

اعداد مختلط به‌عنوان ساختارهای C¶

اعداد مختلط به‌عنوان اشیاء پایتون¶

فهرست مطالب

موضوع قبلی

موضوع بعدی

این صفحه