اشیاء ممیز شناور¶
-
PyTypeObject PyFloat_Type¶
- قسمتی از ABI پایدار.
این نمونه از
PyTypeObjectنوع ممیز شناور پایتون را نشان می‌دهد. این همان شیءfloatدر لایه‌ی پایتون است.
-
int PyFloat_Check(PyObject *p)¶
اگر آرگومان آن یک
PyFloatObjectیا زیرنوعی ازPyFloatObjectباشد، مقدار درست را برمی‌گرداند. این تابع همیشه با موفقیت انجام می‌شود.
-
int PyFloat_CheckExact(PyObject *p)¶
اگر آرگومان آن یک
PyFloatObjectباشد، اما زیرنوعی ازPyFloatObjectنباشد، مقدار true برمی‌گرداند. این تابع همیشه موفق می‌شود.
-
PyObject *PyFloat_FromString(PyObject *str)¶
- مقدار بازگشتی: مرجع جدید. قسمتی از ABI پایدار.
ایجاد یک شیء
PyFloatObjectبر اساس مقدار رشته در str، یاNULLدر صورت شکست.
-
PyObject *PyFloat_FromDouble(double v)¶
- مقدار بازگشتی: مرجع جدید. قسمتی از ABI پایدار.
یک شیء
PyFloatObjectاز v می‌سازد، یا در صورت شکستNULL.
-
double PyFloat_AsDouble(PyObject *pyfloat)¶
- قسمتی از ABI پایدار.
یک نمایش double در C از محتویات pyfloat برمی‌گرداند. اگر pyfloat یک شیء ممیز شناور پایتون نباشد اما متد
__float__()را داشته باشد، این متد ابتدا برای تبدیل pyfloat به یک عدد ممیز شناور فراخوانی می‌شود. اگر__float__()تعریف‌نشده باشد، به__index__()بازمی‌گردد. این متد در صورت شکست-1.0را برمی‌گرداند، بنابراین برای بررسی خطاها بایدPyErr_Occurred()را فراخوانی کنید.تغییر یافته در نسخه‌ی 3.8: در صورت وجود، از
__index__()استفاده کنید.
-
double PyFloat_AS_DOUBLE(PyObject *pyfloat)¶
نمایش C double از محتویات pyfloat را برمی‌گرداند، اما بدون بررسی خطا.
-
PyObject *PyFloat_GetInfo(void)¶
- مقدار بازگشتی: مرجع جدید. قسمتی از ABI پایدار.
یک نمونه از دنباله ساختاری برمی‌گرداند که اطلاعاتی درباره‌ی دقت و مقادیر کمینه و بیشینه‌ی یک عدد ممیز شناور در بر دارد. این یک دربرگیرنده‌ی نازک حول پرونده‌ی سرآیند
float.hاست.
-
double PyFloat_GetMax()¶
- قسمتی از ABI پایدار.
بزرگ‌ترین عدد ممیز شناور محدود قابل نمایش DBL_MAX را به‌صورت double در C برمی‌گرداند.
-
double PyFloat_GetMin()¶
- قسمتی از ABI پایدار.
کمترین عدد اعشاری مثبت نرمال‌شده DBL_MIN را به‌صورت double در C برمی‌گرداند.
-
Py_INFINITY¶
این ماکرو به یک عبارت ثابت از نوع double بسط می‌یابد که بی‌نهایت مثبت را نشان می‌دهد.
این معادل کلان‌دستور
INFINITYاز سرآیند<math.h>استاندارد C11 است.منسوخ‌سازی نرم <Soft deprecated> از نسخه‌ی 3.15.
-
Py_NAN¶
این ماکرو به عبارت ثابتی از نوع double بسط می‌یابد که نشان‌دهنده‌ی مقدار عدد-نیست ساکت (qNaN) است.
در بیشتر پلتفرم‌ها، این معادل ماکروی
NANاز سرآیند<math.h>استاندارد C11 است.
-
Py_HUGE_VAL¶
معادل
INFINITYاست.منسوخ‌سازی نرم <Soft deprecated> از نسخه‌ی 3.14.
-
Py_MATH_El¶
تعریف با دقت بالا (long double) ثابت
e.منسوخ شده از نسخه‌ی 3.15, در نسخه‌ی 3.20 حذف خواهد شد.
-
Py_MATH_PIl¶
تعریف ثابت
piبا دقت بالا (long double).منسوخ شده از نسخه‌ی 3.15, در نسخه‌ی 3.20 حذف خواهد شد.
-
Py_RETURN_NAN¶
برگرداندن
math.nanاز یک تابع.در اکثر پلتفرم‌ها، این معادل
return PyFloat_FromDouble(NAN)است.
-
Py_RETURN_INF(sign)¶
برگرداندن
math.infیا-math.infاز یک تابع، بسته به علامت sign.در اغلب پلتفرم‌ها، این معادل موارد زیر است:
return PyFloat_FromDouble(copysign(INFINITY, sign));
-
Py_IS_FINITE(X)¶
اگر عدد ممیز شناور داده‌شده X متناهی باشد، یعنی نرمال، زیرنرمال یا صفر باشد، اما بی‌نهایت یا NaN نباشد،
1را برمی‌گرداند. در غیر این صورت0را برمی‌گرداند.منسوخ‌سازی نرم <Soft deprecated> از نسخه‌ی 3.14: به جای آن از
isfiniteاستفاده کنید.
-
Py_IS_INFINITY(X)¶
اگر عدد ممیز شناورِ داده‌شده‌ی X بی‌نهایت مثبت یا منفی باشد،
1را برمی‌گرداند. در غیر این صورت0را برمی‌گرداند.منسوخ‌سازی نرم <Soft deprecated> از نسخه‌ی 3.14: به جای آن از
isinfاستفاده کنید.
-
Py_IS_NAN(X)¶
اگر عدد ممیز شناورِ داده‌شده‌ی X مقداری غیرعددی (NaN) باشد،
1را برمی‌گرداند. در غیر این صورت0را برمی‌گرداند.منسوخ‌سازی نرم <Soft deprecated> از نسخه‌ی 3.14: به جای آن از
isnanاستفاده کنید.
توابع بسته‌بندی و باز کردن بسته‌بندی¶
توابع pack و unpack روشی کارآمد و مستقل از پلتفرم برای ذخیره‌سازی مقادیر ممیز شناور به صورت رشته‌های بایتی فراهم می‌کنند. روال‌های Pack یک رشته‌ی bytes از یک double در زبان C تولید می‌کنند و روال‌های Unpack یک double در زبان C را از چنین رشته‌ی bytesی به دست می‌آورند. پسوند (۲، ۴ یا ۸) تعداد بایت‌ها را در رشته‌ی bytes مشخص می‌کند:
فرمت ۲ بایتی، فرمت دقت نیمه‌ی binary16 استاندارد IEEE 754 است.
فرمت ۴ بایتی، فرمت دقت تک (single-precision) استاندارد IEEE 754 binary32 است.
فرمت ۸ بایتی، فرمت ممیز شناور با دقت مضاعف binary64 استاندارد IEEE 754 است.
نوع NaN ممکن است روی برخی از پلتفرم‌ها هنگام بازکردن بسته حفظ نشود (مقادیر signaling NaN به quiet NaN تبدیل می‌شوند)، برای مثال روی سیستم‌های x86 در حالت ۳۲ بیتی.
فرض بر این است که نوع double دارای فرمت ممیز شناور با دقت مضاعف binary64 استاندارد IEEE 754 است. این که اگر این طور نباشد چه اتفاقی می‌افتد تا حدی اتفاقی است (متأسفانه). روی پلتفرم‌های غیر IEEE با دقت بیشتر یا بازه‌ی پویای بزرگ‌تر نسبت به آن چه IEEE 754 پشتیبانی می‌کند، همه‌ی مقادیر را نمی‌توان بسته‌بندی کرد؛ و روی پلتفرم‌های غیر IEEE با دقت کمتر یا بازه‌ی پویای کوچک‌تر، همه‌ی مقادیر را نمی‌توان باز کرد. بسته‌بندی اعداد خاص مانند INFها و NaNها (اگر چنین چیزهایی روی پلتفرم وجود داشته باشد) ممکن است به درستی مدیریت نشود و تلاش برای بازکردن بسته‌ی یک رشته‌ی bytes حاوی یک INF یا NaN استاندارد IEEE ممکن است باعث بروز یک استثنا شود.
اضافه شده در نسخه‌ی 3.11.
توابع بسته‌بندی¶
روال‌های pack تعداد ۲، ۴ یا ۸ بایت را از p به بعد می‌نویسند. پارامتر le یک آرگومان int است که اگر بخواهید رشته‌ی بایتی در فرمت کوچک‌اندیان (توان در انتها، در p+1، p+3، یا p+6 و p+7) باشد، غیرصفر است و اگر فرمت بزرگ‌اندیان (توان در ابتدا، در p) را بخواهید، صفر است. از ثابت PY_LITTLE_ENDIAN برای انتخاب اندیان بومی استفاده کنید: این مقدار روی پردازنده‌ی بزرگ‌اندیان برابر با 0 و روی پردازنده‌ی کوچک‌اندیان برابر با 1 است.
مقدار بازگشتی: 0 در صورت موفقیت، -1 در صورت خطا (و استثنا تنظیم‌شده است، به احتمال زیاد OverflowError).
-
int PyFloat_Pack2(double x, char *p, int le)¶
یک ممیز شناور با دقت مضاعف در C را به قالب binary16 با دقت نصف IEEE 754 بسته‌بندی می‌کند.
-
int PyFloat_Pack4(double x, char *p, int le)¶
یک ممیز شناور با دقت مضاعف در C را به قالب IEEE 754 binary32 با دقت منفرد بسته‌بندی می‌کند.
-
int PyFloat_Pack8(double x, char *p, int le)¶
یک double زبان C را به قالب دقت مضاعف binary64 استاندارد IEEE 754 بسته‌بندی می‌کند.
توابع واگشایی¶
روال‌های unpack تعداد ۲، ۴ یا ۸ بایت را از p به بعد می‌خوانند. پارامتر le یک آرگومان int است که اگر رشته‌ی بایتی در فرمت کوچک‌اندیان (توان در انتها، در p+1، p+3 یا p+6 و p+7) باشد، غیرصفر است و اگر بزرگ‌اندیان باشد (توان در ابتدا، در p)، صفر است. از ثابت PY_LITTLE_ENDIAN برای انتخاب اندیان بومی استفاده کنید: این مقدار روی پردازنده‌ی بزرگ‌اندیان برابر با 0 و روی پردازنده‌ی کوچک‌اندیان برابر با 1 است.
مقدار بازگشتی: ممیز شناور با دقت مضاعفِ واگشایی‌شده. در صورت خطا، این مقدار -1.0 است و PyErr_Occurred() درست است (و استثنایی تنظیم‌شده است که به احتمال زیاد OverflowError است).
-
double PyFloat_Unpack2(const char *p, int le)¶
قالب IEEE 754 binary16 با دقت نصف را به‌صورت یک double در C واگشایی می‌کند.
-
double PyFloat_Unpack4(const char *p, int le)¶
واگشایی کردن قالب دقت منفرد binary32 از IEEE 754 به‌صورت double در C.
-
double PyFloat_Unpack8(const char *p, int le)¶
قالب دقت مضاعف binary64 در استاندارد IEEE 754 را به‌صورت یک double در C واگشایی می‌کند.