blob: d67f17abb5c2711270f277844230383afcc8617d [file] [log] [blame]
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001/* Float object implementation */
2
Guido van Rossum2a9096b1990-10-21 22:15:08 +00003/* XXX There should be overflow checks here, but it's hard to check
4 for any kind of float exception without losing portability. */
5
Guido van Rossumc0b618a1997-05-02 03:12:38 +00006#include "Python.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00007
Guido van Rossum3f5da241990-12-20 15:06:42 +00008#include <ctype.h>
Christian Heimes93852662007-12-01 12:22:32 +00009#include <float.h>
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000010
Serhiy Storchakab5c51d32017-03-11 09:21:05 +020011/*[clinic input]
12class float "PyObject *" "&PyFloat_Type"
13[clinic start generated code]*/
14/*[clinic end generated code: output=da39a3ee5e6b4b0d input=dd0003f68f144284]*/
15
16#include "clinic/floatobject.c.h"
Guido van Rossum6923e131990-11-02 17:50:43 +000017
Mark Dickinsond19052c2010-06-27 18:19:09 +000018/* Special free list
Mark Dickinsond19052c2010-06-27 18:19:09 +000019 free_list is a singly-linked list of available PyFloatObjects, linked
20 via abuse of their ob_type members.
21*/
22
Kristján Valur Jónssondaa06542012-03-30 09:18:15 +000023#ifndef PyFloat_MAXFREELIST
24#define PyFloat_MAXFREELIST 100
25#endif
26static int numfree = 0;
Guido van Rossum3fce8831999-03-12 19:43:17 +000027static PyFloatObject *free_list = NULL;
28
Christian Heimes93852662007-12-01 12:22:32 +000029double
30PyFloat_GetMax(void)
31{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000032 return DBL_MAX;
Christian Heimes93852662007-12-01 12:22:32 +000033}
34
35double
36PyFloat_GetMin(void)
37{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000038 return DBL_MIN;
Christian Heimes93852662007-12-01 12:22:32 +000039}
40
Christian Heimesd32ed6f2008-01-14 18:49:24 +000041static PyTypeObject FloatInfoType;
42
43PyDoc_STRVAR(floatinfo__doc__,
Benjamin Peterson78565b22009-06-28 19:19:51 +000044"sys.float_info\n\
Christian Heimesd32ed6f2008-01-14 18:49:24 +000045\n\
Raymond Hettinger71170742019-09-11 07:17:32 -070046A named tuple holding information about the float type. It contains low level\n\
Christian Heimesd32ed6f2008-01-14 18:49:24 +000047information about the precision and internal representation. Please study\n\
48your system's :file:`float.h` for more information.");
49
50static PyStructSequence_Field floatinfo_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000051 {"max", "DBL_MAX -- maximum representable finite float"},
52 {"max_exp", "DBL_MAX_EXP -- maximum int e such that radix**(e-1) "
53 "is representable"},
54 {"max_10_exp", "DBL_MAX_10_EXP -- maximum int e such that 10**e "
55 "is representable"},
Stefano Taschini0301c9b2018-03-26 11:41:30 +020056 {"min", "DBL_MIN -- Minimum positive normalized float"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000057 {"min_exp", "DBL_MIN_EXP -- minimum int e such that radix**(e-1) "
58 "is a normalized float"},
59 {"min_10_exp", "DBL_MIN_10_EXP -- minimum int e such that 10**e is "
60 "a normalized"},
61 {"dig", "DBL_DIG -- digits"},
62 {"mant_dig", "DBL_MANT_DIG -- mantissa digits"},
63 {"epsilon", "DBL_EPSILON -- Difference between 1 and the next "
64 "representable float"},
65 {"radix", "FLT_RADIX -- radix of exponent"},
Stefano Taschini0301c9b2018-03-26 11:41:30 +020066 {"rounds", "FLT_ROUNDS -- rounding mode"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000067 {0}
Christian Heimesd32ed6f2008-01-14 18:49:24 +000068};
69
70static PyStructSequence_Desc floatinfo_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000071 "sys.float_info", /* name */
72 floatinfo__doc__, /* doc */
73 floatinfo_fields, /* fields */
74 11
Christian Heimesd32ed6f2008-01-14 18:49:24 +000075};
76
Christian Heimes93852662007-12-01 12:22:32 +000077PyObject *
78PyFloat_GetInfo(void)
79{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000080 PyObject* floatinfo;
81 int pos = 0;
Christian Heimes93852662007-12-01 12:22:32 +000082
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000083 floatinfo = PyStructSequence_New(&FloatInfoType);
84 if (floatinfo == NULL) {
85 return NULL;
86 }
Christian Heimes93852662007-12-01 12:22:32 +000087
Christian Heimesd32ed6f2008-01-14 18:49:24 +000088#define SetIntFlag(flag) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000089 PyStructSequence_SET_ITEM(floatinfo, pos++, PyLong_FromLong(flag))
Christian Heimesd32ed6f2008-01-14 18:49:24 +000090#define SetDblFlag(flag) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000091 PyStructSequence_SET_ITEM(floatinfo, pos++, PyFloat_FromDouble(flag))
Christian Heimes93852662007-12-01 12:22:32 +000092
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000093 SetDblFlag(DBL_MAX);
94 SetIntFlag(DBL_MAX_EXP);
95 SetIntFlag(DBL_MAX_10_EXP);
96 SetDblFlag(DBL_MIN);
97 SetIntFlag(DBL_MIN_EXP);
98 SetIntFlag(DBL_MIN_10_EXP);
99 SetIntFlag(DBL_DIG);
100 SetIntFlag(DBL_MANT_DIG);
101 SetDblFlag(DBL_EPSILON);
102 SetIntFlag(FLT_RADIX);
103 SetIntFlag(FLT_ROUNDS);
Christian Heimesd32ed6f2008-01-14 18:49:24 +0000104#undef SetIntFlag
105#undef SetDblFlag
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000106
107 if (PyErr_Occurred()) {
108 Py_CLEAR(floatinfo);
109 return NULL;
110 }
111 return floatinfo;
Christian Heimes93852662007-12-01 12:22:32 +0000112}
113
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000114PyObject *
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000115PyFloat_FromDouble(double fval)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000116{
Antoine Pitrou9ed5f272013-08-13 20:18:52 +0200117 PyFloatObject *op = free_list;
Kristján Valur Jónssondaa06542012-03-30 09:18:15 +0000118 if (op != NULL) {
119 free_list = (PyFloatObject *) Py_TYPE(op);
120 numfree--;
121 } else {
122 op = (PyFloatObject*) PyObject_MALLOC(sizeof(PyFloatObject));
123 if (!op)
124 return PyErr_NoMemory();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000125 }
126 /* Inline PyObject_New */
Victor Stinnerb509d522018-11-23 14:27:38 +0100127 (void)PyObject_INIT(op, &PyFloat_Type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000128 op->ob_fval = fval;
129 return (PyObject *) op;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000130}
131
Brett Cannona721aba2016-09-09 14:57:09 -0700132static PyObject *
133float_from_string_inner(const char *s, Py_ssize_t len, void *obj)
134{
135 double x;
136 const char *end;
137 const char *last = s + len;
138 /* strip space */
139 while (s < last && Py_ISSPACE(*s)) {
140 s++;
141 }
142
143 while (s < last - 1 && Py_ISSPACE(last[-1])) {
144 last--;
145 }
146
147 /* We don't care about overflow or underflow. If the platform
148 * supports them, infinities and signed zeroes (on underflow) are
149 * fine. */
150 x = PyOS_string_to_double(s, (char **)&end, NULL);
151 if (end != last) {
152 PyErr_Format(PyExc_ValueError,
153 "could not convert string to float: "
154 "%R", obj);
155 return NULL;
156 }
157 else if (x == -1.0 && PyErr_Occurred()) {
158 return NULL;
159 }
160 else {
161 return PyFloat_FromDouble(x);
162 }
163}
164
Barry Warsaw226ae6c1999-10-12 19:54:53 +0000165PyObject *
Georg Brandl428f0642007-03-18 18:35:15 +0000166PyFloat_FromString(PyObject *v)
Barry Warsaw226ae6c1999-10-12 19:54:53 +0000167{
Brett Cannona721aba2016-09-09 14:57:09 -0700168 const char *s;
Alexander Belopolsky942af5a2010-12-04 03:38:46 +0000169 PyObject *s_buffer = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000170 Py_ssize_t len;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +0200171 Py_buffer view = {NULL, NULL};
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000172 PyObject *result = NULL;
Barry Warsaw226ae6c1999-10-12 19:54:53 +0000173
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000174 if (PyUnicode_Check(v)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200175 s_buffer = _PyUnicode_TransformDecimalAndSpaceToASCII(v);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000176 if (s_buffer == NULL)
Alexander Belopolsky942af5a2010-12-04 03:38:46 +0000177 return NULL;
Serhiy Storchaka9b6c60c2017-11-13 21:23:48 +0200178 assert(PyUnicode_IS_ASCII(s_buffer));
179 /* Simply get a pointer to existing ASCII characters. */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200180 s = PyUnicode_AsUTF8AndSize(s_buffer, &len);
Serhiy Storchaka9b6c60c2017-11-13 21:23:48 +0200181 assert(s != NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000182 }
Martin Pantereeb896c2015-11-07 02:32:21 +0000183 else if (PyBytes_Check(v)) {
184 s = PyBytes_AS_STRING(v);
185 len = PyBytes_GET_SIZE(v);
186 }
187 else if (PyByteArray_Check(v)) {
188 s = PyByteArray_AS_STRING(v);
189 len = PyByteArray_GET_SIZE(v);
190 }
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +0200191 else if (PyObject_GetBuffer(v, &view, PyBUF_SIMPLE) == 0) {
192 s = (const char *)view.buf;
193 len = view.len;
Martin Pantereeb896c2015-11-07 02:32:21 +0000194 /* Copy to NUL-terminated buffer. */
195 s_buffer = PyBytes_FromStringAndSize(s, len);
196 if (s_buffer == NULL) {
197 PyBuffer_Release(&view);
198 return NULL;
199 }
200 s = PyBytes_AS_STRING(s_buffer);
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +0200201 }
202 else {
Ezio Melottia5b95992013-11-07 19:18:34 +0200203 PyErr_Format(PyExc_TypeError,
204 "float() argument must be a string or a number, not '%.200s'",
205 Py_TYPE(v)->tp_name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000206 return NULL;
207 }
Brett Cannona721aba2016-09-09 14:57:09 -0700208 result = _Py_string_to_number_with_underscores(s, len, "float", v, v,
209 float_from_string_inner);
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +0200210 PyBuffer_Release(&view);
Alexander Belopolsky942af5a2010-12-04 03:38:46 +0000211 Py_XDECREF(s_buffer);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000212 return result;
Barry Warsaw226ae6c1999-10-12 19:54:53 +0000213}
214
Guido van Rossum234f9421993-06-17 12:35:49 +0000215static void
Fred Drakefd99de62000-07-09 05:02:18 +0000216float_dealloc(PyFloatObject *op)
Guido van Rossum3132a5a1992-03-27 17:28:44 +0000217{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000218 if (PyFloat_CheckExact(op)) {
Kristján Valur Jónssondaa06542012-03-30 09:18:15 +0000219 if (numfree >= PyFloat_MAXFREELIST) {
220 PyObject_FREE(op);
221 return;
222 }
223 numfree++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000224 Py_TYPE(op) = (struct _typeobject *)free_list;
225 free_list = op;
226 }
227 else
228 Py_TYPE(op)->tp_free((PyObject *)op);
Guido van Rossum3132a5a1992-03-27 17:28:44 +0000229}
230
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000231double
Fred Drakefd99de62000-07-09 05:02:18 +0000232PyFloat_AsDouble(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000233{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000234 PyNumberMethods *nb;
Serhiy Storchaka16931c32016-06-03 21:42:55 +0300235 PyObject *res;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000236 double val;
Tim Petersd2364e82001-11-01 20:09:42 +0000237
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000238 if (op == NULL) {
239 PyErr_BadArgument();
240 return -1;
241 }
Tim Petersd2364e82001-11-01 20:09:42 +0000242
Serhiy Storchaka16931c32016-06-03 21:42:55 +0300243 if (PyFloat_Check(op)) {
244 return PyFloat_AS_DOUBLE(op);
245 }
246
247 nb = Py_TYPE(op)->tp_as_number;
248 if (nb == NULL || nb->nb_float == NULL) {
Serhiy Storchakabdbad712019-06-02 00:05:48 +0300249 if (nb && nb->nb_index) {
250 PyObject *res = PyNumber_Index(op);
251 if (!res) {
252 return -1;
253 }
254 double val = PyLong_AsDouble(res);
255 Py_DECREF(res);
256 return val;
257 }
Serhiy Storchaka16931c32016-06-03 21:42:55 +0300258 PyErr_Format(PyExc_TypeError, "must be real number, not %.50s",
259 op->ob_type->tp_name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000260 return -1;
261 }
Neil Schemenauer2c77e902002-11-18 16:06:21 +0000262
Serhiy Storchaka16931c32016-06-03 21:42:55 +0300263 res = (*nb->nb_float) (op);
264 if (res == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000265 return -1;
266 }
Serhiy Storchaka16931c32016-06-03 21:42:55 +0300267 if (!PyFloat_CheckExact(res)) {
268 if (!PyFloat_Check(res)) {
269 PyErr_Format(PyExc_TypeError,
270 "%.50s.__float__ returned non-float (type %.50s)",
271 op->ob_type->tp_name, res->ob_type->tp_name);
272 Py_DECREF(res);
273 return -1;
274 }
275 if (PyErr_WarnFormat(PyExc_DeprecationWarning, 1,
276 "%.50s.__float__ returned non-float (type %.50s). "
277 "The ability to return an instance of a strict subclass of float "
278 "is deprecated, and may be removed in a future version of Python.",
279 op->ob_type->tp_name, res->ob_type->tp_name)) {
280 Py_DECREF(res);
281 return -1;
282 }
283 }
Tim Petersd2364e82001-11-01 20:09:42 +0000284
Serhiy Storchaka16931c32016-06-03 21:42:55 +0300285 val = PyFloat_AS_DOUBLE(res);
286 Py_DECREF(res);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000287 return val;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000288}
289
Neil Schemenauer32117e52001-01-04 01:44:34 +0000290/* Macro and helper that convert PyObject obj to a C double and store
Neil Schemenauer16c70752007-09-21 20:19:23 +0000291 the value in dbl. If conversion to double raises an exception, obj is
Tim Peters77d8a4f2001-12-11 20:31:34 +0000292 set to NULL, and the function invoking this macro returns NULL. If
Serhiy Storchaka95949422013-08-27 19:40:23 +0300293 obj is not of float or int type, Py_NotImplemented is incref'ed,
Tim Peters77d8a4f2001-12-11 20:31:34 +0000294 stored in obj, and returned from the function invoking this macro.
295*/
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000296#define CONVERT_TO_DOUBLE(obj, dbl) \
297 if (PyFloat_Check(obj)) \
298 dbl = PyFloat_AS_DOUBLE(obj); \
299 else if (convert_to_double(&(obj), &(dbl)) < 0) \
300 return obj;
Neil Schemenauer32117e52001-01-04 01:44:34 +0000301
Eric Smith0923d1d2009-04-16 20:16:10 +0000302/* Methods */
303
Neil Schemenauer32117e52001-01-04 01:44:34 +0000304static int
Tim Peters9fffa3e2001-09-04 05:14:19 +0000305convert_to_double(PyObject **v, double *dbl)
Neil Schemenauer32117e52001-01-04 01:44:34 +0000306{
Antoine Pitrou9ed5f272013-08-13 20:18:52 +0200307 PyObject *obj = *v;
Tim Peters9fffa3e2001-09-04 05:14:19 +0000308
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000309 if (PyLong_Check(obj)) {
310 *dbl = PyLong_AsDouble(obj);
311 if (*dbl == -1.0 && PyErr_Occurred()) {
312 *v = NULL;
313 return -1;
314 }
315 }
316 else {
317 Py_INCREF(Py_NotImplemented);
318 *v = Py_NotImplemented;
319 return -1;
320 }
321 return 0;
Neil Schemenauer32117e52001-01-04 01:44:34 +0000322}
323
Eric Smith0923d1d2009-04-16 20:16:10 +0000324static PyObject *
Mark Dickinson388122d2010-08-04 20:56:28 +0000325float_repr(PyFloatObject *v)
Eric Smith0923d1d2009-04-16 20:16:10 +0000326{
327 PyObject *result;
Victor Stinnerd3f08822012-05-29 12:57:52 +0200328 char *buf;
329
330 buf = PyOS_double_to_string(PyFloat_AS_DOUBLE(v),
331 'r', 0,
332 Py_DTSF_ADD_DOT_0,
333 NULL);
Eric Smith0923d1d2009-04-16 20:16:10 +0000334 if (!buf)
Mark Dickinson388122d2010-08-04 20:56:28 +0000335 return PyErr_NoMemory();
Victor Stinnerd3f08822012-05-29 12:57:52 +0200336 result = _PyUnicode_FromASCII(buf, strlen(buf));
Eric Smith0923d1d2009-04-16 20:16:10 +0000337 PyMem_Free(buf);
338 return result;
339}
Guido van Rossum57072eb1999-12-23 19:00:28 +0000340
Tim Peters307fa782004-09-23 08:06:40 +0000341/* Comparison is pretty much a nightmare. When comparing float to float,
342 * we do it as straightforwardly (and long-windedly) as conceivable, so
343 * that, e.g., Python x == y delivers the same result as the platform
344 * C x == y when x and/or y is a NaN.
345 * When mixing float with an integer type, there's no good *uniform* approach.
346 * Converting the double to an integer obviously doesn't work, since we
347 * may lose info from fractional bits. Converting the integer to a double
Serhiy Storchaka95949422013-08-27 19:40:23 +0300348 * also has two failure modes: (1) an int may trigger overflow (too
Tim Peters307fa782004-09-23 08:06:40 +0000349 * large to fit in the dynamic range of a C double); (2) even a C long may have
Ezio Melotti3f5db392013-01-27 06:20:14 +0200350 * more bits than fit in a C double (e.g., on a 64-bit box long may have
Tim Peters307fa782004-09-23 08:06:40 +0000351 * 63 bits of precision, but a C double probably has only 53), and then
352 * we can falsely claim equality when low-order integer bits are lost by
353 * coercion to double. So this part is painful too.
354 */
355
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000356static PyObject*
357float_richcompare(PyObject *v, PyObject *w, int op)
358{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000359 double i, j;
360 int r = 0;
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000361
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000362 assert(PyFloat_Check(v));
363 i = PyFloat_AS_DOUBLE(v);
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000364
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000365 /* Switch on the type of w. Set i and j to doubles to be compared,
366 * and op to the richcomp to use.
367 */
368 if (PyFloat_Check(w))
369 j = PyFloat_AS_DOUBLE(w);
Tim Peters307fa782004-09-23 08:06:40 +0000370
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000371 else if (!Py_IS_FINITE(i)) {
372 if (PyLong_Check(w))
373 /* If i is an infinity, its magnitude exceeds any
374 * finite integer, so it doesn't matter which int we
375 * compare i with. If i is a NaN, similarly.
376 */
377 j = 0.0;
378 else
379 goto Unimplemented;
380 }
Tim Peters307fa782004-09-23 08:06:40 +0000381
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000382 else if (PyLong_Check(w)) {
383 int vsign = i == 0.0 ? 0 : i < 0.0 ? -1 : 1;
384 int wsign = _PyLong_Sign(w);
385 size_t nbits;
386 int exponent;
Tim Peters307fa782004-09-23 08:06:40 +0000387
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000388 if (vsign != wsign) {
389 /* Magnitudes are irrelevant -- the signs alone
390 * determine the outcome.
391 */
392 i = (double)vsign;
393 j = (double)wsign;
394 goto Compare;
395 }
396 /* The signs are the same. */
397 /* Convert w to a double if it fits. In particular, 0 fits. */
398 nbits = _PyLong_NumBits(w);
399 if (nbits == (size_t)-1 && PyErr_Occurred()) {
400 /* This long is so large that size_t isn't big enough
401 * to hold the # of bits. Replace with little doubles
402 * that give the same outcome -- w is so large that
403 * its magnitude must exceed the magnitude of any
404 * finite float.
405 */
406 PyErr_Clear();
407 i = (double)vsign;
408 assert(wsign != 0);
409 j = wsign * 2.0;
410 goto Compare;
411 }
412 if (nbits <= 48) {
413 j = PyLong_AsDouble(w);
414 /* It's impossible that <= 48 bits overflowed. */
415 assert(j != -1.0 || ! PyErr_Occurred());
416 goto Compare;
417 }
418 assert(wsign != 0); /* else nbits was 0 */
419 assert(vsign != 0); /* if vsign were 0, then since wsign is
420 * not 0, we would have taken the
421 * vsign != wsign branch at the start */
422 /* We want to work with non-negative numbers. */
423 if (vsign < 0) {
424 /* "Multiply both sides" by -1; this also swaps the
425 * comparator.
426 */
427 i = -i;
428 op = _Py_SwappedOp[op];
429 }
430 assert(i > 0.0);
431 (void) frexp(i, &exponent);
432 /* exponent is the # of bits in v before the radix point;
433 * we know that nbits (the # of bits in w) > 48 at this point
434 */
435 if (exponent < 0 || (size_t)exponent < nbits) {
436 i = 1.0;
437 j = 2.0;
438 goto Compare;
439 }
440 if ((size_t)exponent > nbits) {
441 i = 2.0;
442 j = 1.0;
443 goto Compare;
444 }
445 /* v and w have the same number of bits before the radix
Serhiy Storchaka95949422013-08-27 19:40:23 +0300446 * point. Construct two ints that have the same comparison
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000447 * outcome.
448 */
449 {
450 double fracpart;
451 double intpart;
452 PyObject *result = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000453 PyObject *vv = NULL;
454 PyObject *ww = w;
Tim Peters307fa782004-09-23 08:06:40 +0000455
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000456 if (wsign < 0) {
457 ww = PyNumber_Negative(w);
458 if (ww == NULL)
459 goto Error;
460 }
461 else
462 Py_INCREF(ww);
Tim Peters307fa782004-09-23 08:06:40 +0000463
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000464 fracpart = modf(i, &intpart);
465 vv = PyLong_FromDouble(intpart);
466 if (vv == NULL)
467 goto Error;
Tim Peters307fa782004-09-23 08:06:40 +0000468
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000469 if (fracpart != 0.0) {
470 /* Shift left, and or a 1 bit into vv
471 * to represent the lost fraction.
472 */
473 PyObject *temp;
Tim Peters307fa782004-09-23 08:06:40 +0000474
Serhiy Storchakaa5119e72019-05-19 14:14:38 +0300475 temp = _PyLong_Lshift(ww, 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000476 if (temp == NULL)
477 goto Error;
478 Py_DECREF(ww);
479 ww = temp;
Tim Peters307fa782004-09-23 08:06:40 +0000480
Serhiy Storchakaa5119e72019-05-19 14:14:38 +0300481 temp = _PyLong_Lshift(vv, 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000482 if (temp == NULL)
483 goto Error;
484 Py_DECREF(vv);
485 vv = temp;
Tim Peters307fa782004-09-23 08:06:40 +0000486
Serhiy Storchakaba85d692017-03-30 09:09:41 +0300487 temp = PyNumber_Or(vv, _PyLong_One);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000488 if (temp == NULL)
489 goto Error;
490 Py_DECREF(vv);
491 vv = temp;
492 }
Tim Peters307fa782004-09-23 08:06:40 +0000493
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000494 r = PyObject_RichCompareBool(vv, ww, op);
495 if (r < 0)
496 goto Error;
497 result = PyBool_FromLong(r);
498 Error:
499 Py_XDECREF(vv);
500 Py_XDECREF(ww);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000501 return result;
502 }
503 } /* else if (PyLong_Check(w)) */
Tim Peters307fa782004-09-23 08:06:40 +0000504
Serhiy Storchaka95949422013-08-27 19:40:23 +0300505 else /* w isn't float or int */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000506 goto Unimplemented;
Tim Peters307fa782004-09-23 08:06:40 +0000507
508 Compare:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000509 switch (op) {
510 case Py_EQ:
511 r = i == j;
512 break;
513 case Py_NE:
514 r = i != j;
515 break;
516 case Py_LE:
517 r = i <= j;
518 break;
519 case Py_GE:
520 r = i >= j;
521 break;
522 case Py_LT:
523 r = i < j;
524 break;
525 case Py_GT:
526 r = i > j;
527 break;
528 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000529 return PyBool_FromLong(r);
Tim Peters307fa782004-09-23 08:06:40 +0000530
531 Unimplemented:
Brian Curtindfc80e32011-08-10 20:28:54 -0500532 Py_RETURN_NOTIMPLEMENTED;
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000533}
534
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000535static Py_hash_t
Fred Drakefd99de62000-07-09 05:02:18 +0000536float_hash(PyFloatObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000537{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000538 return _Py_HashDouble(v->ob_fval);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000539}
540
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000541static PyObject *
Neil Schemenauer32117e52001-01-04 01:44:34 +0000542float_add(PyObject *v, PyObject *w)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000543{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000544 double a,b;
545 CONVERT_TO_DOUBLE(v, a);
546 CONVERT_TO_DOUBLE(w, b);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000547 a = a + b;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000548 return PyFloat_FromDouble(a);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000549}
550
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000551static PyObject *
Neil Schemenauer32117e52001-01-04 01:44:34 +0000552float_sub(PyObject *v, PyObject *w)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000553{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000554 double a,b;
555 CONVERT_TO_DOUBLE(v, a);
556 CONVERT_TO_DOUBLE(w, b);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000557 a = a - b;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000558 return PyFloat_FromDouble(a);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000559}
560
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000561static PyObject *
Neil Schemenauer32117e52001-01-04 01:44:34 +0000562float_mul(PyObject *v, PyObject *w)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000563{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000564 double a,b;
565 CONVERT_TO_DOUBLE(v, a);
566 CONVERT_TO_DOUBLE(w, b);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000567 a = a * b;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000568 return PyFloat_FromDouble(a);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000569}
570
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000571static PyObject *
Neil Schemenauer32117e52001-01-04 01:44:34 +0000572float_div(PyObject *v, PyObject *w)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000573{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000574 double a,b;
575 CONVERT_TO_DOUBLE(v, a);
576 CONVERT_TO_DOUBLE(w, b);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000577 if (b == 0.0) {
578 PyErr_SetString(PyExc_ZeroDivisionError,
579 "float division by zero");
580 return NULL;
581 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000582 a = a / b;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000583 return PyFloat_FromDouble(a);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000584}
585
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000586static PyObject *
Neil Schemenauer32117e52001-01-04 01:44:34 +0000587float_rem(PyObject *v, PyObject *w)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000588{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000589 double vx, wx;
590 double mod;
591 CONVERT_TO_DOUBLE(v, vx);
592 CONVERT_TO_DOUBLE(w, wx);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000593 if (wx == 0.0) {
594 PyErr_SetString(PyExc_ZeroDivisionError,
595 "float modulo");
596 return NULL;
597 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000598 mod = fmod(vx, wx);
Mark Dickinsond2a9b202010-12-04 12:25:30 +0000599 if (mod) {
600 /* ensure the remainder has the same sign as the denominator */
601 if ((wx < 0) != (mod < 0)) {
602 mod += wx;
603 }
604 }
605 else {
606 /* the remainder is zero, and in the presence of signed zeroes
607 fmod returns different results across platforms; ensure
Mark Dickinson7b1bee42010-12-04 13:14:29 +0000608 it has the same sign as the denominator. */
609 mod = copysign(0.0, wx);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000610 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000611 return PyFloat_FromDouble(mod);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000612}
613
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000614static PyObject *
Neil Schemenauer32117e52001-01-04 01:44:34 +0000615float_divmod(PyObject *v, PyObject *w)
Guido van Rossumeba1b5e1991-05-05 20:07:00 +0000616{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000617 double vx, wx;
618 double div, mod, floordiv;
619 CONVERT_TO_DOUBLE(v, vx);
620 CONVERT_TO_DOUBLE(w, wx);
621 if (wx == 0.0) {
622 PyErr_SetString(PyExc_ZeroDivisionError, "float divmod()");
623 return NULL;
624 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000625 mod = fmod(vx, wx);
626 /* fmod is typically exact, so vx-mod is *mathematically* an
627 exact multiple of wx. But this is fp arithmetic, and fp
628 vx - mod is an approximation; the result is that div may
629 not be an exact integral value after the division, although
630 it will always be very close to one.
631 */
632 div = (vx - mod) / wx;
633 if (mod) {
634 /* ensure the remainder has the same sign as the denominator */
635 if ((wx < 0) != (mod < 0)) {
636 mod += wx;
637 div -= 1.0;
638 }
639 }
640 else {
641 /* the remainder is zero, and in the presence of signed zeroes
642 fmod returns different results across platforms; ensure
Mark Dickinson7b1bee42010-12-04 13:14:29 +0000643 it has the same sign as the denominator. */
644 mod = copysign(0.0, wx);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000645 }
646 /* snap quotient to nearest integral value */
647 if (div) {
648 floordiv = floor(div);
649 if (div - floordiv > 0.5)
650 floordiv += 1.0;
651 }
652 else {
653 /* div is zero - get the same sign as the true quotient */
Mark Dickinson7b1bee42010-12-04 13:14:29 +0000654 floordiv = copysign(0.0, vx / wx); /* zero w/ sign of vx/wx */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000655 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000656 return Py_BuildValue("(dd)", floordiv, mod);
Guido van Rossumeba1b5e1991-05-05 20:07:00 +0000657}
658
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000659static PyObject *
Tim Peters63a35712001-12-11 19:57:24 +0000660float_floor_div(PyObject *v, PyObject *w)
661{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000662 PyObject *t, *r;
Tim Peters63a35712001-12-11 19:57:24 +0000663
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000664 t = float_divmod(v, w);
665 if (t == NULL || t == Py_NotImplemented)
666 return t;
667 assert(PyTuple_CheckExact(t));
668 r = PyTuple_GET_ITEM(t, 0);
669 Py_INCREF(r);
670 Py_DECREF(t);
671 return r;
Tim Peters63a35712001-12-11 19:57:24 +0000672}
673
Mark Dickinson9ab44b52009-12-30 16:22:49 +0000674/* determine whether x is an odd integer or not; assumes that
675 x is not an infinity or nan. */
676#define DOUBLE_IS_ODD_INTEGER(x) (fmod(fabs(x), 2.0) == 1.0)
677
Tim Peters63a35712001-12-11 19:57:24 +0000678static PyObject *
Neil Schemenauer32117e52001-01-04 01:44:34 +0000679float_pow(PyObject *v, PyObject *w, PyObject *z)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000680{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000681 double iv, iw, ix;
682 int negate_result = 0;
Tim Peters32f453e2001-09-03 08:35:41 +0000683
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000684 if ((PyObject *)z != Py_None) {
685 PyErr_SetString(PyExc_TypeError, "pow() 3rd argument not "
686 "allowed unless all arguments are integers");
687 return NULL;
688 }
Tim Peters32f453e2001-09-03 08:35:41 +0000689
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000690 CONVERT_TO_DOUBLE(v, iv);
691 CONVERT_TO_DOUBLE(w, iw);
Tim Petersc54d1902000-10-06 00:36:09 +0000692
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000693 /* Sort out special cases here instead of relying on pow() */
694 if (iw == 0) { /* v**0 is 1, even 0**0 */
695 return PyFloat_FromDouble(1.0);
696 }
697 if (Py_IS_NAN(iv)) { /* nan**w = nan, unless w == 0 */
698 return PyFloat_FromDouble(iv);
699 }
700 if (Py_IS_NAN(iw)) { /* v**nan = nan, unless v == 1; 1**nan = 1 */
701 return PyFloat_FromDouble(iv == 1.0 ? 1.0 : iw);
702 }
703 if (Py_IS_INFINITY(iw)) {
704 /* v**inf is: 0.0 if abs(v) < 1; 1.0 if abs(v) == 1; inf if
705 * abs(v) > 1 (including case where v infinite)
706 *
707 * v**-inf is: inf if abs(v) < 1; 1.0 if abs(v) == 1; 0.0 if
708 * abs(v) > 1 (including case where v infinite)
709 */
710 iv = fabs(iv);
711 if (iv == 1.0)
712 return PyFloat_FromDouble(1.0);
713 else if ((iw > 0.0) == (iv > 1.0))
714 return PyFloat_FromDouble(fabs(iw)); /* return inf */
715 else
716 return PyFloat_FromDouble(0.0);
717 }
718 if (Py_IS_INFINITY(iv)) {
719 /* (+-inf)**w is: inf for w positive, 0 for w negative; in
720 * both cases, we need to add the appropriate sign if w is
721 * an odd integer.
722 */
723 int iw_is_odd = DOUBLE_IS_ODD_INTEGER(iw);
724 if (iw > 0.0)
725 return PyFloat_FromDouble(iw_is_odd ? iv : fabs(iv));
726 else
727 return PyFloat_FromDouble(iw_is_odd ?
728 copysign(0.0, iv) : 0.0);
729 }
730 if (iv == 0.0) { /* 0**w is: 0 for w positive, 1 for w zero
731 (already dealt with above), and an error
732 if w is negative. */
733 int iw_is_odd = DOUBLE_IS_ODD_INTEGER(iw);
734 if (iw < 0.0) {
735 PyErr_SetString(PyExc_ZeroDivisionError,
736 "0.0 cannot be raised to a "
737 "negative power");
738 return NULL;
739 }
740 /* use correct sign if iw is odd */
741 return PyFloat_FromDouble(iw_is_odd ? iv : 0.0);
742 }
Mark Dickinson9ab44b52009-12-30 16:22:49 +0000743
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000744 if (iv < 0.0) {
745 /* Whether this is an error is a mess, and bumps into libm
746 * bugs so we have to figure it out ourselves.
747 */
748 if (iw != floor(iw)) {
749 /* Negative numbers raised to fractional powers
750 * become complex.
751 */
752 return PyComplex_Type.tp_as_number->nb_power(v, w, z);
753 }
754 /* iw is an exact integer, albeit perhaps a very large
755 * one. Replace iv by its absolute value and remember
756 * to negate the pow result if iw is odd.
757 */
758 iv = -iv;
759 negate_result = DOUBLE_IS_ODD_INTEGER(iw);
760 }
Mark Dickinson9ab44b52009-12-30 16:22:49 +0000761
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000762 if (iv == 1.0) { /* 1**w is 1, even 1**inf and 1**nan */
763 /* (-1) ** large_integer also ends up here. Here's an
764 * extract from the comments for the previous
765 * implementation explaining why this special case is
766 * necessary:
767 *
768 * -1 raised to an exact integer should never be exceptional.
769 * Alas, some libms (chiefly glibc as of early 2003) return
770 * NaN and set EDOM on pow(-1, large_int) if the int doesn't
771 * happen to be representable in a *C* integer. That's a
772 * bug.
773 */
774 return PyFloat_FromDouble(negate_result ? -1.0 : 1.0);
775 }
Mark Dickinson9ab44b52009-12-30 16:22:49 +0000776
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000777 /* Now iv and iw are finite, iw is nonzero, and iv is
778 * positive and not equal to 1.0. We finally allow
779 * the platform pow to step in and do the rest.
780 */
781 errno = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000782 ix = pow(iv, iw);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000783 Py_ADJUST_ERANGE1(ix);
784 if (negate_result)
785 ix = -ix;
Mark Dickinson9ab44b52009-12-30 16:22:49 +0000786
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000787 if (errno != 0) {
788 /* We don't expect any errno value other than ERANGE, but
789 * the range of libm bugs appears unbounded.
790 */
791 PyErr_SetFromErrno(errno == ERANGE ? PyExc_OverflowError :
792 PyExc_ValueError);
793 return NULL;
794 }
795 return PyFloat_FromDouble(ix);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000796}
797
Mark Dickinson9ab44b52009-12-30 16:22:49 +0000798#undef DOUBLE_IS_ODD_INTEGER
799
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000800static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000801float_neg(PyFloatObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000802{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000803 return PyFloat_FromDouble(-v->ob_fval);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000804}
805
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000806static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000807float_abs(PyFloatObject *v)
Guido van Rossumeba1b5e1991-05-05 20:07:00 +0000808{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000809 return PyFloat_FromDouble(fabs(v->ob_fval));
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000810}
811
Guido van Rossum50b4ef61991-05-14 11:57:01 +0000812static int
Jack Diederich4dafcc42006-11-28 19:15:13 +0000813float_bool(PyFloatObject *v)
Guido van Rossum50b4ef61991-05-14 11:57:01 +0000814{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000815 return v->ob_fval != 0.0;
Guido van Rossum50b4ef61991-05-14 11:57:01 +0000816}
817
Serhiy Storchakab5c51d32017-03-11 09:21:05 +0200818/*[clinic input]
819float.is_integer
820
821Return True if the float is an integer.
822[clinic start generated code]*/
823
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000824static PyObject *
Serhiy Storchakab5c51d32017-03-11 09:21:05 +0200825float_is_integer_impl(PyObject *self)
826/*[clinic end generated code: output=7112acf95a4d31ea input=311810d3f777e10d]*/
Christian Heimes53876d92008-04-19 00:31:39 +0000827{
Serhiy Storchakab5c51d32017-03-11 09:21:05 +0200828 double x = PyFloat_AsDouble(self);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000829 PyObject *o;
830
831 if (x == -1.0 && PyErr_Occurred())
832 return NULL;
833 if (!Py_IS_FINITE(x))
834 Py_RETURN_FALSE;
835 errno = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000836 o = (floor(x) == x) ? Py_True : Py_False;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000837 if (errno != 0) {
838 PyErr_SetFromErrno(errno == ERANGE ? PyExc_OverflowError :
839 PyExc_ValueError);
840 return NULL;
841 }
842 Py_INCREF(o);
843 return o;
Christian Heimes53876d92008-04-19 00:31:39 +0000844}
845
Serhiy Storchakab5c51d32017-03-11 09:21:05 +0200846/*[clinic input]
847float.__trunc__
848
849Return the Integral closest to x between 0 and x.
850[clinic start generated code]*/
851
Christian Heimes53876d92008-04-19 00:31:39 +0000852static PyObject *
Serhiy Storchakab5c51d32017-03-11 09:21:05 +0200853float___trunc___impl(PyObject *self)
854/*[clinic end generated code: output=dd3e289dd4c6b538 input=591b9ba0d650fdff]*/
Guido van Rossum1899c2e1992-09-12 11:09:23 +0000855{
Serhiy Storchakab5c51d32017-03-11 09:21:05 +0200856 double x = PyFloat_AsDouble(self);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000857 double wholepart; /* integral portion of x, rounded toward 0 */
Tim Peters7321ec42001-07-26 20:02:17 +0000858
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000859 (void)modf(x, &wholepart);
860 /* Try to get out cheap if this fits in a Python int. The attempt
861 * to cast to long must be protected, as C doesn't define what
862 * happens if the double is too big to fit in a long. Some rare
863 * systems raise an exception then (RISCOS was mentioned as one,
864 * and someone using a non-default option on Sun also bumped into
865 * that). Note that checking for >= and <= LONG_{MIN,MAX} would
866 * still be vulnerable: if a long has more bits of precision than
867 * a double, casting MIN/MAX to double may yield an approximation,
868 * and if that's rounded up, then, e.g., wholepart=LONG_MAX+1 would
869 * yield true from the C expression wholepart<=LONG_MAX, despite
870 * that wholepart is actually greater than LONG_MAX.
871 */
872 if (LONG_MIN < wholepart && wholepart < LONG_MAX) {
873 const long aslong = (long)wholepart;
874 return PyLong_FromLong(aslong);
875 }
876 return PyLong_FromDouble(wholepart);
Guido van Rossum1899c2e1992-09-12 11:09:23 +0000877}
878
Batuhan Taşkayacb8b9462019-12-16 01:00:28 +0300879/*[clinic input]
880float.__floor__
881
882Return the floor as an Integral.
883[clinic start generated code]*/
884
885static PyObject *
886float___floor___impl(PyObject *self)
887/*[clinic end generated code: output=e0551dbaea8c01d1 input=77bb13eb12e268df]*/
888{
889 double x = PyFloat_AS_DOUBLE(self);
890 return PyLong_FromDouble(floor(x));
891}
892
893/*[clinic input]
894float.__ceil__
895
896Return the ceiling as an Integral.
897[clinic start generated code]*/
898
899static PyObject *
900float___ceil___impl(PyObject *self)
901/*[clinic end generated code: output=a2fd8858f73736f9 input=79e41ae94aa0a516]*/
902{
903 double x = PyFloat_AS_DOUBLE(self);
904 return PyLong_FromDouble(ceil(x));
905}
906
Mark Dickinsone6a076d2009-04-18 11:48:33 +0000907/* double_round: rounds a finite double to the closest multiple of
908 10**-ndigits; here ndigits is within reasonable bounds (typically, -308 <=
909 ndigits <= 323). Returns a Python float, or sets a Python error and
910 returns NULL on failure (OverflowError and memory errors are possible). */
911
912#ifndef PY_NO_SHORT_FLOAT_REPR
913/* version of double_round that uses the correctly-rounded string<->double
914 conversions from Python/dtoa.c */
915
916static PyObject *
917double_round(double x, int ndigits) {
918
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000919 double rounded;
920 Py_ssize_t buflen, mybuflen=100;
921 char *buf, *buf_end, shortbuf[100], *mybuf=shortbuf;
922 int decpt, sign;
923 PyObject *result = NULL;
Mark Dickinson261896b2012-01-27 21:16:01 +0000924 _Py_SET_53BIT_PRECISION_HEADER;
Mark Dickinsone6a076d2009-04-18 11:48:33 +0000925
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000926 /* round to a decimal string */
Mark Dickinson261896b2012-01-27 21:16:01 +0000927 _Py_SET_53BIT_PRECISION_START;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000928 buf = _Py_dg_dtoa(x, 3, ndigits, &decpt, &sign, &buf_end);
Mark Dickinson261896b2012-01-27 21:16:01 +0000929 _Py_SET_53BIT_PRECISION_END;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000930 if (buf == NULL) {
931 PyErr_NoMemory();
932 return NULL;
933 }
Mark Dickinsone6a076d2009-04-18 11:48:33 +0000934
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000935 /* Get new buffer if shortbuf is too small. Space needed <= buf_end -
936 buf + 8: (1 extra for '0', 1 for sign, 5 for exp, 1 for '\0'). */
937 buflen = buf_end - buf;
938 if (buflen + 8 > mybuflen) {
939 mybuflen = buflen+8;
940 mybuf = (char *)PyMem_Malloc(mybuflen);
941 if (mybuf == NULL) {
942 PyErr_NoMemory();
943 goto exit;
944 }
945 }
946 /* copy buf to mybuf, adding exponent, sign and leading 0 */
947 PyOS_snprintf(mybuf, mybuflen, "%s0%se%d", (sign ? "-" : ""),
948 buf, decpt - (int)buflen);
Mark Dickinsone6a076d2009-04-18 11:48:33 +0000949
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000950 /* and convert the resulting string back to a double */
951 errno = 0;
Mark Dickinson261896b2012-01-27 21:16:01 +0000952 _Py_SET_53BIT_PRECISION_START;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000953 rounded = _Py_dg_strtod(mybuf, NULL);
Mark Dickinson261896b2012-01-27 21:16:01 +0000954 _Py_SET_53BIT_PRECISION_END;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000955 if (errno == ERANGE && fabs(rounded) >= 1.)
956 PyErr_SetString(PyExc_OverflowError,
957 "rounded value too large to represent");
958 else
959 result = PyFloat_FromDouble(rounded);
Mark Dickinsone6a076d2009-04-18 11:48:33 +0000960
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000961 /* done computing value; now clean up */
962 if (mybuf != shortbuf)
963 PyMem_Free(mybuf);
Mark Dickinsone6a076d2009-04-18 11:48:33 +0000964 exit:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000965 _Py_dg_freedtoa(buf);
966 return result;
Mark Dickinsone6a076d2009-04-18 11:48:33 +0000967}
968
969#else /* PY_NO_SHORT_FLOAT_REPR */
970
971/* fallback version, to be used when correctly rounded binary<->decimal
972 conversions aren't available */
973
974static PyObject *
975double_round(double x, int ndigits) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000976 double pow1, pow2, y, z;
977 if (ndigits >= 0) {
978 if (ndigits > 22) {
979 /* pow1 and pow2 are each safe from overflow, but
980 pow1*pow2 ~= pow(10.0, ndigits) might overflow */
981 pow1 = pow(10.0, (double)(ndigits-22));
982 pow2 = 1e22;
983 }
984 else {
985 pow1 = pow(10.0, (double)ndigits);
986 pow2 = 1.0;
987 }
988 y = (x*pow1)*pow2;
989 /* if y overflows, then rounded value is exactly x */
990 if (!Py_IS_FINITE(y))
991 return PyFloat_FromDouble(x);
992 }
993 else {
994 pow1 = pow(10.0, (double)-ndigits);
995 pow2 = 1.0; /* unused; silences a gcc compiler warning */
996 y = x / pow1;
997 }
Mark Dickinsone6a076d2009-04-18 11:48:33 +0000998
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000999 z = round(y);
1000 if (fabs(y-z) == 0.5)
1001 /* halfway between two integers; use round-half-even */
1002 z = 2.0*round(y/2.0);
Mark Dickinsone6a076d2009-04-18 11:48:33 +00001003
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001004 if (ndigits >= 0)
1005 z = (z / pow2) / pow1;
1006 else
1007 z *= pow1;
Mark Dickinsone6a076d2009-04-18 11:48:33 +00001008
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001009 /* if computation resulted in overflow, raise OverflowError */
1010 if (!Py_IS_FINITE(z)) {
1011 PyErr_SetString(PyExc_OverflowError,
1012 "overflow occurred during round");
1013 return NULL;
1014 }
Mark Dickinsone6a076d2009-04-18 11:48:33 +00001015
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001016 return PyFloat_FromDouble(z);
Mark Dickinsone6a076d2009-04-18 11:48:33 +00001017}
1018
1019#endif /* PY_NO_SHORT_FLOAT_REPR */
1020
1021/* round a Python float v to the closest multiple of 10**-ndigits */
1022
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001023/*[clinic input]
1024float.__round__
1025
Serhiy Storchaka279f4462019-09-14 12:24:05 +03001026 ndigits as o_ndigits: object = None
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001027 /
1028
1029Return the Integral closest to x, rounding half toward even.
1030
1031When an argument is passed, work like built-in round(x, ndigits).
1032[clinic start generated code]*/
1033
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001034static PyObject *
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001035float___round___impl(PyObject *self, PyObject *o_ndigits)
Serhiy Storchaka279f4462019-09-14 12:24:05 +03001036/*[clinic end generated code: output=374c36aaa0f13980 input=fc0fe25924fbc9ed]*/
Guido van Rossum2fa33db2007-08-23 22:07:24 +00001037{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001038 double x, rounded;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001039 Py_ssize_t ndigits;
Guido van Rossum2fa33db2007-08-23 22:07:24 +00001040
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001041 x = PyFloat_AsDouble(self);
Serhiy Storchaka279f4462019-09-14 12:24:05 +03001042 if (o_ndigits == Py_None) {
Steve Dowercb39d1f2015-04-15 16:10:59 -04001043 /* single-argument round or with None ndigits:
1044 * round to nearest integer */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001045 rounded = round(x);
1046 if (fabs(x-rounded) == 0.5)
1047 /* halfway case: round to even */
1048 rounded = 2.0*round(x/2.0);
1049 return PyLong_FromDouble(rounded);
1050 }
Guido van Rossum2fa33db2007-08-23 22:07:24 +00001051
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001052 /* interpret second argument as a Py_ssize_t; clips on overflow */
1053 ndigits = PyNumber_AsSsize_t(o_ndigits, NULL);
1054 if (ndigits == -1 && PyErr_Occurred())
1055 return NULL;
Guido van Rossum2fa33db2007-08-23 22:07:24 +00001056
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001057 /* nans and infinities round to themselves */
1058 if (!Py_IS_FINITE(x))
1059 return PyFloat_FromDouble(x);
Mark Dickinsone6a076d2009-04-18 11:48:33 +00001060
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001061 /* Deal with extreme values for ndigits. For ndigits > NDIGITS_MAX, x
1062 always rounds to itself. For ndigits < NDIGITS_MIN, x always
1063 rounds to +-0.0. Here 0.30103 is an upper bound for log10(2). */
Mark Dickinsone6a076d2009-04-18 11:48:33 +00001064#define NDIGITS_MAX ((int)((DBL_MANT_DIG-DBL_MIN_EXP) * 0.30103))
1065#define NDIGITS_MIN (-(int)((DBL_MAX_EXP + 1) * 0.30103))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001066 if (ndigits > NDIGITS_MAX)
1067 /* return x */
1068 return PyFloat_FromDouble(x);
1069 else if (ndigits < NDIGITS_MIN)
1070 /* return 0.0, but with sign of x */
1071 return PyFloat_FromDouble(0.0*x);
1072 else
1073 /* finite x, and ndigits is not unreasonably large */
1074 return double_round(x, (int)ndigits);
Mark Dickinsone6a076d2009-04-18 11:48:33 +00001075#undef NDIGITS_MAX
1076#undef NDIGITS_MIN
Guido van Rossum2fa33db2007-08-23 22:07:24 +00001077}
1078
1079static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001080float_float(PyObject *v)
Guido van Rossum1899c2e1992-09-12 11:09:23 +00001081{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001082 if (PyFloat_CheckExact(v))
1083 Py_INCREF(v);
1084 else
1085 v = PyFloat_FromDouble(((PyFloatObject *)v)->ob_fval);
1086 return v;
Guido van Rossum1899c2e1992-09-12 11:09:23 +00001087}
1088
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001089/*[clinic input]
1090float.conjugate
1091
1092Return self, the complex conjugate of any float.
1093[clinic start generated code]*/
1094
1095static PyObject *
1096float_conjugate_impl(PyObject *self)
1097/*[clinic end generated code: output=8ca292c2479194af input=82ba6f37a9ff91dd]*/
1098{
1099 return float_float(self);
1100}
1101
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001102/* turn ASCII hex characters into integer values and vice versa */
1103
1104static char
1105char_from_hex(int x)
1106{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001107 assert(0 <= x && x < 16);
Victor Stinnerf5cff562011-10-14 02:13:11 +02001108 return Py_hexdigits[x];
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001109}
1110
1111static int
1112hex_from_char(char c) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001113 int x;
1114 switch(c) {
1115 case '0':
1116 x = 0;
1117 break;
1118 case '1':
1119 x = 1;
1120 break;
1121 case '2':
1122 x = 2;
1123 break;
1124 case '3':
1125 x = 3;
1126 break;
1127 case '4':
1128 x = 4;
1129 break;
1130 case '5':
1131 x = 5;
1132 break;
1133 case '6':
1134 x = 6;
1135 break;
1136 case '7':
1137 x = 7;
1138 break;
1139 case '8':
1140 x = 8;
1141 break;
1142 case '9':
1143 x = 9;
1144 break;
1145 case 'a':
1146 case 'A':
1147 x = 10;
1148 break;
1149 case 'b':
1150 case 'B':
1151 x = 11;
1152 break;
1153 case 'c':
1154 case 'C':
1155 x = 12;
1156 break;
1157 case 'd':
1158 case 'D':
1159 x = 13;
1160 break;
1161 case 'e':
1162 case 'E':
1163 x = 14;
1164 break;
1165 case 'f':
1166 case 'F':
1167 x = 15;
1168 break;
1169 default:
1170 x = -1;
1171 break;
1172 }
1173 return x;
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001174}
1175
1176/* convert a float to a hexadecimal string */
1177
1178/* TOHEX_NBITS is DBL_MANT_DIG rounded up to the next integer
1179 of the form 4k+1. */
1180#define TOHEX_NBITS DBL_MANT_DIG + 3 - (DBL_MANT_DIG+2)%4
1181
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001182/*[clinic input]
1183float.hex
1184
1185Return a hexadecimal representation of a floating-point number.
1186
1187>>> (-0.1).hex()
1188'-0x1.999999999999ap-4'
1189>>> 3.14159.hex()
1190'0x1.921f9f01b866ep+1'
1191[clinic start generated code]*/
1192
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001193static PyObject *
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001194float_hex_impl(PyObject *self)
1195/*[clinic end generated code: output=0ebc9836e4d302d4 input=bec1271a33d47e67]*/
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001196{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001197 double x, m;
1198 int e, shift, i, si, esign;
1199 /* Space for 1+(TOHEX_NBITS-1)/4 digits, a decimal point, and the
1200 trailing NUL byte. */
1201 char s[(TOHEX_NBITS-1)/4+3];
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001202
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001203 CONVERT_TO_DOUBLE(self, x);
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001204
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001205 if (Py_IS_NAN(x) || Py_IS_INFINITY(x))
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001206 return float_repr((PyFloatObject *)self);
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001207
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001208 if (x == 0.0) {
Benjamin Peterson5d470832010-07-02 19:45:07 +00001209 if (copysign(1.0, x) == -1.0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001210 return PyUnicode_FromString("-0x0.0p+0");
1211 else
1212 return PyUnicode_FromString("0x0.0p+0");
1213 }
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001214
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001215 m = frexp(fabs(x), &e);
Victor Stinner640c35c2013-06-04 23:14:37 +02001216 shift = 1 - Py_MAX(DBL_MIN_EXP - e, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001217 m = ldexp(m, shift);
1218 e -= shift;
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001219
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001220 si = 0;
1221 s[si] = char_from_hex((int)m);
1222 si++;
1223 m -= (int)m;
1224 s[si] = '.';
1225 si++;
1226 for (i=0; i < (TOHEX_NBITS-1)/4; i++) {
1227 m *= 16.0;
1228 s[si] = char_from_hex((int)m);
1229 si++;
1230 m -= (int)m;
1231 }
1232 s[si] = '\0';
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001233
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001234 if (e < 0) {
1235 esign = (int)'-';
1236 e = -e;
1237 }
1238 else
1239 esign = (int)'+';
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001240
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001241 if (x < 0.0)
1242 return PyUnicode_FromFormat("-0x%sp%c%d", s, esign, e);
1243 else
1244 return PyUnicode_FromFormat("0x%sp%c%d", s, esign, e);
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001245}
1246
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001247/* Convert a hexadecimal string to a float. */
1248
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001249/*[clinic input]
1250@classmethod
1251float.fromhex
1252
1253 string: object
1254 /
1255
1256Create a floating-point number from a hexadecimal string.
1257
1258>>> float.fromhex('0x1.ffffp10')
12592047.984375
1260>>> float.fromhex('-0x1p-1074')
1261-5e-324
1262[clinic start generated code]*/
1263
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001264static PyObject *
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001265float_fromhex(PyTypeObject *type, PyObject *string)
1266/*[clinic end generated code: output=46c0274d22b78e82 input=0407bebd354bca89]*/
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001267{
Serhiy Storchaka25885d12016-05-12 10:21:14 +03001268 PyObject *result;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001269 double x;
1270 long exp, top_exp, lsb, key_digit;
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001271 const char *s, *coeff_start, *s_store, *coeff_end, *exp_start, *s_end;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001272 int half_eps, digit, round_up, negate=0;
1273 Py_ssize_t length, ndigits, fdigits, i;
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001274
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001275 /*
1276 * For the sake of simplicity and correctness, we impose an artificial
1277 * limit on ndigits, the total number of hex digits in the coefficient
1278 * The limit is chosen to ensure that, writing exp for the exponent,
1279 *
1280 * (1) if exp > LONG_MAX/2 then the value of the hex string is
1281 * guaranteed to overflow (provided it's nonzero)
1282 *
1283 * (2) if exp < LONG_MIN/2 then the value of the hex string is
1284 * guaranteed to underflow to 0.
1285 *
1286 * (3) if LONG_MIN/2 <= exp <= LONG_MAX/2 then there's no danger of
1287 * overflow in the calculation of exp and top_exp below.
1288 *
1289 * More specifically, ndigits is assumed to satisfy the following
1290 * inequalities:
1291 *
1292 * 4*ndigits <= DBL_MIN_EXP - DBL_MANT_DIG - LONG_MIN/2
1293 * 4*ndigits <= LONG_MAX/2 + 1 - DBL_MAX_EXP
1294 *
1295 * If either of these inequalities is not satisfied, a ValueError is
1296 * raised. Otherwise, write x for the value of the hex string, and
1297 * assume x is nonzero. Then
1298 *
1299 * 2**(exp-4*ndigits) <= |x| < 2**(exp+4*ndigits).
1300 *
1301 * Now if exp > LONG_MAX/2 then:
1302 *
1303 * exp - 4*ndigits >= LONG_MAX/2 + 1 - (LONG_MAX/2 + 1 - DBL_MAX_EXP)
1304 * = DBL_MAX_EXP
1305 *
1306 * so |x| >= 2**DBL_MAX_EXP, which is too large to be stored in C
1307 * double, so overflows. If exp < LONG_MIN/2, then
1308 *
1309 * exp + 4*ndigits <= LONG_MIN/2 - 1 + (
1310 * DBL_MIN_EXP - DBL_MANT_DIG - LONG_MIN/2)
1311 * = DBL_MIN_EXP - DBL_MANT_DIG - 1
1312 *
1313 * and so |x| < 2**(DBL_MIN_EXP-DBL_MANT_DIG-1), hence underflows to 0
1314 * when converted to a C double.
1315 *
1316 * It's easy to show that if LONG_MIN/2 <= exp <= LONG_MAX/2 then both
1317 * exp+4*ndigits and exp-4*ndigits are within the range of a long.
1318 */
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001319
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001320 s = PyUnicode_AsUTF8AndSize(string, &length);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001321 if (s == NULL)
1322 return NULL;
1323 s_end = s + length;
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001324
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001325 /********************
1326 * Parse the string *
1327 ********************/
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001328
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001329 /* leading whitespace */
1330 while (Py_ISSPACE(*s))
1331 s++;
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001332
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001333 /* infinities and nans */
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001334 x = _Py_parse_inf_or_nan(s, (char **)&coeff_end);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001335 if (coeff_end != s) {
1336 s = coeff_end;
1337 goto finished;
1338 }
Mark Dickinsonbd16edd2009-05-20 22:05:25 +00001339
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001340 /* optional sign */
1341 if (*s == '-') {
1342 s++;
1343 negate = 1;
1344 }
1345 else if (*s == '+')
1346 s++;
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001347
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001348 /* [0x] */
1349 s_store = s;
1350 if (*s == '0') {
1351 s++;
1352 if (*s == 'x' || *s == 'X')
1353 s++;
1354 else
1355 s = s_store;
1356 }
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001357
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001358 /* coefficient: <integer> [. <fraction>] */
1359 coeff_start = s;
1360 while (hex_from_char(*s) >= 0)
1361 s++;
1362 s_store = s;
1363 if (*s == '.') {
1364 s++;
1365 while (hex_from_char(*s) >= 0)
1366 s++;
1367 coeff_end = s-1;
1368 }
1369 else
1370 coeff_end = s;
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001371
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001372 /* ndigits = total # of hex digits; fdigits = # after point */
1373 ndigits = coeff_end - coeff_start;
1374 fdigits = coeff_end - s_store;
1375 if (ndigits == 0)
1376 goto parse_error;
Victor Stinner640c35c2013-06-04 23:14:37 +02001377 if (ndigits > Py_MIN(DBL_MIN_EXP - DBL_MANT_DIG - LONG_MIN/2,
1378 LONG_MAX/2 + 1 - DBL_MAX_EXP)/4)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001379 goto insane_length_error;
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001380
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001381 /* [p <exponent>] */
1382 if (*s == 'p' || *s == 'P') {
1383 s++;
1384 exp_start = s;
1385 if (*s == '-' || *s == '+')
1386 s++;
1387 if (!('0' <= *s && *s <= '9'))
1388 goto parse_error;
1389 s++;
1390 while ('0' <= *s && *s <= '9')
1391 s++;
1392 exp = strtol(exp_start, NULL, 10);
1393 }
1394 else
1395 exp = 0;
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001396
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001397/* for 0 <= j < ndigits, HEX_DIGIT(j) gives the jth most significant digit */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001398#define HEX_DIGIT(j) hex_from_char(*((j) < fdigits ? \
1399 coeff_end-(j) : \
1400 coeff_end-1-(j)))
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001401
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001402 /*******************************************
1403 * Compute rounded value of the hex string *
1404 *******************************************/
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001405
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001406 /* Discard leading zeros, and catch extreme overflow and underflow */
1407 while (ndigits > 0 && HEX_DIGIT(ndigits-1) == 0)
1408 ndigits--;
1409 if (ndigits == 0 || exp < LONG_MIN/2) {
1410 x = 0.0;
1411 goto finished;
1412 }
1413 if (exp > LONG_MAX/2)
1414 goto overflow_error;
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001415
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001416 /* Adjust exponent for fractional part. */
1417 exp = exp - 4*((long)fdigits);
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001418
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001419 /* top_exp = 1 more than exponent of most sig. bit of coefficient */
1420 top_exp = exp + 4*((long)ndigits - 1);
1421 for (digit = HEX_DIGIT(ndigits-1); digit != 0; digit /= 2)
1422 top_exp++;
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001423
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001424 /* catch almost all nonextreme cases of overflow and underflow here */
1425 if (top_exp < DBL_MIN_EXP - DBL_MANT_DIG) {
1426 x = 0.0;
1427 goto finished;
1428 }
1429 if (top_exp > DBL_MAX_EXP)
1430 goto overflow_error;
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001431
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001432 /* lsb = exponent of least significant bit of the *rounded* value.
1433 This is top_exp - DBL_MANT_DIG unless result is subnormal. */
Victor Stinner640c35c2013-06-04 23:14:37 +02001434 lsb = Py_MAX(top_exp, (long)DBL_MIN_EXP) - DBL_MANT_DIG;
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001435
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001436 x = 0.0;
1437 if (exp >= lsb) {
1438 /* no rounding required */
1439 for (i = ndigits-1; i >= 0; i--)
1440 x = 16.0*x + HEX_DIGIT(i);
1441 x = ldexp(x, (int)(exp));
1442 goto finished;
1443 }
1444 /* rounding required. key_digit is the index of the hex digit
1445 containing the first bit to be rounded away. */
1446 half_eps = 1 << (int)((lsb - exp - 1) % 4);
1447 key_digit = (lsb - exp - 1) / 4;
1448 for (i = ndigits-1; i > key_digit; i--)
1449 x = 16.0*x + HEX_DIGIT(i);
1450 digit = HEX_DIGIT(key_digit);
1451 x = 16.0*x + (double)(digit & (16-2*half_eps));
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001452
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001453 /* round-half-even: round up if bit lsb-1 is 1 and at least one of
1454 bits lsb, lsb-2, lsb-3, lsb-4, ... is 1. */
1455 if ((digit & half_eps) != 0) {
1456 round_up = 0;
1457 if ((digit & (3*half_eps-1)) != 0 ||
1458 (half_eps == 8 && (HEX_DIGIT(key_digit+1) & 1) != 0))
1459 round_up = 1;
1460 else
1461 for (i = key_digit-1; i >= 0; i--)
1462 if (HEX_DIGIT(i) != 0) {
1463 round_up = 1;
1464 break;
1465 }
Mark Dickinson21a1f732010-07-06 15:11:44 +00001466 if (round_up) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001467 x += 2*half_eps;
1468 if (top_exp == DBL_MAX_EXP &&
1469 x == ldexp((double)(2*half_eps), DBL_MANT_DIG))
1470 /* overflow corner case: pre-rounded value <
1471 2**DBL_MAX_EXP; rounded=2**DBL_MAX_EXP. */
1472 goto overflow_error;
1473 }
1474 }
1475 x = ldexp(x, (int)(exp+4*key_digit));
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001476
1477 finished:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001478 /* optional trailing whitespace leading to the end of the string */
1479 while (Py_ISSPACE(*s))
1480 s++;
1481 if (s != s_end)
1482 goto parse_error;
Serhiy Storchaka25885d12016-05-12 10:21:14 +03001483 result = PyFloat_FromDouble(negate ? -x : x);
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001484 if (type != &PyFloat_Type && result != NULL) {
Jeroen Demeyer196a5302019-07-04 12:31:34 +02001485 Py_SETREF(result, _PyObject_CallOneArg((PyObject *)type, result));
Serhiy Storchaka25885d12016-05-12 10:21:14 +03001486 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001487 return result;
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001488
1489 overflow_error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001490 PyErr_SetString(PyExc_OverflowError,
1491 "hexadecimal value too large to represent as a float");
1492 return NULL;
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001493
1494 parse_error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001495 PyErr_SetString(PyExc_ValueError,
1496 "invalid hexadecimal floating-point string");
1497 return NULL;
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001498
1499 insane_length_error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001500 PyErr_SetString(PyExc_ValueError,
1501 "hexadecimal string too long to convert");
1502 return NULL;
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001503}
1504
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001505/*[clinic input]
1506float.as_integer_ratio
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001507
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001508Return integer ratio.
1509
1510Return a pair of integers, whose ratio is exactly equal to the original float
1511and with a positive denominator.
1512
1513Raise OverflowError on infinities and a ValueError on NaNs.
1514
1515>>> (10.0).as_integer_ratio()
1516(10, 1)
1517>>> (0.0).as_integer_ratio()
1518(0, 1)
1519>>> (-.25).as_integer_ratio()
1520(-1, 4)
1521[clinic start generated code]*/
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001522
Christian Heimes26855632008-01-27 23:50:43 +00001523static PyObject *
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001524float_as_integer_ratio_impl(PyObject *self)
1525/*[clinic end generated code: output=65f25f0d8d30a712 input=e21d08b4630c2e44]*/
Christian Heimes26855632008-01-27 23:50:43 +00001526{
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001527 double self_double;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001528 double float_part;
1529 int exponent;
1530 int i;
Christian Heimes292d3512008-02-03 16:51:08 +00001531
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001532 PyObject *py_exponent = NULL;
1533 PyObject *numerator = NULL;
1534 PyObject *denominator = NULL;
1535 PyObject *result_pair = NULL;
1536 PyNumberMethods *long_methods = PyLong_Type.tp_as_number;
Christian Heimes26855632008-01-27 23:50:43 +00001537
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001538 CONVERT_TO_DOUBLE(self, self_double);
Christian Heimes26855632008-01-27 23:50:43 +00001539
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001540 if (Py_IS_INFINITY(self_double)) {
Serhiy Storchaka0d250bc2015-12-29 22:34:23 +02001541 PyErr_SetString(PyExc_OverflowError,
1542 "cannot convert Infinity to integer ratio");
1543 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001544 }
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001545 if (Py_IS_NAN(self_double)) {
Serhiy Storchaka0d250bc2015-12-29 22:34:23 +02001546 PyErr_SetString(PyExc_ValueError,
1547 "cannot convert NaN to integer ratio");
1548 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001549 }
Christian Heimes26855632008-01-27 23:50:43 +00001550
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001551 float_part = frexp(self_double, &exponent); /* self_double == float_part * 2**exponent exactly */
Christian Heimes26855632008-01-27 23:50:43 +00001552
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001553 for (i=0; i<300 && float_part != floor(float_part) ; i++) {
1554 float_part *= 2.0;
1555 exponent--;
1556 }
1557 /* self == float_part * 2**exponent exactly and float_part is integral.
1558 If FLT_RADIX != 2, the 300 steps may leave a tiny fractional part
1559 to be truncated by PyLong_FromDouble(). */
Christian Heimes26855632008-01-27 23:50:43 +00001560
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001561 numerator = PyLong_FromDouble(float_part);
Serhiy Storchaka4e6aad12015-12-29 22:55:48 +02001562 if (numerator == NULL)
1563 goto error;
1564 denominator = PyLong_FromLong(1);
1565 if (denominator == NULL)
1566 goto error;
1567 py_exponent = PyLong_FromLong(Py_ABS(exponent));
1568 if (py_exponent == NULL)
1569 goto error;
Christian Heimes26855632008-01-27 23:50:43 +00001570
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001571 /* fold in 2**exponent */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001572 if (exponent > 0) {
Serhiy Storchaka59865e72016-04-11 09:57:37 +03001573 Py_SETREF(numerator,
Serhiy Storchaka4e6aad12015-12-29 22:55:48 +02001574 long_methods->nb_lshift(numerator, py_exponent));
1575 if (numerator == NULL)
1576 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001577 }
1578 else {
Serhiy Storchaka59865e72016-04-11 09:57:37 +03001579 Py_SETREF(denominator,
Serhiy Storchaka4e6aad12015-12-29 22:55:48 +02001580 long_methods->nb_lshift(denominator, py_exponent));
1581 if (denominator == NULL)
1582 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001583 }
1584
1585 result_pair = PyTuple_Pack(2, numerator, denominator);
Christian Heimes26855632008-01-27 23:50:43 +00001586
Christian Heimes26855632008-01-27 23:50:43 +00001587error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001588 Py_XDECREF(py_exponent);
1589 Py_XDECREF(denominator);
1590 Py_XDECREF(numerator);
1591 return result_pair;
Christian Heimes26855632008-01-27 23:50:43 +00001592}
1593
Jeremy Hylton938ace62002-07-17 16:30:39 +00001594static PyObject *
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02001595float_subtype_new(PyTypeObject *type, PyObject *x);
1596
1597/*[clinic input]
1598@classmethod
1599float.__new__ as float_new
Serhiy Storchakaba85d692017-03-30 09:09:41 +03001600 x: object(c_default="_PyLong_Zero") = 0
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02001601 /
1602
1603Convert a string or number to a floating point number, if possible.
1604[clinic start generated code]*/
Guido van Rossumbef14172001-08-29 15:47:46 +00001605
Tim Peters6d6c1a32001-08-02 04:15:00 +00001606static PyObject *
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02001607float_new_impl(PyTypeObject *type, PyObject *x)
Serhiy Storchakabae68812017-04-05 12:00:42 +03001608/*[clinic end generated code: output=ccf1e8dc460ba6ba input=540ee77c204ff87a]*/
Tim Peters6d6c1a32001-08-02 04:15:00 +00001609{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001610 if (type != &PyFloat_Type)
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02001611 return float_subtype_new(type, x); /* Wimp out */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001612 /* If it's a string, but not a string subclass, use
1613 PyFloat_FromString. */
1614 if (PyUnicode_CheckExact(x))
1615 return PyFloat_FromString(x);
1616 return PyNumber_Float(x);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001617}
1618
Guido van Rossumbef14172001-08-29 15:47:46 +00001619/* Wimpy, slow approach to tp_new calls for subtypes of float:
1620 first create a regular float from whatever arguments we got,
1621 then allocate a subtype instance and initialize its ob_fval
1622 from the regular float. The regular float is then thrown away.
1623*/
1624static PyObject *
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02001625float_subtype_new(PyTypeObject *type, PyObject *x)
Guido van Rossumbef14172001-08-29 15:47:46 +00001626{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001627 PyObject *tmp, *newobj;
Guido van Rossumbef14172001-08-29 15:47:46 +00001628
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001629 assert(PyType_IsSubtype(type, &PyFloat_Type));
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02001630 tmp = float_new_impl(&PyFloat_Type, x);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001631 if (tmp == NULL)
1632 return NULL;
Serhiy Storchaka15095802015-11-25 15:47:01 +02001633 assert(PyFloat_Check(tmp));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001634 newobj = type->tp_alloc(type, 0);
1635 if (newobj == NULL) {
1636 Py_DECREF(tmp);
1637 return NULL;
1638 }
1639 ((PyFloatObject *)newobj)->ob_fval = ((PyFloatObject *)tmp)->ob_fval;
1640 Py_DECREF(tmp);
1641 return newobj;
Guido van Rossumbef14172001-08-29 15:47:46 +00001642}
1643
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001644/*[clinic input]
1645float.__getnewargs__
1646[clinic start generated code]*/
1647
Guido van Rossum5d9113d2003-01-29 17:58:45 +00001648static PyObject *
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001649float___getnewargs___impl(PyObject *self)
1650/*[clinic end generated code: output=873258c9d206b088 input=002279d1d77891e6]*/
Guido van Rossum5d9113d2003-01-29 17:58:45 +00001651{
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001652 return Py_BuildValue("(d)", ((PyFloatObject *)self)->ob_fval);
Guido van Rossum5d9113d2003-01-29 17:58:45 +00001653}
1654
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001655/* this is for the benefit of the pack/unpack routines below */
1656
1657typedef enum {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001658 unknown_format, ieee_big_endian_format, ieee_little_endian_format
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001659} float_format_type;
1660
1661static float_format_type double_format, float_format;
1662static float_format_type detected_double_format, detected_float_format;
1663
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001664/*[clinic input]
1665@classmethod
1666float.__getformat__
1667
1668 typestr: str
1669 Must be 'double' or 'float'.
1670 /
1671
1672You probably don't want to use this function.
1673
1674It exists mainly to be used in Python's test suite.
1675
1676This function returns whichever of 'unknown', 'IEEE, big-endian' or 'IEEE,
1677little-endian' best describes the format of floating point numbers used by the
1678C type named by typestr.
1679[clinic start generated code]*/
1680
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001681static PyObject *
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001682float___getformat___impl(PyTypeObject *type, const char *typestr)
1683/*[clinic end generated code: output=2bfb987228cc9628 input=d5a52600f835ad67]*/
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001684{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001685 float_format_type r;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001686
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001687 if (strcmp(typestr, "double") == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001688 r = double_format;
1689 }
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001690 else if (strcmp(typestr, "float") == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001691 r = float_format;
1692 }
1693 else {
1694 PyErr_SetString(PyExc_ValueError,
1695 "__getformat__() argument 1 must be "
1696 "'double' or 'float'");
1697 return NULL;
1698 }
1699
1700 switch (r) {
1701 case unknown_format:
1702 return PyUnicode_FromString("unknown");
1703 case ieee_little_endian_format:
1704 return PyUnicode_FromString("IEEE, little-endian");
1705 case ieee_big_endian_format:
1706 return PyUnicode_FromString("IEEE, big-endian");
1707 default:
Victor Stinner04394df2019-11-18 17:39:48 +01001708 PyErr_SetString(PyExc_RuntimeError,
1709 "insane float_format or double_format");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001710 return NULL;
1711 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001712}
1713
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001714/*[clinic input]
1715@classmethod
1716float.__set_format__
1717
1718 typestr: str
1719 Must be 'double' or 'float'.
1720 fmt: str
1721 Must be one of 'unknown', 'IEEE, big-endian' or 'IEEE, little-endian',
1722 and in addition can only be one of the latter two if it appears to
1723 match the underlying C reality.
1724 /
1725
1726You probably don't want to use this function.
1727
1728It exists mainly to be used in Python's test suite.
1729
1730Override the automatic determination of C-level floating point type.
1731This affects how floats are converted to and from binary strings.
1732[clinic start generated code]*/
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001733
1734static PyObject *
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001735float___set_format___impl(PyTypeObject *type, const char *typestr,
1736 const char *fmt)
1737/*[clinic end generated code: output=504460f5dc85acbd input=5306fa2b81a997e4]*/
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001738{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001739 float_format_type f;
1740 float_format_type detected;
1741 float_format_type *p;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001742
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001743 if (strcmp(typestr, "double") == 0) {
1744 p = &double_format;
1745 detected = detected_double_format;
1746 }
1747 else if (strcmp(typestr, "float") == 0) {
1748 p = &float_format;
1749 detected = detected_float_format;
1750 }
1751 else {
1752 PyErr_SetString(PyExc_ValueError,
1753 "__setformat__() argument 1 must "
1754 "be 'double' or 'float'");
1755 return NULL;
1756 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001757
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001758 if (strcmp(fmt, "unknown") == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001759 f = unknown_format;
1760 }
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001761 else if (strcmp(fmt, "IEEE, little-endian") == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001762 f = ieee_little_endian_format;
1763 }
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001764 else if (strcmp(fmt, "IEEE, big-endian") == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001765 f = ieee_big_endian_format;
1766 }
1767 else {
1768 PyErr_SetString(PyExc_ValueError,
1769 "__setformat__() argument 2 must be "
1770 "'unknown', 'IEEE, little-endian' or "
1771 "'IEEE, big-endian'");
1772 return NULL;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001773
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001774 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001775
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001776 if (f != unknown_format && f != detected) {
1777 PyErr_Format(PyExc_ValueError,
1778 "can only set %s format to 'unknown' or the "
1779 "detected platform value", typestr);
1780 return NULL;
1781 }
1782
1783 *p = f;
1784 Py_RETURN_NONE;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001785}
1786
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001787static PyObject *
1788float_getreal(PyObject *v, void *closure)
1789{
1790 return float_float(v);
1791}
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001792
Guido van Rossumb43daf72007-08-01 18:08:08 +00001793static PyObject *
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001794float_getimag(PyObject *v, void *closure)
Guido van Rossumb43daf72007-08-01 18:08:08 +00001795{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001796 return PyFloat_FromDouble(0.0);
Guido van Rossumb43daf72007-08-01 18:08:08 +00001797}
1798
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001799/*[clinic input]
1800float.__format__
1801
1802 format_spec: unicode
1803 /
1804
1805Formats the float according to format_spec.
1806[clinic start generated code]*/
1807
Eric Smith8c663262007-08-25 02:26:07 +00001808static PyObject *
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001809float___format___impl(PyObject *self, PyObject *format_spec)
1810/*[clinic end generated code: output=b260e52a47eade56 input=2ece1052211fd0e6]*/
Eric Smith8c663262007-08-25 02:26:07 +00001811{
Victor Stinnerd3f08822012-05-29 12:57:52 +02001812 _PyUnicodeWriter writer;
1813 int ret;
Eric Smith4a7d76d2008-05-30 18:10:19 +00001814
Victor Stinner8f674cc2013-04-17 23:02:17 +02001815 _PyUnicodeWriter_Init(&writer);
Victor Stinnerd3f08822012-05-29 12:57:52 +02001816 ret = _PyFloat_FormatAdvancedWriter(
1817 &writer,
1818 self,
1819 format_spec, 0, PyUnicode_GET_LENGTH(format_spec));
1820 if (ret == -1) {
1821 _PyUnicodeWriter_Dealloc(&writer);
1822 return NULL;
1823 }
1824 return _PyUnicodeWriter_Finish(&writer);
Eric Smith8c663262007-08-25 02:26:07 +00001825}
1826
Guido van Rossum5d9113d2003-01-29 17:58:45 +00001827static PyMethodDef float_methods[] = {
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001828 FLOAT_CONJUGATE_METHODDEF
1829 FLOAT___TRUNC___METHODDEF
Batuhan Taşkayacb8b9462019-12-16 01:00:28 +03001830 FLOAT___FLOOR___METHODDEF
1831 FLOAT___CEIL___METHODDEF
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001832 FLOAT___ROUND___METHODDEF
1833 FLOAT_AS_INTEGER_RATIO_METHODDEF
1834 FLOAT_FROMHEX_METHODDEF
1835 FLOAT_HEX_METHODDEF
1836 FLOAT_IS_INTEGER_METHODDEF
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001837 FLOAT___GETNEWARGS___METHODDEF
1838 FLOAT___GETFORMAT___METHODDEF
1839 FLOAT___SET_FORMAT___METHODDEF
1840 FLOAT___FORMAT___METHODDEF
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001841 {NULL, NULL} /* sentinel */
Guido van Rossum5d9113d2003-01-29 17:58:45 +00001842};
1843
Guido van Rossumb43daf72007-08-01 18:08:08 +00001844static PyGetSetDef float_getset[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001845 {"real",
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001846 float_getreal, (setter)NULL,
Guido van Rossumb43daf72007-08-01 18:08:08 +00001847 "the real part of a complex number",
1848 NULL},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001849 {"imag",
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001850 float_getimag, (setter)NULL,
Guido van Rossumb43daf72007-08-01 18:08:08 +00001851 "the imaginary part of a complex number",
1852 NULL},
1853 {NULL} /* Sentinel */
1854};
1855
Tim Peters6d6c1a32001-08-02 04:15:00 +00001856
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001857static PyNumberMethods float_as_number = {
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001858 float_add, /* nb_add */
1859 float_sub, /* nb_subtract */
1860 float_mul, /* nb_multiply */
1861 float_rem, /* nb_remainder */
1862 float_divmod, /* nb_divmod */
1863 float_pow, /* nb_power */
1864 (unaryfunc)float_neg, /* nb_negative */
1865 float_float, /* nb_positive */
1866 (unaryfunc)float_abs, /* nb_absolute */
1867 (inquiry)float_bool, /* nb_bool */
1868 0, /* nb_invert */
1869 0, /* nb_lshift */
1870 0, /* nb_rshift */
1871 0, /* nb_and */
1872 0, /* nb_xor */
1873 0, /* nb_or */
1874 float___trunc___impl, /* nb_int */
1875 0, /* nb_reserved */
1876 float_float, /* nb_float */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001877 0, /* nb_inplace_add */
1878 0, /* nb_inplace_subtract */
1879 0, /* nb_inplace_multiply */
1880 0, /* nb_inplace_remainder */
1881 0, /* nb_inplace_power */
1882 0, /* nb_inplace_lshift */
1883 0, /* nb_inplace_rshift */
1884 0, /* nb_inplace_and */
1885 0, /* nb_inplace_xor */
1886 0, /* nb_inplace_or */
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001887 float_floor_div, /* nb_floor_divide */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001888 float_div, /* nb_true_divide */
1889 0, /* nb_inplace_floor_divide */
1890 0, /* nb_inplace_true_divide */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001891};
1892
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001893PyTypeObject PyFloat_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001894 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1895 "float",
1896 sizeof(PyFloatObject),
1897 0,
1898 (destructor)float_dealloc, /* tp_dealloc */
Jeroen Demeyer530f5062019-05-31 04:13:39 +02001899 0, /* tp_vectorcall_offset */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001900 0, /* tp_getattr */
1901 0, /* tp_setattr */
Jeroen Demeyer530f5062019-05-31 04:13:39 +02001902 0, /* tp_as_async */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001903 (reprfunc)float_repr, /* tp_repr */
1904 &float_as_number, /* tp_as_number */
1905 0, /* tp_as_sequence */
1906 0, /* tp_as_mapping */
1907 (hashfunc)float_hash, /* tp_hash */
1908 0, /* tp_call */
Serhiy Storchaka96aeaec2019-05-06 22:29:40 +03001909 0, /* tp_str */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001910 PyObject_GenericGetAttr, /* tp_getattro */
1911 0, /* tp_setattro */
1912 0, /* tp_as_buffer */
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001913 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02001914 float_new__doc__, /* tp_doc */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001915 0, /* tp_traverse */
1916 0, /* tp_clear */
1917 float_richcompare, /* tp_richcompare */
1918 0, /* tp_weaklistoffset */
1919 0, /* tp_iter */
1920 0, /* tp_iternext */
1921 float_methods, /* tp_methods */
1922 0, /* tp_members */
1923 float_getset, /* tp_getset */
1924 0, /* tp_base */
1925 0, /* tp_dict */
1926 0, /* tp_descr_get */
1927 0, /* tp_descr_set */
1928 0, /* tp_dictoffset */
1929 0, /* tp_init */
1930 0, /* tp_alloc */
1931 float_new, /* tp_new */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001932};
Guido van Rossumfbbd57e1997-08-05 02:16:08 +00001933
Victor Stinner1c8f0592013-07-22 22:24:54 +02001934int
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001935_PyFloat_Init(void)
1936{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001937 /* We attempt to determine if this machine is using IEEE
1938 floating point formats by peering at the bits of some
1939 carefully chosen values. If it looks like we are on an
1940 IEEE platform, the float packing/unpacking routines can
1941 just copy bits, if not they resort to arithmetic & shifts
1942 and masks. The shifts & masks approach works on all finite
1943 values, but what happens to infinities, NaNs and signed
1944 zeroes on packing is an accident, and attempting to unpack
1945 a NaN or an infinity will raise an exception.
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001946
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001947 Note that if we're on some whacked-out platform which uses
1948 IEEE formats but isn't strictly little-endian or big-
1949 endian, we will fall back to the portable shifts & masks
1950 method. */
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001951
1952#if SIZEOF_DOUBLE == 8
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001953 {
1954 double x = 9006104071832581.0;
1955 if (memcmp(&x, "\x43\x3f\xff\x01\x02\x03\x04\x05", 8) == 0)
1956 detected_double_format = ieee_big_endian_format;
1957 else if (memcmp(&x, "\x05\x04\x03\x02\x01\xff\x3f\x43", 8) == 0)
1958 detected_double_format = ieee_little_endian_format;
1959 else
1960 detected_double_format = unknown_format;
1961 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001962#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001963 detected_double_format = unknown_format;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001964#endif
1965
1966#if SIZEOF_FLOAT == 4
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001967 {
1968 float y = 16711938.0;
1969 if (memcmp(&y, "\x4b\x7f\x01\x02", 4) == 0)
1970 detected_float_format = ieee_big_endian_format;
1971 else if (memcmp(&y, "\x02\x01\x7f\x4b", 4) == 0)
1972 detected_float_format = ieee_little_endian_format;
1973 else
1974 detected_float_format = unknown_format;
1975 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001976#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001977 detected_float_format = unknown_format;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001978#endif
1979
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001980 double_format = detected_double_format;
1981 float_format = detected_float_format;
Christian Heimesb76922a2007-12-11 01:06:40 +00001982
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001983 /* Init float info */
Victor Stinner1c8f0592013-07-22 22:24:54 +02001984 if (FloatInfoType.tp_name == NULL) {
Victor Stinner6d43f6f2019-01-22 21:18:05 +01001985 if (PyStructSequence_InitType2(&FloatInfoType, &floatinfo_desc) < 0) {
Victor Stinner1c8f0592013-07-22 22:24:54 +02001986 return 0;
Victor Stinner6d43f6f2019-01-22 21:18:05 +01001987 }
Victor Stinner1c8f0592013-07-22 22:24:54 +02001988 }
1989 return 1;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001990}
1991
Georg Brandl2ee470f2008-07-16 12:55:28 +00001992int
1993PyFloat_ClearFreeList(void)
Guido van Rossumfbbd57e1997-08-05 02:16:08 +00001994{
Kristján Valur Jónssondaa06542012-03-30 09:18:15 +00001995 PyFloatObject *f = free_list, *next;
1996 int i = numfree;
1997 while (f) {
1998 next = (PyFloatObject*) Py_TYPE(f);
1999 PyObject_FREE(f);
2000 f = next;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002001 }
Kristján Valur Jónssondaa06542012-03-30 09:18:15 +00002002 free_list = NULL;
2003 numfree = 0;
2004 return i;
Christian Heimes15ebc882008-02-04 18:48:49 +00002005}
2006
2007void
Victor Stinnerbed48172019-08-27 00:12:32 +02002008_PyFloat_Fini(void)
Christian Heimes15ebc882008-02-04 18:48:49 +00002009{
Kristján Valur Jónssondaa06542012-03-30 09:18:15 +00002010 (void)PyFloat_ClearFreeList();
Guido van Rossumfbbd57e1997-08-05 02:16:08 +00002011}
Tim Peters9905b942003-03-20 20:53:32 +00002012
David Malcolm49526f42012-06-22 14:55:41 -04002013/* Print summary info about the state of the optimized allocator */
2014void
2015_PyFloat_DebugMallocStats(FILE *out)
2016{
2017 _PyDebugAllocatorStats(out,
2018 "free PyFloatObject",
2019 numfree, sizeof(PyFloatObject));
2020}
2021
2022
Tim Peters9905b942003-03-20 20:53:32 +00002023/*----------------------------------------------------------------------------
Mark Dickinson7c4e4092016-09-03 17:21:29 +01002024 * _PyFloat_{Pack,Unpack}{2,4,8}. See floatobject.h.
2025 * To match the NPY_HALF_ROUND_TIES_TO_EVEN behavior in:
2026 * https://github.com/numpy/numpy/blob/master/numpy/core/src/npymath/halffloat.c
2027 * We use:
2028 * bits = (unsigned short)f; Note the truncation
2029 * if ((f - bits > 0.5) || (f - bits == 0.5 && bits % 2)) {
2030 * bits++;
2031 * }
Tim Peters9905b942003-03-20 20:53:32 +00002032 */
Mark Dickinson7c4e4092016-09-03 17:21:29 +01002033
2034int
2035_PyFloat_Pack2(double x, unsigned char *p, int le)
2036{
2037 unsigned char sign;
2038 int e;
2039 double f;
2040 unsigned short bits;
2041 int incr = 1;
2042
2043 if (x == 0.0) {
2044 sign = (copysign(1.0, x) == -1.0);
2045 e = 0;
2046 bits = 0;
2047 }
2048 else if (Py_IS_INFINITY(x)) {
2049 sign = (x < 0.0);
2050 e = 0x1f;
2051 bits = 0;
2052 }
2053 else if (Py_IS_NAN(x)) {
2054 /* There are 2046 distinct half-precision NaNs (1022 signaling and
2055 1024 quiet), but there are only two quiet NaNs that don't arise by
2056 quieting a signaling NaN; we get those by setting the topmost bit
2057 of the fraction field and clearing all other fraction bits. We
2058 choose the one with the appropriate sign. */
2059 sign = (copysign(1.0, x) == -1.0);
2060 e = 0x1f;
2061 bits = 512;
2062 }
2063 else {
2064 sign = (x < 0.0);
2065 if (sign) {
2066 x = -x;
2067 }
2068
2069 f = frexp(x, &e);
2070 if (f < 0.5 || f >= 1.0) {
2071 PyErr_SetString(PyExc_SystemError,
2072 "frexp() result out of range");
2073 return -1;
2074 }
2075
2076 /* Normalize f to be in the range [1.0, 2.0) */
2077 f *= 2.0;
2078 e--;
2079
2080 if (e >= 16) {
2081 goto Overflow;
2082 }
2083 else if (e < -25) {
2084 /* |x| < 2**-25. Underflow to zero. */
2085 f = 0.0;
2086 e = 0;
2087 }
2088 else if (e < -14) {
2089 /* |x| < 2**-14. Gradual underflow */
2090 f = ldexp(f, 14 + e);
2091 e = 0;
2092 }
2093 else /* if (!(e == 0 && f == 0.0)) */ {
2094 e += 15;
2095 f -= 1.0; /* Get rid of leading 1 */
2096 }
2097
2098 f *= 1024.0; /* 2**10 */
2099 /* Round to even */
2100 bits = (unsigned short)f; /* Note the truncation */
2101 assert(bits < 1024);
2102 assert(e < 31);
2103 if ((f - bits > 0.5) || ((f - bits == 0.5) && (bits % 2 == 1))) {
2104 ++bits;
2105 if (bits == 1024) {
2106 /* The carry propagated out of a string of 10 1 bits. */
2107 bits = 0;
2108 ++e;
2109 if (e == 31)
2110 goto Overflow;
2111 }
2112 }
2113 }
2114
2115 bits |= (e << 10) | (sign << 15);
2116
2117 /* Write out result. */
2118 if (le) {
2119 p += 1;
2120 incr = -1;
2121 }
2122
2123 /* First byte */
2124 *p = (unsigned char)((bits >> 8) & 0xFF);
2125 p += incr;
2126
2127 /* Second byte */
2128 *p = (unsigned char)(bits & 0xFF);
2129
2130 return 0;
2131
2132 Overflow:
2133 PyErr_SetString(PyExc_OverflowError,
2134 "float too large to pack with e format");
2135 return -1;
2136}
2137
Tim Peters9905b942003-03-20 20:53:32 +00002138int
2139_PyFloat_Pack4(double x, unsigned char *p, int le)
2140{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002141 if (float_format == unknown_format) {
2142 unsigned char sign;
2143 int e;
2144 double f;
2145 unsigned int fbits;
2146 int incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00002147
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002148 if (le) {
2149 p += 3;
2150 incr = -1;
2151 }
Tim Peters9905b942003-03-20 20:53:32 +00002152
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002153 if (x < 0) {
2154 sign = 1;
2155 x = -x;
2156 }
2157 else
2158 sign = 0;
Tim Peters9905b942003-03-20 20:53:32 +00002159
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002160 f = frexp(x, &e);
Tim Peters9905b942003-03-20 20:53:32 +00002161
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002162 /* Normalize f to be in the range [1.0, 2.0) */
2163 if (0.5 <= f && f < 1.0) {
2164 f *= 2.0;
2165 e--;
2166 }
2167 else if (f == 0.0)
2168 e = 0;
2169 else {
2170 PyErr_SetString(PyExc_SystemError,
2171 "frexp() result out of range");
2172 return -1;
2173 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002174
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002175 if (e >= 128)
2176 goto Overflow;
2177 else if (e < -126) {
2178 /* Gradual underflow */
2179 f = ldexp(f, 126 + e);
2180 e = 0;
2181 }
2182 else if (!(e == 0 && f == 0.0)) {
2183 e += 127;
2184 f -= 1.0; /* Get rid of leading 1 */
2185 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002186
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002187 f *= 8388608.0; /* 2**23 */
2188 fbits = (unsigned int)(f + 0.5); /* Round */
2189 assert(fbits <= 8388608);
2190 if (fbits >> 23) {
2191 /* The carry propagated out of a string of 23 1 bits. */
2192 fbits = 0;
2193 ++e;
2194 if (e >= 255)
2195 goto Overflow;
2196 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002197
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002198 /* First byte */
2199 *p = (sign << 7) | (e >> 1);
2200 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002201
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002202 /* Second byte */
2203 *p = (char) (((e & 1) << 7) | (fbits >> 16));
2204 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002205
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002206 /* Third byte */
2207 *p = (fbits >> 8) & 0xFF;
2208 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002209
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002210 /* Fourth byte */
2211 *p = fbits & 0xFF;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002212
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002213 /* Done */
2214 return 0;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002215
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002216 }
2217 else {
Benjamin Peterson2bb69a52017-09-10 23:50:46 -07002218 float y = (float)x;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002219 int i, incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00002220
Benjamin Peterson2bb69a52017-09-10 23:50:46 -07002221 if (Py_IS_INFINITY(y) && !Py_IS_INFINITY(x))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002222 goto Overflow;
Christian Heimesdd15f6c2008-03-16 00:07:10 +00002223
Benjamin Petersona853a8b2017-09-07 11:13:59 -07002224 unsigned char s[sizeof(float)];
Benjamin Petersona853a8b2017-09-07 11:13:59 -07002225 memcpy(s, &y, sizeof(float));
2226
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002227 if ((float_format == ieee_little_endian_format && !le)
2228 || (float_format == ieee_big_endian_format && le)) {
2229 p += 3;
2230 incr = -1;
2231 }
Christian Heimesdd15f6c2008-03-16 00:07:10 +00002232
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002233 for (i = 0; i < 4; i++) {
Benjamin Petersona853a8b2017-09-07 11:13:59 -07002234 *p = s[i];
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002235 p += incr;
2236 }
2237 return 0;
2238 }
Christian Heimesdd15f6c2008-03-16 00:07:10 +00002239 Overflow:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002240 PyErr_SetString(PyExc_OverflowError,
2241 "float too large to pack with f format");
2242 return -1;
Tim Peters9905b942003-03-20 20:53:32 +00002243}
2244
2245int
2246_PyFloat_Pack8(double x, unsigned char *p, int le)
2247{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002248 if (double_format == unknown_format) {
2249 unsigned char sign;
2250 int e;
2251 double f;
2252 unsigned int fhi, flo;
2253 int incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00002254
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002255 if (le) {
2256 p += 7;
2257 incr = -1;
2258 }
Tim Peters9905b942003-03-20 20:53:32 +00002259
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002260 if (x < 0) {
2261 sign = 1;
2262 x = -x;
2263 }
2264 else
2265 sign = 0;
Tim Peters9905b942003-03-20 20:53:32 +00002266
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002267 f = frexp(x, &e);
Tim Peters9905b942003-03-20 20:53:32 +00002268
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002269 /* Normalize f to be in the range [1.0, 2.0) */
2270 if (0.5 <= f && f < 1.0) {
2271 f *= 2.0;
2272 e--;
2273 }
2274 else if (f == 0.0)
2275 e = 0;
2276 else {
2277 PyErr_SetString(PyExc_SystemError,
2278 "frexp() result out of range");
2279 return -1;
2280 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002281
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002282 if (e >= 1024)
2283 goto Overflow;
2284 else if (e < -1022) {
2285 /* Gradual underflow */
2286 f = ldexp(f, 1022 + e);
2287 e = 0;
2288 }
2289 else if (!(e == 0 && f == 0.0)) {
2290 e += 1023;
2291 f -= 1.0; /* Get rid of leading 1 */
2292 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002293
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002294 /* fhi receives the high 28 bits; flo the low 24 bits (== 52 bits) */
2295 f *= 268435456.0; /* 2**28 */
2296 fhi = (unsigned int)f; /* Truncate */
2297 assert(fhi < 268435456);
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002298
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002299 f -= (double)fhi;
2300 f *= 16777216.0; /* 2**24 */
2301 flo = (unsigned int)(f + 0.5); /* Round */
2302 assert(flo <= 16777216);
2303 if (flo >> 24) {
2304 /* The carry propagated out of a string of 24 1 bits. */
2305 flo = 0;
2306 ++fhi;
2307 if (fhi >> 28) {
2308 /* And it also progagated out of the next 28 bits. */
2309 fhi = 0;
2310 ++e;
2311 if (e >= 2047)
2312 goto Overflow;
2313 }
2314 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002315
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002316 /* First byte */
2317 *p = (sign << 7) | (e >> 4);
2318 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002319
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002320 /* Second byte */
2321 *p = (unsigned char) (((e & 0xF) << 4) | (fhi >> 24));
2322 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002323
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002324 /* Third byte */
2325 *p = (fhi >> 16) & 0xFF;
2326 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002327
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002328 /* Fourth byte */
2329 *p = (fhi >> 8) & 0xFF;
2330 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002331
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002332 /* Fifth byte */
2333 *p = fhi & 0xFF;
2334 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002335
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002336 /* Sixth byte */
2337 *p = (flo >> 16) & 0xFF;
2338 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002339
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002340 /* Seventh byte */
2341 *p = (flo >> 8) & 0xFF;
2342 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002343
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002344 /* Eighth byte */
2345 *p = flo & 0xFF;
Brett Cannonb94767f2011-02-22 20:15:44 +00002346 /* p += incr; */
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002347
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002348 /* Done */
2349 return 0;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002350
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002351 Overflow:
2352 PyErr_SetString(PyExc_OverflowError,
2353 "float too large to pack with d format");
2354 return -1;
2355 }
2356 else {
Serhiy Storchaka20b39b22014-09-28 11:27:24 +03002357 const unsigned char *s = (unsigned char*)&x;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002358 int i, incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00002359
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002360 if ((double_format == ieee_little_endian_format && !le)
2361 || (double_format == ieee_big_endian_format && le)) {
2362 p += 7;
2363 incr = -1;
2364 }
2365
2366 for (i = 0; i < 8; i++) {
2367 *p = *s++;
2368 p += incr;
2369 }
2370 return 0;
2371 }
Tim Peters9905b942003-03-20 20:53:32 +00002372}
2373
2374double
Mark Dickinson7c4e4092016-09-03 17:21:29 +01002375_PyFloat_Unpack2(const unsigned char *p, int le)
2376{
2377 unsigned char sign;
2378 int e;
2379 unsigned int f;
2380 double x;
2381 int incr = 1;
2382
2383 if (le) {
2384 p += 1;
2385 incr = -1;
2386 }
2387
2388 /* First byte */
2389 sign = (*p >> 7) & 1;
2390 e = (*p & 0x7C) >> 2;
2391 f = (*p & 0x03) << 8;
2392 p += incr;
2393
2394 /* Second byte */
2395 f |= *p;
2396
2397 if (e == 0x1f) {
2398#ifdef PY_NO_SHORT_FLOAT_REPR
2399 if (f == 0) {
2400 /* Infinity */
2401 return sign ? -Py_HUGE_VAL : Py_HUGE_VAL;
2402 }
2403 else {
2404 /* NaN */
2405#ifdef Py_NAN
2406 return sign ? -Py_NAN : Py_NAN;
2407#else
2408 PyErr_SetString(
2409 PyExc_ValueError,
2410 "can't unpack IEEE 754 NaN "
2411 "on platform that does not support NaNs");
2412 return -1;
2413#endif /* #ifdef Py_NAN */
2414 }
2415#else
2416 if (f == 0) {
2417 /* Infinity */
2418 return _Py_dg_infinity(sign);
2419 }
2420 else {
2421 /* NaN */
2422 return _Py_dg_stdnan(sign);
2423 }
2424#endif /* #ifdef PY_NO_SHORT_FLOAT_REPR */
2425 }
2426
2427 x = (double)f / 1024.0;
2428
2429 if (e == 0) {
2430 e = -14;
2431 }
2432 else {
2433 x += 1.0;
2434 e -= 15;
2435 }
2436 x = ldexp(x, e);
2437
2438 if (sign)
2439 x = -x;
2440
2441 return x;
2442}
2443
2444double
Tim Peters9905b942003-03-20 20:53:32 +00002445_PyFloat_Unpack4(const unsigned char *p, int le)
2446{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002447 if (float_format == unknown_format) {
2448 unsigned char sign;
2449 int e;
2450 unsigned int f;
2451 double x;
2452 int incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00002453
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002454 if (le) {
2455 p += 3;
2456 incr = -1;
2457 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002458
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002459 /* First byte */
2460 sign = (*p >> 7) & 1;
2461 e = (*p & 0x7F) << 1;
2462 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002463
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002464 /* Second byte */
2465 e |= (*p >> 7) & 1;
2466 f = (*p & 0x7F) << 16;
2467 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002468
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002469 if (e == 255) {
2470 PyErr_SetString(
2471 PyExc_ValueError,
2472 "can't unpack IEEE 754 special value "
2473 "on non-IEEE platform");
2474 return -1;
2475 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002476
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002477 /* Third byte */
2478 f |= *p << 8;
2479 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002480
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002481 /* Fourth byte */
2482 f |= *p;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002483
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002484 x = (double)f / 8388608.0;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002485
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002486 /* XXX This sadly ignores Inf/NaN issues */
2487 if (e == 0)
2488 e = -126;
2489 else {
2490 x += 1.0;
2491 e -= 127;
2492 }
2493 x = ldexp(x, e);
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002494
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002495 if (sign)
2496 x = -x;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002497
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002498 return x;
2499 }
2500 else {
2501 float x;
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00002502
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002503 if ((float_format == ieee_little_endian_format && !le)
2504 || (float_format == ieee_big_endian_format && le)) {
2505 char buf[4];
2506 char *d = &buf[3];
2507 int i;
Tim Peters9905b942003-03-20 20:53:32 +00002508
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002509 for (i = 0; i < 4; i++) {
2510 *d-- = *p++;
2511 }
2512 memcpy(&x, buf, 4);
2513 }
2514 else {
2515 memcpy(&x, p, 4);
2516 }
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00002517
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002518 return x;
2519 }
Tim Peters9905b942003-03-20 20:53:32 +00002520}
2521
2522double
2523_PyFloat_Unpack8(const unsigned char *p, int le)
2524{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002525 if (double_format == unknown_format) {
2526 unsigned char sign;
2527 int e;
2528 unsigned int fhi, flo;
2529 double x;
2530 int incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00002531
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002532 if (le) {
2533 p += 7;
2534 incr = -1;
2535 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002536
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002537 /* First byte */
2538 sign = (*p >> 7) & 1;
2539 e = (*p & 0x7F) << 4;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002540
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002541 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002542
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002543 /* Second byte */
2544 e |= (*p >> 4) & 0xF;
2545 fhi = (*p & 0xF) << 24;
2546 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002547
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002548 if (e == 2047) {
2549 PyErr_SetString(
2550 PyExc_ValueError,
2551 "can't unpack IEEE 754 special value "
2552 "on non-IEEE platform");
2553 return -1.0;
2554 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002555
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002556 /* Third byte */
2557 fhi |= *p << 16;
2558 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002559
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002560 /* Fourth byte */
2561 fhi |= *p << 8;
2562 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002563
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002564 /* Fifth byte */
2565 fhi |= *p;
2566 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002567
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002568 /* Sixth byte */
2569 flo = *p << 16;
2570 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002571
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002572 /* Seventh byte */
2573 flo |= *p << 8;
2574 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002575
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002576 /* Eighth byte */
2577 flo |= *p;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002578
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002579 x = (double)fhi + (double)flo / 16777216.0; /* 2**24 */
2580 x /= 268435456.0; /* 2**28 */
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002581
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002582 if (e == 0)
2583 e = -1022;
2584 else {
2585 x += 1.0;
2586 e -= 1023;
2587 }
2588 x = ldexp(x, e);
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002589
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002590 if (sign)
2591 x = -x;
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00002592
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002593 return x;
2594 }
2595 else {
2596 double x;
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00002597
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002598 if ((double_format == ieee_little_endian_format && !le)
2599 || (double_format == ieee_big_endian_format && le)) {
2600 char buf[8];
2601 char *d = &buf[7];
2602 int i;
2603
2604 for (i = 0; i < 8; i++) {
2605 *d-- = *p++;
2606 }
2607 memcpy(&x, buf, 8);
2608 }
2609 else {
2610 memcpy(&x, p, 8);
2611 }
2612
2613 return x;
2614 }
Tim Peters9905b942003-03-20 20:53:32 +00002615}