2 /* Float object implementation */
4 /* XXX There should be overflow checks here, but it's hard to check
5 for any kind of float exception without losing portability. */
15 #define MAX(x, y) ((x) < (y) ? (y) : (x))
16 #define MIN(x, y) ((x) < (y) ? (x) : (y))
24 /* OSF1 5.1 doesn't make this available with XOPEN_SOURCE_EXTENDED defined */
25 extern int finite(double);
28 /* Special free list -- see comments for same code in intobject.c. */
29 #define BLOCK_SIZE 1000 /* 1K less typical malloc overhead */
30 #define BHEAD_SIZE 8 /* Enough for a 64-bit pointer */
31 #define N_FLOATOBJECTS ((BLOCK_SIZE - BHEAD_SIZE) / sizeof(PyFloatObject))
34 struct _floatblock
*next
;
35 PyFloatObject objects
[N_FLOATOBJECTS
];
38 typedef struct _floatblock PyFloatBlock
;
40 static PyFloatBlock
*block_list
= NULL
;
41 static PyFloatObject
*free_list
= NULL
;
43 static PyFloatObject
*
47 /* XXX Float blocks escape the object heap. Use PyObject_MALLOC ??? */
48 p
= (PyFloatObject
*) PyMem_MALLOC(sizeof(PyFloatBlock
));
50 return (PyFloatObject
*) PyErr_NoMemory();
51 ((PyFloatBlock
*)p
)->next
= block_list
;
52 block_list
= (PyFloatBlock
*)p
;
53 p
= &((PyFloatBlock
*)p
)->objects
[0];
54 q
= p
+ N_FLOATOBJECTS
;
56 Py_TYPE(q
) = (struct _typeobject
*)(q
-1);
58 return p
+ N_FLOATOBJECTS
- 1;
73 static PyTypeObject FloatInfoType
;
75 PyDoc_STRVAR(floatinfo__doc__
,
78 A structseq holding information about the float type. It contains low level\n\
79 information about the precision and internal representation. Please study\n\
80 your system's :file:`float.h` for more information.");
82 static PyStructSequence_Field floatinfo_fields
[] = {
83 {"max", "DBL_MAX -- maximum representable finite float"},
84 {"max_exp", "DBL_MAX_EXP -- maximum int e such that radix**(e-1) "
86 {"max_10_exp", "DBL_MAX_10_EXP -- maximum int e such that 10**e "
88 {"min", "DBL_MIN -- Minimum positive normalizer float"},
89 {"min_exp", "DBL_MIN_EXP -- minimum int e such that radix**(e-1) "
90 "is a normalized float"},
91 {"min_10_exp", "DBL_MIN_10_EXP -- minimum int e such that 10**e is "
93 {"dig", "DBL_DIG -- digits"},
94 {"mant_dig", "DBL_MANT_DIG -- mantissa digits"},
95 {"epsilon", "DBL_EPSILON -- Difference between 1 and the next "
96 "representable float"},
97 {"radix", "FLT_RADIX -- radix of exponent"},
98 {"rounds", "FLT_ROUNDS -- addition rounds"},
102 static PyStructSequence_Desc floatinfo_desc
= {
103 "sys.floatinfo", /* name */
104 floatinfo__doc__
, /* doc */
105 floatinfo_fields
, /* fields */
110 PyFloat_GetInfo(void)
115 floatinfo
= PyStructSequence_New(&FloatInfoType
);
116 if (floatinfo
== NULL
) {
120 #define SetIntFlag(flag) \
121 PyStructSequence_SET_ITEM(floatinfo, pos++, PyLong_FromLong(flag))
122 #define SetDblFlag(flag) \
123 PyStructSequence_SET_ITEM(floatinfo, pos++, PyFloat_FromDouble(flag))
126 SetIntFlag(DBL_MAX_EXP
);
127 SetIntFlag(DBL_MAX_10_EXP
);
129 SetIntFlag(DBL_MIN_EXP
);
130 SetIntFlag(DBL_MIN_10_EXP
);
132 SetIntFlag(DBL_MANT_DIG
);
133 SetDblFlag(DBL_EPSILON
);
134 SetIntFlag(FLT_RADIX
);
135 SetIntFlag(FLT_ROUNDS
);
139 if (PyErr_Occurred()) {
147 PyFloat_FromDouble(double fval
)
149 register PyFloatObject
*op
;
150 if (free_list
== NULL
) {
151 if ((free_list
= fill_free_list()) == NULL
)
154 /* Inline PyObject_New */
156 free_list
= (PyFloatObject
*)Py_TYPE(op
);
157 PyObject_INIT(op
, &PyFloat_Type
);
159 return (PyObject
*) op
;
163 PyFloat_FromString(PyObject
*v
)
165 const char *s
, *last
, *end
;
167 char buffer
[256]; /* for errors */
168 char *s_buffer
= NULL
;
170 PyObject
*result
= NULL
;
172 if (PyUnicode_Check(v
)) {
173 s_buffer
= (char *)PyMem_MALLOC(PyUnicode_GET_SIZE(v
)+1);
174 if (s_buffer
== NULL
)
175 return PyErr_NoMemory();
176 if (PyUnicode_EncodeDecimal(PyUnicode_AS_UNICODE(v
),
177 PyUnicode_GET_SIZE(v
),
184 else if (PyObject_AsCharBuffer(v
, &s
, &len
)) {
185 PyErr_SetString(PyExc_TypeError
,
186 "float() argument must be a string or a number");
191 while (Py_ISSPACE(*s
))
193 /* We don't care about overflow or underflow. If the platform
194 * supports them, infinities and signed zeroes (on underflow) are
196 x
= PyOS_string_to_double(s
, (char **)&end
, NULL
);
197 if (x
== -1.0 && PyErr_Occurred())
199 while (Py_ISSPACE(*end
))
202 result
= PyFloat_FromDouble(x
);
204 PyOS_snprintf(buffer
, sizeof(buffer
),
205 "invalid literal for float(): %.200s", s
);
206 PyErr_SetString(PyExc_ValueError
, buffer
);
212 PyMem_FREE(s_buffer
);
217 float_dealloc(PyFloatObject
*op
)
219 if (PyFloat_CheckExact(op
)) {
220 Py_TYPE(op
) = (struct _typeobject
*)free_list
;
224 Py_TYPE(op
)->tp_free((PyObject
*)op
);
228 PyFloat_AsDouble(PyObject
*op
)
234 if (op
&& PyFloat_Check(op
))
235 return PyFloat_AS_DOUBLE((PyFloatObject
*) op
);
242 if ((nb
= Py_TYPE(op
)->tp_as_number
) == NULL
|| nb
->nb_float
== NULL
) {
243 PyErr_SetString(PyExc_TypeError
, "a float is required");
247 fo
= (PyFloatObject
*) (*nb
->nb_float
) (op
);
250 if (!PyFloat_Check(fo
)) {
251 PyErr_SetString(PyExc_TypeError
,
252 "nb_float should return float object");
256 val
= PyFloat_AS_DOUBLE(fo
);
262 /* Macro and helper that convert PyObject obj to a C double and store
263 the value in dbl. If conversion to double raises an exception, obj is
264 set to NULL, and the function invoking this macro returns NULL. If
265 obj is not of float, int or long type, Py_NotImplemented is incref'ed,
266 stored in obj, and returned from the function invoking this macro.
268 #define CONVERT_TO_DOUBLE(obj, dbl) \
269 if (PyFloat_Check(obj)) \
270 dbl = PyFloat_AS_DOUBLE(obj); \
271 else if (convert_to_double(&(obj), &(dbl)) < 0) \
277 convert_to_double(PyObject
**v
, double *dbl
)
279 register PyObject
*obj
= *v
;
281 if (PyLong_Check(obj
)) {
282 *dbl
= PyLong_AsDouble(obj
);
283 if (*dbl
== -1.0 && PyErr_Occurred()) {
289 Py_INCREF(Py_NotImplemented
);
290 *v
= Py_NotImplemented
;
297 float_str_or_repr(PyFloatObject
*v
, int precision
, char format_code
)
300 char *buf
= PyOS_double_to_string(PyFloat_AS_DOUBLE(v
),
301 format_code
, precision
,
305 return PyErr_NoMemory();
306 result
= PyUnicode_FromString(buf
);
312 float_repr(PyFloatObject
*v
)
314 return float_str_or_repr(v
, 0, 'r');
318 float_str(PyFloatObject
*v
)
320 return float_str_or_repr(v
, PyFloat_STR_PRECISION
, 'g');
323 /* Comparison is pretty much a nightmare. When comparing float to float,
324 * we do it as straightforwardly (and long-windedly) as conceivable, so
325 * that, e.g., Python x == y delivers the same result as the platform
326 * C x == y when x and/or y is a NaN.
327 * When mixing float with an integer type, there's no good *uniform* approach.
328 * Converting the double to an integer obviously doesn't work, since we
329 * may lose info from fractional bits. Converting the integer to a double
330 * also has two failure modes: (1) a long int may trigger overflow (too
331 * large to fit in the dynamic range of a C double); (2) even a C long may have
332 * more bits than fit in a C double (e.g., on a a 64-bit box long may have
333 * 63 bits of precision, but a C double probably has only 53), and then
334 * we can falsely claim equality when low-order integer bits are lost by
335 * coercion to double. So this part is painful too.
339 float_richcompare(PyObject
*v
, PyObject
*w
, int op
)
344 assert(PyFloat_Check(v
));
345 i
= PyFloat_AS_DOUBLE(v
);
347 /* Switch on the type of w. Set i and j to doubles to be compared,
348 * and op to the richcomp to use.
350 if (PyFloat_Check(w
))
351 j
= PyFloat_AS_DOUBLE(w
);
353 else if (!Py_IS_FINITE(i
)) {
355 /* If i is an infinity, its magnitude exceeds any
356 * finite integer, so it doesn't matter which int we
357 * compare i with. If i is a NaN, similarly.
364 else if (PyLong_Check(w
)) {
365 int vsign
= i
== 0.0 ? 0 : i
< 0.0 ? -1 : 1;
366 int wsign
= _PyLong_Sign(w
);
370 if (vsign
!= wsign
) {
371 /* Magnitudes are irrelevant -- the signs alone
372 * determine the outcome.
378 /* The signs are the same. */
379 /* Convert w to a double if it fits. In particular, 0 fits. */
380 nbits
= _PyLong_NumBits(w
);
381 if (nbits
== (size_t)-1 && PyErr_Occurred()) {
382 /* This long is so large that size_t isn't big enough
383 * to hold the # of bits. Replace with little doubles
384 * that give the same outcome -- w is so large that
385 * its magnitude must exceed the magnitude of any
395 j
= PyLong_AsDouble(w
);
396 /* It's impossible that <= 48 bits overflowed. */
397 assert(j
!= -1.0 || ! PyErr_Occurred());
400 assert(wsign
!= 0); /* else nbits was 0 */
401 assert(vsign
!= 0); /* if vsign were 0, then since wsign is
402 * not 0, we would have taken the
403 * vsign != wsign branch at the start */
404 /* We want to work with non-negative numbers. */
406 /* "Multiply both sides" by -1; this also swaps the
410 op
= _Py_SwappedOp
[op
];
413 (void) frexp(i
, &exponent
);
414 /* exponent is the # of bits in v before the radix point;
415 * we know that nbits (the # of bits in w) > 48 at this point
417 if (exponent
< 0 || (size_t)exponent
< nbits
) {
422 if ((size_t)exponent
> nbits
) {
427 /* v and w have the same number of bits before the radix
428 * point. Construct two longs that have the same comparison
434 PyObject
*result
= NULL
;
435 PyObject
*one
= NULL
;
440 ww
= PyNumber_Negative(w
);
447 fracpart
= modf(i
, &intpart
);
448 vv
= PyLong_FromDouble(intpart
);
452 if (fracpart
!= 0.0) {
453 /* Shift left, and or a 1 bit into vv
454 * to represent the lost fraction.
458 one
= PyLong_FromLong(1);
462 temp
= PyNumber_Lshift(ww
, one
);
468 temp
= PyNumber_Lshift(vv
, one
);
474 temp
= PyNumber_Or(vv
, one
);
481 r
= PyObject_RichCompareBool(vv
, ww
, op
);
484 result
= PyBool_FromLong(r
);
491 } /* else if (PyLong_Check(w)) */
493 else /* w isn't float, int, or long */
497 PyFPE_START_PROTECT("richcompare", return NULL
)
519 return PyBool_FromLong(r
);
522 Py_INCREF(Py_NotImplemented
);
523 return Py_NotImplemented
;
527 float_hash(PyFloatObject
*v
)
529 return _Py_HashDouble(v
->ob_fval
);
533 float_add(PyObject
*v
, PyObject
*w
)
536 CONVERT_TO_DOUBLE(v
, a
);
537 CONVERT_TO_DOUBLE(w
, b
);
538 PyFPE_START_PROTECT("add", return 0)
541 return PyFloat_FromDouble(a
);
545 float_sub(PyObject
*v
, PyObject
*w
)
548 CONVERT_TO_DOUBLE(v
, a
);
549 CONVERT_TO_DOUBLE(w
, b
);
550 PyFPE_START_PROTECT("subtract", return 0)
553 return PyFloat_FromDouble(a
);
557 float_mul(PyObject
*v
, PyObject
*w
)
560 CONVERT_TO_DOUBLE(v
, a
);
561 CONVERT_TO_DOUBLE(w
, b
);
562 PyFPE_START_PROTECT("multiply", return 0)
565 return PyFloat_FromDouble(a
);
569 float_div(PyObject
*v
, PyObject
*w
)
572 CONVERT_TO_DOUBLE(v
, a
);
573 CONVERT_TO_DOUBLE(w
, b
);
576 PyErr_SetString(PyExc_ZeroDivisionError
,
581 PyFPE_START_PROTECT("divide", return 0)
584 return PyFloat_FromDouble(a
);
588 float_rem(PyObject
*v
, PyObject
*w
)
592 CONVERT_TO_DOUBLE(v
, vx
);
593 CONVERT_TO_DOUBLE(w
, wx
);
596 PyErr_SetString(PyExc_ZeroDivisionError
,
601 PyFPE_START_PROTECT("modulo", return 0)
603 /* note: checking mod*wx < 0 is incorrect -- underflows to
604 0 if wx < sqrt(smallest nonzero double) */
605 if (mod
&& ((wx
< 0) != (mod
< 0))) {
608 PyFPE_END_PROTECT(mod
)
609 return PyFloat_FromDouble(mod
);
613 float_divmod(PyObject
*v
, PyObject
*w
)
616 double div
, mod
, floordiv
;
617 CONVERT_TO_DOUBLE(v
, vx
);
618 CONVERT_TO_DOUBLE(w
, wx
);
620 PyErr_SetString(PyExc_ZeroDivisionError
, "float divmod()");
623 PyFPE_START_PROTECT("divmod", return 0)
625 /* fmod is typically exact, so vx-mod is *mathematically* an
626 exact multiple of wx. But this is fp arithmetic, and fp
627 vx - mod is an approximation; the result is that div may
628 not be an exact integral value after the division, although
629 it will always be very close to one.
631 div
= (vx
- mod
) / wx
;
633 /* ensure the remainder has the same sign as the denominator */
634 if ((wx
< 0) != (mod
< 0)) {
640 /* the remainder is zero, and in the presence of signed zeroes
641 fmod returns different results across platforms; ensure
642 it has the same sign as the denominator; we'd like to do
643 "mod = wx * 0.0", but that may get optimized away */
644 mod
*= mod
; /* hide "mod = +0" from optimizer */
648 /* snap quotient to nearest integral value */
650 floordiv
= floor(div
);
651 if (div
- floordiv
> 0.5)
655 /* div is zero - get the same sign as the true quotient */
656 div
*= div
; /* hide "div = +0" from optimizers */
657 floordiv
= div
* vx
/ wx
; /* zero w/ sign of vx/wx */
659 PyFPE_END_PROTECT(floordiv
)
660 return Py_BuildValue("(dd)", floordiv
, mod
);
664 float_floor_div(PyObject
*v
, PyObject
*w
)
668 t
= float_divmod(v
, w
);
669 if (t
== NULL
|| t
== Py_NotImplemented
)
671 assert(PyTuple_CheckExact(t
));
672 r
= PyTuple_GET_ITEM(t
, 0);
679 float_pow(PyObject
*v
, PyObject
*w
, PyObject
*z
)
683 if ((PyObject
*)z
!= Py_None
) {
684 PyErr_SetString(PyExc_TypeError
, "pow() 3rd argument not "
685 "allowed unless all arguments are integers");
689 CONVERT_TO_DOUBLE(v
, iv
);
690 CONVERT_TO_DOUBLE(w
, iw
);
692 /* Sort out special cases here instead of relying on pow() */
693 if (iw
== 0) { /* v**0 is 1, even 0**0 */
694 return PyFloat_FromDouble(1.0);
696 if (iv
== 0.0) { /* 0**w is error if w<0, else 1 */
698 PyErr_SetString(PyExc_ZeroDivisionError
,
699 "0.0 cannot be raised to a negative power");
702 return PyFloat_FromDouble(0.0);
704 if (iv
== 1.0) { /* 1**w is 1, even 1**inf and 1**nan */
705 return PyFloat_FromDouble(1.0);
708 /* Whether this is an error is a mess, and bumps into libm
709 * bugs so we have to figure it out ourselves.
711 if (iw
!= floor(iw
)) {
712 /* Negative numbers raised to fractional powers
715 return PyComplex_Type
.tp_as_number
->nb_power(v
, w
, z
);
717 /* iw is an exact integer, albeit perhaps a very large one.
718 * -1 raised to an exact integer should never be exceptional.
719 * Alas, some libms (chiefly glibc as of early 2003) return
720 * NaN and set EDOM on pow(-1, large_int) if the int doesn't
721 * happen to be representable in a *C* integer. That's a
722 * bug; we let that slide in math.pow() (which currently
723 * reflects all platform accidents), but not for Python's **.
725 if (iv
== -1.0 && Py_IS_FINITE(iw
)) {
726 /* Return 1 if iw is even, -1 if iw is odd; there's
727 * no guarantee that any C integral type is big
728 * enough to hold iw, so we have to check this
731 ix
= floor(iw
* 0.5) * 2.0;
732 return PyFloat_FromDouble(ix
== iw
? 1.0 : -1.0);
734 /* Else iv != -1.0, and overflow or underflow are possible.
735 * Unless we're to write pow() ourselves, we have to trust
736 * the platform to do this correctly.
740 PyFPE_START_PROTECT("pow", return NULL
)
742 PyFPE_END_PROTECT(ix
)
743 Py_ADJUST_ERANGE1(ix
);
745 /* We don't expect any errno value other than ERANGE, but
746 * the range of libm bugs appears unbounded.
748 PyErr_SetFromErrno(errno
== ERANGE
? PyExc_OverflowError
:
752 return PyFloat_FromDouble(ix
);
756 float_neg(PyFloatObject
*v
)
758 return PyFloat_FromDouble(-v
->ob_fval
);
762 float_abs(PyFloatObject
*v
)
764 return PyFloat_FromDouble(fabs(v
->ob_fval
));
768 float_bool(PyFloatObject
*v
)
770 return v
->ob_fval
!= 0.0;
774 float_is_integer(PyObject
*v
)
776 double x
= PyFloat_AsDouble(v
);
779 if (x
== -1.0 && PyErr_Occurred())
781 if (!Py_IS_FINITE(x
))
784 PyFPE_START_PROTECT("is_integer", return NULL
)
785 o
= (floor(x
) == x
) ? Py_True
: Py_False
;
788 PyErr_SetFromErrno(errno
== ERANGE
? PyExc_OverflowError
:
798 float_is_inf(PyObject
*v
)
800 double x
= PyFloat_AsDouble(v
);
801 if (x
== -1.0 && PyErr_Occurred())
803 return PyBool_FromLong((long)Py_IS_INFINITY(x
));
807 float_is_nan(PyObject
*v
)
809 double x
= PyFloat_AsDouble(v
);
810 if (x
== -1.0 && PyErr_Occurred())
812 return PyBool_FromLong((long)Py_IS_NAN(x
));
816 float_is_finite(PyObject
*v
)
818 double x
= PyFloat_AsDouble(v
);
819 if (x
== -1.0 && PyErr_Occurred())
821 return PyBool_FromLong((long)Py_IS_FINITE(x
));
826 float_trunc(PyObject
*v
)
828 double x
= PyFloat_AsDouble(v
);
829 double wholepart
; /* integral portion of x, rounded toward 0 */
831 (void)modf(x
, &wholepart
);
832 /* Try to get out cheap if this fits in a Python int. The attempt
833 * to cast to long must be protected, as C doesn't define what
834 * happens if the double is too big to fit in a long. Some rare
835 * systems raise an exception then (RISCOS was mentioned as one,
836 * and someone using a non-default option on Sun also bumped into
837 * that). Note that checking for >= and <= LONG_{MIN,MAX} would
838 * still be vulnerable: if a long has more bits of precision than
839 * a double, casting MIN/MAX to double may yield an approximation,
840 * and if that's rounded up, then, e.g., wholepart=LONG_MAX+1 would
841 * yield true from the C expression wholepart<=LONG_MAX, despite
842 * that wholepart is actually greater than LONG_MAX.
844 if (LONG_MIN
< wholepart
&& wholepart
< LONG_MAX
) {
845 const long aslong
= (long)wholepart
;
846 return PyLong_FromLong(aslong
);
848 return PyLong_FromDouble(wholepart
);
851 /* double_round: rounds a finite double to the closest multiple of
852 10**-ndigits; here ndigits is within reasonable bounds (typically, -308 <=
853 ndigits <= 323). Returns a Python float, or sets a Python error and
854 returns NULL on failure (OverflowError and memory errors are possible). */
856 #ifndef PY_NO_SHORT_FLOAT_REPR
857 /* version of double_round that uses the correctly-rounded string<->double
858 conversions from Python/dtoa.c */
861 double_round(double x
, int ndigits
) {
864 Py_ssize_t buflen
, mybuflen
=100;
865 char *buf
, *buf_end
, shortbuf
[100], *mybuf
=shortbuf
;
867 PyObject
*result
= NULL
;
869 /* round to a decimal string */
870 buf
= _Py_dg_dtoa(x
, 3, ndigits
, &decpt
, &sign
, &buf_end
);
876 /* Get new buffer if shortbuf is too small. Space needed <= buf_end -
877 buf + 8: (1 extra for '0', 1 for sign, 5 for exp, 1 for '\0'). */
878 buflen
= buf_end
- buf
;
879 if (buflen
+ 8 > mybuflen
) {
881 mybuf
= (char *)PyMem_Malloc(mybuflen
);
887 /* copy buf to mybuf, adding exponent, sign and leading 0 */
888 PyOS_snprintf(mybuf
, mybuflen
, "%s0%se%d", (sign
? "-" : ""),
889 buf
, decpt
- (int)buflen
);
891 /* and convert the resulting string back to a double */
893 rounded
= _Py_dg_strtod(mybuf
, NULL
);
894 if (errno
== ERANGE
&& fabs(rounded
) >= 1.)
895 PyErr_SetString(PyExc_OverflowError
,
896 "rounded value too large to represent");
898 result
= PyFloat_FromDouble(rounded
);
900 /* done computing value; now clean up */
901 if (mybuf
!= shortbuf
)
904 _Py_dg_freedtoa(buf
);
908 #else /* PY_NO_SHORT_FLOAT_REPR */
910 /* fallback version, to be used when correctly rounded binary<->decimal
911 conversions aren't available */
914 double_round(double x
, int ndigits
) {
915 double pow1
, pow2
, y
, z
;
918 /* pow1 and pow2 are each safe from overflow, but
919 pow1*pow2 ~= pow(10.0, ndigits) might overflow */
920 pow1
= pow(10.0, (double)(ndigits
-22));
924 pow1
= pow(10.0, (double)ndigits
);
928 /* if y overflows, then rounded value is exactly x */
929 if (!Py_IS_FINITE(y
))
930 return PyFloat_FromDouble(x
);
933 pow1
= pow(10.0, (double)-ndigits
);
934 pow2
= 1.0; /* unused; silences a gcc compiler warning */
939 if (fabs(y
-z
) == 0.5)
940 /* halfway between two integers; use round-half-even */
941 z
= 2.0*round(y
/2.0);
944 z
= (z
/ pow2
) / pow1
;
948 /* if computation resulted in overflow, raise OverflowError */
949 if (!Py_IS_FINITE(z
)) {
950 PyErr_SetString(PyExc_OverflowError
,
951 "overflow occurred during round");
955 return PyFloat_FromDouble(z
);
958 #endif /* PY_NO_SHORT_FLOAT_REPR */
960 /* round a Python float v to the closest multiple of 10**-ndigits */
963 float_round(PyObject
*v
, PyObject
*args
)
966 PyObject
*o_ndigits
= NULL
;
969 x
= PyFloat_AsDouble(v
);
970 if (!PyArg_ParseTuple(args
, "|O", &o_ndigits
))
972 if (o_ndigits
== NULL
) {
973 /* single-argument round: round to nearest integer */
975 if (fabs(x
-rounded
) == 0.5)
976 /* halfway case: round to even */
977 rounded
= 2.0*round(x
/2.0);
978 return PyLong_FromDouble(rounded
);
981 /* interpret second argument as a Py_ssize_t; clips on overflow */
982 ndigits
= PyNumber_AsSsize_t(o_ndigits
, NULL
);
983 if (ndigits
== -1 && PyErr_Occurred())
986 /* nans and infinities round to themselves */
987 if (!Py_IS_FINITE(x
))
988 return PyFloat_FromDouble(x
);
990 /* Deal with extreme values for ndigits. For ndigits > NDIGITS_MAX, x
991 always rounds to itself. For ndigits < NDIGITS_MIN, x always
992 rounds to +-0.0. Here 0.30103 is an upper bound for log10(2). */
993 #define NDIGITS_MAX ((int)((DBL_MANT_DIG-DBL_MIN_EXP) * 0.30103))
994 #define NDIGITS_MIN (-(int)((DBL_MAX_EXP + 1) * 0.30103))
995 if (ndigits
> NDIGITS_MAX
)
997 return PyFloat_FromDouble(x
);
998 else if (ndigits
< NDIGITS_MIN
)
999 /* return 0.0, but with sign of x */
1000 return PyFloat_FromDouble(0.0*x
);
1002 /* finite x, and ndigits is not unreasonably large */
1003 return double_round(x
, (int)ndigits
);
1009 float_float(PyObject
*v
)
1011 if (PyFloat_CheckExact(v
))
1014 v
= PyFloat_FromDouble(((PyFloatObject
*)v
)->ob_fval
);
1018 /* turn ASCII hex characters into integer values and vice versa */
1021 char_from_hex(int x
)
1023 assert(0 <= x
&& x
< 16);
1024 return "0123456789abcdef"[x
];
1028 hex_from_char(char c
) {
1092 /* convert a float to a hexadecimal string */
1094 /* TOHEX_NBITS is DBL_MANT_DIG rounded up to the next integer
1095 of the form 4k+1. */
1096 #define TOHEX_NBITS DBL_MANT_DIG + 3 - (DBL_MANT_DIG+2)%4
1099 float_hex(PyObject
*v
)
1102 int e
, shift
, i
, si
, esign
;
1103 /* Space for 1+(TOHEX_NBITS-1)/4 digits, a decimal point, and the
1104 trailing NUL byte. */
1105 char s
[(TOHEX_NBITS
-1)/4+3];
1107 CONVERT_TO_DOUBLE(v
, x
);
1109 if (Py_IS_NAN(x
) || Py_IS_INFINITY(x
))
1110 return float_str((PyFloatObject
*)v
);
1113 if(copysign(1.0, x
) == -1.0)
1114 return PyUnicode_FromString("-0x0.0p+0");
1116 return PyUnicode_FromString("0x0.0p+0");
1119 m
= frexp(fabs(x
), &e
);
1120 shift
= 1 - MAX(DBL_MIN_EXP
- e
, 0);
1121 m
= ldexp(m
, shift
);
1125 s
[si
] = char_from_hex((int)m
);
1130 for (i
=0; i
< (TOHEX_NBITS
-1)/4; i
++) {
1132 s
[si
] = char_from_hex((int)m
);
1146 return PyUnicode_FromFormat("-0x%sp%c%d", s
, esign
, e
);
1148 return PyUnicode_FromFormat("0x%sp%c%d", s
, esign
, e
);
1151 PyDoc_STRVAR(float_hex_doc
,
1152 "float.hex() -> string\n\
1154 Return a hexadecimal representation of a floating-point number.\n\
1156 '-0x1.999999999999ap-4'\n\
1157 >>> 3.14159.hex()\n\
1158 '0x1.921f9f01b866ep+1'");
1160 /* Convert a hexadecimal string to a float. */
1163 float_fromhex(PyObject
*cls
, PyObject
*arg
)
1165 PyObject
*result_as_float
, *result
;
1167 long exp
, top_exp
, lsb
, key_digit
;
1168 char *s
, *coeff_start
, *s_store
, *coeff_end
, *exp_start
, *s_end
;
1169 int half_eps
, digit
, round_up
, sign
=1;
1170 Py_ssize_t length
, ndigits
, fdigits
, i
;
1173 * For the sake of simplicity and correctness, we impose an artificial
1174 * limit on ndigits, the total number of hex digits in the coefficient
1175 * The limit is chosen to ensure that, writing exp for the exponent,
1177 * (1) if exp > LONG_MAX/2 then the value of the hex string is
1178 * guaranteed to overflow (provided it's nonzero)
1180 * (2) if exp < LONG_MIN/2 then the value of the hex string is
1181 * guaranteed to underflow to 0.
1183 * (3) if LONG_MIN/2 <= exp <= LONG_MAX/2 then there's no danger of
1184 * overflow in the calculation of exp and top_exp below.
1186 * More specifically, ndigits is assumed to satisfy the following
1189 * 4*ndigits <= DBL_MIN_EXP - DBL_MANT_DIG - LONG_MIN/2
1190 * 4*ndigits <= LONG_MAX/2 + 1 - DBL_MAX_EXP
1192 * If either of these inequalities is not satisfied, a ValueError is
1193 * raised. Otherwise, write x for the value of the hex string, and
1194 * assume x is nonzero. Then
1196 * 2**(exp-4*ndigits) <= |x| < 2**(exp+4*ndigits).
1198 * Now if exp > LONG_MAX/2 then:
1200 * exp - 4*ndigits >= LONG_MAX/2 + 1 - (LONG_MAX/2 + 1 - DBL_MAX_EXP)
1203 * so |x| >= 2**DBL_MAX_EXP, which is too large to be stored in C
1204 * double, so overflows. If exp < LONG_MIN/2, then
1206 * exp + 4*ndigits <= LONG_MIN/2 - 1 + (
1207 * DBL_MIN_EXP - DBL_MANT_DIG - LONG_MIN/2)
1208 * = DBL_MIN_EXP - DBL_MANT_DIG - 1
1210 * and so |x| < 2**(DBL_MIN_EXP-DBL_MANT_DIG-1), hence underflows to 0
1211 * when converted to a C double.
1213 * It's easy to show that if LONG_MIN/2 <= exp <= LONG_MAX/2 then both
1214 * exp+4*ndigits and exp-4*ndigits are within the range of a long.
1217 s
= _PyUnicode_AsStringAndSize(arg
, &length
);
1222 /********************
1223 * Parse the string *
1224 ********************/
1226 /* leading whitespace and optional sign */
1227 while (Py_ISSPACE(*s
))
1236 /* infinities and nans */
1237 if (PyOS_strnicmp(s
, "nan", 4) == 0) {
1241 if (PyOS_strnicmp(s
, "inf", 4) == 0 ||
1242 PyOS_strnicmp(s
, "infinity", 9) == 0) {
1243 x
= sign
*Py_HUGE_VAL
;
1251 if (*s
== 'x' || *s
== 'X')
1257 /* coefficient: <integer> [. <fraction>] */
1259 while (hex_from_char(*s
) >= 0)
1264 while (hex_from_char(*s
) >= 0)
1271 /* ndigits = total # of hex digits; fdigits = # after point */
1272 ndigits
= coeff_end
- coeff_start
;
1273 fdigits
= coeff_end
- s_store
;
1276 if (ndigits
> MIN(DBL_MIN_EXP
- DBL_MANT_DIG
- LONG_MIN
/2,
1277 LONG_MAX
/2 + 1 - DBL_MAX_EXP
)/4)
1278 goto insane_length_error
;
1280 /* [p <exponent>] */
1281 if (*s
== 'p' || *s
== 'P') {
1284 if (*s
== '-' || *s
== '+')
1286 if (!('0' <= *s
&& *s
<= '9'))
1289 while ('0' <= *s
&& *s
<= '9')
1291 exp
= strtol(exp_start
, NULL
, 10);
1296 /* optional trailing whitespace leading to the end of the string */
1297 while (Py_ISSPACE(*s
))
1302 /* for 0 <= j < ndigits, HEX_DIGIT(j) gives the jth most significant digit */
1303 #define HEX_DIGIT(j) hex_from_char(*((j) < fdigits ? \
1307 /*******************************************
1308 * Compute rounded value of the hex string *
1309 *******************************************/
1311 /* Discard leading zeros, and catch extreme overflow and underflow */
1312 while (ndigits
> 0 && HEX_DIGIT(ndigits
-1) == 0)
1314 if (ndigits
== 0 || exp
< LONG_MIN
/2) {
1318 if (exp
> LONG_MAX
/2)
1319 goto overflow_error
;
1321 /* Adjust exponent for fractional part. */
1322 exp
= exp
- 4*((long)fdigits
);
1324 /* top_exp = 1 more than exponent of most sig. bit of coefficient */
1325 top_exp
= exp
+ 4*((long)ndigits
- 1);
1326 for (digit
= HEX_DIGIT(ndigits
-1); digit
!= 0; digit
/= 2)
1329 /* catch almost all nonextreme cases of overflow and underflow here */
1330 if (top_exp
< DBL_MIN_EXP
- DBL_MANT_DIG
) {
1334 if (top_exp
> DBL_MAX_EXP
)
1335 goto overflow_error
;
1337 /* lsb = exponent of least significant bit of the *rounded* value.
1338 This is top_exp - DBL_MANT_DIG unless result is subnormal. */
1339 lsb
= MAX(top_exp
, (long)DBL_MIN_EXP
) - DBL_MANT_DIG
;
1343 /* no rounding required */
1344 for (i
= ndigits
-1; i
>= 0; i
--)
1345 x
= 16.0*x
+ HEX_DIGIT(i
);
1346 x
= sign
* ldexp(x
, (int)(exp
));
1349 /* rounding required. key_digit is the index of the hex digit
1350 containing the first bit to be rounded away. */
1351 half_eps
= 1 << (int)((lsb
- exp
- 1) % 4);
1352 key_digit
= (lsb
- exp
- 1) / 4;
1353 for (i
= ndigits
-1; i
> key_digit
; i
--)
1354 x
= 16.0*x
+ HEX_DIGIT(i
);
1355 digit
= HEX_DIGIT(key_digit
);
1356 x
= 16.0*x
+ (double)(digit
& (16-2*half_eps
));
1358 /* round-half-even: round up if bit lsb-1 is 1 and at least one of
1359 bits lsb, lsb-2, lsb-3, lsb-4, ... is 1. */
1360 if ((digit
& half_eps
) != 0) {
1362 if ((digit
& (3*half_eps
-1)) != 0 ||
1363 (half_eps
== 8 && (HEX_DIGIT(key_digit
+1) & 1) != 0))
1366 for (i
= key_digit
-1; i
>= 0; i
--)
1367 if (HEX_DIGIT(i
) != 0) {
1371 if (round_up
== 1) {
1373 if (top_exp
== DBL_MAX_EXP
&&
1374 x
== ldexp((double)(2*half_eps
), DBL_MANT_DIG
))
1375 /* overflow corner case: pre-rounded value <
1376 2**DBL_MAX_EXP; rounded=2**DBL_MAX_EXP. */
1377 goto overflow_error
;
1380 x
= sign
* ldexp(x
, (int)(exp
+4*key_digit
));
1383 result_as_float
= Py_BuildValue("(d)", x
);
1384 if (result_as_float
== NULL
)
1386 result
= PyObject_CallObject(cls
, result_as_float
);
1387 Py_DECREF(result_as_float
);
1391 PyErr_SetString(PyExc_OverflowError
,
1392 "hexadecimal value too large to represent as a float");
1396 PyErr_SetString(PyExc_ValueError
,
1397 "invalid hexadecimal floating-point string");
1400 insane_length_error
:
1401 PyErr_SetString(PyExc_ValueError
,
1402 "hexadecimal string too long to convert");
1406 PyDoc_STRVAR(float_fromhex_doc
,
1407 "float.fromhex(string) -> float\n\
1409 Create a floating-point number from a hexadecimal string.\n\
1410 >>> float.fromhex('0x1.ffffp10')\n\
1412 >>> float.fromhex('-0x1p-1074')\n\
1413 -4.9406564584124654e-324");
1417 float_as_integer_ratio(PyObject
*v
, PyObject
*unused
)
1425 PyObject
*py_exponent
= NULL
;
1426 PyObject
*numerator
= NULL
;
1427 PyObject
*denominator
= NULL
;
1428 PyObject
*result_pair
= NULL
;
1429 PyNumberMethods
*long_methods
= PyLong_Type
.tp_as_number
;
1431 #define INPLACE_UPDATE(obj, call) \
1436 CONVERT_TO_DOUBLE(v, self);
1438 if (Py_IS_INFINITY(self
)) {
1439 PyErr_SetString(PyExc_OverflowError
,
1440 "Cannot pass infinity to float.as_integer_ratio.");
1444 if (Py_IS_NAN(self
)) {
1445 PyErr_SetString(PyExc_ValueError
,
1446 "Cannot pass NaN to float.as_integer_ratio.");
1451 PyFPE_START_PROTECT("as_integer_ratio", goto error
);
1452 float_part
= frexp(self
, &exponent
); /* self == float_part * 2**exponent exactly */
1453 PyFPE_END_PROTECT(float_part
);
1455 for (i
=0; i
<300 && float_part
!= floor(float_part
) ; i
++) {
1459 /* self == float_part * 2**exponent exactly and float_part is integral.
1460 If FLT_RADIX != 2, the 300 steps may leave a tiny fractional part
1461 to be truncated by PyLong_FromDouble(). */
1463 numerator
= PyLong_FromDouble(float_part
);
1464 if (numerator
== NULL
) goto error
;
1466 /* fold in 2**exponent */
1467 denominator
= PyLong_FromLong(1);
1468 py_exponent
= PyLong_FromLong(labs((long)exponent
));
1469 if (py_exponent
== NULL
) goto error
;
1470 INPLACE_UPDATE(py_exponent
,
1471 long_methods
->nb_lshift(denominator
, py_exponent
));
1472 if (py_exponent
== NULL
) goto error
;
1474 INPLACE_UPDATE(numerator
,
1475 long_methods
->nb_multiply(numerator
, py_exponent
));
1476 if (numerator
== NULL
) goto error
;
1479 Py_DECREF(denominator
);
1480 denominator
= py_exponent
;
1484 result_pair
= PyTuple_Pack(2, numerator
, denominator
);
1486 #undef INPLACE_UPDATE
1488 Py_XDECREF(py_exponent
);
1489 Py_XDECREF(denominator
);
1490 Py_XDECREF(numerator
);
1494 PyDoc_STRVAR(float_as_integer_ratio_doc
,
1495 "float.as_integer_ratio() -> (int, int)\n"
1497 "Returns a pair of integers, whose ratio is exactly equal to the original\n"
1498 "float and with a positive denominator.\n"
1499 "Raises OverflowError on infinities and a ValueError on NaNs.\n"
1501 ">>> (10.0).as_integer_ratio()\n"
1503 ">>> (0.0).as_integer_ratio()\n"
1505 ">>> (-.25).as_integer_ratio()\n"
1510 float_subtype_new(PyTypeObject
*type
, PyObject
*args
, PyObject
*kwds
);
1513 float_new(PyTypeObject
*type
, PyObject
*args
, PyObject
*kwds
)
1515 PyObject
*x
= Py_False
; /* Integer zero */
1516 static char *kwlist
[] = {"x", 0};
1518 if (type
!= &PyFloat_Type
)
1519 return float_subtype_new(type
, args
, kwds
); /* Wimp out */
1520 if (!PyArg_ParseTupleAndKeywords(args
, kwds
, "|O:float", kwlist
, &x
))
1522 /* If it's a string, but not a string subclass, use
1523 PyFloat_FromString. */
1524 if (PyUnicode_CheckExact(x
))
1525 return PyFloat_FromString(x
);
1526 return PyNumber_Float(x
);
1529 /* Wimpy, slow approach to tp_new calls for subtypes of float:
1530 first create a regular float from whatever arguments we got,
1531 then allocate a subtype instance and initialize its ob_fval
1532 from the regular float. The regular float is then thrown away.
1535 float_subtype_new(PyTypeObject
*type
, PyObject
*args
, PyObject
*kwds
)
1537 PyObject
*tmp
, *newobj
;
1539 assert(PyType_IsSubtype(type
, &PyFloat_Type
));
1540 tmp
= float_new(&PyFloat_Type
, args
, kwds
);
1543 assert(PyFloat_CheckExact(tmp
));
1544 newobj
= type
->tp_alloc(type
, 0);
1545 if (newobj
== NULL
) {
1549 ((PyFloatObject
*)newobj
)->ob_fval
= ((PyFloatObject
*)tmp
)->ob_fval
;
1555 float_getnewargs(PyFloatObject
*v
)
1557 return Py_BuildValue("(d)", v
->ob_fval
);
1560 /* this is for the benefit of the pack/unpack routines below */
1563 unknown_format
, ieee_big_endian_format
, ieee_little_endian_format
1564 } float_format_type
;
1566 static float_format_type double_format
, float_format
;
1567 static float_format_type detected_double_format
, detected_float_format
;
1570 float_getformat(PyTypeObject
*v
, PyObject
* arg
)
1573 float_format_type r
;
1575 if (!PyUnicode_Check(arg
)) {
1576 PyErr_Format(PyExc_TypeError
,
1577 "__getformat__() argument must be string, not %.500s",
1578 Py_TYPE(arg
)->tp_name
);
1581 s
= _PyUnicode_AsString(arg
);
1584 if (strcmp(s
, "double") == 0) {
1587 else if (strcmp(s
, "float") == 0) {
1591 PyErr_SetString(PyExc_ValueError
,
1592 "__getformat__() argument 1 must be "
1593 "'double' or 'float'");
1598 case unknown_format
:
1599 return PyUnicode_FromString("unknown");
1600 case ieee_little_endian_format
:
1601 return PyUnicode_FromString("IEEE, little-endian");
1602 case ieee_big_endian_format
:
1603 return PyUnicode_FromString("IEEE, big-endian");
1605 Py_FatalError("insane float_format or double_format");
1610 PyDoc_STRVAR(float_getformat_doc
,
1611 "float.__getformat__(typestr) -> string\n"
1613 "You probably don't want to use this function. It exists mainly to be\n"
1614 "used in Python's test suite.\n"
1616 "typestr must be 'double' or 'float'. This function returns whichever of\n"
1617 "'unknown', 'IEEE, big-endian' or 'IEEE, little-endian' best describes the\n"
1618 "format of floating point numbers used by the C type named by typestr.");
1621 float_setformat(PyTypeObject
*v
, PyObject
* args
)
1625 float_format_type f
;
1626 float_format_type detected
;
1627 float_format_type
*p
;
1629 if (!PyArg_ParseTuple(args
, "ss:__setformat__", &typestr
, &format
))
1632 if (strcmp(typestr
, "double") == 0) {
1634 detected
= detected_double_format
;
1636 else if (strcmp(typestr
, "float") == 0) {
1638 detected
= detected_float_format
;
1641 PyErr_SetString(PyExc_ValueError
,
1642 "__setformat__() argument 1 must "
1643 "be 'double' or 'float'");
1647 if (strcmp(format
, "unknown") == 0) {
1650 else if (strcmp(format
, "IEEE, little-endian") == 0) {
1651 f
= ieee_little_endian_format
;
1653 else if (strcmp(format
, "IEEE, big-endian") == 0) {
1654 f
= ieee_big_endian_format
;
1657 PyErr_SetString(PyExc_ValueError
,
1658 "__setformat__() argument 2 must be "
1659 "'unknown', 'IEEE, little-endian' or "
1660 "'IEEE, big-endian'");
1665 if (f
!= unknown_format
&& f
!= detected
) {
1666 PyErr_Format(PyExc_ValueError
,
1667 "can only set %s format to 'unknown' or the "
1668 "detected platform value", typestr
);
1676 PyDoc_STRVAR(float_setformat_doc
,
1677 "float.__setformat__(typestr, fmt) -> None\n"
1679 "You probably don't want to use this function. It exists mainly to be\n"
1680 "used in Python's test suite.\n"
1682 "typestr must be 'double' or 'float'. fmt must be one of 'unknown',\n"
1683 "'IEEE, big-endian' or 'IEEE, little-endian', and in addition can only be\n"
1684 "one of the latter two if it appears to match the underlying C reality.\n"
1686 "Overrides the automatic determination of C-level floating point type.\n"
1687 "This affects how floats are converted to and from binary strings.");
1690 float_getzero(PyObject
*v
, void *closure
)
1692 return PyFloat_FromDouble(0.0);
1696 float__format__(PyObject
*self
, PyObject
*args
)
1698 PyObject
*format_spec
;
1700 if (!PyArg_ParseTuple(args
, "U:__format__", &format_spec
))
1702 return _PyFloat_FormatAdvanced(self
,
1703 PyUnicode_AS_UNICODE(format_spec
),
1704 PyUnicode_GET_SIZE(format_spec
));
1707 PyDoc_STRVAR(float__format__doc
,
1708 "float.__format__(format_spec) -> string\n"
1710 "Formats the float according to format_spec.");
1713 static PyMethodDef float_methods
[] = {
1714 {"conjugate", (PyCFunction
)float_float
, METH_NOARGS
,
1715 "Returns self, the complex conjugate of any float."},
1716 {"__trunc__", (PyCFunction
)float_trunc
, METH_NOARGS
,
1717 "Returns the Integral closest to x between 0 and x."},
1718 {"__round__", (PyCFunction
)float_round
, METH_VARARGS
,
1719 "Returns the Integral closest to x, rounding half toward even.\n"
1720 "When an argument is passed, works like built-in round(x, ndigits)."},
1721 {"as_integer_ratio", (PyCFunction
)float_as_integer_ratio
, METH_NOARGS
,
1722 float_as_integer_ratio_doc
},
1723 {"fromhex", (PyCFunction
)float_fromhex
,
1724 METH_O
|METH_CLASS
, float_fromhex_doc
},
1725 {"hex", (PyCFunction
)float_hex
,
1726 METH_NOARGS
, float_hex_doc
},
1727 {"is_integer", (PyCFunction
)float_is_integer
, METH_NOARGS
,
1728 "Returns True if the float is an integer."},
1730 {"is_inf", (PyCFunction
)float_is_inf
, METH_NOARGS
,
1731 "Returns True if the float is positive or negative infinite."},
1732 {"is_finite", (PyCFunction
)float_is_finite
, METH_NOARGS
,
1733 "Returns True if the float is finite, neither infinite nor NaN."},
1734 {"is_nan", (PyCFunction
)float_is_nan
, METH_NOARGS
,
1735 "Returns True if the float is not a number (NaN)."},
1737 {"__getnewargs__", (PyCFunction
)float_getnewargs
, METH_NOARGS
},
1738 {"__getformat__", (PyCFunction
)float_getformat
,
1739 METH_O
|METH_CLASS
, float_getformat_doc
},
1740 {"__setformat__", (PyCFunction
)float_setformat
,
1741 METH_VARARGS
|METH_CLASS
, float_setformat_doc
},
1742 {"__format__", (PyCFunction
)float__format__
,
1743 METH_VARARGS
, float__format__doc
},
1744 {NULL
, NULL
} /* sentinel */
1747 static PyGetSetDef float_getset
[] = {
1749 (getter
)float_float
, (setter
)NULL
,
1750 "the real part of a complex number",
1753 (getter
)float_getzero
, (setter
)NULL
,
1754 "the imaginary part of a complex number",
1756 {NULL
} /* Sentinel */
1759 PyDoc_STRVAR(float_doc
,
1760 "float(x) -> floating point number\n\
1762 Convert a string or number to a floating point number, if possible.");
1765 static PyNumberMethods float_as_number
= {
1766 float_add
, /*nb_add*/
1767 float_sub
, /*nb_subtract*/
1768 float_mul
, /*nb_multiply*/
1769 float_rem
, /*nb_remainder*/
1770 float_divmod
, /*nb_divmod*/
1771 float_pow
, /*nb_power*/
1772 (unaryfunc
)float_neg
, /*nb_negative*/
1773 (unaryfunc
)float_float
, /*nb_positive*/
1774 (unaryfunc
)float_abs
, /*nb_absolute*/
1775 (inquiry
)float_bool
, /*nb_bool*/
1782 float_trunc
, /*nb_int*/
1784 float_float
, /*nb_float*/
1785 0, /* nb_inplace_add */
1786 0, /* nb_inplace_subtract */
1787 0, /* nb_inplace_multiply */
1788 0, /* nb_inplace_remainder */
1789 0, /* nb_inplace_power */
1790 0, /* nb_inplace_lshift */
1791 0, /* nb_inplace_rshift */
1792 0, /* nb_inplace_and */
1793 0, /* nb_inplace_xor */
1794 0, /* nb_inplace_or */
1795 float_floor_div
, /* nb_floor_divide */
1796 float_div
, /* nb_true_divide */
1797 0, /* nb_inplace_floor_divide */
1798 0, /* nb_inplace_true_divide */
1801 PyTypeObject PyFloat_Type
= {
1802 PyVarObject_HEAD_INIT(&PyType_Type
, 0)
1804 sizeof(PyFloatObject
),
1806 (destructor
)float_dealloc
, /* tp_dealloc */
1810 0, /* tp_reserved */
1811 (reprfunc
)float_repr
, /* tp_repr */
1812 &float_as_number
, /* tp_as_number */
1813 0, /* tp_as_sequence */
1814 0, /* tp_as_mapping */
1815 (hashfunc
)float_hash
, /* tp_hash */
1817 (reprfunc
)float_str
, /* tp_str */
1818 PyObject_GenericGetAttr
, /* tp_getattro */
1819 0, /* tp_setattro */
1820 0, /* tp_as_buffer */
1821 Py_TPFLAGS_DEFAULT
| Py_TPFLAGS_BASETYPE
, /* tp_flags */
1822 float_doc
, /* tp_doc */
1823 0, /* tp_traverse */
1825 float_richcompare
, /* tp_richcompare */
1826 0, /* tp_weaklistoffset */
1828 0, /* tp_iternext */
1829 float_methods
, /* tp_methods */
1831 float_getset
, /* tp_getset */
1834 0, /* tp_descr_get */
1835 0, /* tp_descr_set */
1836 0, /* tp_dictoffset */
1839 float_new
, /* tp_new */
1845 /* We attempt to determine if this machine is using IEEE
1846 floating point formats by peering at the bits of some
1847 carefully chosen values. If it looks like we are on an
1848 IEEE platform, the float packing/unpacking routines can
1849 just copy bits, if not they resort to arithmetic & shifts
1850 and masks. The shifts & masks approach works on all finite
1851 values, but what happens to infinities, NaNs and signed
1852 zeroes on packing is an accident, and attempting to unpack
1853 a NaN or an infinity will raise an exception.
1855 Note that if we're on some whacked-out platform which uses
1856 IEEE formats but isn't strictly little-endian or big-
1857 endian, we will fall back to the portable shifts & masks
1860 #if SIZEOF_DOUBLE == 8
1862 double x
= 9006104071832581.0;
1863 if (memcmp(&x
, "\x43\x3f\xff\x01\x02\x03\x04\x05", 8) == 0)
1864 detected_double_format
= ieee_big_endian_format
;
1865 else if (memcmp(&x
, "\x05\x04\x03\x02\x01\xff\x3f\x43", 8) == 0)
1866 detected_double_format
= ieee_little_endian_format
;
1868 detected_double_format
= unknown_format
;
1871 detected_double_format
= unknown_format
;
1874 #if SIZEOF_FLOAT == 4
1876 float y
= 16711938.0;
1877 if (memcmp(&y
, "\x4b\x7f\x01\x02", 4) == 0)
1878 detected_float_format
= ieee_big_endian_format
;
1879 else if (memcmp(&y
, "\x02\x01\x7f\x4b", 4) == 0)
1880 detected_float_format
= ieee_little_endian_format
;
1882 detected_float_format
= unknown_format
;
1885 detected_float_format
= unknown_format
;
1888 double_format
= detected_double_format
;
1889 float_format
= detected_float_format
;
1891 /* Init float info */
1892 if (FloatInfoType
.tp_name
== 0)
1893 PyStructSequence_InitType(&FloatInfoType
, &floatinfo_desc
);
1897 PyFloat_ClearFreeList(void)
1900 PyFloatBlock
*list
, *next
;
1902 int u
; /* remaining unfreed floats per block */
1903 int freelist_size
= 0;
1908 while (list
!= NULL
) {
1910 for (i
= 0, p
= &list
->objects
[0];
1913 if (PyFloat_CheckExact(p
) && Py_REFCNT(p
) != 0)
1918 list
->next
= block_list
;
1920 for (i
= 0, p
= &list
->objects
[0];
1923 if (!PyFloat_CheckExact(p
) ||
1924 Py_REFCNT(p
) == 0) {
1925 Py_TYPE(p
) = (struct _typeobject
*)
1937 return freelist_size
;
1946 int u
; /* total unfreed floats per block */
1948 u
= PyFloat_ClearFreeList();
1950 if (!Py_VerboseFlag
)
1952 fprintf(stderr
, "# cleanup floats");
1954 fprintf(stderr
, "\n");
1958 ": %d unfreed float%s\n",
1959 u
, u
== 1 ? "" : "s");
1961 if (Py_VerboseFlag
> 1) {
1963 while (list
!= NULL
) {
1964 for (i
= 0, p
= &list
->objects
[0];
1967 if (PyFloat_CheckExact(p
) &&
1968 Py_REFCNT(p
) != 0) {
1969 char *buf
= PyOS_double_to_string(
1970 PyFloat_AS_DOUBLE(p
), 'r',
1973 /* XXX(twouters) cast
1980 "# <float at %p, refcnt=%ld, val=%s>\n",
1981 p
, (long)Py_REFCNT(p
), buf
);
1991 /*----------------------------------------------------------------------------
1992 * _PyFloat_{Pack,Unpack}{4,8}. See floatobject.h.
1995 _PyFloat_Pack4(double x
, unsigned char *p
, int le
)
1997 if (float_format
== unknown_format
) {
2018 /* Normalize f to be in the range [1.0, 2.0) */
2019 if (0.5 <= f
&& f
< 1.0) {
2026 PyErr_SetString(PyExc_SystemError
,
2027 "frexp() result out of range");
2033 else if (e
< -126) {
2034 /* Gradual underflow */
2035 f
= ldexp(f
, 126 + e
);
2038 else if (!(e
== 0 && f
== 0.0)) {
2040 f
-= 1.0; /* Get rid of leading 1 */
2043 f
*= 8388608.0; /* 2**23 */
2044 fbits
= (unsigned int)(f
+ 0.5); /* Round */
2045 assert(fbits
<= 8388608);
2047 /* The carry propagated out of a string of 23 1 bits. */
2055 *p
= (sign
<< 7) | (e
>> 1);
2059 *p
= (char) (((e
& 1) << 7) | (fbits
>> 16));
2063 *p
= (fbits
>> 8) & 0xFF;
2075 const char *s
= (char*)&y
;
2078 if (Py_IS_INFINITY(y
) && !Py_IS_INFINITY(x
))
2081 if ((float_format
== ieee_little_endian_format
&& !le
)
2082 || (float_format
== ieee_big_endian_format
&& le
)) {
2087 for (i
= 0; i
< 4; i
++) {
2094 PyErr_SetString(PyExc_OverflowError
,
2095 "float too large to pack with f format");
2100 _PyFloat_Pack8(double x
, unsigned char *p
, int le
)
2102 if (double_format
== unknown_format
) {
2106 unsigned int fhi
, flo
;
2123 /* Normalize f to be in the range [1.0, 2.0) */
2124 if (0.5 <= f
&& f
< 1.0) {
2131 PyErr_SetString(PyExc_SystemError
,
2132 "frexp() result out of range");
2138 else if (e
< -1022) {
2139 /* Gradual underflow */
2140 f
= ldexp(f
, 1022 + e
);
2143 else if (!(e
== 0 && f
== 0.0)) {
2145 f
-= 1.0; /* Get rid of leading 1 */
2148 /* fhi receives the high 28 bits; flo the low 24 bits (== 52 bits) */
2149 f
*= 268435456.0; /* 2**28 */
2150 fhi
= (unsigned int)f
; /* Truncate */
2151 assert(fhi
< 268435456);
2154 f
*= 16777216.0; /* 2**24 */
2155 flo
= (unsigned int)(f
+ 0.5); /* Round */
2156 assert(flo
<= 16777216);
2158 /* The carry propagated out of a string of 24 1 bits. */
2162 /* And it also progagated out of the next 28 bits. */
2171 *p
= (sign
<< 7) | (e
>> 4);
2175 *p
= (unsigned char) (((e
& 0xF) << 4) | (fhi
>> 24));
2179 *p
= (fhi
>> 16) & 0xFF;
2183 *p
= (fhi
>> 8) & 0xFF;
2191 *p
= (flo
>> 16) & 0xFF;
2195 *p
= (flo
>> 8) & 0xFF;
2206 PyErr_SetString(PyExc_OverflowError
,
2207 "float too large to pack with d format");
2211 const char *s
= (char*)&x
;
2214 if ((double_format
== ieee_little_endian_format
&& !le
)
2215 || (double_format
== ieee_big_endian_format
&& le
)) {
2220 for (i
= 0; i
< 8; i
++) {
2229 _PyFloat_Unpack4(const unsigned char *p
, int le
)
2231 if (float_format
== unknown_format
) {
2244 sign
= (*p
>> 7) & 1;
2245 e
= (*p
& 0x7F) << 1;
2250 f
= (*p
& 0x7F) << 16;
2256 "can't unpack IEEE 754 special value "
2257 "on non-IEEE platform");
2268 x
= (double)f
/ 8388608.0;
2270 /* XXX This sadly ignores Inf/NaN issues */
2287 if ((float_format
== ieee_little_endian_format
&& !le
)
2288 || (float_format
== ieee_big_endian_format
&& le
)) {
2293 for (i
= 0; i
< 4; i
++) {
2307 _PyFloat_Unpack8(const unsigned char *p
, int le
)
2309 if (double_format
== unknown_format
) {
2312 unsigned int fhi
, flo
;
2322 sign
= (*p
>> 7) & 1;
2323 e
= (*p
& 0x7F) << 4;
2328 e
|= (*p
>> 4) & 0xF;
2329 fhi
= (*p
& 0xF) << 24;
2335 "can't unpack IEEE 754 special value "
2336 "on non-IEEE platform");
2363 x
= (double)fhi
+ (double)flo
/ 16777216.0; /* 2**24 */
2364 x
/= 268435456.0; /* 2**28 */
2382 if ((double_format
== ieee_little_endian_format
&& !le
)
2383 || (double_format
== ieee_big_endian_format
&& le
)) {
2388 for (i
= 0; i
< 8; i
++) {