浮動小数点オブジェクト

type PyFloatObject

この PyObject のサブタイプは Python の浮動小数点オブジェクトを表します。

PyTypeObject PyFloat_Type
次に属します: Stable ABI.

この PyTypeObject のインスタンスは Python の浮動小数点型を表します。 Python レベルの float と同じオブジェクトです。

int PyFloat_Check(PyObject *p)

引数が PyFloatObject か PyFloatObject のサブタイプであるときに真を返します。この関数は常に成功します。

int PyFloat_CheckExact(PyObject *p)

引数が PyFloatObject であるが PyFloatObject のサブタイプでないときに真を返します。この関数は常に成功します。

PyObject *PyFloat_FromString(PyObject *str)
戻り値: 新しい参照。 次に属します: Stable ABI.

str の文字列値をもとに PyFloatObject オブジェクトを生成します。失敗すると NULL を返します。

PyObject *PyFloat_FromDouble(double v)
戻り値: 新しい参照。 次に属します: Stable ABI.

v から PyFloatObject オブジェクトを生成して返します。 失敗すると NULL を返します。

double PyFloat_AsDouble(PyObject *pyfloat)
次に属します: Stable ABI.

pyfloat の値を C の double で返します。 pyfloat が Python の浮動小数点オブジェクトでなく、__float__() メソッドを持つ場合は、まずそのメソッドを呼び出して pyfloat を float に変換します。 __float__() が定義されていなければ __index__() を使います。 失敗した場合は -1.0 を返すので、PyErr_Occurred() を呼び出してエラーの有無を確認する必要があります。

バージョン 3.8 で変更: 可能であれば __index__() を使うようになりました。

double PyFloat_AS_DOUBLE(PyObject *pyfloat)

pyfloat の指す値を、 C の double 型表現で返しますが、エラーチェックを行いません。

PyObject *PyFloat_GetInfo(void)
戻り値: 新しい参照。 次に属します: Stable ABI.

float の精度、最小値、最大値に関する情報を含む structseq インスタンスを返します。これは、 float.h ファイルの薄いラッパーです。

double PyFloat_GetMax()
次に属します: Stable ABI.

表現できる最大の有限の浮動小数点数 DBL_MAX を C の double として返します。

double PyFloat_GetMin()
次に属します: Stable ABI.

float の正規化された最小の正の値 DBL_MIN を C の double 型で返します。

Py_INFINITY

This macro expands to a constant expression of type double, that represents the positive infinity.

On most platforms, this is equivalent to the INFINITY macro from the C11 standard <math.h> header.

Py_NAN

This macro expands to a constant expression of type double, that represents a quiet not-a-number (qNaN) value.

On most platforms, this is equivalent to the NAN macro from the C11 standard <math.h> header.

Py_HUGE_VAL

Equivalent to INFINITY.

バージョン 3.14 で非推奨: The macro is soft deprecated.

Py_MATH_E

The definition (accurate for a double type) of the math.e constant.

Py_MATH_El

High precision (long double) definition of e constant.

Py_MATH_PI

The definition (accurate for a double type) of the math.pi constant.

Py_MATH_PIl

High precision (long double) definition of pi constant.

Py_MATH_TAU

The definition (accurate for a double type) of the math.tau constant.

Added in version 3.6.

Py_RETURN_NAN

Return math.nan from a function.

On most platforms, this is equivalent to return PyFloat_FromDouble(NAN).

Py_RETURN_INF(sign)

Return math.inf or -math.inf from a function, depending on the sign of sign.

On most platforms, this is equivalent to the following:

return PyFloat_FromDouble(copysign(INFINITY, sign));
Py_IS_FINITE(X)

Return 1 if the given floating-point number X is finite, that is, it is normal, subnormal or zero, but not infinite or NaN. Return 0 otherwise.

バージョン 3.14 で非推奨: The macro is soft deprecated. Use isfinite instead.

Py_IS_INFINITY(X)

Return 1 if the given floating-point number X is positive or negative infinity. Return 0 otherwise.

バージョン 3.14 で非推奨: The macro is soft deprecated. Use isinf instead.

Py_IS_NAN(X)

Return 1 if the given floating-point number X is a not-a-number (NaN) value. Return 0 otherwise.

バージョン 3.14 で非推奨: The macro is soft deprecated. Use isnan instead.

パック関数とアンパック関数

The pack and unpack functions provide an efficient platform-independent way to store floating-point values as byte strings. The Pack routines produce a bytes string from a C double, and the Unpack routines produce a C double from such a bytes string. The suffix (2, 4 or 8) specifies the number of bytes in the bytes string.

On platforms that appear to use IEEE 754 formats these functions work by copying bits. On other platforms, the 2-byte format is identical to the IEEE 754 binary16 half-precision format, the 4-byte format (32-bit) is identical to the IEEE 754 binary32 single precision format, and the 8-byte format to the IEEE 754 binary64 double precision format, although the packing of INFs and NaNs (if such things exist on the platform) isn't handled correctly, and attempting to unpack a bytes string containing an IEEE INF or NaN will raise an exception.

On non-IEEE platforms with more precision, or larger dynamic range, than IEEE 754 supports, not all values can be packed; on non-IEEE platforms with less precision, or smaller dynamic range, not all values can be unpacked. What happens in such cases is partly accidental (alas).

Added in version 3.11.

パック関数

The pack routines write 2, 4 or 8 bytes, starting at p. le is an int argument, non-zero if you want the bytes string in little-endian format (exponent last, at p+1, p+3, or p+6 p+7), zero if you want big-endian format (exponent first, at p). The PY_BIG_ENDIAN constant can be used to use the native endian: it is equal to 1 on big endian processor, or 0 on little endian processor.

戻り値は、成功した場合は 0、エラーの場合は -1 です (例外も設定され、通常は OverflowError です)。

There are two problems on non-IEEE platforms:

  • What this does is undefined if x is a NaN or infinity.

  • -0.0 and +0.0 produce the same bytes string.

int PyFloat_Pack2(double x, char *p, int le)

C の double を IEEE 754 binary16 半精度形式にパックします。

int PyFloat_Pack4(double x, char *p, int le)

C の double を IEEE 754 binary32 単精度形式にパックします。

int PyFloat_Pack8(double x, char *p, int le)

C の double を IEEE 754 binary64 倍精度形式にパックします。

アンパック関数

The unpack routines read 2, 4 or 8 bytes, starting at p. le is an int argument, non-zero if the bytes string is in little-endian format (exponent last, at p+1, p+3 or p+6 and p+7), zero if big-endian (exponent first, at p). The PY_BIG_ENDIAN constant can be used to use the native endian: it is equal to 1 on big endian processor, or 0 on little endian processor.

戻り値は、アンパックした double です。 エラーの場合は -1.0 を返し、PyErr_Occurred() が真になります (例外も設定され、通常は OverflowError です)。

Note that on a non-IEEE platform this will refuse to unpack a bytes string that represents a NaN or infinity.

double PyFloat_Unpack2(const char *p, int le)

IEEE 754 binary16 半精度形式を C の double にアンパックします。

double PyFloat_Unpack4(const char *p, int le)

IEEE 754 binary32 単精度形式を C の double にアンパックします。

double PyFloat_Unpack8(const char *p, int le)

IEEE 754 binary64 倍精度形式を C の double にアンパックします。