blob: 20a5155e07346d8d36c6cbaf9cbda3aff5278944 [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
846#if 0
847static PyObject *
848float_is_inf(PyObject *v)
849{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000850 double x = PyFloat_AsDouble(v);
851 if (x == -1.0 && PyErr_Occurred())
852 return NULL;
853 return PyBool_FromLong((long)Py_IS_INFINITY(x));
Christian Heimes53876d92008-04-19 00:31:39 +0000854}
855
856static PyObject *
857float_is_nan(PyObject *v)
858{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000859 double x = PyFloat_AsDouble(v);
860 if (x == -1.0 && PyErr_Occurred())
861 return NULL;
862 return PyBool_FromLong((long)Py_IS_NAN(x));
Christian Heimes53876d92008-04-19 00:31:39 +0000863}
864
865static PyObject *
866float_is_finite(PyObject *v)
867{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000868 double x = PyFloat_AsDouble(v);
869 if (x == -1.0 && PyErr_Occurred())
870 return NULL;
871 return PyBool_FromLong((long)Py_IS_FINITE(x));
Christian Heimes53876d92008-04-19 00:31:39 +0000872}
873#endif
874
Serhiy Storchakab5c51d32017-03-11 09:21:05 +0200875/*[clinic input]
876float.__trunc__
877
878Return the Integral closest to x between 0 and x.
879[clinic start generated code]*/
880
Christian Heimes53876d92008-04-19 00:31:39 +0000881static PyObject *
Serhiy Storchakab5c51d32017-03-11 09:21:05 +0200882float___trunc___impl(PyObject *self)
883/*[clinic end generated code: output=dd3e289dd4c6b538 input=591b9ba0d650fdff]*/
Guido van Rossum1899c2e1992-09-12 11:09:23 +0000884{
Serhiy Storchakab5c51d32017-03-11 09:21:05 +0200885 double x = PyFloat_AsDouble(self);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000886 double wholepart; /* integral portion of x, rounded toward 0 */
Tim Peters7321ec42001-07-26 20:02:17 +0000887
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000888 (void)modf(x, &wholepart);
889 /* Try to get out cheap if this fits in a Python int. The attempt
890 * to cast to long must be protected, as C doesn't define what
891 * happens if the double is too big to fit in a long. Some rare
892 * systems raise an exception then (RISCOS was mentioned as one,
893 * and someone using a non-default option on Sun also bumped into
894 * that). Note that checking for >= and <= LONG_{MIN,MAX} would
895 * still be vulnerable: if a long has more bits of precision than
896 * a double, casting MIN/MAX to double may yield an approximation,
897 * and if that's rounded up, then, e.g., wholepart=LONG_MAX+1 would
898 * yield true from the C expression wholepart<=LONG_MAX, despite
899 * that wholepart is actually greater than LONG_MAX.
900 */
901 if (LONG_MIN < wholepart && wholepart < LONG_MAX) {
902 const long aslong = (long)wholepart;
903 return PyLong_FromLong(aslong);
904 }
905 return PyLong_FromDouble(wholepart);
Guido van Rossum1899c2e1992-09-12 11:09:23 +0000906}
907
Mark Dickinsone6a076d2009-04-18 11:48:33 +0000908/* double_round: rounds a finite double to the closest multiple of
909 10**-ndigits; here ndigits is within reasonable bounds (typically, -308 <=
910 ndigits <= 323). Returns a Python float, or sets a Python error and
911 returns NULL on failure (OverflowError and memory errors are possible). */
912
913#ifndef PY_NO_SHORT_FLOAT_REPR
914/* version of double_round that uses the correctly-rounded string<->double
915 conversions from Python/dtoa.c */
916
917static PyObject *
918double_round(double x, int ndigits) {
919
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000920 double rounded;
921 Py_ssize_t buflen, mybuflen=100;
922 char *buf, *buf_end, shortbuf[100], *mybuf=shortbuf;
923 int decpt, sign;
924 PyObject *result = NULL;
Mark Dickinson261896b2012-01-27 21:16:01 +0000925 _Py_SET_53BIT_PRECISION_HEADER;
Mark Dickinsone6a076d2009-04-18 11:48:33 +0000926
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000927 /* round to a decimal string */
Mark Dickinson261896b2012-01-27 21:16:01 +0000928 _Py_SET_53BIT_PRECISION_START;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000929 buf = _Py_dg_dtoa(x, 3, ndigits, &decpt, &sign, &buf_end);
Mark Dickinson261896b2012-01-27 21:16:01 +0000930 _Py_SET_53BIT_PRECISION_END;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000931 if (buf == NULL) {
932 PyErr_NoMemory();
933 return NULL;
934 }
Mark Dickinsone6a076d2009-04-18 11:48:33 +0000935
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000936 /* Get new buffer if shortbuf is too small. Space needed <= buf_end -
937 buf + 8: (1 extra for '0', 1 for sign, 5 for exp, 1 for '\0'). */
938 buflen = buf_end - buf;
939 if (buflen + 8 > mybuflen) {
940 mybuflen = buflen+8;
941 mybuf = (char *)PyMem_Malloc(mybuflen);
942 if (mybuf == NULL) {
943 PyErr_NoMemory();
944 goto exit;
945 }
946 }
947 /* copy buf to mybuf, adding exponent, sign and leading 0 */
948 PyOS_snprintf(mybuf, mybuflen, "%s0%se%d", (sign ? "-" : ""),
949 buf, decpt - (int)buflen);
Mark Dickinsone6a076d2009-04-18 11:48:33 +0000950
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000951 /* and convert the resulting string back to a double */
952 errno = 0;
Mark Dickinson261896b2012-01-27 21:16:01 +0000953 _Py_SET_53BIT_PRECISION_START;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000954 rounded = _Py_dg_strtod(mybuf, NULL);
Mark Dickinson261896b2012-01-27 21:16:01 +0000955 _Py_SET_53BIT_PRECISION_END;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000956 if (errno == ERANGE && fabs(rounded) >= 1.)
957 PyErr_SetString(PyExc_OverflowError,
958 "rounded value too large to represent");
959 else
960 result = PyFloat_FromDouble(rounded);
Mark Dickinsone6a076d2009-04-18 11:48:33 +0000961
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000962 /* done computing value; now clean up */
963 if (mybuf != shortbuf)
964 PyMem_Free(mybuf);
Mark Dickinsone6a076d2009-04-18 11:48:33 +0000965 exit:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000966 _Py_dg_freedtoa(buf);
967 return result;
Mark Dickinsone6a076d2009-04-18 11:48:33 +0000968}
969
970#else /* PY_NO_SHORT_FLOAT_REPR */
971
972/* fallback version, to be used when correctly rounded binary<->decimal
973 conversions aren't available */
974
975static PyObject *
976double_round(double x, int ndigits) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000977 double pow1, pow2, y, z;
978 if (ndigits >= 0) {
979 if (ndigits > 22) {
980 /* pow1 and pow2 are each safe from overflow, but
981 pow1*pow2 ~= pow(10.0, ndigits) might overflow */
982 pow1 = pow(10.0, (double)(ndigits-22));
983 pow2 = 1e22;
984 }
985 else {
986 pow1 = pow(10.0, (double)ndigits);
987 pow2 = 1.0;
988 }
989 y = (x*pow1)*pow2;
990 /* if y overflows, then rounded value is exactly x */
991 if (!Py_IS_FINITE(y))
992 return PyFloat_FromDouble(x);
993 }
994 else {
995 pow1 = pow(10.0, (double)-ndigits);
996 pow2 = 1.0; /* unused; silences a gcc compiler warning */
997 y = x / pow1;
998 }
Mark Dickinsone6a076d2009-04-18 11:48:33 +0000999
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001000 z = round(y);
1001 if (fabs(y-z) == 0.5)
1002 /* halfway between two integers; use round-half-even */
1003 z = 2.0*round(y/2.0);
Mark Dickinsone6a076d2009-04-18 11:48:33 +00001004
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001005 if (ndigits >= 0)
1006 z = (z / pow2) / pow1;
1007 else
1008 z *= pow1;
Mark Dickinsone6a076d2009-04-18 11:48:33 +00001009
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001010 /* if computation resulted in overflow, raise OverflowError */
1011 if (!Py_IS_FINITE(z)) {
1012 PyErr_SetString(PyExc_OverflowError,
1013 "overflow occurred during round");
1014 return NULL;
1015 }
Mark Dickinsone6a076d2009-04-18 11:48:33 +00001016
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001017 return PyFloat_FromDouble(z);
Mark Dickinsone6a076d2009-04-18 11:48:33 +00001018}
1019
1020#endif /* PY_NO_SHORT_FLOAT_REPR */
1021
1022/* round a Python float v to the closest multiple of 10**-ndigits */
1023
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001024/*[clinic input]
1025float.__round__
1026
Serhiy Storchaka279f4462019-09-14 12:24:05 +03001027 ndigits as o_ndigits: object = None
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001028 /
1029
1030Return the Integral closest to x, rounding half toward even.
1031
1032When an argument is passed, work like built-in round(x, ndigits).
1033[clinic start generated code]*/
1034
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001035static PyObject *
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001036float___round___impl(PyObject *self, PyObject *o_ndigits)
Serhiy Storchaka279f4462019-09-14 12:24:05 +03001037/*[clinic end generated code: output=374c36aaa0f13980 input=fc0fe25924fbc9ed]*/
Guido van Rossum2fa33db2007-08-23 22:07:24 +00001038{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001039 double x, rounded;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001040 Py_ssize_t ndigits;
Guido van Rossum2fa33db2007-08-23 22:07:24 +00001041
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001042 x = PyFloat_AsDouble(self);
Serhiy Storchaka279f4462019-09-14 12:24:05 +03001043 if (o_ndigits == Py_None) {
Steve Dowercb39d1f2015-04-15 16:10:59 -04001044 /* single-argument round or with None ndigits:
1045 * round to nearest integer */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001046 rounded = round(x);
1047 if (fabs(x-rounded) == 0.5)
1048 /* halfway case: round to even */
1049 rounded = 2.0*round(x/2.0);
1050 return PyLong_FromDouble(rounded);
1051 }
Guido van Rossum2fa33db2007-08-23 22:07:24 +00001052
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001053 /* interpret second argument as a Py_ssize_t; clips on overflow */
1054 ndigits = PyNumber_AsSsize_t(o_ndigits, NULL);
1055 if (ndigits == -1 && PyErr_Occurred())
1056 return NULL;
Guido van Rossum2fa33db2007-08-23 22:07:24 +00001057
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001058 /* nans and infinities round to themselves */
1059 if (!Py_IS_FINITE(x))
1060 return PyFloat_FromDouble(x);
Mark Dickinsone6a076d2009-04-18 11:48:33 +00001061
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001062 /* Deal with extreme values for ndigits. For ndigits > NDIGITS_MAX, x
1063 always rounds to itself. For ndigits < NDIGITS_MIN, x always
1064 rounds to +-0.0. Here 0.30103 is an upper bound for log10(2). */
Mark Dickinsone6a076d2009-04-18 11:48:33 +00001065#define NDIGITS_MAX ((int)((DBL_MANT_DIG-DBL_MIN_EXP) * 0.30103))
1066#define NDIGITS_MIN (-(int)((DBL_MAX_EXP + 1) * 0.30103))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001067 if (ndigits > NDIGITS_MAX)
1068 /* return x */
1069 return PyFloat_FromDouble(x);
1070 else if (ndigits < NDIGITS_MIN)
1071 /* return 0.0, but with sign of x */
1072 return PyFloat_FromDouble(0.0*x);
1073 else
1074 /* finite x, and ndigits is not unreasonably large */
1075 return double_round(x, (int)ndigits);
Mark Dickinsone6a076d2009-04-18 11:48:33 +00001076#undef NDIGITS_MAX
1077#undef NDIGITS_MIN
Guido van Rossum2fa33db2007-08-23 22:07:24 +00001078}
1079
1080static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001081float_float(PyObject *v)
Guido van Rossum1899c2e1992-09-12 11:09:23 +00001082{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001083 if (PyFloat_CheckExact(v))
1084 Py_INCREF(v);
1085 else
1086 v = PyFloat_FromDouble(((PyFloatObject *)v)->ob_fval);
1087 return v;
Guido van Rossum1899c2e1992-09-12 11:09:23 +00001088}
1089
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001090/*[clinic input]
1091float.conjugate
1092
1093Return self, the complex conjugate of any float.
1094[clinic start generated code]*/
1095
1096static PyObject *
1097float_conjugate_impl(PyObject *self)
1098/*[clinic end generated code: output=8ca292c2479194af input=82ba6f37a9ff91dd]*/
1099{
1100 return float_float(self);
1101}
1102
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001103/* turn ASCII hex characters into integer values and vice versa */
1104
1105static char
1106char_from_hex(int x)
1107{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001108 assert(0 <= x && x < 16);
Victor Stinnerf5cff562011-10-14 02:13:11 +02001109 return Py_hexdigits[x];
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001110}
1111
1112static int
1113hex_from_char(char c) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001114 int x;
1115 switch(c) {
1116 case '0':
1117 x = 0;
1118 break;
1119 case '1':
1120 x = 1;
1121 break;
1122 case '2':
1123 x = 2;
1124 break;
1125 case '3':
1126 x = 3;
1127 break;
1128 case '4':
1129 x = 4;
1130 break;
1131 case '5':
1132 x = 5;
1133 break;
1134 case '6':
1135 x = 6;
1136 break;
1137 case '7':
1138 x = 7;
1139 break;
1140 case '8':
1141 x = 8;
1142 break;
1143 case '9':
1144 x = 9;
1145 break;
1146 case 'a':
1147 case 'A':
1148 x = 10;
1149 break;
1150 case 'b':
1151 case 'B':
1152 x = 11;
1153 break;
1154 case 'c':
1155 case 'C':
1156 x = 12;
1157 break;
1158 case 'd':
1159 case 'D':
1160 x = 13;
1161 break;
1162 case 'e':
1163 case 'E':
1164 x = 14;
1165 break;
1166 case 'f':
1167 case 'F':
1168 x = 15;
1169 break;
1170 default:
1171 x = -1;
1172 break;
1173 }
1174 return x;
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001175}
1176
1177/* convert a float to a hexadecimal string */
1178
1179/* TOHEX_NBITS is DBL_MANT_DIG rounded up to the next integer
1180 of the form 4k+1. */
1181#define TOHEX_NBITS DBL_MANT_DIG + 3 - (DBL_MANT_DIG+2)%4
1182
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001183/*[clinic input]
1184float.hex
1185
1186Return a hexadecimal representation of a floating-point number.
1187
1188>>> (-0.1).hex()
1189'-0x1.999999999999ap-4'
1190>>> 3.14159.hex()
1191'0x1.921f9f01b866ep+1'
1192[clinic start generated code]*/
1193
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001194static PyObject *
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001195float_hex_impl(PyObject *self)
1196/*[clinic end generated code: output=0ebc9836e4d302d4 input=bec1271a33d47e67]*/
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001197{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001198 double x, m;
1199 int e, shift, i, si, esign;
1200 /* Space for 1+(TOHEX_NBITS-1)/4 digits, a decimal point, and the
1201 trailing NUL byte. */
1202 char s[(TOHEX_NBITS-1)/4+3];
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001203
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001204 CONVERT_TO_DOUBLE(self, x);
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001205
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001206 if (Py_IS_NAN(x) || Py_IS_INFINITY(x))
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001207 return float_repr((PyFloatObject *)self);
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001208
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001209 if (x == 0.0) {
Benjamin Peterson5d470832010-07-02 19:45:07 +00001210 if (copysign(1.0, x) == -1.0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001211 return PyUnicode_FromString("-0x0.0p+0");
1212 else
1213 return PyUnicode_FromString("0x0.0p+0");
1214 }
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001215
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001216 m = frexp(fabs(x), &e);
Victor Stinner640c35c2013-06-04 23:14:37 +02001217 shift = 1 - Py_MAX(DBL_MIN_EXP - e, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001218 m = ldexp(m, shift);
1219 e -= shift;
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001220
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001221 si = 0;
1222 s[si] = char_from_hex((int)m);
1223 si++;
1224 m -= (int)m;
1225 s[si] = '.';
1226 si++;
1227 for (i=0; i < (TOHEX_NBITS-1)/4; i++) {
1228 m *= 16.0;
1229 s[si] = char_from_hex((int)m);
1230 si++;
1231 m -= (int)m;
1232 }
1233 s[si] = '\0';
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001234
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001235 if (e < 0) {
1236 esign = (int)'-';
1237 e = -e;
1238 }
1239 else
1240 esign = (int)'+';
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001241
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001242 if (x < 0.0)
1243 return PyUnicode_FromFormat("-0x%sp%c%d", s, esign, e);
1244 else
1245 return PyUnicode_FromFormat("0x%sp%c%d", s, esign, e);
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001246}
1247
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001248/* Convert a hexadecimal string to a float. */
1249
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001250/*[clinic input]
1251@classmethod
1252float.fromhex
1253
1254 string: object
1255 /
1256
1257Create a floating-point number from a hexadecimal string.
1258
1259>>> float.fromhex('0x1.ffffp10')
12602047.984375
1261>>> float.fromhex('-0x1p-1074')
1262-5e-324
1263[clinic start generated code]*/
1264
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001265static PyObject *
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001266float_fromhex(PyTypeObject *type, PyObject *string)
1267/*[clinic end generated code: output=46c0274d22b78e82 input=0407bebd354bca89]*/
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001268{
Serhiy Storchaka25885d12016-05-12 10:21:14 +03001269 PyObject *result;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001270 double x;
1271 long exp, top_exp, lsb, key_digit;
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001272 const char *s, *coeff_start, *s_store, *coeff_end, *exp_start, *s_end;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001273 int half_eps, digit, round_up, negate=0;
1274 Py_ssize_t length, ndigits, fdigits, i;
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001275
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001276 /*
1277 * For the sake of simplicity and correctness, we impose an artificial
1278 * limit on ndigits, the total number of hex digits in the coefficient
1279 * The limit is chosen to ensure that, writing exp for the exponent,
1280 *
1281 * (1) if exp > LONG_MAX/2 then the value of the hex string is
1282 * guaranteed to overflow (provided it's nonzero)
1283 *
1284 * (2) if exp < LONG_MIN/2 then the value of the hex string is
1285 * guaranteed to underflow to 0.
1286 *
1287 * (3) if LONG_MIN/2 <= exp <= LONG_MAX/2 then there's no danger of
1288 * overflow in the calculation of exp and top_exp below.
1289 *
1290 * More specifically, ndigits is assumed to satisfy the following
1291 * inequalities:
1292 *
1293 * 4*ndigits <= DBL_MIN_EXP - DBL_MANT_DIG - LONG_MIN/2
1294 * 4*ndigits <= LONG_MAX/2 + 1 - DBL_MAX_EXP
1295 *
1296 * If either of these inequalities is not satisfied, a ValueError is
1297 * raised. Otherwise, write x for the value of the hex string, and
1298 * assume x is nonzero. Then
1299 *
1300 * 2**(exp-4*ndigits) <= |x| < 2**(exp+4*ndigits).
1301 *
1302 * Now if exp > LONG_MAX/2 then:
1303 *
1304 * exp - 4*ndigits >= LONG_MAX/2 + 1 - (LONG_MAX/2 + 1 - DBL_MAX_EXP)
1305 * = DBL_MAX_EXP
1306 *
1307 * so |x| >= 2**DBL_MAX_EXP, which is too large to be stored in C
1308 * double, so overflows. If exp < LONG_MIN/2, then
1309 *
1310 * exp + 4*ndigits <= LONG_MIN/2 - 1 + (
1311 * DBL_MIN_EXP - DBL_MANT_DIG - LONG_MIN/2)
1312 * = DBL_MIN_EXP - DBL_MANT_DIG - 1
1313 *
1314 * and so |x| < 2**(DBL_MIN_EXP-DBL_MANT_DIG-1), hence underflows to 0
1315 * when converted to a C double.
1316 *
1317 * It's easy to show that if LONG_MIN/2 <= exp <= LONG_MAX/2 then both
1318 * exp+4*ndigits and exp-4*ndigits are within the range of a long.
1319 */
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001320
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001321 s = PyUnicode_AsUTF8AndSize(string, &length);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001322 if (s == NULL)
1323 return NULL;
1324 s_end = s + length;
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001325
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001326 /********************
1327 * Parse the string *
1328 ********************/
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001329
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001330 /* leading whitespace */
1331 while (Py_ISSPACE(*s))
1332 s++;
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001333
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001334 /* infinities and nans */
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001335 x = _Py_parse_inf_or_nan(s, (char **)&coeff_end);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001336 if (coeff_end != s) {
1337 s = coeff_end;
1338 goto finished;
1339 }
Mark Dickinsonbd16edd2009-05-20 22:05:25 +00001340
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001341 /* optional sign */
1342 if (*s == '-') {
1343 s++;
1344 negate = 1;
1345 }
1346 else if (*s == '+')
1347 s++;
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001348
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001349 /* [0x] */
1350 s_store = s;
1351 if (*s == '0') {
1352 s++;
1353 if (*s == 'x' || *s == 'X')
1354 s++;
1355 else
1356 s = s_store;
1357 }
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001358
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001359 /* coefficient: <integer> [. <fraction>] */
1360 coeff_start = s;
1361 while (hex_from_char(*s) >= 0)
1362 s++;
1363 s_store = s;
1364 if (*s == '.') {
1365 s++;
1366 while (hex_from_char(*s) >= 0)
1367 s++;
1368 coeff_end = s-1;
1369 }
1370 else
1371 coeff_end = s;
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001372
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001373 /* ndigits = total # of hex digits; fdigits = # after point */
1374 ndigits = coeff_end - coeff_start;
1375 fdigits = coeff_end - s_store;
1376 if (ndigits == 0)
1377 goto parse_error;
Victor Stinner640c35c2013-06-04 23:14:37 +02001378 if (ndigits > Py_MIN(DBL_MIN_EXP - DBL_MANT_DIG - LONG_MIN/2,
1379 LONG_MAX/2 + 1 - DBL_MAX_EXP)/4)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001380 goto insane_length_error;
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001381
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001382 /* [p <exponent>] */
1383 if (*s == 'p' || *s == 'P') {
1384 s++;
1385 exp_start = s;
1386 if (*s == '-' || *s == '+')
1387 s++;
1388 if (!('0' <= *s && *s <= '9'))
1389 goto parse_error;
1390 s++;
1391 while ('0' <= *s && *s <= '9')
1392 s++;
1393 exp = strtol(exp_start, NULL, 10);
1394 }
1395 else
1396 exp = 0;
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001397
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001398/* for 0 <= j < ndigits, HEX_DIGIT(j) gives the jth most significant digit */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001399#define HEX_DIGIT(j) hex_from_char(*((j) < fdigits ? \
1400 coeff_end-(j) : \
1401 coeff_end-1-(j)))
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001402
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001403 /*******************************************
1404 * Compute rounded value of the hex string *
1405 *******************************************/
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001406
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001407 /* Discard leading zeros, and catch extreme overflow and underflow */
1408 while (ndigits > 0 && HEX_DIGIT(ndigits-1) == 0)
1409 ndigits--;
1410 if (ndigits == 0 || exp < LONG_MIN/2) {
1411 x = 0.0;
1412 goto finished;
1413 }
1414 if (exp > LONG_MAX/2)
1415 goto overflow_error;
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001416
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001417 /* Adjust exponent for fractional part. */
1418 exp = exp - 4*((long)fdigits);
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001419
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001420 /* top_exp = 1 more than exponent of most sig. bit of coefficient */
1421 top_exp = exp + 4*((long)ndigits - 1);
1422 for (digit = HEX_DIGIT(ndigits-1); digit != 0; digit /= 2)
1423 top_exp++;
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001424
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001425 /* catch almost all nonextreme cases of overflow and underflow here */
1426 if (top_exp < DBL_MIN_EXP - DBL_MANT_DIG) {
1427 x = 0.0;
1428 goto finished;
1429 }
1430 if (top_exp > DBL_MAX_EXP)
1431 goto overflow_error;
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001432
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001433 /* lsb = exponent of least significant bit of the *rounded* value.
1434 This is top_exp - DBL_MANT_DIG unless result is subnormal. */
Victor Stinner640c35c2013-06-04 23:14:37 +02001435 lsb = Py_MAX(top_exp, (long)DBL_MIN_EXP) - DBL_MANT_DIG;
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001436
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001437 x = 0.0;
1438 if (exp >= lsb) {
1439 /* no rounding required */
1440 for (i = ndigits-1; i >= 0; i--)
1441 x = 16.0*x + HEX_DIGIT(i);
1442 x = ldexp(x, (int)(exp));
1443 goto finished;
1444 }
1445 /* rounding required. key_digit is the index of the hex digit
1446 containing the first bit to be rounded away. */
1447 half_eps = 1 << (int)((lsb - exp - 1) % 4);
1448 key_digit = (lsb - exp - 1) / 4;
1449 for (i = ndigits-1; i > key_digit; i--)
1450 x = 16.0*x + HEX_DIGIT(i);
1451 digit = HEX_DIGIT(key_digit);
1452 x = 16.0*x + (double)(digit & (16-2*half_eps));
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001453
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001454 /* round-half-even: round up if bit lsb-1 is 1 and at least one of
1455 bits lsb, lsb-2, lsb-3, lsb-4, ... is 1. */
1456 if ((digit & half_eps) != 0) {
1457 round_up = 0;
1458 if ((digit & (3*half_eps-1)) != 0 ||
1459 (half_eps == 8 && (HEX_DIGIT(key_digit+1) & 1) != 0))
1460 round_up = 1;
1461 else
1462 for (i = key_digit-1; i >= 0; i--)
1463 if (HEX_DIGIT(i) != 0) {
1464 round_up = 1;
1465 break;
1466 }
Mark Dickinson21a1f732010-07-06 15:11:44 +00001467 if (round_up) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001468 x += 2*half_eps;
1469 if (top_exp == DBL_MAX_EXP &&
1470 x == ldexp((double)(2*half_eps), DBL_MANT_DIG))
1471 /* overflow corner case: pre-rounded value <
1472 2**DBL_MAX_EXP; rounded=2**DBL_MAX_EXP. */
1473 goto overflow_error;
1474 }
1475 }
1476 x = ldexp(x, (int)(exp+4*key_digit));
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001477
1478 finished:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001479 /* optional trailing whitespace leading to the end of the string */
1480 while (Py_ISSPACE(*s))
1481 s++;
1482 if (s != s_end)
1483 goto parse_error;
Serhiy Storchaka25885d12016-05-12 10:21:14 +03001484 result = PyFloat_FromDouble(negate ? -x : x);
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001485 if (type != &PyFloat_Type && result != NULL) {
Jeroen Demeyer196a5302019-07-04 12:31:34 +02001486 Py_SETREF(result, _PyObject_CallOneArg((PyObject *)type, result));
Serhiy Storchaka25885d12016-05-12 10:21:14 +03001487 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001488 return result;
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001489
1490 overflow_error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001491 PyErr_SetString(PyExc_OverflowError,
1492 "hexadecimal value too large to represent as a float");
1493 return NULL;
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001494
1495 parse_error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001496 PyErr_SetString(PyExc_ValueError,
1497 "invalid hexadecimal floating-point string");
1498 return NULL;
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001499
1500 insane_length_error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001501 PyErr_SetString(PyExc_ValueError,
1502 "hexadecimal string too long to convert");
1503 return NULL;
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001504}
1505
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001506/*[clinic input]
1507float.as_integer_ratio
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001508
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001509Return integer ratio.
1510
1511Return a pair of integers, whose ratio is exactly equal to the original float
1512and with a positive denominator.
1513
1514Raise OverflowError on infinities and a ValueError on NaNs.
1515
1516>>> (10.0).as_integer_ratio()
1517(10, 1)
1518>>> (0.0).as_integer_ratio()
1519(0, 1)
1520>>> (-.25).as_integer_ratio()
1521(-1, 4)
1522[clinic start generated code]*/
Mark Dickinson65fe25e2008-07-16 11:30:51 +00001523
Christian Heimes26855632008-01-27 23:50:43 +00001524static PyObject *
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001525float_as_integer_ratio_impl(PyObject *self)
1526/*[clinic end generated code: output=65f25f0d8d30a712 input=e21d08b4630c2e44]*/
Christian Heimes26855632008-01-27 23:50:43 +00001527{
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001528 double self_double;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001529 double float_part;
1530 int exponent;
1531 int i;
Christian Heimes292d3512008-02-03 16:51:08 +00001532
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001533 PyObject *py_exponent = NULL;
1534 PyObject *numerator = NULL;
1535 PyObject *denominator = NULL;
1536 PyObject *result_pair = NULL;
1537 PyNumberMethods *long_methods = PyLong_Type.tp_as_number;
Christian Heimes26855632008-01-27 23:50:43 +00001538
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001539 CONVERT_TO_DOUBLE(self, self_double);
Christian Heimes26855632008-01-27 23:50:43 +00001540
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001541 if (Py_IS_INFINITY(self_double)) {
Serhiy Storchaka0d250bc2015-12-29 22:34:23 +02001542 PyErr_SetString(PyExc_OverflowError,
1543 "cannot convert Infinity to integer ratio");
1544 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001545 }
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001546 if (Py_IS_NAN(self_double)) {
Serhiy Storchaka0d250bc2015-12-29 22:34:23 +02001547 PyErr_SetString(PyExc_ValueError,
1548 "cannot convert NaN to integer ratio");
1549 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001550 }
Christian Heimes26855632008-01-27 23:50:43 +00001551
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001552 float_part = frexp(self_double, &exponent); /* self_double == float_part * 2**exponent exactly */
Christian Heimes26855632008-01-27 23:50:43 +00001553
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001554 for (i=0; i<300 && float_part != floor(float_part) ; i++) {
1555 float_part *= 2.0;
1556 exponent--;
1557 }
1558 /* self == float_part * 2**exponent exactly and float_part is integral.
1559 If FLT_RADIX != 2, the 300 steps may leave a tiny fractional part
1560 to be truncated by PyLong_FromDouble(). */
Christian Heimes26855632008-01-27 23:50:43 +00001561
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001562 numerator = PyLong_FromDouble(float_part);
Serhiy Storchaka4e6aad12015-12-29 22:55:48 +02001563 if (numerator == NULL)
1564 goto error;
1565 denominator = PyLong_FromLong(1);
1566 if (denominator == NULL)
1567 goto error;
1568 py_exponent = PyLong_FromLong(Py_ABS(exponent));
1569 if (py_exponent == NULL)
1570 goto error;
Christian Heimes26855632008-01-27 23:50:43 +00001571
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001572 /* fold in 2**exponent */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001573 if (exponent > 0) {
Serhiy Storchaka59865e72016-04-11 09:57:37 +03001574 Py_SETREF(numerator,
Serhiy Storchaka4e6aad12015-12-29 22:55:48 +02001575 long_methods->nb_lshift(numerator, py_exponent));
1576 if (numerator == NULL)
1577 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001578 }
1579 else {
Serhiy Storchaka59865e72016-04-11 09:57:37 +03001580 Py_SETREF(denominator,
Serhiy Storchaka4e6aad12015-12-29 22:55:48 +02001581 long_methods->nb_lshift(denominator, py_exponent));
1582 if (denominator == NULL)
1583 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001584 }
1585
1586 result_pair = PyTuple_Pack(2, numerator, denominator);
Christian Heimes26855632008-01-27 23:50:43 +00001587
Christian Heimes26855632008-01-27 23:50:43 +00001588error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001589 Py_XDECREF(py_exponent);
1590 Py_XDECREF(denominator);
1591 Py_XDECREF(numerator);
1592 return result_pair;
Christian Heimes26855632008-01-27 23:50:43 +00001593}
1594
Jeremy Hylton938ace62002-07-17 16:30:39 +00001595static PyObject *
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02001596float_subtype_new(PyTypeObject *type, PyObject *x);
1597
1598/*[clinic input]
1599@classmethod
1600float.__new__ as float_new
Serhiy Storchakaba85d692017-03-30 09:09:41 +03001601 x: object(c_default="_PyLong_Zero") = 0
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02001602 /
1603
1604Convert a string or number to a floating point number, if possible.
1605[clinic start generated code]*/
Guido van Rossumbef14172001-08-29 15:47:46 +00001606
Tim Peters6d6c1a32001-08-02 04:15:00 +00001607static PyObject *
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02001608float_new_impl(PyTypeObject *type, PyObject *x)
Serhiy Storchakabae68812017-04-05 12:00:42 +03001609/*[clinic end generated code: output=ccf1e8dc460ba6ba input=540ee77c204ff87a]*/
Tim Peters6d6c1a32001-08-02 04:15:00 +00001610{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001611 if (type != &PyFloat_Type)
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02001612 return float_subtype_new(type, x); /* Wimp out */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001613 /* If it's a string, but not a string subclass, use
1614 PyFloat_FromString. */
1615 if (PyUnicode_CheckExact(x))
1616 return PyFloat_FromString(x);
1617 return PyNumber_Float(x);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001618}
1619
Guido van Rossumbef14172001-08-29 15:47:46 +00001620/* Wimpy, slow approach to tp_new calls for subtypes of float:
1621 first create a regular float from whatever arguments we got,
1622 then allocate a subtype instance and initialize its ob_fval
1623 from the regular float. The regular float is then thrown away.
1624*/
1625static PyObject *
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02001626float_subtype_new(PyTypeObject *type, PyObject *x)
Guido van Rossumbef14172001-08-29 15:47:46 +00001627{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001628 PyObject *tmp, *newobj;
Guido van Rossumbef14172001-08-29 15:47:46 +00001629
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001630 assert(PyType_IsSubtype(type, &PyFloat_Type));
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02001631 tmp = float_new_impl(&PyFloat_Type, x);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001632 if (tmp == NULL)
1633 return NULL;
Serhiy Storchaka15095802015-11-25 15:47:01 +02001634 assert(PyFloat_Check(tmp));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001635 newobj = type->tp_alloc(type, 0);
1636 if (newobj == NULL) {
1637 Py_DECREF(tmp);
1638 return NULL;
1639 }
1640 ((PyFloatObject *)newobj)->ob_fval = ((PyFloatObject *)tmp)->ob_fval;
1641 Py_DECREF(tmp);
1642 return newobj;
Guido van Rossumbef14172001-08-29 15:47:46 +00001643}
1644
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001645/*[clinic input]
1646float.__getnewargs__
1647[clinic start generated code]*/
1648
Guido van Rossum5d9113d2003-01-29 17:58:45 +00001649static PyObject *
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001650float___getnewargs___impl(PyObject *self)
1651/*[clinic end generated code: output=873258c9d206b088 input=002279d1d77891e6]*/
Guido van Rossum5d9113d2003-01-29 17:58:45 +00001652{
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001653 return Py_BuildValue("(d)", ((PyFloatObject *)self)->ob_fval);
Guido van Rossum5d9113d2003-01-29 17:58:45 +00001654}
1655
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001656/* this is for the benefit of the pack/unpack routines below */
1657
1658typedef enum {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001659 unknown_format, ieee_big_endian_format, ieee_little_endian_format
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001660} float_format_type;
1661
1662static float_format_type double_format, float_format;
1663static float_format_type detected_double_format, detected_float_format;
1664
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001665/*[clinic input]
1666@classmethod
1667float.__getformat__
1668
1669 typestr: str
1670 Must be 'double' or 'float'.
1671 /
1672
1673You probably don't want to use this function.
1674
1675It exists mainly to be used in Python's test suite.
1676
1677This function returns whichever of 'unknown', 'IEEE, big-endian' or 'IEEE,
1678little-endian' best describes the format of floating point numbers used by the
1679C type named by typestr.
1680[clinic start generated code]*/
1681
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001682static PyObject *
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001683float___getformat___impl(PyTypeObject *type, const char *typestr)
1684/*[clinic end generated code: output=2bfb987228cc9628 input=d5a52600f835ad67]*/
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001685{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001686 float_format_type r;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001687
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001688 if (strcmp(typestr, "double") == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001689 r = double_format;
1690 }
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001691 else if (strcmp(typestr, "float") == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001692 r = float_format;
1693 }
1694 else {
1695 PyErr_SetString(PyExc_ValueError,
1696 "__getformat__() argument 1 must be "
1697 "'double' or 'float'");
1698 return NULL;
1699 }
1700
1701 switch (r) {
1702 case unknown_format:
1703 return PyUnicode_FromString("unknown");
1704 case ieee_little_endian_format:
1705 return PyUnicode_FromString("IEEE, little-endian");
1706 case ieee_big_endian_format:
1707 return PyUnicode_FromString("IEEE, big-endian");
1708 default:
Victor Stinner04394df2019-11-18 17:39:48 +01001709 PyErr_SetString(PyExc_RuntimeError,
1710 "insane float_format or double_format");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001711 return NULL;
1712 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001713}
1714
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001715/*[clinic input]
1716@classmethod
1717float.__set_format__
1718
1719 typestr: str
1720 Must be 'double' or 'float'.
1721 fmt: str
1722 Must be one of 'unknown', 'IEEE, big-endian' or 'IEEE, little-endian',
1723 and in addition can only be one of the latter two if it appears to
1724 match the underlying C reality.
1725 /
1726
1727You probably don't want to use this function.
1728
1729It exists mainly to be used in Python's test suite.
1730
1731Override the automatic determination of C-level floating point type.
1732This affects how floats are converted to and from binary strings.
1733[clinic start generated code]*/
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001734
1735static PyObject *
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001736float___set_format___impl(PyTypeObject *type, const char *typestr,
1737 const char *fmt)
1738/*[clinic end generated code: output=504460f5dc85acbd input=5306fa2b81a997e4]*/
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001739{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001740 float_format_type f;
1741 float_format_type detected;
1742 float_format_type *p;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001743
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001744 if (strcmp(typestr, "double") == 0) {
1745 p = &double_format;
1746 detected = detected_double_format;
1747 }
1748 else if (strcmp(typestr, "float") == 0) {
1749 p = &float_format;
1750 detected = detected_float_format;
1751 }
1752 else {
1753 PyErr_SetString(PyExc_ValueError,
1754 "__setformat__() argument 1 must "
1755 "be 'double' or 'float'");
1756 return NULL;
1757 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001758
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001759 if (strcmp(fmt, "unknown") == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001760 f = unknown_format;
1761 }
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001762 else if (strcmp(fmt, "IEEE, little-endian") == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001763 f = ieee_little_endian_format;
1764 }
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001765 else if (strcmp(fmt, "IEEE, big-endian") == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001766 f = ieee_big_endian_format;
1767 }
1768 else {
1769 PyErr_SetString(PyExc_ValueError,
1770 "__setformat__() argument 2 must be "
1771 "'unknown', 'IEEE, little-endian' or "
1772 "'IEEE, big-endian'");
1773 return NULL;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001774
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001775 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001776
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001777 if (f != unknown_format && f != detected) {
1778 PyErr_Format(PyExc_ValueError,
1779 "can only set %s format to 'unknown' or the "
1780 "detected platform value", typestr);
1781 return NULL;
1782 }
1783
1784 *p = f;
1785 Py_RETURN_NONE;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001786}
1787
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001788static PyObject *
1789float_getreal(PyObject *v, void *closure)
1790{
1791 return float_float(v);
1792}
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001793
Guido van Rossumb43daf72007-08-01 18:08:08 +00001794static PyObject *
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001795float_getimag(PyObject *v, void *closure)
Guido van Rossumb43daf72007-08-01 18:08:08 +00001796{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001797 return PyFloat_FromDouble(0.0);
Guido van Rossumb43daf72007-08-01 18:08:08 +00001798}
1799
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001800/*[clinic input]
1801float.__format__
1802
1803 format_spec: unicode
1804 /
1805
1806Formats the float according to format_spec.
1807[clinic start generated code]*/
1808
Eric Smith8c663262007-08-25 02:26:07 +00001809static PyObject *
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001810float___format___impl(PyObject *self, PyObject *format_spec)
1811/*[clinic end generated code: output=b260e52a47eade56 input=2ece1052211fd0e6]*/
Eric Smith8c663262007-08-25 02:26:07 +00001812{
Victor Stinnerd3f08822012-05-29 12:57:52 +02001813 _PyUnicodeWriter writer;
1814 int ret;
Eric Smith4a7d76d2008-05-30 18:10:19 +00001815
Victor Stinner8f674cc2013-04-17 23:02:17 +02001816 _PyUnicodeWriter_Init(&writer);
Victor Stinnerd3f08822012-05-29 12:57:52 +02001817 ret = _PyFloat_FormatAdvancedWriter(
1818 &writer,
1819 self,
1820 format_spec, 0, PyUnicode_GET_LENGTH(format_spec));
1821 if (ret == -1) {
1822 _PyUnicodeWriter_Dealloc(&writer);
1823 return NULL;
1824 }
1825 return _PyUnicodeWriter_Finish(&writer);
Eric Smith8c663262007-08-25 02:26:07 +00001826}
1827
Guido van Rossum5d9113d2003-01-29 17:58:45 +00001828static PyMethodDef float_methods[] = {
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001829 FLOAT_CONJUGATE_METHODDEF
1830 FLOAT___TRUNC___METHODDEF
1831 FLOAT___ROUND___METHODDEF
1832 FLOAT_AS_INTEGER_RATIO_METHODDEF
1833 FLOAT_FROMHEX_METHODDEF
1834 FLOAT_HEX_METHODDEF
1835 FLOAT_IS_INTEGER_METHODDEF
Christian Heimes53876d92008-04-19 00:31:39 +00001836#if 0
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001837 {"is_inf", (PyCFunction)float_is_inf, METH_NOARGS,
Ezio Melotti7760b4e2013-10-06 00:45:11 +03001838 "Return True if the float is positive or negative infinite."},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001839 {"is_finite", (PyCFunction)float_is_finite, METH_NOARGS,
Ezio Melotti7760b4e2013-10-06 00:45:11 +03001840 "Return True if the float is finite, neither infinite nor NaN."},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001841 {"is_nan", (PyCFunction)float_is_nan, METH_NOARGS,
Ezio Melotti7760b4e2013-10-06 00:45:11 +03001842 "Return True if the float is not a number (NaN)."},
Christian Heimes53876d92008-04-19 00:31:39 +00001843#endif
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001844 FLOAT___GETNEWARGS___METHODDEF
1845 FLOAT___GETFORMAT___METHODDEF
1846 FLOAT___SET_FORMAT___METHODDEF
1847 FLOAT___FORMAT___METHODDEF
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001848 {NULL, NULL} /* sentinel */
Guido van Rossum5d9113d2003-01-29 17:58:45 +00001849};
1850
Guido van Rossumb43daf72007-08-01 18:08:08 +00001851static PyGetSetDef float_getset[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001852 {"real",
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001853 float_getreal, (setter)NULL,
Guido van Rossumb43daf72007-08-01 18:08:08 +00001854 "the real part of a complex number",
1855 NULL},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001856 {"imag",
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001857 float_getimag, (setter)NULL,
Guido van Rossumb43daf72007-08-01 18:08:08 +00001858 "the imaginary part of a complex number",
1859 NULL},
1860 {NULL} /* Sentinel */
1861};
1862
Tim Peters6d6c1a32001-08-02 04:15:00 +00001863
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001864static PyNumberMethods float_as_number = {
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001865 float_add, /* nb_add */
1866 float_sub, /* nb_subtract */
1867 float_mul, /* nb_multiply */
1868 float_rem, /* nb_remainder */
1869 float_divmod, /* nb_divmod */
1870 float_pow, /* nb_power */
1871 (unaryfunc)float_neg, /* nb_negative */
1872 float_float, /* nb_positive */
1873 (unaryfunc)float_abs, /* nb_absolute */
1874 (inquiry)float_bool, /* nb_bool */
1875 0, /* nb_invert */
1876 0, /* nb_lshift */
1877 0, /* nb_rshift */
1878 0, /* nb_and */
1879 0, /* nb_xor */
1880 0, /* nb_or */
1881 float___trunc___impl, /* nb_int */
1882 0, /* nb_reserved */
1883 float_float, /* nb_float */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001884 0, /* nb_inplace_add */
1885 0, /* nb_inplace_subtract */
1886 0, /* nb_inplace_multiply */
1887 0, /* nb_inplace_remainder */
1888 0, /* nb_inplace_power */
1889 0, /* nb_inplace_lshift */
1890 0, /* nb_inplace_rshift */
1891 0, /* nb_inplace_and */
1892 0, /* nb_inplace_xor */
1893 0, /* nb_inplace_or */
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001894 float_floor_div, /* nb_floor_divide */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001895 float_div, /* nb_true_divide */
1896 0, /* nb_inplace_floor_divide */
1897 0, /* nb_inplace_true_divide */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001898};
1899
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001900PyTypeObject PyFloat_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001901 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1902 "float",
1903 sizeof(PyFloatObject),
1904 0,
1905 (destructor)float_dealloc, /* tp_dealloc */
Jeroen Demeyer530f5062019-05-31 04:13:39 +02001906 0, /* tp_vectorcall_offset */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001907 0, /* tp_getattr */
1908 0, /* tp_setattr */
Jeroen Demeyer530f5062019-05-31 04:13:39 +02001909 0, /* tp_as_async */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001910 (reprfunc)float_repr, /* tp_repr */
1911 &float_as_number, /* tp_as_number */
1912 0, /* tp_as_sequence */
1913 0, /* tp_as_mapping */
1914 (hashfunc)float_hash, /* tp_hash */
1915 0, /* tp_call */
Serhiy Storchaka96aeaec2019-05-06 22:29:40 +03001916 0, /* tp_str */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001917 PyObject_GenericGetAttr, /* tp_getattro */
1918 0, /* tp_setattro */
1919 0, /* tp_as_buffer */
Serhiy Storchakab5c51d32017-03-11 09:21:05 +02001920 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02001921 float_new__doc__, /* tp_doc */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001922 0, /* tp_traverse */
1923 0, /* tp_clear */
1924 float_richcompare, /* tp_richcompare */
1925 0, /* tp_weaklistoffset */
1926 0, /* tp_iter */
1927 0, /* tp_iternext */
1928 float_methods, /* tp_methods */
1929 0, /* tp_members */
1930 float_getset, /* tp_getset */
1931 0, /* tp_base */
1932 0, /* tp_dict */
1933 0, /* tp_descr_get */
1934 0, /* tp_descr_set */
1935 0, /* tp_dictoffset */
1936 0, /* tp_init */
1937 0, /* tp_alloc */
1938 float_new, /* tp_new */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001939};
Guido van Rossumfbbd57e1997-08-05 02:16:08 +00001940
Victor Stinner1c8f0592013-07-22 22:24:54 +02001941int
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001942_PyFloat_Init(void)
1943{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001944 /* We attempt to determine if this machine is using IEEE
1945 floating point formats by peering at the bits of some
1946 carefully chosen values. If it looks like we are on an
1947 IEEE platform, the float packing/unpacking routines can
1948 just copy bits, if not they resort to arithmetic & shifts
1949 and masks. The shifts & masks approach works on all finite
1950 values, but what happens to infinities, NaNs and signed
1951 zeroes on packing is an accident, and attempting to unpack
1952 a NaN or an infinity will raise an exception.
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001953
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001954 Note that if we're on some whacked-out platform which uses
1955 IEEE formats but isn't strictly little-endian or big-
1956 endian, we will fall back to the portable shifts & masks
1957 method. */
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001958
1959#if SIZEOF_DOUBLE == 8
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001960 {
1961 double x = 9006104071832581.0;
1962 if (memcmp(&x, "\x43\x3f\xff\x01\x02\x03\x04\x05", 8) == 0)
1963 detected_double_format = ieee_big_endian_format;
1964 else if (memcmp(&x, "\x05\x04\x03\x02\x01\xff\x3f\x43", 8) == 0)
1965 detected_double_format = ieee_little_endian_format;
1966 else
1967 detected_double_format = unknown_format;
1968 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001969#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001970 detected_double_format = unknown_format;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001971#endif
1972
1973#if SIZEOF_FLOAT == 4
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001974 {
1975 float y = 16711938.0;
1976 if (memcmp(&y, "\x4b\x7f\x01\x02", 4) == 0)
1977 detected_float_format = ieee_big_endian_format;
1978 else if (memcmp(&y, "\x02\x01\x7f\x4b", 4) == 0)
1979 detected_float_format = ieee_little_endian_format;
1980 else
1981 detected_float_format = unknown_format;
1982 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001983#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001984 detected_float_format = unknown_format;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001985#endif
1986
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001987 double_format = detected_double_format;
1988 float_format = detected_float_format;
Christian Heimesb76922a2007-12-11 01:06:40 +00001989
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001990 /* Init float info */
Victor Stinner1c8f0592013-07-22 22:24:54 +02001991 if (FloatInfoType.tp_name == NULL) {
Victor Stinner6d43f6f2019-01-22 21:18:05 +01001992 if (PyStructSequence_InitType2(&FloatInfoType, &floatinfo_desc) < 0) {
Victor Stinner1c8f0592013-07-22 22:24:54 +02001993 return 0;
Victor Stinner6d43f6f2019-01-22 21:18:05 +01001994 }
Victor Stinner1c8f0592013-07-22 22:24:54 +02001995 }
1996 return 1;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001997}
1998
Georg Brandl2ee470f2008-07-16 12:55:28 +00001999int
2000PyFloat_ClearFreeList(void)
Guido van Rossumfbbd57e1997-08-05 02:16:08 +00002001{
Kristján Valur Jónssondaa06542012-03-30 09:18:15 +00002002 PyFloatObject *f = free_list, *next;
2003 int i = numfree;
2004 while (f) {
2005 next = (PyFloatObject*) Py_TYPE(f);
2006 PyObject_FREE(f);
2007 f = next;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002008 }
Kristján Valur Jónssondaa06542012-03-30 09:18:15 +00002009 free_list = NULL;
2010 numfree = 0;
2011 return i;
Christian Heimes15ebc882008-02-04 18:48:49 +00002012}
2013
2014void
Victor Stinnerbed48172019-08-27 00:12:32 +02002015_PyFloat_Fini(void)
Christian Heimes15ebc882008-02-04 18:48:49 +00002016{
Kristján Valur Jónssondaa06542012-03-30 09:18:15 +00002017 (void)PyFloat_ClearFreeList();
Guido van Rossumfbbd57e1997-08-05 02:16:08 +00002018}
Tim Peters9905b942003-03-20 20:53:32 +00002019
David Malcolm49526f42012-06-22 14:55:41 -04002020/* Print summary info about the state of the optimized allocator */
2021void
2022_PyFloat_DebugMallocStats(FILE *out)
2023{
2024 _PyDebugAllocatorStats(out,
2025 "free PyFloatObject",
2026 numfree, sizeof(PyFloatObject));
2027}
2028
2029
Tim Peters9905b942003-03-20 20:53:32 +00002030/*----------------------------------------------------------------------------
Mark Dickinson7c4e4092016-09-03 17:21:29 +01002031 * _PyFloat_{Pack,Unpack}{2,4,8}. See floatobject.h.
2032 * To match the NPY_HALF_ROUND_TIES_TO_EVEN behavior in:
2033 * https://github.com/numpy/numpy/blob/master/numpy/core/src/npymath/halffloat.c
2034 * We use:
2035 * bits = (unsigned short)f; Note the truncation
2036 * if ((f - bits > 0.5) || (f - bits == 0.5 && bits % 2)) {
2037 * bits++;
2038 * }
Tim Peters9905b942003-03-20 20:53:32 +00002039 */
Mark Dickinson7c4e4092016-09-03 17:21:29 +01002040
2041int
2042_PyFloat_Pack2(double x, unsigned char *p, int le)
2043{
2044 unsigned char sign;
2045 int e;
2046 double f;
2047 unsigned short bits;
2048 int incr = 1;
2049
2050 if (x == 0.0) {
2051 sign = (copysign(1.0, x) == -1.0);
2052 e = 0;
2053 bits = 0;
2054 }
2055 else if (Py_IS_INFINITY(x)) {
2056 sign = (x < 0.0);
2057 e = 0x1f;
2058 bits = 0;
2059 }
2060 else if (Py_IS_NAN(x)) {
2061 /* There are 2046 distinct half-precision NaNs (1022 signaling and
2062 1024 quiet), but there are only two quiet NaNs that don't arise by
2063 quieting a signaling NaN; we get those by setting the topmost bit
2064 of the fraction field and clearing all other fraction bits. We
2065 choose the one with the appropriate sign. */
2066 sign = (copysign(1.0, x) == -1.0);
2067 e = 0x1f;
2068 bits = 512;
2069 }
2070 else {
2071 sign = (x < 0.0);
2072 if (sign) {
2073 x = -x;
2074 }
2075
2076 f = frexp(x, &e);
2077 if (f < 0.5 || f >= 1.0) {
2078 PyErr_SetString(PyExc_SystemError,
2079 "frexp() result out of range");
2080 return -1;
2081 }
2082
2083 /* Normalize f to be in the range [1.0, 2.0) */
2084 f *= 2.0;
2085 e--;
2086
2087 if (e >= 16) {
2088 goto Overflow;
2089 }
2090 else if (e < -25) {
2091 /* |x| < 2**-25. Underflow to zero. */
2092 f = 0.0;
2093 e = 0;
2094 }
2095 else if (e < -14) {
2096 /* |x| < 2**-14. Gradual underflow */
2097 f = ldexp(f, 14 + e);
2098 e = 0;
2099 }
2100 else /* if (!(e == 0 && f == 0.0)) */ {
2101 e += 15;
2102 f -= 1.0; /* Get rid of leading 1 */
2103 }
2104
2105 f *= 1024.0; /* 2**10 */
2106 /* Round to even */
2107 bits = (unsigned short)f; /* Note the truncation */
2108 assert(bits < 1024);
2109 assert(e < 31);
2110 if ((f - bits > 0.5) || ((f - bits == 0.5) && (bits % 2 == 1))) {
2111 ++bits;
2112 if (bits == 1024) {
2113 /* The carry propagated out of a string of 10 1 bits. */
2114 bits = 0;
2115 ++e;
2116 if (e == 31)
2117 goto Overflow;
2118 }
2119 }
2120 }
2121
2122 bits |= (e << 10) | (sign << 15);
2123
2124 /* Write out result. */
2125 if (le) {
2126 p += 1;
2127 incr = -1;
2128 }
2129
2130 /* First byte */
2131 *p = (unsigned char)((bits >> 8) & 0xFF);
2132 p += incr;
2133
2134 /* Second byte */
2135 *p = (unsigned char)(bits & 0xFF);
2136
2137 return 0;
2138
2139 Overflow:
2140 PyErr_SetString(PyExc_OverflowError,
2141 "float too large to pack with e format");
2142 return -1;
2143}
2144
Tim Peters9905b942003-03-20 20:53:32 +00002145int
2146_PyFloat_Pack4(double x, unsigned char *p, int le)
2147{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002148 if (float_format == unknown_format) {
2149 unsigned char sign;
2150 int e;
2151 double f;
2152 unsigned int fbits;
2153 int incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00002154
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002155 if (le) {
2156 p += 3;
2157 incr = -1;
2158 }
Tim Peters9905b942003-03-20 20:53:32 +00002159
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002160 if (x < 0) {
2161 sign = 1;
2162 x = -x;
2163 }
2164 else
2165 sign = 0;
Tim Peters9905b942003-03-20 20:53:32 +00002166
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002167 f = frexp(x, &e);
Tim Peters9905b942003-03-20 20:53:32 +00002168
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002169 /* Normalize f to be in the range [1.0, 2.0) */
2170 if (0.5 <= f && f < 1.0) {
2171 f *= 2.0;
2172 e--;
2173 }
2174 else if (f == 0.0)
2175 e = 0;
2176 else {
2177 PyErr_SetString(PyExc_SystemError,
2178 "frexp() result out of range");
2179 return -1;
2180 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002181
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002182 if (e >= 128)
2183 goto Overflow;
2184 else if (e < -126) {
2185 /* Gradual underflow */
2186 f = ldexp(f, 126 + e);
2187 e = 0;
2188 }
2189 else if (!(e == 0 && f == 0.0)) {
2190 e += 127;
2191 f -= 1.0; /* Get rid of leading 1 */
2192 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002193
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002194 f *= 8388608.0; /* 2**23 */
2195 fbits = (unsigned int)(f + 0.5); /* Round */
2196 assert(fbits <= 8388608);
2197 if (fbits >> 23) {
2198 /* The carry propagated out of a string of 23 1 bits. */
2199 fbits = 0;
2200 ++e;
2201 if (e >= 255)
2202 goto Overflow;
2203 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002204
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002205 /* First byte */
2206 *p = (sign << 7) | (e >> 1);
2207 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002208
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002209 /* Second byte */
2210 *p = (char) (((e & 1) << 7) | (fbits >> 16));
2211 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002212
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002213 /* Third byte */
2214 *p = (fbits >> 8) & 0xFF;
2215 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002216
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002217 /* Fourth byte */
2218 *p = fbits & 0xFF;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002219
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002220 /* Done */
2221 return 0;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002222
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002223 }
2224 else {
Benjamin Peterson2bb69a52017-09-10 23:50:46 -07002225 float y = (float)x;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002226 int i, incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00002227
Benjamin Peterson2bb69a52017-09-10 23:50:46 -07002228 if (Py_IS_INFINITY(y) && !Py_IS_INFINITY(x))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002229 goto Overflow;
Christian Heimesdd15f6c2008-03-16 00:07:10 +00002230
Benjamin Petersona853a8b2017-09-07 11:13:59 -07002231 unsigned char s[sizeof(float)];
Benjamin Petersona853a8b2017-09-07 11:13:59 -07002232 memcpy(s, &y, sizeof(float));
2233
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002234 if ((float_format == ieee_little_endian_format && !le)
2235 || (float_format == ieee_big_endian_format && le)) {
2236 p += 3;
2237 incr = -1;
2238 }
Christian Heimesdd15f6c2008-03-16 00:07:10 +00002239
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002240 for (i = 0; i < 4; i++) {
Benjamin Petersona853a8b2017-09-07 11:13:59 -07002241 *p = s[i];
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002242 p += incr;
2243 }
2244 return 0;
2245 }
Christian Heimesdd15f6c2008-03-16 00:07:10 +00002246 Overflow:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002247 PyErr_SetString(PyExc_OverflowError,
2248 "float too large to pack with f format");
2249 return -1;
Tim Peters9905b942003-03-20 20:53:32 +00002250}
2251
2252int
2253_PyFloat_Pack8(double x, unsigned char *p, int le)
2254{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002255 if (double_format == unknown_format) {
2256 unsigned char sign;
2257 int e;
2258 double f;
2259 unsigned int fhi, flo;
2260 int incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00002261
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002262 if (le) {
2263 p += 7;
2264 incr = -1;
2265 }
Tim Peters9905b942003-03-20 20:53:32 +00002266
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002267 if (x < 0) {
2268 sign = 1;
2269 x = -x;
2270 }
2271 else
2272 sign = 0;
Tim Peters9905b942003-03-20 20:53:32 +00002273
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002274 f = frexp(x, &e);
Tim Peters9905b942003-03-20 20:53:32 +00002275
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002276 /* Normalize f to be in the range [1.0, 2.0) */
2277 if (0.5 <= f && f < 1.0) {
2278 f *= 2.0;
2279 e--;
2280 }
2281 else if (f == 0.0)
2282 e = 0;
2283 else {
2284 PyErr_SetString(PyExc_SystemError,
2285 "frexp() result out of range");
2286 return -1;
2287 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002288
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002289 if (e >= 1024)
2290 goto Overflow;
2291 else if (e < -1022) {
2292 /* Gradual underflow */
2293 f = ldexp(f, 1022 + e);
2294 e = 0;
2295 }
2296 else if (!(e == 0 && f == 0.0)) {
2297 e += 1023;
2298 f -= 1.0; /* Get rid of leading 1 */
2299 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002300
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002301 /* fhi receives the high 28 bits; flo the low 24 bits (== 52 bits) */
2302 f *= 268435456.0; /* 2**28 */
2303 fhi = (unsigned int)f; /* Truncate */
2304 assert(fhi < 268435456);
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002305
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002306 f -= (double)fhi;
2307 f *= 16777216.0; /* 2**24 */
2308 flo = (unsigned int)(f + 0.5); /* Round */
2309 assert(flo <= 16777216);
2310 if (flo >> 24) {
2311 /* The carry propagated out of a string of 24 1 bits. */
2312 flo = 0;
2313 ++fhi;
2314 if (fhi >> 28) {
2315 /* And it also progagated out of the next 28 bits. */
2316 fhi = 0;
2317 ++e;
2318 if (e >= 2047)
2319 goto Overflow;
2320 }
2321 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002322
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002323 /* First byte */
2324 *p = (sign << 7) | (e >> 4);
2325 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002326
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002327 /* Second byte */
2328 *p = (unsigned char) (((e & 0xF) << 4) | (fhi >> 24));
2329 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002330
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002331 /* Third byte */
2332 *p = (fhi >> 16) & 0xFF;
2333 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002334
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002335 /* Fourth byte */
2336 *p = (fhi >> 8) & 0xFF;
2337 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002338
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002339 /* Fifth byte */
2340 *p = fhi & 0xFF;
2341 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002342
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002343 /* Sixth byte */
2344 *p = (flo >> 16) & 0xFF;
2345 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002346
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002347 /* Seventh byte */
2348 *p = (flo >> 8) & 0xFF;
2349 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002350
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002351 /* Eighth byte */
2352 *p = flo & 0xFF;
Brett Cannonb94767f2011-02-22 20:15:44 +00002353 /* p += incr; */
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002354
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002355 /* Done */
2356 return 0;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002357
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002358 Overflow:
2359 PyErr_SetString(PyExc_OverflowError,
2360 "float too large to pack with d format");
2361 return -1;
2362 }
2363 else {
Serhiy Storchaka20b39b22014-09-28 11:27:24 +03002364 const unsigned char *s = (unsigned char*)&x;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002365 int i, incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00002366
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002367 if ((double_format == ieee_little_endian_format && !le)
2368 || (double_format == ieee_big_endian_format && le)) {
2369 p += 7;
2370 incr = -1;
2371 }
2372
2373 for (i = 0; i < 8; i++) {
2374 *p = *s++;
2375 p += incr;
2376 }
2377 return 0;
2378 }
Tim Peters9905b942003-03-20 20:53:32 +00002379}
2380
2381double
Mark Dickinson7c4e4092016-09-03 17:21:29 +01002382_PyFloat_Unpack2(const unsigned char *p, int le)
2383{
2384 unsigned char sign;
2385 int e;
2386 unsigned int f;
2387 double x;
2388 int incr = 1;
2389
2390 if (le) {
2391 p += 1;
2392 incr = -1;
2393 }
2394
2395 /* First byte */
2396 sign = (*p >> 7) & 1;
2397 e = (*p & 0x7C) >> 2;
2398 f = (*p & 0x03) << 8;
2399 p += incr;
2400
2401 /* Second byte */
2402 f |= *p;
2403
2404 if (e == 0x1f) {
2405#ifdef PY_NO_SHORT_FLOAT_REPR
2406 if (f == 0) {
2407 /* Infinity */
2408 return sign ? -Py_HUGE_VAL : Py_HUGE_VAL;
2409 }
2410 else {
2411 /* NaN */
2412#ifdef Py_NAN
2413 return sign ? -Py_NAN : Py_NAN;
2414#else
2415 PyErr_SetString(
2416 PyExc_ValueError,
2417 "can't unpack IEEE 754 NaN "
2418 "on platform that does not support NaNs");
2419 return -1;
2420#endif /* #ifdef Py_NAN */
2421 }
2422#else
2423 if (f == 0) {
2424 /* Infinity */
2425 return _Py_dg_infinity(sign);
2426 }
2427 else {
2428 /* NaN */
2429 return _Py_dg_stdnan(sign);
2430 }
2431#endif /* #ifdef PY_NO_SHORT_FLOAT_REPR */
2432 }
2433
2434 x = (double)f / 1024.0;
2435
2436 if (e == 0) {
2437 e = -14;
2438 }
2439 else {
2440 x += 1.0;
2441 e -= 15;
2442 }
2443 x = ldexp(x, e);
2444
2445 if (sign)
2446 x = -x;
2447
2448 return x;
2449}
2450
2451double
Tim Peters9905b942003-03-20 20:53:32 +00002452_PyFloat_Unpack4(const unsigned char *p, int le)
2453{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002454 if (float_format == unknown_format) {
2455 unsigned char sign;
2456 int e;
2457 unsigned int f;
2458 double x;
2459 int incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00002460
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002461 if (le) {
2462 p += 3;
2463 incr = -1;
2464 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002465
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002466 /* First byte */
2467 sign = (*p >> 7) & 1;
2468 e = (*p & 0x7F) << 1;
2469 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002470
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002471 /* Second byte */
2472 e |= (*p >> 7) & 1;
2473 f = (*p & 0x7F) << 16;
2474 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002475
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002476 if (e == 255) {
2477 PyErr_SetString(
2478 PyExc_ValueError,
2479 "can't unpack IEEE 754 special value "
2480 "on non-IEEE platform");
2481 return -1;
2482 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002483
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002484 /* Third byte */
2485 f |= *p << 8;
2486 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002487
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002488 /* Fourth byte */
2489 f |= *p;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002490
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002491 x = (double)f / 8388608.0;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002492
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002493 /* XXX This sadly ignores Inf/NaN issues */
2494 if (e == 0)
2495 e = -126;
2496 else {
2497 x += 1.0;
2498 e -= 127;
2499 }
2500 x = ldexp(x, e);
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002501
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002502 if (sign)
2503 x = -x;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002504
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002505 return x;
2506 }
2507 else {
2508 float x;
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00002509
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002510 if ((float_format == ieee_little_endian_format && !le)
2511 || (float_format == ieee_big_endian_format && le)) {
2512 char buf[4];
2513 char *d = &buf[3];
2514 int i;
Tim Peters9905b942003-03-20 20:53:32 +00002515
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002516 for (i = 0; i < 4; i++) {
2517 *d-- = *p++;
2518 }
2519 memcpy(&x, buf, 4);
2520 }
2521 else {
2522 memcpy(&x, p, 4);
2523 }
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00002524
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002525 return x;
2526 }
Tim Peters9905b942003-03-20 20:53:32 +00002527}
2528
2529double
2530_PyFloat_Unpack8(const unsigned char *p, int le)
2531{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002532 if (double_format == unknown_format) {
2533 unsigned char sign;
2534 int e;
2535 unsigned int fhi, flo;
2536 double x;
2537 int incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00002538
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002539 if (le) {
2540 p += 7;
2541 incr = -1;
2542 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002543
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002544 /* First byte */
2545 sign = (*p >> 7) & 1;
2546 e = (*p & 0x7F) << 4;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002547
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002548 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002549
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002550 /* Second byte */
2551 e |= (*p >> 4) & 0xF;
2552 fhi = (*p & 0xF) << 24;
2553 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002554
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002555 if (e == 2047) {
2556 PyErr_SetString(
2557 PyExc_ValueError,
2558 "can't unpack IEEE 754 special value "
2559 "on non-IEEE platform");
2560 return -1.0;
2561 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002562
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002563 /* Third byte */
2564 fhi |= *p << 16;
2565 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002566
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002567 /* Fourth byte */
2568 fhi |= *p << 8;
2569 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002570
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002571 /* Fifth byte */
2572 fhi |= *p;
2573 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002574
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002575 /* Sixth byte */
2576 flo = *p << 16;
2577 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002578
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002579 /* Seventh byte */
2580 flo |= *p << 8;
2581 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002582
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002583 /* Eighth byte */
2584 flo |= *p;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002585
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002586 x = (double)fhi + (double)flo / 16777216.0; /* 2**24 */
2587 x /= 268435456.0; /* 2**28 */
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002588
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002589 if (e == 0)
2590 e = -1022;
2591 else {
2592 x += 1.0;
2593 e -= 1023;
2594 }
2595 x = ldexp(x, e);
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002596
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002597 if (sign)
2598 x = -x;
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00002599
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002600 return x;
2601 }
2602 else {
2603 double x;
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00002604
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002605 if ((double_format == ieee_little_endian_format && !le)
2606 || (double_format == ieee_big_endian_format && le)) {
2607 char buf[8];
2608 char *d = &buf[7];
2609 int i;
2610
2611 for (i = 0; i < 8; i++) {
2612 *d-- = *p++;
2613 }
2614 memcpy(&x, buf, 8);
2615 }
2616 else {
2617 memcpy(&x, p, 8);
2618 }
2619
2620 return x;
2621 }
Tim Peters9905b942003-03-20 20:53:32 +00002622}