blob: 77b10051a7ad3f7bf48e6b58339e9a827029a188 [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002/* Float object implementation */
3
Guido van Rossum2a9096b1990-10-21 22:15:08 +00004/* XXX There should be overflow checks here, but it's hard to check
5 for any kind of float exception without losing portability. */
6
Guido van Rossumc0b618a1997-05-02 03:12:38 +00007#include "Python.h"
Christian Heimesc94e2b52008-01-14 04:13:37 +00008#include "structseq.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00009
Guido van Rossum3f5da241990-12-20 15:06:42 +000010#include <ctype.h>
Christian Heimesdfdfaab2007-12-01 11:20:10 +000011#include <float.h>
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000012
Mark Dickinson7103aa42008-07-15 19:08:33 +000013#undef MAX
14#undef MIN
15#define MAX(x, y) ((x) < (y) ? (y) : (x))
16#define MIN(x, y) ((x) < (y) ? (x) : (y))
17
Neal Norwitz5f95a792008-01-25 08:04:16 +000018#ifdef _OSF_SOURCE
19/* OSF1 5.1 doesn't make this available with XOPEN_SOURCE_EXTENDED defined */
20extern int finite(double);
21#endif
22
Guido van Rossum93ad0df1997-05-13 21:00:42 +000023/* Special free list -- see comments for same code in intobject.c. */
Antoine Pitrouc83ea132010-05-09 14:46:46 +000024#define BLOCK_SIZE 1000 /* 1K less typical malloc overhead */
25#define BHEAD_SIZE 8 /* Enough for a 64-bit pointer */
26#define N_FLOATOBJECTS ((BLOCK_SIZE - BHEAD_SIZE) / sizeof(PyFloatObject))
Guido van Rossum3fce8831999-03-12 19:43:17 +000027
Guido van Rossum3fce8831999-03-12 19:43:17 +000028struct _floatblock {
Antoine Pitrouc83ea132010-05-09 14:46:46 +000029 struct _floatblock *next;
30 PyFloatObject objects[N_FLOATOBJECTS];
Guido van Rossum3fce8831999-03-12 19:43:17 +000031};
32
33typedef struct _floatblock PyFloatBlock;
34
35static PyFloatBlock *block_list = NULL;
36static PyFloatObject *free_list = NULL;
37
Guido van Rossum93ad0df1997-05-13 21:00:42 +000038static PyFloatObject *
Fred Drakefd99de62000-07-09 05:02:18 +000039fill_free_list(void)
Guido van Rossum93ad0df1997-05-13 21:00:42 +000040{
Antoine Pitrouc83ea132010-05-09 14:46:46 +000041 PyFloatObject *p, *q;
42 /* XXX Float blocks escape the object heap. Use PyObject_MALLOC ??? */
43 p = (PyFloatObject *) PyMem_MALLOC(sizeof(PyFloatBlock));
44 if (p == NULL)
45 return (PyFloatObject *) PyErr_NoMemory();
46 ((PyFloatBlock *)p)->next = block_list;
47 block_list = (PyFloatBlock *)p;
48 p = &((PyFloatBlock *)p)->objects[0];
49 q = p + N_FLOATOBJECTS;
50 while (--q > p)
51 Py_TYPE(q) = (struct _typeobject *)(q-1);
52 Py_TYPE(q) = NULL;
53 return p + N_FLOATOBJECTS - 1;
Guido van Rossum93ad0df1997-05-13 21:00:42 +000054}
55
Christian Heimesdfdfaab2007-12-01 11:20:10 +000056double
57PyFloat_GetMax(void)
58{
Antoine Pitrouc83ea132010-05-09 14:46:46 +000059 return DBL_MAX;
Christian Heimesdfdfaab2007-12-01 11:20:10 +000060}
61
62double
63PyFloat_GetMin(void)
64{
Antoine Pitrouc83ea132010-05-09 14:46:46 +000065 return DBL_MIN;
Christian Heimesdfdfaab2007-12-01 11:20:10 +000066}
67
Christian Heimes796fc312008-01-30 18:58:29 +000068static PyTypeObject FloatInfoType = {0, 0, 0, 0, 0, 0};
Christian Heimesc94e2b52008-01-14 04:13:37 +000069
70PyDoc_STRVAR(floatinfo__doc__,
Benjamin Petersonbf9ec9b2009-06-16 23:13:09 +000071"sys.float_info\n\
Christian Heimesc94e2b52008-01-14 04:13:37 +000072\n\
73A structseq holding information about the float type. It contains low level\n\
74information about the precision and internal representation. Please study\n\
75your system's :file:`float.h` for more information.");
76
77static PyStructSequence_Field floatinfo_fields[] = {
Antoine Pitrouc83ea132010-05-09 14:46:46 +000078 {"max", "DBL_MAX -- maximum representable finite float"},
79 {"max_exp", "DBL_MAX_EXP -- maximum int e such that radix**(e-1) "
80 "is representable"},
81 {"max_10_exp", "DBL_MAX_10_EXP -- maximum int e such that 10**e "
82 "is representable"},
83 {"min", "DBL_MIN -- Minimum positive normalizer float"},
84 {"min_exp", "DBL_MIN_EXP -- minimum int e such that radix**(e-1) "
85 "is a normalized float"},
86 {"min_10_exp", "DBL_MIN_10_EXP -- minimum int e such that 10**e is "
87 "a normalized"},
88 {"dig", "DBL_DIG -- digits"},
89 {"mant_dig", "DBL_MANT_DIG -- mantissa digits"},
90 {"epsilon", "DBL_EPSILON -- Difference between 1 and the next "
91 "representable float"},
92 {"radix", "FLT_RADIX -- radix of exponent"},
93 {"rounds", "FLT_ROUNDS -- addition rounds"},
94 {0}
Christian Heimesc94e2b52008-01-14 04:13:37 +000095};
96
97static PyStructSequence_Desc floatinfo_desc = {
Antoine Pitrouc83ea132010-05-09 14:46:46 +000098 "sys.float_info", /* name */
99 floatinfo__doc__, /* doc */
100 floatinfo_fields, /* fields */
101 11
Christian Heimesc94e2b52008-01-14 04:13:37 +0000102};
103
Christian Heimesdfdfaab2007-12-01 11:20:10 +0000104PyObject *
105PyFloat_GetInfo(void)
106{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000107 PyObject* floatinfo;
108 int pos = 0;
Christian Heimesdfdfaab2007-12-01 11:20:10 +0000109
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000110 floatinfo = PyStructSequence_New(&FloatInfoType);
111 if (floatinfo == NULL) {
112 return NULL;
113 }
Christian Heimesdfdfaab2007-12-01 11:20:10 +0000114
Christian Heimesc94e2b52008-01-14 04:13:37 +0000115#define SetIntFlag(flag) \
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000116 PyStructSequence_SET_ITEM(floatinfo, pos++, PyInt_FromLong(flag))
Christian Heimesc94e2b52008-01-14 04:13:37 +0000117#define SetDblFlag(flag) \
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000118 PyStructSequence_SET_ITEM(floatinfo, pos++, PyFloat_FromDouble(flag))
Christian Heimesdfdfaab2007-12-01 11:20:10 +0000119
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000120 SetDblFlag(DBL_MAX);
121 SetIntFlag(DBL_MAX_EXP);
122 SetIntFlag(DBL_MAX_10_EXP);
123 SetDblFlag(DBL_MIN);
124 SetIntFlag(DBL_MIN_EXP);
125 SetIntFlag(DBL_MIN_10_EXP);
126 SetIntFlag(DBL_DIG);
127 SetIntFlag(DBL_MANT_DIG);
128 SetDblFlag(DBL_EPSILON);
129 SetIntFlag(FLT_RADIX);
130 SetIntFlag(FLT_ROUNDS);
Christian Heimesc94e2b52008-01-14 04:13:37 +0000131#undef SetIntFlag
132#undef SetDblFlag
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000133
134 if (PyErr_Occurred()) {
135 Py_CLEAR(floatinfo);
136 return NULL;
137 }
138 return floatinfo;
Christian Heimesdfdfaab2007-12-01 11:20:10 +0000139}
140
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000141PyObject *
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000142PyFloat_FromDouble(double fval)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000143{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000144 register PyFloatObject *op;
145 if (free_list == NULL) {
146 if ((free_list = fill_free_list()) == NULL)
147 return NULL;
148 }
149 /* Inline PyObject_New */
150 op = free_list;
151 free_list = (PyFloatObject *)Py_TYPE(op);
152 PyObject_INIT(op, &PyFloat_Type);
153 op->ob_fval = fval;
154 return (PyObject *) op;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000155}
156
Tim Petersef14d732000-09-23 03:39:17 +0000157/**************************************************************************
158RED_FLAG 22-Sep-2000 tim
159PyFloat_FromString's pend argument is braindead. Prior to this RED_FLAG,
160
1611. If v was a regular string, *pend was set to point to its terminating
162 null byte. That's useless (the caller can find that without any
163 help from this function!).
164
1652. If v was a Unicode string, or an object convertible to a character
166 buffer, *pend was set to point into stack trash (the auto temp
167 vector holding the character buffer). That was downright dangerous.
168
169Since we can't change the interface of a public API function, pend is
170still supported but now *officially* useless: if pend is not NULL,
171*pend is set to NULL.
172**************************************************************************/
Barry Warsaw226ae6c1999-10-12 19:54:53 +0000173PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000174PyFloat_FromString(PyObject *v, char **pend)
Barry Warsaw226ae6c1999-10-12 19:54:53 +0000175{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000176 const char *s, *last, *end;
177 double x;
178 char buffer[256]; /* for errors */
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000179#ifdef Py_USING_UNICODE
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000180 char *s_buffer = NULL;
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000181#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000182 Py_ssize_t len;
183 PyObject *result = NULL;
Barry Warsaw226ae6c1999-10-12 19:54:53 +0000184
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000185 if (pend)
186 *pend = NULL;
187 if (PyString_Check(v)) {
188 s = PyString_AS_STRING(v);
189 len = PyString_GET_SIZE(v);
190 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000191#ifdef Py_USING_UNICODE
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000192 else if (PyUnicode_Check(v)) {
193 s_buffer = (char *)PyMem_MALLOC(PyUnicode_GET_SIZE(v)+1);
194 if (s_buffer == NULL)
195 return PyErr_NoMemory();
196 if (PyUnicode_EncodeDecimal(PyUnicode_AS_UNICODE(v),
197 PyUnicode_GET_SIZE(v),
198 s_buffer,
199 NULL))
200 goto error;
201 s = s_buffer;
202 len = strlen(s);
203 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000204#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000205 else if (PyObject_AsCharBuffer(v, &s, &len)) {
206 PyErr_SetString(PyExc_TypeError,
207 "float() argument must be a string or a number");
208 return NULL;
209 }
210 last = s + len;
Mark Dickinson6d6b2202009-04-26 16:04:05 +0000211
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000212 while (Py_ISSPACE(*s))
213 s++;
214 /* We don't care about overflow or underflow. If the platform
215 * supports them, infinities and signed zeroes (on underflow) are
216 * fine. */
217 x = PyOS_string_to_double(s, (char **)&end, NULL);
218 if (x == -1.0 && PyErr_Occurred())
219 goto error;
220 while (Py_ISSPACE(*end))
221 end++;
222 if (end == last)
223 result = PyFloat_FromDouble(x);
224 else {
225 PyOS_snprintf(buffer, sizeof(buffer),
226 "invalid literal for float(): %.200s", s);
227 PyErr_SetString(PyExc_ValueError, buffer);
228 result = NULL;
229 }
Mark Dickinson8568b192009-10-26 21:11:20 +0000230
231 error:
232#ifdef Py_USING_UNICODE
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000233 if (s_buffer)
234 PyMem_FREE(s_buffer);
Mark Dickinson8568b192009-10-26 21:11:20 +0000235#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000236 return result;
Barry Warsaw226ae6c1999-10-12 19:54:53 +0000237}
238
Guido van Rossum234f9421993-06-17 12:35:49 +0000239static void
Fred Drakefd99de62000-07-09 05:02:18 +0000240float_dealloc(PyFloatObject *op)
Guido van Rossum3132a5a1992-03-27 17:28:44 +0000241{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000242 if (PyFloat_CheckExact(op)) {
243 Py_TYPE(op) = (struct _typeobject *)free_list;
244 free_list = op;
245 }
246 else
247 Py_TYPE(op)->tp_free((PyObject *)op);
Guido van Rossum3132a5a1992-03-27 17:28:44 +0000248}
249
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000250double
Fred Drakefd99de62000-07-09 05:02:18 +0000251PyFloat_AsDouble(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000252{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000253 PyNumberMethods *nb;
254 PyFloatObject *fo;
255 double val;
Tim Petersd2364e82001-11-01 20:09:42 +0000256
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000257 if (op && PyFloat_Check(op))
258 return PyFloat_AS_DOUBLE((PyFloatObject*) op);
Tim Petersd2364e82001-11-01 20:09:42 +0000259
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000260 if (op == NULL) {
261 PyErr_BadArgument();
262 return -1;
263 }
Tim Petersd2364e82001-11-01 20:09:42 +0000264
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000265 if ((nb = Py_TYPE(op)->tp_as_number) == NULL || nb->nb_float == NULL) {
266 PyErr_SetString(PyExc_TypeError, "a float is required");
267 return -1;
268 }
Neil Schemenauer2c77e902002-11-18 16:06:21 +0000269
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000270 fo = (PyFloatObject*) (*nb->nb_float) (op);
271 if (fo == NULL)
272 return -1;
273 if (!PyFloat_Check(fo)) {
274 PyErr_SetString(PyExc_TypeError,
275 "nb_float should return float object");
276 return -1;
277 }
Tim Petersd2364e82001-11-01 20:09:42 +0000278
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000279 val = PyFloat_AS_DOUBLE(fo);
280 Py_DECREF(fo);
Tim Petersd2364e82001-11-01 20:09:42 +0000281
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000282 return val;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000283}
284
285/* Methods */
286
Neil Schemenauer32117e52001-01-04 01:44:34 +0000287/* Macro and helper that convert PyObject obj to a C double and store
288 the value in dbl; this replaces the functionality of the coercion
Tim Peters77d8a4f2001-12-11 20:31:34 +0000289 slot function. If conversion to double raises an exception, obj is
290 set to NULL, and the function invoking this macro returns NULL. If
291 obj is not of float, int or long type, Py_NotImplemented is incref'ed,
292 stored in obj, and returned from the function invoking this macro.
293*/
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000294#define CONVERT_TO_DOUBLE(obj, dbl) \
295 if (PyFloat_Check(obj)) \
296 dbl = PyFloat_AS_DOUBLE(obj); \
297 else if (convert_to_double(&(obj), &(dbl)) < 0) \
298 return obj;
Neil Schemenauer32117e52001-01-04 01:44:34 +0000299
300static int
Tim Peters9fffa3e2001-09-04 05:14:19 +0000301convert_to_double(PyObject **v, double *dbl)
Neil Schemenauer32117e52001-01-04 01:44:34 +0000302{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000303 register PyObject *obj = *v;
Tim Peters9fffa3e2001-09-04 05:14:19 +0000304
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000305 if (PyInt_Check(obj)) {
306 *dbl = (double)PyInt_AS_LONG(obj);
307 }
308 else if (PyLong_Check(obj)) {
309 *dbl = PyLong_AsDouble(obj);
310 if (*dbl == -1.0 && PyErr_Occurred()) {
311 *v = NULL;
312 return -1;
313 }
314 }
315 else {
316 Py_INCREF(Py_NotImplemented);
317 *v = Py_NotImplemented;
318 return -1;
319 }
320 return 0;
Neil Schemenauer32117e52001-01-04 01:44:34 +0000321}
322
Eric Smithcfaf79c2009-10-26 14:48:55 +0000323/* XXX PyFloat_AsString and PyFloat_AsReprString are deprecated:
Tim Peters97019e42001-11-28 22:43:45 +0000324 XXX they pass a char buffer without passing a length.
325*/
Guido van Rossum57072eb1999-12-23 19:00:28 +0000326void
Fred Drakefd99de62000-07-09 05:02:18 +0000327PyFloat_AsString(char *buf, PyFloatObject *v)
Guido van Rossum57072eb1999-12-23 19:00:28 +0000328{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000329 char *tmp = PyOS_double_to_string(v->ob_fval, 'g',
330 PyFloat_STR_PRECISION,
331 Py_DTSF_ADD_DOT_0, NULL);
332 strcpy(buf, tmp);
333 PyMem_Free(tmp);
Guido van Rossum57072eb1999-12-23 19:00:28 +0000334}
335
Tim Peters72f98e92001-05-08 15:19:57 +0000336void
337PyFloat_AsReprString(char *buf, PyFloatObject *v)
338{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000339 char * tmp = PyOS_double_to_string(v->ob_fval, 'r', 0,
340 Py_DTSF_ADD_DOT_0, NULL);
341 strcpy(buf, tmp);
342 PyMem_Free(tmp);
Tim Peters72f98e92001-05-08 15:19:57 +0000343}
344
Guido van Rossum3132a5a1992-03-27 17:28:44 +0000345/* ARGSUSED */
Guido van Rossum90933611991-06-07 16:10:43 +0000346static int
Fred Drakefd99de62000-07-09 05:02:18 +0000347float_print(PyFloatObject *v, FILE *fp, int flags)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000348{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000349 char *buf;
350 if (flags & Py_PRINT_RAW)
351 buf = PyOS_double_to_string(v->ob_fval,
352 'g', PyFloat_STR_PRECISION,
353 Py_DTSF_ADD_DOT_0, NULL);
354 else
355 buf = PyOS_double_to_string(v->ob_fval,
356 'r', 0, Py_DTSF_ADD_DOT_0, NULL);
357 Py_BEGIN_ALLOW_THREADS
358 fputs(buf, fp);
359 Py_END_ALLOW_THREADS
360 PyMem_Free(buf);
361 return 0;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000362}
363
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000364static PyObject *
Eric Smithcfaf79c2009-10-26 14:48:55 +0000365float_str_or_repr(PyFloatObject *v, int precision, char format_code)
366{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000367 PyObject *result;
368 char *buf = PyOS_double_to_string(PyFloat_AS_DOUBLE(v),
369 format_code, precision,
370 Py_DTSF_ADD_DOT_0,
371 NULL);
372 if (!buf)
373 return PyErr_NoMemory();
374 result = PyString_FromString(buf);
375 PyMem_Free(buf);
376 return result;
Eric Smithcfaf79c2009-10-26 14:48:55 +0000377}
378
379static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000380float_repr(PyFloatObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000381{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000382 return float_str_or_repr(v, 0, 'r');
Guido van Rossum57072eb1999-12-23 19:00:28 +0000383}
384
385static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000386float_str(PyFloatObject *v)
Guido van Rossum57072eb1999-12-23 19:00:28 +0000387{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000388 return float_str_or_repr(v, PyFloat_STR_PRECISION, 'g');
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000389}
390
Tim Peters307fa782004-09-23 08:06:40 +0000391/* Comparison is pretty much a nightmare. When comparing float to float,
392 * we do it as straightforwardly (and long-windedly) as conceivable, so
393 * that, e.g., Python x == y delivers the same result as the platform
394 * C x == y when x and/or y is a NaN.
395 * When mixing float with an integer type, there's no good *uniform* approach.
396 * Converting the double to an integer obviously doesn't work, since we
397 * may lose info from fractional bits. Converting the integer to a double
398 * also has two failure modes: (1) a long int may trigger overflow (too
399 * large to fit in the dynamic range of a C double); (2) even a C long may have
400 * more bits than fit in a C double (e.g., on a a 64-bit box long may have
401 * 63 bits of precision, but a C double probably has only 53), and then
402 * we can falsely claim equality when low-order integer bits are lost by
403 * coercion to double. So this part is painful too.
404 */
405
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000406static PyObject*
407float_richcompare(PyObject *v, PyObject *w, int op)
408{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000409 double i, j;
410 int r = 0;
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000411
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000412 assert(PyFloat_Check(v));
413 i = PyFloat_AS_DOUBLE(v);
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000414
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000415 /* Switch on the type of w. Set i and j to doubles to be compared,
416 * and op to the richcomp to use.
417 */
418 if (PyFloat_Check(w))
419 j = PyFloat_AS_DOUBLE(w);
Tim Peters307fa782004-09-23 08:06:40 +0000420
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000421 else if (!Py_IS_FINITE(i)) {
422 if (PyInt_Check(w) || PyLong_Check(w))
423 /* If i is an infinity, its magnitude exceeds any
424 * finite integer, so it doesn't matter which int we
425 * compare i with. If i is a NaN, similarly.
426 */
427 j = 0.0;
428 else
429 goto Unimplemented;
430 }
Tim Peters307fa782004-09-23 08:06:40 +0000431
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000432 else if (PyInt_Check(w)) {
433 long jj = PyInt_AS_LONG(w);
434 /* In the worst realistic case I can imagine, C double is a
435 * Cray single with 48 bits of precision, and long has 64
436 * bits.
437 */
Tim Peterse1c69b32004-09-23 19:22:41 +0000438#if SIZEOF_LONG > 6
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000439 unsigned long abs = (unsigned long)(jj < 0 ? -jj : jj);
440 if (abs >> 48) {
441 /* Needs more than 48 bits. Make it take the
442 * PyLong path.
443 */
444 PyObject *result;
445 PyObject *ww = PyLong_FromLong(jj);
Tim Peters307fa782004-09-23 08:06:40 +0000446
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000447 if (ww == NULL)
448 return NULL;
449 result = float_richcompare(v, ww, op);
450 Py_DECREF(ww);
451 return result;
452 }
Tim Peters307fa782004-09-23 08:06:40 +0000453#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000454 j = (double)jj;
455 assert((long)j == jj);
456 }
Tim Peters307fa782004-09-23 08:06:40 +0000457
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000458 else if (PyLong_Check(w)) {
459 int vsign = i == 0.0 ? 0 : i < 0.0 ? -1 : 1;
460 int wsign = _PyLong_Sign(w);
461 size_t nbits;
462 int exponent;
Tim Peters307fa782004-09-23 08:06:40 +0000463
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000464 if (vsign != wsign) {
465 /* Magnitudes are irrelevant -- the signs alone
466 * determine the outcome.
467 */
468 i = (double)vsign;
469 j = (double)wsign;
470 goto Compare;
471 }
472 /* The signs are the same. */
473 /* Convert w to a double if it fits. In particular, 0 fits. */
474 nbits = _PyLong_NumBits(w);
475 if (nbits == (size_t)-1 && PyErr_Occurred()) {
476 /* This long is so large that size_t isn't big enough
477 * to hold the # of bits. Replace with little doubles
478 * that give the same outcome -- w is so large that
479 * its magnitude must exceed the magnitude of any
480 * finite float.
481 */
482 PyErr_Clear();
483 i = (double)vsign;
484 assert(wsign != 0);
485 j = wsign * 2.0;
486 goto Compare;
487 }
488 if (nbits <= 48) {
489 j = PyLong_AsDouble(w);
490 /* It's impossible that <= 48 bits overflowed. */
491 assert(j != -1.0 || ! PyErr_Occurred());
492 goto Compare;
493 }
494 assert(wsign != 0); /* else nbits was 0 */
495 assert(vsign != 0); /* if vsign were 0, then since wsign is
496 * not 0, we would have taken the
497 * vsign != wsign branch at the start */
498 /* We want to work with non-negative numbers. */
499 if (vsign < 0) {
500 /* "Multiply both sides" by -1; this also swaps the
501 * comparator.
502 */
503 i = -i;
504 op = _Py_SwappedOp[op];
505 }
506 assert(i > 0.0);
507 (void) frexp(i, &exponent);
508 /* exponent is the # of bits in v before the radix point;
509 * we know that nbits (the # of bits in w) > 48 at this point
510 */
511 if (exponent < 0 || (size_t)exponent < nbits) {
512 i = 1.0;
513 j = 2.0;
514 goto Compare;
515 }
516 if ((size_t)exponent > nbits) {
517 i = 2.0;
518 j = 1.0;
519 goto Compare;
520 }
521 /* v and w have the same number of bits before the radix
522 * point. Construct two longs that have the same comparison
523 * outcome.
524 */
525 {
526 double fracpart;
527 double intpart;
528 PyObject *result = NULL;
529 PyObject *one = NULL;
530 PyObject *vv = NULL;
531 PyObject *ww = w;
Tim Peters307fa782004-09-23 08:06:40 +0000532
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000533 if (wsign < 0) {
534 ww = PyNumber_Negative(w);
535 if (ww == NULL)
536 goto Error;
537 }
538 else
539 Py_INCREF(ww);
Tim Peters307fa782004-09-23 08:06:40 +0000540
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000541 fracpart = modf(i, &intpart);
542 vv = PyLong_FromDouble(intpart);
543 if (vv == NULL)
544 goto Error;
Tim Peters307fa782004-09-23 08:06:40 +0000545
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000546 if (fracpart != 0.0) {
547 /* Shift left, and or a 1 bit into vv
548 * to represent the lost fraction.
549 */
550 PyObject *temp;
Tim Peters307fa782004-09-23 08:06:40 +0000551
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000552 one = PyInt_FromLong(1);
553 if (one == NULL)
554 goto Error;
Tim Peters307fa782004-09-23 08:06:40 +0000555
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000556 temp = PyNumber_Lshift(ww, one);
557 if (temp == NULL)
558 goto Error;
559 Py_DECREF(ww);
560 ww = temp;
Tim Peters307fa782004-09-23 08:06:40 +0000561
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000562 temp = PyNumber_Lshift(vv, one);
563 if (temp == NULL)
564 goto Error;
565 Py_DECREF(vv);
566 vv = temp;
Tim Peters307fa782004-09-23 08:06:40 +0000567
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000568 temp = PyNumber_Or(vv, one);
569 if (temp == NULL)
570 goto Error;
571 Py_DECREF(vv);
572 vv = temp;
573 }
Tim Peters307fa782004-09-23 08:06:40 +0000574
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000575 r = PyObject_RichCompareBool(vv, ww, op);
576 if (r < 0)
577 goto Error;
578 result = PyBool_FromLong(r);
579 Error:
580 Py_XDECREF(vv);
581 Py_XDECREF(ww);
582 Py_XDECREF(one);
583 return result;
584 }
585 } /* else if (PyLong_Check(w)) */
Tim Peters307fa782004-09-23 08:06:40 +0000586
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000587 else /* w isn't float, int, or long */
588 goto Unimplemented;
Tim Peters307fa782004-09-23 08:06:40 +0000589
590 Compare:
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000591 PyFPE_START_PROTECT("richcompare", return NULL)
592 switch (op) {
593 case Py_EQ:
594 r = i == j;
595 break;
596 case Py_NE:
597 r = i != j;
598 break;
599 case Py_LE:
600 r = i <= j;
601 break;
602 case Py_GE:
603 r = i >= j;
604 break;
605 case Py_LT:
606 r = i < j;
607 break;
608 case Py_GT:
609 r = i > j;
610 break;
611 }
612 PyFPE_END_PROTECT(r)
613 return PyBool_FromLong(r);
Tim Peters307fa782004-09-23 08:06:40 +0000614
615 Unimplemented:
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000616 Py_INCREF(Py_NotImplemented);
617 return Py_NotImplemented;
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000618}
619
Guido van Rossum9bfef441993-03-29 10:43:31 +0000620static long
Fred Drakefd99de62000-07-09 05:02:18 +0000621float_hash(PyFloatObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000622{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000623 return _Py_HashDouble(v->ob_fval);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000624}
625
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000626static PyObject *
Neil Schemenauer32117e52001-01-04 01:44:34 +0000627float_add(PyObject *v, PyObject *w)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000628{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000629 double a,b;
630 CONVERT_TO_DOUBLE(v, a);
631 CONVERT_TO_DOUBLE(w, b);
632 PyFPE_START_PROTECT("add", return 0)
633 a = a + b;
634 PyFPE_END_PROTECT(a)
635 return PyFloat_FromDouble(a);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000636}
637
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000638static PyObject *
Neil Schemenauer32117e52001-01-04 01:44:34 +0000639float_sub(PyObject *v, PyObject *w)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000640{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000641 double a,b;
642 CONVERT_TO_DOUBLE(v, a);
643 CONVERT_TO_DOUBLE(w, b);
644 PyFPE_START_PROTECT("subtract", return 0)
645 a = a - b;
646 PyFPE_END_PROTECT(a)
647 return PyFloat_FromDouble(a);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000648}
649
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000650static PyObject *
Neil Schemenauer32117e52001-01-04 01:44:34 +0000651float_mul(PyObject *v, PyObject *w)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000652{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000653 double a,b;
654 CONVERT_TO_DOUBLE(v, a);
655 CONVERT_TO_DOUBLE(w, b);
656 PyFPE_START_PROTECT("multiply", return 0)
657 a = a * b;
658 PyFPE_END_PROTECT(a)
659 return PyFloat_FromDouble(a);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000660}
661
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000662static PyObject *
Neil Schemenauer32117e52001-01-04 01:44:34 +0000663float_div(PyObject *v, PyObject *w)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000664{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000665 double a,b;
666 CONVERT_TO_DOUBLE(v, a);
667 CONVERT_TO_DOUBLE(w, b);
Christian Heimes6f341092008-04-18 23:13:07 +0000668#ifdef Py_NAN
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000669 if (b == 0.0) {
670 PyErr_SetString(PyExc_ZeroDivisionError,
671 "float division by zero");
672 return NULL;
673 }
Christian Heimes6f341092008-04-18 23:13:07 +0000674#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000675 PyFPE_START_PROTECT("divide", return 0)
676 a = a / b;
677 PyFPE_END_PROTECT(a)
678 return PyFloat_FromDouble(a);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000679}
680
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000681static PyObject *
Guido van Rossum393661d2001-08-31 17:40:15 +0000682float_classic_div(PyObject *v, PyObject *w)
683{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000684 double a,b;
685 CONVERT_TO_DOUBLE(v, a);
686 CONVERT_TO_DOUBLE(w, b);
687 if (Py_DivisionWarningFlag >= 2 &&
688 PyErr_Warn(PyExc_DeprecationWarning, "classic float division") < 0)
689 return NULL;
Christian Heimes6f341092008-04-18 23:13:07 +0000690#ifdef Py_NAN
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000691 if (b == 0.0) {
692 PyErr_SetString(PyExc_ZeroDivisionError,
693 "float division by zero");
694 return NULL;
695 }
Christian Heimes6f341092008-04-18 23:13:07 +0000696#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000697 PyFPE_START_PROTECT("divide", return 0)
698 a = a / b;
699 PyFPE_END_PROTECT(a)
700 return PyFloat_FromDouble(a);
Guido van Rossum393661d2001-08-31 17:40:15 +0000701}
702
703static PyObject *
Neil Schemenauer32117e52001-01-04 01:44:34 +0000704float_rem(PyObject *v, PyObject *w)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000705{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000706 double vx, wx;
707 double mod;
708 CONVERT_TO_DOUBLE(v, vx);
709 CONVERT_TO_DOUBLE(w, wx);
Christian Heimes6f341092008-04-18 23:13:07 +0000710#ifdef Py_NAN
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000711 if (wx == 0.0) {
712 PyErr_SetString(PyExc_ZeroDivisionError,
713 "float modulo");
714 return NULL;
715 }
Christian Heimes6f341092008-04-18 23:13:07 +0000716#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000717 PyFPE_START_PROTECT("modulo", return 0)
718 mod = fmod(vx, wx);
Mark Dickinsonecf8ec62010-12-04 12:30:41 +0000719 if (mod) {
720 /* ensure the remainder has the same sign as the denominator */
721 if ((wx < 0) != (mod < 0)) {
722 mod += wx;
723 }
724 }
725 else {
726 /* the remainder is zero, and in the presence of signed zeroes
727 fmod returns different results across platforms; ensure
728 it has the same sign as the denominator; we'd like to do
729 "mod = wx * 0.0", but that may get optimized away */
730 mod *= mod; /* hide "mod = +0" from optimizer */
731 if (wx < 0.0)
732 mod = -mod;
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000733 }
734 PyFPE_END_PROTECT(mod)
735 return PyFloat_FromDouble(mod);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000736}
737
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000738static PyObject *
Neil Schemenauer32117e52001-01-04 01:44:34 +0000739float_divmod(PyObject *v, PyObject *w)
Guido van Rossumeba1b5e1991-05-05 20:07:00 +0000740{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000741 double vx, wx;
742 double div, mod, floordiv;
743 CONVERT_TO_DOUBLE(v, vx);
744 CONVERT_TO_DOUBLE(w, wx);
745 if (wx == 0.0) {
746 PyErr_SetString(PyExc_ZeroDivisionError, "float divmod()");
747 return NULL;
748 }
749 PyFPE_START_PROTECT("divmod", return 0)
750 mod = fmod(vx, wx);
751 /* fmod is typically exact, so vx-mod is *mathematically* an
752 exact multiple of wx. But this is fp arithmetic, and fp
753 vx - mod is an approximation; the result is that div may
754 not be an exact integral value after the division, although
755 it will always be very close to one.
756 */
757 div = (vx - mod) / wx;
758 if (mod) {
759 /* ensure the remainder has the same sign as the denominator */
760 if ((wx < 0) != (mod < 0)) {
761 mod += wx;
762 div -= 1.0;
763 }
764 }
765 else {
766 /* the remainder is zero, and in the presence of signed zeroes
767 fmod returns different results across platforms; ensure
768 it has the same sign as the denominator; we'd like to do
769 "mod = wx * 0.0", but that may get optimized away */
770 mod *= mod; /* hide "mod = +0" from optimizer */
771 if (wx < 0.0)
772 mod = -mod;
773 }
774 /* snap quotient to nearest integral value */
775 if (div) {
776 floordiv = floor(div);
777 if (div - floordiv > 0.5)
778 floordiv += 1.0;
779 }
780 else {
781 /* div is zero - get the same sign as the true quotient */
782 div *= div; /* hide "div = +0" from optimizers */
783 floordiv = div * vx / wx; /* zero w/ sign of vx/wx */
784 }
785 PyFPE_END_PROTECT(floordiv)
786 return Py_BuildValue("(dd)", floordiv, mod);
Guido van Rossumeba1b5e1991-05-05 20:07:00 +0000787}
788
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000789static PyObject *
Tim Peters63a35712001-12-11 19:57:24 +0000790float_floor_div(PyObject *v, PyObject *w)
791{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000792 PyObject *t, *r;
Tim Peters63a35712001-12-11 19:57:24 +0000793
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000794 t = float_divmod(v, w);
795 if (t == NULL || t == Py_NotImplemented)
796 return t;
797 assert(PyTuple_CheckExact(t));
798 r = PyTuple_GET_ITEM(t, 0);
799 Py_INCREF(r);
800 Py_DECREF(t);
801 return r;
Tim Peters63a35712001-12-11 19:57:24 +0000802}
803
Mark Dickinson99d652e2009-12-30 12:12:23 +0000804/* determine whether x is an odd integer or not; assumes that
805 x is not an infinity or nan. */
806#define DOUBLE_IS_ODD_INTEGER(x) (fmod(fabs(x), 2.0) == 1.0)
807
Tim Peters63a35712001-12-11 19:57:24 +0000808static PyObject *
Neil Schemenauer32117e52001-01-04 01:44:34 +0000809float_pow(PyObject *v, PyObject *w, PyObject *z)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000810{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000811 double iv, iw, ix;
812 int negate_result = 0;
Tim Peters32f453e2001-09-03 08:35:41 +0000813
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000814 if ((PyObject *)z != Py_None) {
815 PyErr_SetString(PyExc_TypeError, "pow() 3rd argument not "
816 "allowed unless all arguments are integers");
817 return NULL;
818 }
Tim Peters32f453e2001-09-03 08:35:41 +0000819
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000820 CONVERT_TO_DOUBLE(v, iv);
821 CONVERT_TO_DOUBLE(w, iw);
Tim Petersc54d1902000-10-06 00:36:09 +0000822
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000823 /* Sort out special cases here instead of relying on pow() */
824 if (iw == 0) { /* v**0 is 1, even 0**0 */
825 return PyFloat_FromDouble(1.0);
826 }
827 if (Py_IS_NAN(iv)) { /* nan**w = nan, unless w == 0 */
828 return PyFloat_FromDouble(iv);
829 }
830 if (Py_IS_NAN(iw)) { /* v**nan = nan, unless v == 1; 1**nan = 1 */
831 return PyFloat_FromDouble(iv == 1.0 ? 1.0 : iw);
832 }
833 if (Py_IS_INFINITY(iw)) {
834 /* v**inf is: 0.0 if abs(v) < 1; 1.0 if abs(v) == 1; inf if
835 * abs(v) > 1 (including case where v infinite)
836 *
837 * v**-inf is: inf if abs(v) < 1; 1.0 if abs(v) == 1; 0.0 if
838 * abs(v) > 1 (including case where v infinite)
839 */
840 iv = fabs(iv);
841 if (iv == 1.0)
842 return PyFloat_FromDouble(1.0);
843 else if ((iw > 0.0) == (iv > 1.0))
844 return PyFloat_FromDouble(fabs(iw)); /* return inf */
845 else
846 return PyFloat_FromDouble(0.0);
847 }
848 if (Py_IS_INFINITY(iv)) {
849 /* (+-inf)**w is: inf for w positive, 0 for w negative; in
850 * both cases, we need to add the appropriate sign if w is
851 * an odd integer.
852 */
853 int iw_is_odd = DOUBLE_IS_ODD_INTEGER(iw);
854 if (iw > 0.0)
855 return PyFloat_FromDouble(iw_is_odd ? iv : fabs(iv));
856 else
857 return PyFloat_FromDouble(iw_is_odd ?
858 copysign(0.0, iv) : 0.0);
859 }
860 if (iv == 0.0) { /* 0**w is: 0 for w positive, 1 for w zero
861 (already dealt with above), and an error
862 if w is negative. */
863 int iw_is_odd = DOUBLE_IS_ODD_INTEGER(iw);
864 if (iw < 0.0) {
865 PyErr_SetString(PyExc_ZeroDivisionError,
866 "0.0 cannot be raised to a "
867 "negative power");
868 return NULL;
869 }
870 /* use correct sign if iw is odd */
871 return PyFloat_FromDouble(iw_is_odd ? iv : 0.0);
872 }
Mark Dickinson99d652e2009-12-30 12:12:23 +0000873
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000874 if (iv < 0.0) {
875 /* Whether this is an error is a mess, and bumps into libm
876 * bugs so we have to figure it out ourselves.
877 */
878 if (iw != floor(iw)) {
879 PyErr_SetString(PyExc_ValueError, "negative number "
880 "cannot be raised to a fractional power");
881 return NULL;
882 }
883 /* iw is an exact integer, albeit perhaps a very large
884 * one. Replace iv by its absolute value and remember
885 * to negate the pow result if iw is odd.
886 */
887 iv = -iv;
888 negate_result = DOUBLE_IS_ODD_INTEGER(iw);
889 }
Mark Dickinson99d652e2009-12-30 12:12:23 +0000890
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000891 if (iv == 1.0) { /* 1**w is 1, even 1**inf and 1**nan */
892 /* (-1) ** large_integer also ends up here. Here's an
893 * extract from the comments for the previous
894 * implementation explaining why this special case is
895 * necessary:
896 *
897 * -1 raised to an exact integer should never be exceptional.
898 * Alas, some libms (chiefly glibc as of early 2003) return
899 * NaN and set EDOM on pow(-1, large_int) if the int doesn't
900 * happen to be representable in a *C* integer. That's a
901 * bug.
902 */
903 return PyFloat_FromDouble(negate_result ? -1.0 : 1.0);
904 }
Mark Dickinson99d652e2009-12-30 12:12:23 +0000905
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000906 /* Now iv and iw are finite, iw is nonzero, and iv is
907 * positive and not equal to 1.0. We finally allow
908 * the platform pow to step in and do the rest.
909 */
910 errno = 0;
911 PyFPE_START_PROTECT("pow", return NULL)
912 ix = pow(iv, iw);
913 PyFPE_END_PROTECT(ix)
914 Py_ADJUST_ERANGE1(ix);
915 if (negate_result)
916 ix = -ix;
Mark Dickinson99d652e2009-12-30 12:12:23 +0000917
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000918 if (errno != 0) {
919 /* We don't expect any errno value other than ERANGE, but
920 * the range of libm bugs appears unbounded.
921 */
922 PyErr_SetFromErrno(errno == ERANGE ? PyExc_OverflowError :
923 PyExc_ValueError);
924 return NULL;
925 }
926 return PyFloat_FromDouble(ix);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000927}
928
Mark Dickinson99d652e2009-12-30 12:12:23 +0000929#undef DOUBLE_IS_ODD_INTEGER
930
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000931static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000932float_neg(PyFloatObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000933{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000934 return PyFloat_FromDouble(-v->ob_fval);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000935}
936
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000937static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000938float_abs(PyFloatObject *v)
Guido van Rossumeba1b5e1991-05-05 20:07:00 +0000939{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000940 return PyFloat_FromDouble(fabs(v->ob_fval));
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000941}
942
Guido van Rossum50b4ef61991-05-14 11:57:01 +0000943static int
Fred Drakefd99de62000-07-09 05:02:18 +0000944float_nonzero(PyFloatObject *v)
Guido van Rossum50b4ef61991-05-14 11:57:01 +0000945{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000946 return v->ob_fval != 0.0;
Guido van Rossum50b4ef61991-05-14 11:57:01 +0000947}
948
Guido van Rossum234f9421993-06-17 12:35:49 +0000949static int
Fred Drakefd99de62000-07-09 05:02:18 +0000950float_coerce(PyObject **pv, PyObject **pw)
Guido van Rossume6eefc21992-08-14 12:06:52 +0000951{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000952 if (PyInt_Check(*pw)) {
953 long x = PyInt_AsLong(*pw);
954 *pw = PyFloat_FromDouble((double)x);
955 Py_INCREF(*pv);
956 return 0;
957 }
958 else if (PyLong_Check(*pw)) {
959 double x = PyLong_AsDouble(*pw);
960 if (x == -1.0 && PyErr_Occurred())
961 return -1;
962 *pw = PyFloat_FromDouble(x);
963 Py_INCREF(*pv);
964 return 0;
965 }
966 else if (PyFloat_Check(*pw)) {
967 Py_INCREF(*pv);
968 Py_INCREF(*pw);
969 return 0;
970 }
971 return 1; /* Can't do it */
Guido van Rossume6eefc21992-08-14 12:06:52 +0000972}
973
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000974static PyObject *
Christian Heimes6f341092008-04-18 23:13:07 +0000975float_is_integer(PyObject *v)
976{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000977 double x = PyFloat_AsDouble(v);
978 PyObject *o;
979
980 if (x == -1.0 && PyErr_Occurred())
981 return NULL;
982 if (!Py_IS_FINITE(x))
983 Py_RETURN_FALSE;
984 errno = 0;
985 PyFPE_START_PROTECT("is_integer", return NULL)
986 o = (floor(x) == x) ? Py_True : Py_False;
987 PyFPE_END_PROTECT(x)
988 if (errno != 0) {
989 PyErr_SetFromErrno(errno == ERANGE ? PyExc_OverflowError :
990 PyExc_ValueError);
991 return NULL;
992 }
993 Py_INCREF(o);
994 return o;
Christian Heimes6f341092008-04-18 23:13:07 +0000995}
996
997#if 0
998static PyObject *
999float_is_inf(PyObject *v)
1000{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001001 double x = PyFloat_AsDouble(v);
1002 if (x == -1.0 && PyErr_Occurred())
1003 return NULL;
1004 return PyBool_FromLong((long)Py_IS_INFINITY(x));
Christian Heimes6f341092008-04-18 23:13:07 +00001005}
1006
1007static PyObject *
1008float_is_nan(PyObject *v)
1009{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001010 double x = PyFloat_AsDouble(v);
1011 if (x == -1.0 && PyErr_Occurred())
1012 return NULL;
1013 return PyBool_FromLong((long)Py_IS_NAN(x));
Christian Heimes6f341092008-04-18 23:13:07 +00001014}
1015
1016static PyObject *
1017float_is_finite(PyObject *v)
1018{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001019 double x = PyFloat_AsDouble(v);
1020 if (x == -1.0 && PyErr_Occurred())
1021 return NULL;
1022 return PyBool_FromLong((long)Py_IS_FINITE(x));
Christian Heimes6f341092008-04-18 23:13:07 +00001023}
1024#endif
1025
1026static PyObject *
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00001027float_trunc(PyObject *v)
Guido van Rossum1899c2e1992-09-12 11:09:23 +00001028{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001029 double x = PyFloat_AsDouble(v);
1030 double wholepart; /* integral portion of x, rounded toward 0 */
Tim Peters7321ec42001-07-26 20:02:17 +00001031
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001032 (void)modf(x, &wholepart);
1033 /* Try to get out cheap if this fits in a Python int. The attempt
1034 * to cast to long must be protected, as C doesn't define what
1035 * happens if the double is too big to fit in a long. Some rare
1036 * systems raise an exception then (RISCOS was mentioned as one,
1037 * and someone using a non-default option on Sun also bumped into
1038 * that). Note that checking for >= and <= LONG_{MIN,MAX} would
1039 * still be vulnerable: if a long has more bits of precision than
1040 * a double, casting MIN/MAX to double may yield an approximation,
1041 * and if that's rounded up, then, e.g., wholepart=LONG_MAX+1 would
1042 * yield true from the C expression wholepart<=LONG_MAX, despite
1043 * that wholepart is actually greater than LONG_MAX.
1044 */
1045 if (LONG_MIN < wholepart && wholepart < LONG_MAX) {
1046 const long aslong = (long)wholepart;
1047 return PyInt_FromLong(aslong);
1048 }
1049 return PyLong_FromDouble(wholepart);
Guido van Rossum1899c2e1992-09-12 11:09:23 +00001050}
1051
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001052static PyObject *
Amaury Forgeot d'Arcd3ffb892008-09-09 07:24:30 +00001053float_long(PyObject *v)
1054{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001055 double x = PyFloat_AsDouble(v);
1056 return PyLong_FromDouble(x);
Amaury Forgeot d'Arcd3ffb892008-09-09 07:24:30 +00001057}
1058
Mark Dickinsonbd15a062009-11-18 19:33:35 +00001059/* _Py_double_round: rounds a finite nonzero double to the closest multiple of
1060 10**-ndigits; here ndigits is within reasonable bounds (typically, -308 <=
1061 ndigits <= 323). Returns a Python float, or sets a Python error and
1062 returns NULL on failure (OverflowError and memory errors are possible). */
1063
1064#ifndef PY_NO_SHORT_FLOAT_REPR
1065/* version of _Py_double_round that uses the correctly-rounded string<->double
1066 conversions from Python/dtoa.c */
1067
1068/* FIVE_POW_LIMIT is the largest k such that 5**k is exactly representable as
1069 a double. Since we're using the code in Python/dtoa.c, it should be safe
1070 to assume that C doubles are IEEE 754 binary64 format. To be on the safe
1071 side, we check this. */
1072#if DBL_MANT_DIG == 53
1073#define FIVE_POW_LIMIT 22
1074#else
1075#error "C doubles do not appear to be IEEE 754 binary64 format"
1076#endif
1077
1078PyObject *
1079_Py_double_round(double x, int ndigits) {
1080
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001081 double rounded, m;
1082 Py_ssize_t buflen, mybuflen=100;
1083 char *buf, *buf_end, shortbuf[100], *mybuf=shortbuf;
1084 int decpt, sign, val, halfway_case;
1085 PyObject *result = NULL;
Mark Dickinsonbd15a062009-11-18 19:33:35 +00001086
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001087 /* The basic idea is very simple: convert and round the double to a
1088 decimal string using _Py_dg_dtoa, then convert that decimal string
1089 back to a double with _Py_dg_strtod. There's one minor difficulty:
1090 Python 2.x expects round to do round-half-away-from-zero, while
1091 _Py_dg_dtoa does round-half-to-even. So we need some way to detect
1092 and correct the halfway cases.
Mark Dickinsonbd15a062009-11-18 19:33:35 +00001093
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001094 Detection: a halfway value has the form k * 0.5 * 10**-ndigits for
1095 some odd integer k. Or in other words, a rational number x is
1096 exactly halfway between two multiples of 10**-ndigits if its
1097 2-valuation is exactly -ndigits-1 and its 5-valuation is at least
1098 -ndigits. For ndigits >= 0 the latter condition is automatically
1099 satisfied for a binary float x, since any such float has
1100 nonnegative 5-valuation. For 0 > ndigits >= -22, x needs to be an
1101 integral multiple of 5**-ndigits; we can check this using fmod.
1102 For -22 > ndigits, there are no halfway cases: 5**23 takes 54 bits
1103 to represent exactly, so any odd multiple of 0.5 * 10**n for n >=
1104 23 takes at least 54 bits of precision to represent exactly.
Mark Dickinsonbd15a062009-11-18 19:33:35 +00001105
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001106 Correction: a simple strategy for dealing with halfway cases is to
1107 (for the halfway cases only) call _Py_dg_dtoa with an argument of
1108 ndigits+1 instead of ndigits (thus doing an exact conversion to
1109 decimal), round the resulting string manually, and then convert
1110 back using _Py_dg_strtod.
1111 */
Mark Dickinsonbd15a062009-11-18 19:33:35 +00001112
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001113 /* nans, infinities and zeros should have already been dealt
1114 with by the caller (in this case, builtin_round) */
1115 assert(Py_IS_FINITE(x) && x != 0.0);
Mark Dickinsonbd15a062009-11-18 19:33:35 +00001116
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001117 /* find 2-valuation val of x */
1118 m = frexp(x, &val);
1119 while (m != floor(m)) {
1120 m *= 2.0;
1121 val--;
1122 }
Mark Dickinsonbd15a062009-11-18 19:33:35 +00001123
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001124 /* determine whether this is a halfway case */
1125 if (val == -ndigits-1) {
1126 if (ndigits >= 0)
1127 halfway_case = 1;
1128 else if (ndigits >= -FIVE_POW_LIMIT) {
1129 double five_pow = 1.0;
1130 int i;
1131 for (i=0; i < -ndigits; i++)
1132 five_pow *= 5.0;
1133 halfway_case = fmod(x, five_pow) == 0.0;
1134 }
1135 else
1136 halfway_case = 0;
1137 }
1138 else
1139 halfway_case = 0;
Mark Dickinsonbd15a062009-11-18 19:33:35 +00001140
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001141 /* round to a decimal string; use an extra place for halfway case */
1142 buf = _Py_dg_dtoa(x, 3, ndigits+halfway_case, &decpt, &sign, &buf_end);
1143 if (buf == NULL) {
1144 PyErr_NoMemory();
1145 return NULL;
1146 }
1147 buflen = buf_end - buf;
Mark Dickinsonbd15a062009-11-18 19:33:35 +00001148
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001149 /* in halfway case, do the round-half-away-from-zero manually */
1150 if (halfway_case) {
1151 int i, carry;
1152 /* sanity check: _Py_dg_dtoa should not have stripped
1153 any zeros from the result: there should be exactly
1154 ndigits+1 places following the decimal point, and
1155 the last digit in the buffer should be a '5'.*/
1156 assert(buflen - decpt == ndigits+1);
1157 assert(buf[buflen-1] == '5');
Mark Dickinsonbd15a062009-11-18 19:33:35 +00001158
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001159 /* increment and shift right at the same time. */
1160 decpt += 1;
1161 carry = 1;
1162 for (i=buflen-1; i-- > 0;) {
1163 carry += buf[i] - '0';
1164 buf[i+1] = carry % 10 + '0';
1165 carry /= 10;
1166 }
1167 buf[0] = carry + '0';
1168 }
Mark Dickinsonbd15a062009-11-18 19:33:35 +00001169
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001170 /* Get new buffer if shortbuf is too small. Space needed <= buf_end -
1171 buf + 8: (1 extra for '0', 1 for sign, 5 for exp, 1 for '\0'). */
1172 if (buflen + 8 > mybuflen) {
1173 mybuflen = buflen+8;
1174 mybuf = (char *)PyMem_Malloc(mybuflen);
1175 if (mybuf == NULL) {
1176 PyErr_NoMemory();
1177 goto exit;
1178 }
1179 }
1180 /* copy buf to mybuf, adding exponent, sign and leading 0 */
1181 PyOS_snprintf(mybuf, mybuflen, "%s0%se%d", (sign ? "-" : ""),
1182 buf, decpt - (int)buflen);
Mark Dickinsonbd15a062009-11-18 19:33:35 +00001183
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001184 /* and convert the resulting string back to a double */
1185 errno = 0;
1186 rounded = _Py_dg_strtod(mybuf, NULL);
1187 if (errno == ERANGE && fabs(rounded) >= 1.)
1188 PyErr_SetString(PyExc_OverflowError,
1189 "rounded value too large to represent");
1190 else
1191 result = PyFloat_FromDouble(rounded);
Mark Dickinsonbd15a062009-11-18 19:33:35 +00001192
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001193 /* done computing value; now clean up */
1194 if (mybuf != shortbuf)
1195 PyMem_Free(mybuf);
Mark Dickinsonbd15a062009-11-18 19:33:35 +00001196 exit:
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001197 _Py_dg_freedtoa(buf);
1198 return result;
Mark Dickinsonbd15a062009-11-18 19:33:35 +00001199}
1200
1201#undef FIVE_POW_LIMIT
1202
1203#else /* PY_NO_SHORT_FLOAT_REPR */
1204
1205/* fallback version, to be used when correctly rounded binary<->decimal
1206 conversions aren't available */
1207
1208PyObject *
1209_Py_double_round(double x, int ndigits) {
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001210 double pow1, pow2, y, z;
1211 if (ndigits >= 0) {
1212 if (ndigits > 22) {
1213 /* pow1 and pow2 are each safe from overflow, but
1214 pow1*pow2 ~= pow(10.0, ndigits) might overflow */
1215 pow1 = pow(10.0, (double)(ndigits-22));
1216 pow2 = 1e22;
1217 }
1218 else {
1219 pow1 = pow(10.0, (double)ndigits);
1220 pow2 = 1.0;
1221 }
1222 y = (x*pow1)*pow2;
1223 /* if y overflows, then rounded value is exactly x */
1224 if (!Py_IS_FINITE(y))
1225 return PyFloat_FromDouble(x);
1226 }
1227 else {
1228 pow1 = pow(10.0, (double)-ndigits);
1229 pow2 = 1.0; /* unused; silences a gcc compiler warning */
1230 y = x / pow1;
1231 }
Mark Dickinsonbd15a062009-11-18 19:33:35 +00001232
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001233 z = round(y);
1234 if (fabs(y-z) == 0.5)
1235 /* halfway between two integers; use round-away-from-zero */
1236 z = y + copysign(0.5, y);
Mark Dickinsonbd15a062009-11-18 19:33:35 +00001237
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001238 if (ndigits >= 0)
1239 z = (z / pow2) / pow1;
1240 else
1241 z *= pow1;
Mark Dickinsonbd15a062009-11-18 19:33:35 +00001242
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001243 /* if computation resulted in overflow, raise OverflowError */
1244 if (!Py_IS_FINITE(z)) {
1245 PyErr_SetString(PyExc_OverflowError,
1246 "overflow occurred during round");
1247 return NULL;
1248 }
Mark Dickinsonbd15a062009-11-18 19:33:35 +00001249
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001250 return PyFloat_FromDouble(z);
Mark Dickinsonbd15a062009-11-18 19:33:35 +00001251}
1252
1253#endif /* PY_NO_SHORT_FLOAT_REPR */
1254
Amaury Forgeot d'Arcd3ffb892008-09-09 07:24:30 +00001255static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001256float_float(PyObject *v)
Guido van Rossum1899c2e1992-09-12 11:09:23 +00001257{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001258 if (PyFloat_CheckExact(v))
1259 Py_INCREF(v);
1260 else
1261 v = PyFloat_FromDouble(((PyFloatObject *)v)->ob_fval);
1262 return v;
Guido van Rossum1899c2e1992-09-12 11:09:23 +00001263}
1264
Mark Dickinson7103aa42008-07-15 19:08:33 +00001265/* turn ASCII hex characters into integer values and vice versa */
1266
1267static char
1268char_from_hex(int x)
1269{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001270 assert(0 <= x && x < 16);
1271 return "0123456789abcdef"[x];
Mark Dickinson7103aa42008-07-15 19:08:33 +00001272}
1273
1274static int
1275hex_from_char(char c) {
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001276 int x;
1277 switch(c) {
1278 case '0':
1279 x = 0;
1280 break;
1281 case '1':
1282 x = 1;
1283 break;
1284 case '2':
1285 x = 2;
1286 break;
1287 case '3':
1288 x = 3;
1289 break;
1290 case '4':
1291 x = 4;
1292 break;
1293 case '5':
1294 x = 5;
1295 break;
1296 case '6':
1297 x = 6;
1298 break;
1299 case '7':
1300 x = 7;
1301 break;
1302 case '8':
1303 x = 8;
1304 break;
1305 case '9':
1306 x = 9;
1307 break;
1308 case 'a':
1309 case 'A':
1310 x = 10;
1311 break;
1312 case 'b':
1313 case 'B':
1314 x = 11;
1315 break;
1316 case 'c':
1317 case 'C':
1318 x = 12;
1319 break;
1320 case 'd':
1321 case 'D':
1322 x = 13;
1323 break;
1324 case 'e':
1325 case 'E':
1326 x = 14;
1327 break;
1328 case 'f':
1329 case 'F':
1330 x = 15;
1331 break;
1332 default:
1333 x = -1;
1334 break;
1335 }
1336 return x;
Mark Dickinson7103aa42008-07-15 19:08:33 +00001337}
1338
1339/* convert a float to a hexadecimal string */
1340
1341/* TOHEX_NBITS is DBL_MANT_DIG rounded up to the next integer
1342 of the form 4k+1. */
1343#define TOHEX_NBITS DBL_MANT_DIG + 3 - (DBL_MANT_DIG+2)%4
1344
1345static PyObject *
1346float_hex(PyObject *v)
1347{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001348 double x, m;
1349 int e, shift, i, si, esign;
1350 /* Space for 1+(TOHEX_NBITS-1)/4 digits, a decimal point, and the
1351 trailing NUL byte. */
1352 char s[(TOHEX_NBITS-1)/4+3];
Mark Dickinson7103aa42008-07-15 19:08:33 +00001353
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001354 CONVERT_TO_DOUBLE(v, x);
Mark Dickinson7103aa42008-07-15 19:08:33 +00001355
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001356 if (Py_IS_NAN(x) || Py_IS_INFINITY(x))
1357 return float_str((PyFloatObject *)v);
Mark Dickinson7103aa42008-07-15 19:08:33 +00001358
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001359 if (x == 0.0) {
Benjamin Petersoncf76d1f2010-07-02 19:41:39 +00001360 if (copysign(1.0, x) == -1.0)
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001361 return PyString_FromString("-0x0.0p+0");
1362 else
1363 return PyString_FromString("0x0.0p+0");
1364 }
Mark Dickinson7103aa42008-07-15 19:08:33 +00001365
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001366 m = frexp(fabs(x), &e);
1367 shift = 1 - MAX(DBL_MIN_EXP - e, 0);
1368 m = ldexp(m, shift);
1369 e -= shift;
Mark Dickinson7103aa42008-07-15 19:08:33 +00001370
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001371 si = 0;
1372 s[si] = char_from_hex((int)m);
1373 si++;
1374 m -= (int)m;
1375 s[si] = '.';
1376 si++;
1377 for (i=0; i < (TOHEX_NBITS-1)/4; i++) {
1378 m *= 16.0;
1379 s[si] = char_from_hex((int)m);
1380 si++;
1381 m -= (int)m;
1382 }
1383 s[si] = '\0';
Mark Dickinson7103aa42008-07-15 19:08:33 +00001384
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001385 if (e < 0) {
1386 esign = (int)'-';
1387 e = -e;
1388 }
1389 else
1390 esign = (int)'+';
Mark Dickinson7103aa42008-07-15 19:08:33 +00001391
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001392 if (x < 0.0)
1393 return PyString_FromFormat("-0x%sp%c%d", s, esign, e);
1394 else
1395 return PyString_FromFormat("0x%sp%c%d", s, esign, e);
Mark Dickinson7103aa42008-07-15 19:08:33 +00001396}
1397
1398PyDoc_STRVAR(float_hex_doc,
1399"float.hex() -> string\n\
1400\n\
1401Return a hexadecimal representation of a floating-point number.\n\
1402>>> (-0.1).hex()\n\
1403'-0x1.999999999999ap-4'\n\
1404>>> 3.14159.hex()\n\
1405'0x1.921f9f01b866ep+1'");
1406
Mark Dickinsonb1d45852009-05-11 15:33:08 +00001407/* Case-insensitive locale-independent string match used for nan and inf
1408 detection. t should be lower-case and null-terminated. Return a nonzero
1409 result if the first strlen(t) characters of s match t and 0 otherwise. */
1410
1411static int
1412case_insensitive_match(const char *s, const char *t)
1413{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001414 while(*t && Py_TOLOWER(*s) == *t) {
1415 s++;
1416 t++;
1417 }
1418 return *t ? 0 : 1;
Mark Dickinsonb1d45852009-05-11 15:33:08 +00001419}
1420
Mark Dickinson7103aa42008-07-15 19:08:33 +00001421/* Convert a hexadecimal string to a float. */
1422
1423static PyObject *
1424float_fromhex(PyObject *cls, PyObject *arg)
1425{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001426 PyObject *result_as_float, *result;
1427 double x;
1428 long exp, top_exp, lsb, key_digit;
1429 char *s, *coeff_start, *s_store, *coeff_end, *exp_start, *s_end;
1430 int half_eps, digit, round_up, sign=1;
1431 Py_ssize_t length, ndigits, fdigits, i;
Mark Dickinson7103aa42008-07-15 19:08:33 +00001432
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001433 /*
1434 * For the sake of simplicity and correctness, we impose an artificial
1435 * limit on ndigits, the total number of hex digits in the coefficient
1436 * The limit is chosen to ensure that, writing exp for the exponent,
1437 *
1438 * (1) if exp > LONG_MAX/2 then the value of the hex string is
1439 * guaranteed to overflow (provided it's nonzero)
1440 *
1441 * (2) if exp < LONG_MIN/2 then the value of the hex string is
1442 * guaranteed to underflow to 0.
1443 *
1444 * (3) if LONG_MIN/2 <= exp <= LONG_MAX/2 then there's no danger of
1445 * overflow in the calculation of exp and top_exp below.
1446 *
1447 * More specifically, ndigits is assumed to satisfy the following
1448 * inequalities:
1449 *
1450 * 4*ndigits <= DBL_MIN_EXP - DBL_MANT_DIG - LONG_MIN/2
1451 * 4*ndigits <= LONG_MAX/2 + 1 - DBL_MAX_EXP
1452 *
1453 * If either of these inequalities is not satisfied, a ValueError is
1454 * raised. Otherwise, write x for the value of the hex string, and
1455 * assume x is nonzero. Then
1456 *
1457 * 2**(exp-4*ndigits) <= |x| < 2**(exp+4*ndigits).
1458 *
1459 * Now if exp > LONG_MAX/2 then:
1460 *
1461 * exp - 4*ndigits >= LONG_MAX/2 + 1 - (LONG_MAX/2 + 1 - DBL_MAX_EXP)
1462 * = DBL_MAX_EXP
1463 *
1464 * so |x| >= 2**DBL_MAX_EXP, which is too large to be stored in C
1465 * double, so overflows. If exp < LONG_MIN/2, then
1466 *
1467 * exp + 4*ndigits <= LONG_MIN/2 - 1 + (
1468 * DBL_MIN_EXP - DBL_MANT_DIG - LONG_MIN/2)
1469 * = DBL_MIN_EXP - DBL_MANT_DIG - 1
1470 *
1471 * and so |x| < 2**(DBL_MIN_EXP-DBL_MANT_DIG-1), hence underflows to 0
1472 * when converted to a C double.
1473 *
1474 * It's easy to show that if LONG_MIN/2 <= exp <= LONG_MAX/2 then both
1475 * exp+4*ndigits and exp-4*ndigits are within the range of a long.
1476 */
Mark Dickinson7103aa42008-07-15 19:08:33 +00001477
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001478 if (PyString_AsStringAndSize(arg, &s, &length))
1479 return NULL;
1480 s_end = s + length;
Mark Dickinson7103aa42008-07-15 19:08:33 +00001481
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001482 /********************
1483 * Parse the string *
1484 ********************/
Mark Dickinson7103aa42008-07-15 19:08:33 +00001485
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001486 /* leading whitespace and optional sign */
1487 while (Py_ISSPACE(*s))
1488 s++;
1489 if (*s == '-') {
1490 s++;
1491 sign = -1;
1492 }
1493 else if (*s == '+')
1494 s++;
Mark Dickinson7103aa42008-07-15 19:08:33 +00001495
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001496 /* infinities and nans */
1497 if (*s == 'i' || *s == 'I') {
1498 if (!case_insensitive_match(s+1, "nf"))
1499 goto parse_error;
1500 s += 3;
1501 x = Py_HUGE_VAL;
1502 if (case_insensitive_match(s, "inity"))
1503 s += 5;
1504 goto finished;
1505 }
1506 if (*s == 'n' || *s == 'N') {
1507 if (!case_insensitive_match(s+1, "an"))
1508 goto parse_error;
1509 s += 3;
1510 x = Py_NAN;
1511 goto finished;
1512 }
Mark Dickinson7103aa42008-07-15 19:08:33 +00001513
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001514 /* [0x] */
1515 s_store = s;
1516 if (*s == '0') {
1517 s++;
1518 if (*s == 'x' || *s == 'X')
1519 s++;
1520 else
1521 s = s_store;
1522 }
Mark Dickinson7103aa42008-07-15 19:08:33 +00001523
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001524 /* coefficient: <integer> [. <fraction>] */
1525 coeff_start = s;
1526 while (hex_from_char(*s) >= 0)
1527 s++;
1528 s_store = s;
1529 if (*s == '.') {
1530 s++;
1531 while (hex_from_char(*s) >= 0)
1532 s++;
1533 coeff_end = s-1;
1534 }
1535 else
1536 coeff_end = s;
Mark Dickinson7103aa42008-07-15 19:08:33 +00001537
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001538 /* ndigits = total # of hex digits; fdigits = # after point */
1539 ndigits = coeff_end - coeff_start;
1540 fdigits = coeff_end - s_store;
1541 if (ndigits == 0)
1542 goto parse_error;
1543 if (ndigits > MIN(DBL_MIN_EXP - DBL_MANT_DIG - LONG_MIN/2,
1544 LONG_MAX/2 + 1 - DBL_MAX_EXP)/4)
1545 goto insane_length_error;
Mark Dickinson7103aa42008-07-15 19:08:33 +00001546
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001547 /* [p <exponent>] */
1548 if (*s == 'p' || *s == 'P') {
1549 s++;
1550 exp_start = s;
1551 if (*s == '-' || *s == '+')
1552 s++;
1553 if (!('0' <= *s && *s <= '9'))
1554 goto parse_error;
1555 s++;
1556 while ('0' <= *s && *s <= '9')
1557 s++;
1558 exp = strtol(exp_start, NULL, 10);
1559 }
1560 else
1561 exp = 0;
Mark Dickinson7103aa42008-07-15 19:08:33 +00001562
Mark Dickinson7103aa42008-07-15 19:08:33 +00001563/* for 0 <= j < ndigits, HEX_DIGIT(j) gives the jth most significant digit */
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001564#define HEX_DIGIT(j) hex_from_char(*((j) < fdigits ? \
1565 coeff_end-(j) : \
1566 coeff_end-1-(j)))
Mark Dickinson7103aa42008-07-15 19:08:33 +00001567
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001568 /*******************************************
1569 * Compute rounded value of the hex string *
1570 *******************************************/
Mark Dickinson7103aa42008-07-15 19:08:33 +00001571
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001572 /* Discard leading zeros, and catch extreme overflow and underflow */
1573 while (ndigits > 0 && HEX_DIGIT(ndigits-1) == 0)
1574 ndigits--;
1575 if (ndigits == 0 || exp < LONG_MIN/2) {
1576 x = 0.0;
1577 goto finished;
1578 }
1579 if (exp > LONG_MAX/2)
1580 goto overflow_error;
Mark Dickinson7103aa42008-07-15 19:08:33 +00001581
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001582 /* Adjust exponent for fractional part. */
1583 exp = exp - 4*((long)fdigits);
Mark Dickinson7103aa42008-07-15 19:08:33 +00001584
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001585 /* top_exp = 1 more than exponent of most sig. bit of coefficient */
1586 top_exp = exp + 4*((long)ndigits - 1);
1587 for (digit = HEX_DIGIT(ndigits-1); digit != 0; digit /= 2)
1588 top_exp++;
Mark Dickinson7103aa42008-07-15 19:08:33 +00001589
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001590 /* catch almost all nonextreme cases of overflow and underflow here */
1591 if (top_exp < DBL_MIN_EXP - DBL_MANT_DIG) {
1592 x = 0.0;
1593 goto finished;
1594 }
1595 if (top_exp > DBL_MAX_EXP)
1596 goto overflow_error;
Mark Dickinson7103aa42008-07-15 19:08:33 +00001597
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001598 /* lsb = exponent of least significant bit of the *rounded* value.
1599 This is top_exp - DBL_MANT_DIG unless result is subnormal. */
1600 lsb = MAX(top_exp, (long)DBL_MIN_EXP) - DBL_MANT_DIG;
Mark Dickinson7103aa42008-07-15 19:08:33 +00001601
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001602 x = 0.0;
1603 if (exp >= lsb) {
1604 /* no rounding required */
1605 for (i = ndigits-1; i >= 0; i--)
1606 x = 16.0*x + HEX_DIGIT(i);
1607 x = ldexp(x, (int)(exp));
1608 goto finished;
1609 }
1610 /* rounding required. key_digit is the index of the hex digit
1611 containing the first bit to be rounded away. */
1612 half_eps = 1 << (int)((lsb - exp - 1) % 4);
1613 key_digit = (lsb - exp - 1) / 4;
1614 for (i = ndigits-1; i > key_digit; i--)
1615 x = 16.0*x + HEX_DIGIT(i);
1616 digit = HEX_DIGIT(key_digit);
1617 x = 16.0*x + (double)(digit & (16-2*half_eps));
Mark Dickinson7103aa42008-07-15 19:08:33 +00001618
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001619 /* round-half-even: round up if bit lsb-1 is 1 and at least one of
1620 bits lsb, lsb-2, lsb-3, lsb-4, ... is 1. */
1621 if ((digit & half_eps) != 0) {
1622 round_up = 0;
1623 if ((digit & (3*half_eps-1)) != 0 ||
1624 (half_eps == 8 && (HEX_DIGIT(key_digit+1) & 1) != 0))
1625 round_up = 1;
1626 else
1627 for (i = key_digit-1; i >= 0; i--)
1628 if (HEX_DIGIT(i) != 0) {
1629 round_up = 1;
1630 break;
1631 }
1632 if (round_up == 1) {
1633 x += 2*half_eps;
1634 if (top_exp == DBL_MAX_EXP &&
1635 x == ldexp((double)(2*half_eps), DBL_MANT_DIG))
1636 /* overflow corner case: pre-rounded value <
1637 2**DBL_MAX_EXP; rounded=2**DBL_MAX_EXP. */
1638 goto overflow_error;
1639 }
1640 }
1641 x = ldexp(x, (int)(exp+4*key_digit));
Mark Dickinson7103aa42008-07-15 19:08:33 +00001642
1643 finished:
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001644 /* optional trailing whitespace leading to the end of the string */
1645 while (Py_ISSPACE(*s))
1646 s++;
1647 if (s != s_end)
1648 goto parse_error;
1649 result_as_float = Py_BuildValue("(d)", sign * x);
1650 if (result_as_float == NULL)
1651 return NULL;
1652 result = PyObject_CallObject(cls, result_as_float);
1653 Py_DECREF(result_as_float);
1654 return result;
Mark Dickinson7103aa42008-07-15 19:08:33 +00001655
1656 overflow_error:
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001657 PyErr_SetString(PyExc_OverflowError,
1658 "hexadecimal value too large to represent as a float");
1659 return NULL;
Mark Dickinson7103aa42008-07-15 19:08:33 +00001660
1661 parse_error:
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001662 PyErr_SetString(PyExc_ValueError,
1663 "invalid hexadecimal floating-point string");
1664 return NULL;
Mark Dickinson7103aa42008-07-15 19:08:33 +00001665
1666 insane_length_error:
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001667 PyErr_SetString(PyExc_ValueError,
1668 "hexadecimal string too long to convert");
1669 return NULL;
Mark Dickinson7103aa42008-07-15 19:08:33 +00001670}
1671
1672PyDoc_STRVAR(float_fromhex_doc,
1673"float.fromhex(string) -> float\n\
1674\n\
1675Create a floating-point number from a hexadecimal string.\n\
1676>>> float.fromhex('0x1.ffffp10')\n\
16772047.984375\n\
1678>>> float.fromhex('-0x1p-1074')\n\
1679-4.9406564584124654e-324");
1680
1681
Jeffrey Yasskin3ea7b412008-01-27 23:08:46 +00001682static PyObject *
Raymond Hettinger04c96d52008-02-01 21:30:23 +00001683float_as_integer_ratio(PyObject *v, PyObject *unused)
Jeffrey Yasskin3ea7b412008-01-27 23:08:46 +00001684{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001685 double self;
1686 double float_part;
1687 int exponent;
1688 int i;
Raymond Hettinger04c96d52008-02-01 21:30:23 +00001689
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001690 PyObject *prev;
1691 PyObject *py_exponent = NULL;
1692 PyObject *numerator = NULL;
1693 PyObject *denominator = NULL;
1694 PyObject *result_pair = NULL;
1695 PyNumberMethods *long_methods = PyLong_Type.tp_as_number;
Jeffrey Yasskin3ea7b412008-01-27 23:08:46 +00001696
1697#define INPLACE_UPDATE(obj, call) \
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001698 prev = obj; \
1699 obj = call; \
1700 Py_DECREF(prev); \
Jeffrey Yasskin3ea7b412008-01-27 23:08:46 +00001701
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001702 CONVERT_TO_DOUBLE(v, self);
Jeffrey Yasskin3ea7b412008-01-27 23:08:46 +00001703
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001704 if (Py_IS_INFINITY(self)) {
1705 PyErr_SetString(PyExc_OverflowError,
1706 "Cannot pass infinity to float.as_integer_ratio.");
1707 return NULL;
1708 }
Jeffrey Yasskin3ea7b412008-01-27 23:08:46 +00001709#ifdef Py_NAN
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001710 if (Py_IS_NAN(self)) {
1711 PyErr_SetString(PyExc_ValueError,
1712 "Cannot pass NaN to float.as_integer_ratio.");
1713 return NULL;
1714 }
Jeffrey Yasskin3ea7b412008-01-27 23:08:46 +00001715#endif
1716
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001717 PyFPE_START_PROTECT("as_integer_ratio", goto error);
1718 float_part = frexp(self, &exponent); /* self == float_part * 2**exponent exactly */
1719 PyFPE_END_PROTECT(float_part);
Jeffrey Yasskin3ea7b412008-01-27 23:08:46 +00001720
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001721 for (i=0; i<300 && float_part != floor(float_part) ; i++) {
1722 float_part *= 2.0;
1723 exponent--;
1724 }
1725 /* self == float_part * 2**exponent exactly and float_part is integral.
1726 If FLT_RADIX != 2, the 300 steps may leave a tiny fractional part
1727 to be truncated by PyLong_FromDouble(). */
Jeffrey Yasskin3ea7b412008-01-27 23:08:46 +00001728
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001729 numerator = PyLong_FromDouble(float_part);
1730 if (numerator == NULL) goto error;
Jeffrey Yasskin3ea7b412008-01-27 23:08:46 +00001731
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001732 /* fold in 2**exponent */
1733 denominator = PyLong_FromLong(1);
1734 py_exponent = PyLong_FromLong(labs((long)exponent));
1735 if (py_exponent == NULL) goto error;
1736 INPLACE_UPDATE(py_exponent,
1737 long_methods->nb_lshift(denominator, py_exponent));
1738 if (py_exponent == NULL) goto error;
1739 if (exponent > 0) {
1740 INPLACE_UPDATE(numerator,
1741 long_methods->nb_multiply(numerator, py_exponent));
1742 if (numerator == NULL) goto error;
1743 }
1744 else {
1745 Py_DECREF(denominator);
1746 denominator = py_exponent;
1747 py_exponent = NULL;
1748 }
Raymond Hettingerc9e928a2008-02-01 22:15:52 +00001749
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001750 /* Returns ints instead of longs where possible */
1751 INPLACE_UPDATE(numerator, PyNumber_Int(numerator));
1752 if (numerator == NULL) goto error;
1753 INPLACE_UPDATE(denominator, PyNumber_Int(denominator));
1754 if (denominator == NULL) goto error;
1755
1756 result_pair = PyTuple_Pack(2, numerator, denominator);
Jeffrey Yasskin3ea7b412008-01-27 23:08:46 +00001757
1758#undef INPLACE_UPDATE
1759error:
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001760 Py_XDECREF(py_exponent);
1761 Py_XDECREF(denominator);
1762 Py_XDECREF(numerator);
1763 return result_pair;
Jeffrey Yasskin3ea7b412008-01-27 23:08:46 +00001764}
1765
1766PyDoc_STRVAR(float_as_integer_ratio_doc,
1767"float.as_integer_ratio() -> (int, int)\n"
1768"\n"
Raymond Hettinger04c96d52008-02-01 21:30:23 +00001769"Returns a pair of integers, whose ratio is exactly equal to the original\n"
1770"float and with a positive denominator.\n"
Andrew M. Kuchlingbd7c4ca2008-10-04 01:02:29 +00001771"Raises OverflowError on infinities and a ValueError on NaNs.\n"
Jeffrey Yasskin3ea7b412008-01-27 23:08:46 +00001772"\n"
1773">>> (10.0).as_integer_ratio()\n"
Raymond Hettinger04c96d52008-02-01 21:30:23 +00001774"(10, 1)\n"
Jeffrey Yasskin3ea7b412008-01-27 23:08:46 +00001775">>> (0.0).as_integer_ratio()\n"
1776"(0, 1)\n"
1777">>> (-.25).as_integer_ratio()\n"
Raymond Hettinger04c96d52008-02-01 21:30:23 +00001778"(-1, 4)");
Jeffrey Yasskin3ea7b412008-01-27 23:08:46 +00001779
Guido van Rossum1899c2e1992-09-12 11:09:23 +00001780
Jeremy Hylton938ace62002-07-17 16:30:39 +00001781static PyObject *
Guido van Rossumbef14172001-08-29 15:47:46 +00001782float_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds);
1783
Tim Peters6d6c1a32001-08-02 04:15:00 +00001784static PyObject *
1785float_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
1786{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001787 PyObject *x = Py_False; /* Integer zero */
1788 static char *kwlist[] = {"x", 0};
Tim Peters6d6c1a32001-08-02 04:15:00 +00001789
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001790 if (type != &PyFloat_Type)
1791 return float_subtype_new(type, args, kwds); /* Wimp out */
1792 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|O:float", kwlist, &x))
1793 return NULL;
1794 /* If it's a string, but not a string subclass, use
1795 PyFloat_FromString. */
1796 if (PyString_CheckExact(x))
1797 return PyFloat_FromString(x, NULL);
1798 return PyNumber_Float(x);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001799}
1800
Guido van Rossumbef14172001-08-29 15:47:46 +00001801/* Wimpy, slow approach to tp_new calls for subtypes of float:
1802 first create a regular float from whatever arguments we got,
1803 then allocate a subtype instance and initialize its ob_fval
1804 from the regular float. The regular float is then thrown away.
1805*/
1806static PyObject *
1807float_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
1808{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001809 PyObject *tmp, *newobj;
Guido van Rossumbef14172001-08-29 15:47:46 +00001810
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001811 assert(PyType_IsSubtype(type, &PyFloat_Type));
1812 tmp = float_new(&PyFloat_Type, args, kwds);
1813 if (tmp == NULL)
1814 return NULL;
1815 assert(PyFloat_CheckExact(tmp));
1816 newobj = type->tp_alloc(type, 0);
1817 if (newobj == NULL) {
1818 Py_DECREF(tmp);
1819 return NULL;
1820 }
1821 ((PyFloatObject *)newobj)->ob_fval = ((PyFloatObject *)tmp)->ob_fval;
1822 Py_DECREF(tmp);
1823 return newobj;
Guido van Rossumbef14172001-08-29 15:47:46 +00001824}
1825
Guido van Rossum5d9113d2003-01-29 17:58:45 +00001826static PyObject *
1827float_getnewargs(PyFloatObject *v)
1828{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001829 return Py_BuildValue("(d)", v->ob_fval);
Guido van Rossum5d9113d2003-01-29 17:58:45 +00001830}
1831
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001832/* this is for the benefit of the pack/unpack routines below */
1833
1834typedef enum {
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001835 unknown_format, ieee_big_endian_format, ieee_little_endian_format
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001836} float_format_type;
1837
1838static float_format_type double_format, float_format;
1839static float_format_type detected_double_format, detected_float_format;
1840
1841static PyObject *
1842float_getformat(PyTypeObject *v, PyObject* arg)
1843{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001844 char* s;
1845 float_format_type r;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001846
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001847 if (!PyString_Check(arg)) {
1848 PyErr_Format(PyExc_TypeError,
1849 "__getformat__() argument must be string, not %.500s",
1850 Py_TYPE(arg)->tp_name);
1851 return NULL;
1852 }
1853 s = PyString_AS_STRING(arg);
1854 if (strcmp(s, "double") == 0) {
1855 r = double_format;
1856 }
1857 else if (strcmp(s, "float") == 0) {
1858 r = float_format;
1859 }
1860 else {
1861 PyErr_SetString(PyExc_ValueError,
1862 "__getformat__() argument 1 must be "
1863 "'double' or 'float'");
1864 return NULL;
1865 }
1866
1867 switch (r) {
1868 case unknown_format:
1869 return PyString_FromString("unknown");
1870 case ieee_little_endian_format:
1871 return PyString_FromString("IEEE, little-endian");
1872 case ieee_big_endian_format:
1873 return PyString_FromString("IEEE, big-endian");
1874 default:
1875 Py_FatalError("insane float_format or double_format");
1876 return NULL;
1877 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001878}
1879
1880PyDoc_STRVAR(float_getformat_doc,
1881"float.__getformat__(typestr) -> string\n"
1882"\n"
1883"You probably don't want to use this function. It exists mainly to be\n"
1884"used in Python's test suite.\n"
1885"\n"
1886"typestr must be 'double' or 'float'. This function returns whichever of\n"
1887"'unknown', 'IEEE, big-endian' or 'IEEE, little-endian' best describes the\n"
1888"format of floating point numbers used by the C type named by typestr.");
1889
1890static PyObject *
1891float_setformat(PyTypeObject *v, PyObject* args)
1892{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001893 char* typestr;
1894 char* format;
1895 float_format_type f;
1896 float_format_type detected;
1897 float_format_type *p;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001898
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001899 if (!PyArg_ParseTuple(args, "ss:__setformat__", &typestr, &format))
1900 return NULL;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001901
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001902 if (strcmp(typestr, "double") == 0) {
1903 p = &double_format;
1904 detected = detected_double_format;
1905 }
1906 else if (strcmp(typestr, "float") == 0) {
1907 p = &float_format;
1908 detected = detected_float_format;
1909 }
1910 else {
1911 PyErr_SetString(PyExc_ValueError,
1912 "__setformat__() argument 1 must "
1913 "be 'double' or 'float'");
1914 return NULL;
1915 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001916
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001917 if (strcmp(format, "unknown") == 0) {
1918 f = unknown_format;
1919 }
1920 else if (strcmp(format, "IEEE, little-endian") == 0) {
1921 f = ieee_little_endian_format;
1922 }
1923 else if (strcmp(format, "IEEE, big-endian") == 0) {
1924 f = ieee_big_endian_format;
1925 }
1926 else {
1927 PyErr_SetString(PyExc_ValueError,
1928 "__setformat__() argument 2 must be "
1929 "'unknown', 'IEEE, little-endian' or "
1930 "'IEEE, big-endian'");
1931 return NULL;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001932
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001933 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001934
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001935 if (f != unknown_format && f != detected) {
1936 PyErr_Format(PyExc_ValueError,
1937 "can only set %s format to 'unknown' or the "
1938 "detected platform value", typestr);
1939 return NULL;
1940 }
1941
1942 *p = f;
1943 Py_RETURN_NONE;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001944}
1945
1946PyDoc_STRVAR(float_setformat_doc,
1947"float.__setformat__(typestr, fmt) -> None\n"
1948"\n"
1949"You probably don't want to use this function. It exists mainly to be\n"
1950"used in Python's test suite.\n"
1951"\n"
1952"typestr must be 'double' or 'float'. fmt must be one of 'unknown',\n"
1953"'IEEE, big-endian' or 'IEEE, little-endian', and in addition can only be\n"
1954"one of the latter two if it appears to match the underlying C reality.\n"
1955"\n"
1956"Overrides the automatic determination of C-level floating point type.\n"
1957"This affects how floats are converted to and from binary strings.");
1958
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00001959static PyObject *
1960float_getzero(PyObject *v, void *closure)
1961{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001962 return PyFloat_FromDouble(0.0);
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00001963}
1964
Eric Smitha9f7d622008-02-17 19:46:49 +00001965static PyObject *
1966float__format__(PyObject *self, PyObject *args)
1967{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001968 PyObject *format_spec;
Eric Smitha9f7d622008-02-17 19:46:49 +00001969
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001970 if (!PyArg_ParseTuple(args, "O:__format__", &format_spec))
1971 return NULL;
1972 if (PyBytes_Check(format_spec))
1973 return _PyFloat_FormatAdvanced(self,
1974 PyBytes_AS_STRING(format_spec),
1975 PyBytes_GET_SIZE(format_spec));
1976 if (PyUnicode_Check(format_spec)) {
1977 /* Convert format_spec to a str */
1978 PyObject *result;
1979 PyObject *str_spec = PyObject_Str(format_spec);
Eric Smitha9f7d622008-02-17 19:46:49 +00001980
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001981 if (str_spec == NULL)
1982 return NULL;
Eric Smitha9f7d622008-02-17 19:46:49 +00001983
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001984 result = _PyFloat_FormatAdvanced(self,
1985 PyBytes_AS_STRING(str_spec),
1986 PyBytes_GET_SIZE(str_spec));
Eric Smitha9f7d622008-02-17 19:46:49 +00001987
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001988 Py_DECREF(str_spec);
1989 return result;
1990 }
1991 PyErr_SetString(PyExc_TypeError, "__format__ requires str or unicode");
1992 return NULL;
Eric Smitha9f7d622008-02-17 19:46:49 +00001993}
1994
1995PyDoc_STRVAR(float__format__doc,
1996"float.__format__(format_spec) -> string\n"
1997"\n"
1998"Formats the float according to format_spec.");
1999
2000
Guido van Rossum5d9113d2003-01-29 17:58:45 +00002001static PyMethodDef float_methods[] = {
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002002 {"conjugate", (PyCFunction)float_float, METH_NOARGS,
2003 "Returns self, the complex conjugate of any float."},
2004 {"__trunc__", (PyCFunction)float_trunc, METH_NOARGS,
2005 "Returns the Integral closest to x between 0 and x."},
2006 {"as_integer_ratio", (PyCFunction)float_as_integer_ratio, METH_NOARGS,
2007 float_as_integer_ratio_doc},
2008 {"fromhex", (PyCFunction)float_fromhex,
2009 METH_O|METH_CLASS, float_fromhex_doc},
2010 {"hex", (PyCFunction)float_hex,
2011 METH_NOARGS, float_hex_doc},
2012 {"is_integer", (PyCFunction)float_is_integer, METH_NOARGS,
2013 "Returns True if the float is an integer."},
Christian Heimes6f341092008-04-18 23:13:07 +00002014#if 0
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002015 {"is_inf", (PyCFunction)float_is_inf, METH_NOARGS,
2016 "Returns True if the float is positive or negative infinite."},
2017 {"is_finite", (PyCFunction)float_is_finite, METH_NOARGS,
2018 "Returns True if the float is finite, neither infinite nor NaN."},
2019 {"is_nan", (PyCFunction)float_is_nan, METH_NOARGS,
2020 "Returns True if the float is not a number (NaN)."},
Christian Heimes6f341092008-04-18 23:13:07 +00002021#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002022 {"__getnewargs__", (PyCFunction)float_getnewargs, METH_NOARGS},
2023 {"__getformat__", (PyCFunction)float_getformat,
2024 METH_O|METH_CLASS, float_getformat_doc},
2025 {"__setformat__", (PyCFunction)float_setformat,
2026 METH_VARARGS|METH_CLASS, float_setformat_doc},
2027 {"__format__", (PyCFunction)float__format__,
2028 METH_VARARGS, float__format__doc},
2029 {NULL, NULL} /* sentinel */
Guido van Rossum5d9113d2003-01-29 17:58:45 +00002030};
2031
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00002032static PyGetSetDef float_getset[] = {
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002033 {"real",
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00002034 (getter)float_float, (setter)NULL,
2035 "the real part of a complex number",
2036 NULL},
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002037 {"imag",
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00002038 (getter)float_getzero, (setter)NULL,
2039 "the imaginary part of a complex number",
2040 NULL},
2041 {NULL} /* Sentinel */
2042};
2043
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002044PyDoc_STRVAR(float_doc,
Tim Peters6d6c1a32001-08-02 04:15:00 +00002045"float(x) -> floating point number\n\
2046\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002047Convert a string or number to a floating point number, if possible.");
Tim Peters6d6c1a32001-08-02 04:15:00 +00002048
2049
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002050static PyNumberMethods float_as_number = {
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002051 float_add, /*nb_add*/
2052 float_sub, /*nb_subtract*/
2053 float_mul, /*nb_multiply*/
2054 float_classic_div, /*nb_divide*/
2055 float_rem, /*nb_remainder*/
2056 float_divmod, /*nb_divmod*/
2057 float_pow, /*nb_power*/
2058 (unaryfunc)float_neg, /*nb_negative*/
2059 (unaryfunc)float_float, /*nb_positive*/
2060 (unaryfunc)float_abs, /*nb_absolute*/
2061 (inquiry)float_nonzero, /*nb_nonzero*/
2062 0, /*nb_invert*/
2063 0, /*nb_lshift*/
2064 0, /*nb_rshift*/
2065 0, /*nb_and*/
2066 0, /*nb_xor*/
2067 0, /*nb_or*/
2068 float_coerce, /*nb_coerce*/
2069 float_trunc, /*nb_int*/
2070 float_long, /*nb_long*/
2071 float_float, /*nb_float*/
2072 0, /* nb_oct */
2073 0, /* nb_hex */
2074 0, /* nb_inplace_add */
2075 0, /* nb_inplace_subtract */
2076 0, /* nb_inplace_multiply */
2077 0, /* nb_inplace_divide */
2078 0, /* nb_inplace_remainder */
2079 0, /* nb_inplace_power */
2080 0, /* nb_inplace_lshift */
2081 0, /* nb_inplace_rshift */
2082 0, /* nb_inplace_and */
2083 0, /* nb_inplace_xor */
2084 0, /* nb_inplace_or */
2085 float_floor_div, /* nb_floor_divide */
2086 float_div, /* nb_true_divide */
2087 0, /* nb_inplace_floor_divide */
2088 0, /* nb_inplace_true_divide */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002089};
2090
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002091PyTypeObject PyFloat_Type = {
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002092 PyVarObject_HEAD_INIT(&PyType_Type, 0)
2093 "float",
2094 sizeof(PyFloatObject),
2095 0,
2096 (destructor)float_dealloc, /* tp_dealloc */
2097 (printfunc)float_print, /* tp_print */
2098 0, /* tp_getattr */
2099 0, /* tp_setattr */
2100 0, /* tp_compare */
2101 (reprfunc)float_repr, /* tp_repr */
2102 &float_as_number, /* tp_as_number */
2103 0, /* tp_as_sequence */
2104 0, /* tp_as_mapping */
2105 (hashfunc)float_hash, /* tp_hash */
2106 0, /* tp_call */
2107 (reprfunc)float_str, /* tp_str */
2108 PyObject_GenericGetAttr, /* tp_getattro */
2109 0, /* tp_setattro */
2110 0, /* tp_as_buffer */
2111 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
2112 Py_TPFLAGS_BASETYPE, /* tp_flags */
2113 float_doc, /* tp_doc */
2114 0, /* tp_traverse */
2115 0, /* tp_clear */
2116 float_richcompare, /* tp_richcompare */
2117 0, /* tp_weaklistoffset */
2118 0, /* tp_iter */
2119 0, /* tp_iternext */
2120 float_methods, /* tp_methods */
2121 0, /* tp_members */
2122 float_getset, /* tp_getset */
2123 0, /* tp_base */
2124 0, /* tp_dict */
2125 0, /* tp_descr_get */
2126 0, /* tp_descr_set */
2127 0, /* tp_dictoffset */
2128 0, /* tp_init */
2129 0, /* tp_alloc */
2130 float_new, /* tp_new */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002131};
Guido van Rossumfbbd57e1997-08-05 02:16:08 +00002132
2133void
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002134_PyFloat_Init(void)
2135{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002136 /* We attempt to determine if this machine is using IEEE
2137 floating point formats by peering at the bits of some
2138 carefully chosen values. If it looks like we are on an
2139 IEEE platform, the float packing/unpacking routines can
2140 just copy bits, if not they resort to arithmetic & shifts
2141 and masks. The shifts & masks approach works on all finite
2142 values, but what happens to infinities, NaNs and signed
2143 zeroes on packing is an accident, and attempting to unpack
2144 a NaN or an infinity will raise an exception.
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002145
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002146 Note that if we're on some whacked-out platform which uses
2147 IEEE formats but isn't strictly little-endian or big-
2148 endian, we will fall back to the portable shifts & masks
2149 method. */
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002150
2151#if SIZEOF_DOUBLE == 8
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002152 {
2153 double x = 9006104071832581.0;
2154 if (memcmp(&x, "\x43\x3f\xff\x01\x02\x03\x04\x05", 8) == 0)
2155 detected_double_format = ieee_big_endian_format;
2156 else if (memcmp(&x, "\x05\x04\x03\x02\x01\xff\x3f\x43", 8) == 0)
2157 detected_double_format = ieee_little_endian_format;
2158 else
2159 detected_double_format = unknown_format;
2160 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002161#else
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002162 detected_double_format = unknown_format;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002163#endif
2164
2165#if SIZEOF_FLOAT == 4
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002166 {
2167 float y = 16711938.0;
2168 if (memcmp(&y, "\x4b\x7f\x01\x02", 4) == 0)
2169 detected_float_format = ieee_big_endian_format;
2170 else if (memcmp(&y, "\x02\x01\x7f\x4b", 4) == 0)
2171 detected_float_format = ieee_little_endian_format;
2172 else
2173 detected_float_format = unknown_format;
2174 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002175#else
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002176 detected_float_format = unknown_format;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002177#endif
2178
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002179 double_format = detected_double_format;
2180 float_format = detected_float_format;
Christian Heimesf15c66e2007-12-11 00:54:34 +00002181
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002182 /* Init float info */
2183 if (FloatInfoType.tp_name == 0)
2184 PyStructSequence_InitType(&FloatInfoType, &floatinfo_desc);
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002185}
2186
Gregory P. Smith2fe77062008-07-06 03:35:58 +00002187int
2188PyFloat_ClearFreeList(void)
Guido van Rossumfbbd57e1997-08-05 02:16:08 +00002189{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002190 PyFloatObject *p;
2191 PyFloatBlock *list, *next;
2192 int i;
2193 int u; /* remaining unfreed ints per block */
2194 int freelist_size = 0;
Guido van Rossumf61bbc81999-03-12 00:12:21 +00002195
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002196 list = block_list;
2197 block_list = NULL;
2198 free_list = NULL;
2199 while (list != NULL) {
2200 u = 0;
2201 for (i = 0, p = &list->objects[0];
2202 i < N_FLOATOBJECTS;
2203 i++, p++) {
2204 if (PyFloat_CheckExact(p) && Py_REFCNT(p) != 0)
2205 u++;
2206 }
2207 next = list->next;
2208 if (u) {
2209 list->next = block_list;
2210 block_list = list;
2211 for (i = 0, p = &list->objects[0];
2212 i < N_FLOATOBJECTS;
2213 i++, p++) {
2214 if (!PyFloat_CheckExact(p) ||
2215 Py_REFCNT(p) == 0) {
2216 Py_TYPE(p) = (struct _typeobject *)
2217 free_list;
2218 free_list = p;
2219 }
2220 }
2221 }
2222 else {
2223 PyMem_FREE(list);
2224 }
2225 freelist_size += u;
2226 list = next;
2227 }
2228 return freelist_size;
Christian Heimes422051a2008-02-04 18:00:12 +00002229}
2230
2231void
2232PyFloat_Fini(void)
2233{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002234 PyFloatObject *p;
2235 PyFloatBlock *list;
2236 int i;
2237 int u; /* total unfreed floats per block */
Christian Heimes422051a2008-02-04 18:00:12 +00002238
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002239 u = PyFloat_ClearFreeList();
Christian Heimes422051a2008-02-04 18:00:12 +00002240
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002241 if (!Py_VerboseFlag)
2242 return;
2243 fprintf(stderr, "# cleanup floats");
2244 if (!u) {
2245 fprintf(stderr, "\n");
2246 }
2247 else {
2248 fprintf(stderr,
2249 ": %d unfreed float%s\n",
2250 u, u == 1 ? "" : "s");
2251 }
2252 if (Py_VerboseFlag > 1) {
2253 list = block_list;
2254 while (list != NULL) {
2255 for (i = 0, p = &list->objects[0];
2256 i < N_FLOATOBJECTS;
2257 i++, p++) {
2258 if (PyFloat_CheckExact(p) &&
2259 Py_REFCNT(p) != 0) {
2260 char *buf = PyOS_double_to_string(
2261 PyFloat_AS_DOUBLE(p), 'r',
2262 0, 0, NULL);
2263 if (buf) {
2264 /* XXX(twouters) cast
2265 refcount to long
2266 until %zd is
2267 universally
2268 available
2269 */
2270 fprintf(stderr,
2271 "# <float at %p, refcnt=%ld, val=%s>\n",
2272 p, (long)Py_REFCNT(p), buf);
2273 PyMem_Free(buf);
2274 }
2275 }
2276 }
2277 list = list->next;
2278 }
2279 }
Guido van Rossumfbbd57e1997-08-05 02:16:08 +00002280}
Tim Peters9905b942003-03-20 20:53:32 +00002281
2282/*----------------------------------------------------------------------------
2283 * _PyFloat_{Pack,Unpack}{4,8}. See floatobject.h.
Tim Peters9905b942003-03-20 20:53:32 +00002284 */
2285int
2286_PyFloat_Pack4(double x, unsigned char *p, int le)
2287{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002288 if (float_format == unknown_format) {
2289 unsigned char sign;
2290 int e;
2291 double f;
2292 unsigned int fbits;
2293 int incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00002294
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002295 if (le) {
2296 p += 3;
2297 incr = -1;
2298 }
Tim Peters9905b942003-03-20 20:53:32 +00002299
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002300 if (x < 0) {
2301 sign = 1;
2302 x = -x;
2303 }
2304 else
2305 sign = 0;
Tim Peters9905b942003-03-20 20:53:32 +00002306
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002307 f = frexp(x, &e);
Tim Peters9905b942003-03-20 20:53:32 +00002308
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002309 /* Normalize f to be in the range [1.0, 2.0) */
2310 if (0.5 <= f && f < 1.0) {
2311 f *= 2.0;
2312 e--;
2313 }
2314 else if (f == 0.0)
2315 e = 0;
2316 else {
2317 PyErr_SetString(PyExc_SystemError,
2318 "frexp() result out of range");
2319 return -1;
2320 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002321
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002322 if (e >= 128)
2323 goto Overflow;
2324 else if (e < -126) {
2325 /* Gradual underflow */
2326 f = ldexp(f, 126 + e);
2327 e = 0;
2328 }
2329 else if (!(e == 0 && f == 0.0)) {
2330 e += 127;
2331 f -= 1.0; /* Get rid of leading 1 */
2332 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002333
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002334 f *= 8388608.0; /* 2**23 */
2335 fbits = (unsigned int)(f + 0.5); /* Round */
2336 assert(fbits <= 8388608);
2337 if (fbits >> 23) {
2338 /* The carry propagated out of a string of 23 1 bits. */
2339 fbits = 0;
2340 ++e;
2341 if (e >= 255)
2342 goto Overflow;
2343 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002344
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002345 /* First byte */
2346 *p = (sign << 7) | (e >> 1);
2347 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002348
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002349 /* Second byte */
2350 *p = (char) (((e & 1) << 7) | (fbits >> 16));
2351 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002352
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002353 /* Third byte */
2354 *p = (fbits >> 8) & 0xFF;
2355 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002356
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002357 /* Fourth byte */
2358 *p = fbits & 0xFF;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002359
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002360 /* Done */
2361 return 0;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002362
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002363 }
2364 else {
2365 float y = (float)x;
2366 const char *s = (char*)&y;
2367 int i, incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00002368
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002369 if (Py_IS_INFINITY(y) && !Py_IS_INFINITY(x))
2370 goto Overflow;
Mark Dickinsonc23b8a72008-03-14 14:23:37 +00002371
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002372 if ((float_format == ieee_little_endian_format && !le)
2373 || (float_format == ieee_big_endian_format && le)) {
2374 p += 3;
2375 incr = -1;
2376 }
Mark Dickinsonc23b8a72008-03-14 14:23:37 +00002377
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002378 for (i = 0; i < 4; i++) {
2379 *p = *s++;
2380 p += incr;
2381 }
2382 return 0;
2383 }
Mark Dickinsonc23b8a72008-03-14 14:23:37 +00002384 Overflow:
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002385 PyErr_SetString(PyExc_OverflowError,
2386 "float too large to pack with f format");
2387 return -1;
Tim Peters9905b942003-03-20 20:53:32 +00002388}
2389
2390int
2391_PyFloat_Pack8(double x, unsigned char *p, int le)
2392{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002393 if (double_format == unknown_format) {
2394 unsigned char sign;
2395 int e;
2396 double f;
2397 unsigned int fhi, flo;
2398 int incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00002399
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002400 if (le) {
2401 p += 7;
2402 incr = -1;
2403 }
Tim Peters9905b942003-03-20 20:53:32 +00002404
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002405 if (x < 0) {
2406 sign = 1;
2407 x = -x;
2408 }
2409 else
2410 sign = 0;
Tim Peters9905b942003-03-20 20:53:32 +00002411
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002412 f = frexp(x, &e);
Tim Peters9905b942003-03-20 20:53:32 +00002413
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002414 /* Normalize f to be in the range [1.0, 2.0) */
2415 if (0.5 <= f && f < 1.0) {
2416 f *= 2.0;
2417 e--;
2418 }
2419 else if (f == 0.0)
2420 e = 0;
2421 else {
2422 PyErr_SetString(PyExc_SystemError,
2423 "frexp() result out of range");
2424 return -1;
2425 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002426
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002427 if (e >= 1024)
2428 goto Overflow;
2429 else if (e < -1022) {
2430 /* Gradual underflow */
2431 f = ldexp(f, 1022 + e);
2432 e = 0;
2433 }
2434 else if (!(e == 0 && f == 0.0)) {
2435 e += 1023;
2436 f -= 1.0; /* Get rid of leading 1 */
2437 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002438
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002439 /* fhi receives the high 28 bits; flo the low 24 bits (== 52 bits) */
2440 f *= 268435456.0; /* 2**28 */
2441 fhi = (unsigned int)f; /* Truncate */
2442 assert(fhi < 268435456);
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002443
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002444 f -= (double)fhi;
2445 f *= 16777216.0; /* 2**24 */
2446 flo = (unsigned int)(f + 0.5); /* Round */
2447 assert(flo <= 16777216);
2448 if (flo >> 24) {
2449 /* The carry propagated out of a string of 24 1 bits. */
2450 flo = 0;
2451 ++fhi;
2452 if (fhi >> 28) {
2453 /* And it also progagated out of the next 28 bits. */
2454 fhi = 0;
2455 ++e;
2456 if (e >= 2047)
2457 goto Overflow;
2458 }
2459 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002460
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002461 /* First byte */
2462 *p = (sign << 7) | (e >> 4);
2463 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002464
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002465 /* Second byte */
2466 *p = (unsigned char) (((e & 0xF) << 4) | (fhi >> 24));
2467 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002468
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002469 /* Third byte */
2470 *p = (fhi >> 16) & 0xFF;
2471 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002472
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002473 /* Fourth byte */
2474 *p = (fhi >> 8) & 0xFF;
2475 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002476
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002477 /* Fifth byte */
2478 *p = fhi & 0xFF;
2479 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002480
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002481 /* Sixth byte */
2482 *p = (flo >> 16) & 0xFF;
2483 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002484
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002485 /* Seventh byte */
2486 *p = (flo >> 8) & 0xFF;
2487 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002488
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002489 /* Eighth byte */
2490 *p = flo & 0xFF;
2491 /* p += incr; Unneeded (for now) */
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002492
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002493 /* Done */
2494 return 0;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002495
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002496 Overflow:
2497 PyErr_SetString(PyExc_OverflowError,
2498 "float too large to pack with d format");
2499 return -1;
2500 }
2501 else {
2502 const char *s = (char*)&x;
2503 int i, incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00002504
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002505 if ((double_format == ieee_little_endian_format && !le)
2506 || (double_format == ieee_big_endian_format && le)) {
2507 p += 7;
2508 incr = -1;
2509 }
2510
2511 for (i = 0; i < 8; i++) {
2512 *p = *s++;
2513 p += incr;
2514 }
2515 return 0;
2516 }
Tim Peters9905b942003-03-20 20:53:32 +00002517}
2518
2519double
2520_PyFloat_Unpack4(const unsigned char *p, int le)
2521{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002522 if (float_format == unknown_format) {
2523 unsigned char sign;
2524 int e;
2525 unsigned int f;
2526 double x;
2527 int incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00002528
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002529 if (le) {
2530 p += 3;
2531 incr = -1;
2532 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002533
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002534 /* First byte */
2535 sign = (*p >> 7) & 1;
2536 e = (*p & 0x7F) << 1;
2537 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002538
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002539 /* Second byte */
2540 e |= (*p >> 7) & 1;
2541 f = (*p & 0x7F) << 16;
2542 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002543
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002544 if (e == 255) {
2545 PyErr_SetString(
2546 PyExc_ValueError,
2547 "can't unpack IEEE 754 special value "
2548 "on non-IEEE platform");
2549 return -1;
2550 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002551
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002552 /* Third byte */
2553 f |= *p << 8;
2554 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002555
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002556 /* Fourth byte */
2557 f |= *p;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002558
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002559 x = (double)f / 8388608.0;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002560
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002561 /* XXX This sadly ignores Inf/NaN issues */
2562 if (e == 0)
2563 e = -126;
2564 else {
2565 x += 1.0;
2566 e -= 127;
2567 }
2568 x = ldexp(x, e);
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002569
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002570 if (sign)
2571 x = -x;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002572
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002573 return x;
2574 }
2575 else {
2576 float x;
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00002577
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002578 if ((float_format == ieee_little_endian_format && !le)
2579 || (float_format == ieee_big_endian_format && le)) {
2580 char buf[4];
2581 char *d = &buf[3];
2582 int i;
Tim Peters9905b942003-03-20 20:53:32 +00002583
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002584 for (i = 0; i < 4; i++) {
2585 *d-- = *p++;
2586 }
2587 memcpy(&x, buf, 4);
2588 }
2589 else {
2590 memcpy(&x, p, 4);
2591 }
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00002592
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002593 return x;
2594 }
Tim Peters9905b942003-03-20 20:53:32 +00002595}
2596
2597double
2598_PyFloat_Unpack8(const unsigned char *p, int le)
2599{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002600 if (double_format == unknown_format) {
2601 unsigned char sign;
2602 int e;
2603 unsigned int fhi, flo;
2604 double x;
2605 int incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00002606
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002607 if (le) {
2608 p += 7;
2609 incr = -1;
2610 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002611
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002612 /* First byte */
2613 sign = (*p >> 7) & 1;
2614 e = (*p & 0x7F) << 4;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002615
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002616 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002617
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002618 /* Second byte */
2619 e |= (*p >> 4) & 0xF;
2620 fhi = (*p & 0xF) << 24;
2621 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002622
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002623 if (e == 2047) {
2624 PyErr_SetString(
2625 PyExc_ValueError,
2626 "can't unpack IEEE 754 special value "
2627 "on non-IEEE platform");
2628 return -1.0;
2629 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002630
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002631 /* Third byte */
2632 fhi |= *p << 16;
2633 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002634
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002635 /* Fourth byte */
2636 fhi |= *p << 8;
2637 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002638
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002639 /* Fifth byte */
2640 fhi |= *p;
2641 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002642
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002643 /* Sixth byte */
2644 flo = *p << 16;
2645 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002646
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002647 /* Seventh byte */
2648 flo |= *p << 8;
2649 p += incr;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002650
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002651 /* Eighth byte */
2652 flo |= *p;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002653
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002654 x = (double)fhi + (double)flo / 16777216.0; /* 2**24 */
2655 x /= 268435456.0; /* 2**28 */
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002656
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002657 if (e == 0)
2658 e = -1022;
2659 else {
2660 x += 1.0;
2661 e -= 1023;
2662 }
2663 x = ldexp(x, e);
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002664
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002665 if (sign)
2666 x = -x;
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00002667
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002668 return x;
2669 }
2670 else {
2671 double x;
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00002672
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002673 if ((double_format == ieee_little_endian_format && !le)
2674 || (double_format == ieee_big_endian_format && le)) {
2675 char buf[8];
2676 char *d = &buf[7];
2677 int i;
2678
2679 for (i = 0; i < 8; i++) {
2680 *d-- = *p++;
2681 }
2682 memcpy(&x, buf, 8);
2683 }
2684 else {
2685 memcpy(&x, p, 8);
2686 }
2687
2688 return x;
2689 }
Tim Peters9905b942003-03-20 20:53:32 +00002690}