blob: 461029a91e7893b483f6253bcbdc7a6f509b6a89 [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 Norwitz9fdfaaf2008-03-28 05:34:59 +000018#ifdef HAVE_IEEEFP_H
19#include <ieeefp.h>
20#endif
21
Neal Norwitz5f95a792008-01-25 08:04:16 +000022#ifdef _OSF_SOURCE
23/* OSF1 5.1 doesn't make this available with XOPEN_SOURCE_EXTENDED defined */
24extern int finite(double);
25#endif
26
Guido van Rossum93ad0df1997-05-13 21:00:42 +000027/* Special free list -- see comments for same code in intobject.c. */
Guido van Rossum93ad0df1997-05-13 21:00:42 +000028#define BLOCK_SIZE 1000 /* 1K less typical malloc overhead */
Guido van Rossum3fce8831999-03-12 19:43:17 +000029#define BHEAD_SIZE 8 /* Enough for a 64-bit pointer */
Guido van Rossumf61bbc81999-03-12 00:12:21 +000030#define N_FLOATOBJECTS ((BLOCK_SIZE - BHEAD_SIZE) / sizeof(PyFloatObject))
Guido van Rossum3fce8831999-03-12 19:43:17 +000031
Guido van Rossum3fce8831999-03-12 19:43:17 +000032struct _floatblock {
33 struct _floatblock *next;
34 PyFloatObject objects[N_FLOATOBJECTS];
35};
36
37typedef struct _floatblock PyFloatBlock;
38
39static PyFloatBlock *block_list = NULL;
40static PyFloatObject *free_list = NULL;
41
Guido van Rossum93ad0df1997-05-13 21:00:42 +000042static PyFloatObject *
Fred Drakefd99de62000-07-09 05:02:18 +000043fill_free_list(void)
Guido van Rossum93ad0df1997-05-13 21:00:42 +000044{
45 PyFloatObject *p, *q;
Guido van Rossumb18618d2000-05-03 23:44:39 +000046 /* XXX Float blocks escape the object heap. Use PyObject_MALLOC ??? */
47 p = (PyFloatObject *) PyMem_MALLOC(sizeof(PyFloatBlock));
Guido van Rossum93ad0df1997-05-13 21:00:42 +000048 if (p == NULL)
Guido van Rossumb18618d2000-05-03 23:44:39 +000049 return (PyFloatObject *) PyErr_NoMemory();
Guido van Rossum3fce8831999-03-12 19:43:17 +000050 ((PyFloatBlock *)p)->next = block_list;
51 block_list = (PyFloatBlock *)p;
52 p = &((PyFloatBlock *)p)->objects[0];
Guido van Rossum93ad0df1997-05-13 21:00:42 +000053 q = p + N_FLOATOBJECTS;
54 while (--q > p)
Christian Heimese93237d2007-12-19 02:37:44 +000055 Py_TYPE(q) = (struct _typeobject *)(q-1);
56 Py_TYPE(q) = NULL;
Guido van Rossum93ad0df1997-05-13 21:00:42 +000057 return p + N_FLOATOBJECTS - 1;
58}
59
Christian Heimesdfdfaab2007-12-01 11:20:10 +000060double
61PyFloat_GetMax(void)
62{
63 return DBL_MAX;
64}
65
66double
67PyFloat_GetMin(void)
68{
69 return DBL_MIN;
70}
71
Christian Heimes796fc312008-01-30 18:58:29 +000072static PyTypeObject FloatInfoType = {0, 0, 0, 0, 0, 0};
Christian Heimesc94e2b52008-01-14 04:13:37 +000073
74PyDoc_STRVAR(floatinfo__doc__,
Benjamin Petersonbf9ec9b2009-06-16 23:13:09 +000075"sys.float_info\n\
Christian Heimesc94e2b52008-01-14 04:13:37 +000076\n\
77A structseq holding information about the float type. It contains low level\n\
78information about the precision and internal representation. Please study\n\
79your system's :file:`float.h` for more information.");
80
81static PyStructSequence_Field floatinfo_fields[] = {
82 {"max", "DBL_MAX -- maximum representable finite float"},
83 {"max_exp", "DBL_MAX_EXP -- maximum int e such that radix**(e-1) "
84 "is representable"},
85 {"max_10_exp", "DBL_MAX_10_EXP -- maximum int e such that 10**e "
86 "is representable"},
87 {"min", "DBL_MIN -- Minimum positive normalizer float"},
88 {"min_exp", "DBL_MIN_EXP -- minimum int e such that radix**(e-1) "
89 "is a normalized float"},
90 {"min_10_exp", "DBL_MIN_10_EXP -- minimum int e such that 10**e is "
91 "a normalized"},
92 {"dig", "DBL_DIG -- digits"},
93 {"mant_dig", "DBL_MANT_DIG -- mantissa digits"},
94 {"epsilon", "DBL_EPSILON -- Difference between 1 and the next "
95 "representable float"},
96 {"radix", "FLT_RADIX -- radix of exponent"},
97 {"rounds", "FLT_ROUNDS -- addition rounds"},
98 {0}
99};
100
101static PyStructSequence_Desc floatinfo_desc = {
Benjamin Petersonbf9ec9b2009-06-16 23:13:09 +0000102 "sys.float_info", /* name */
Christian Heimesc94e2b52008-01-14 04:13:37 +0000103 floatinfo__doc__, /* doc */
104 floatinfo_fields, /* fields */
105 11
106};
107
Christian Heimesdfdfaab2007-12-01 11:20:10 +0000108PyObject *
109PyFloat_GetInfo(void)
110{
Christian Heimes796fc312008-01-30 18:58:29 +0000111 PyObject* floatinfo;
Christian Heimesc94e2b52008-01-14 04:13:37 +0000112 int pos = 0;
Christian Heimesdfdfaab2007-12-01 11:20:10 +0000113
Christian Heimesc94e2b52008-01-14 04:13:37 +0000114 floatinfo = PyStructSequence_New(&FloatInfoType);
115 if (floatinfo == NULL) {
116 return NULL;
117 }
Christian Heimesdfdfaab2007-12-01 11:20:10 +0000118
Christian Heimesc94e2b52008-01-14 04:13:37 +0000119#define SetIntFlag(flag) \
120 PyStructSequence_SET_ITEM(floatinfo, pos++, PyInt_FromLong(flag))
121#define SetDblFlag(flag) \
122 PyStructSequence_SET_ITEM(floatinfo, pos++, PyFloat_FromDouble(flag))
Christian Heimesdfdfaab2007-12-01 11:20:10 +0000123
Christian Heimesc94e2b52008-01-14 04:13:37 +0000124 SetDblFlag(DBL_MAX);
125 SetIntFlag(DBL_MAX_EXP);
126 SetIntFlag(DBL_MAX_10_EXP);
127 SetDblFlag(DBL_MIN);
128 SetIntFlag(DBL_MIN_EXP);
129 SetIntFlag(DBL_MIN_10_EXP);
130 SetIntFlag(DBL_DIG);
131 SetIntFlag(DBL_MANT_DIG);
132 SetDblFlag(DBL_EPSILON);
133 SetIntFlag(FLT_RADIX);
134 SetIntFlag(FLT_ROUNDS);
135#undef SetIntFlag
136#undef SetDblFlag
137
138 if (PyErr_Occurred()) {
139 Py_CLEAR(floatinfo);
140 return NULL;
141 }
Christian Heimesc94e2b52008-01-14 04:13:37 +0000142 return floatinfo;
Christian Heimesdfdfaab2007-12-01 11:20:10 +0000143}
144
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000145PyObject *
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000146PyFloat_FromDouble(double fval)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000147{
Guido van Rossum93ad0df1997-05-13 21:00:42 +0000148 register PyFloatObject *op;
149 if (free_list == NULL) {
150 if ((free_list = fill_free_list()) == NULL)
151 return NULL;
152 }
Guido van Rossume3a8e7e2002-08-19 19:26:42 +0000153 /* Inline PyObject_New */
Guido van Rossum93ad0df1997-05-13 21:00:42 +0000154 op = free_list;
Christian Heimese93237d2007-12-19 02:37:44 +0000155 free_list = (PyFloatObject *)Py_TYPE(op);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000156 PyObject_INIT(op, &PyFloat_Type);
Guido van Rossum2a9096b1990-10-21 22:15:08 +0000157 op->ob_fval = fval;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000158 return (PyObject *) op;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000159}
160
Tim Petersef14d732000-09-23 03:39:17 +0000161/**************************************************************************
162RED_FLAG 22-Sep-2000 tim
163PyFloat_FromString's pend argument is braindead. Prior to this RED_FLAG,
164
1651. If v was a regular string, *pend was set to point to its terminating
166 null byte. That's useless (the caller can find that without any
167 help from this function!).
168
1692. If v was a Unicode string, or an object convertible to a character
170 buffer, *pend was set to point into stack trash (the auto temp
171 vector holding the character buffer). That was downright dangerous.
172
173Since we can't change the interface of a public API function, pend is
174still supported but now *officially* useless: if pend is not NULL,
175*pend is set to NULL.
176**************************************************************************/
Barry Warsaw226ae6c1999-10-12 19:54:53 +0000177PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000178PyFloat_FromString(PyObject *v, char **pend)
Barry Warsaw226ae6c1999-10-12 19:54:53 +0000179{
Mark Dickinson6d6b2202009-04-26 16:04:05 +0000180 const char *s, *last, *end;
Barry Warsaw226ae6c1999-10-12 19:54:53 +0000181 double x;
Tim Petersef14d732000-09-23 03:39:17 +0000182 char buffer[256]; /* for errors */
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000183#ifdef Py_USING_UNICODE
Mark Dickinson8568b192009-10-26 21:11:20 +0000184 char *s_buffer = NULL;
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000185#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +0000186 Py_ssize_t len;
Mark Dickinson8568b192009-10-26 21:11:20 +0000187 PyObject *result = NULL;
Barry Warsaw226ae6c1999-10-12 19:54:53 +0000188
Tim Petersef14d732000-09-23 03:39:17 +0000189 if (pend)
190 *pend = NULL;
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000191 if (PyString_Check(v)) {
192 s = PyString_AS_STRING(v);
193 len = PyString_GET_SIZE(v);
Guido van Rossum4c08d552000-03-10 22:55:18 +0000194 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000195#ifdef Py_USING_UNICODE
Guido van Rossum9e896b32000-04-05 20:11:21 +0000196 else if (PyUnicode_Check(v)) {
Mark Dickinson8568b192009-10-26 21:11:20 +0000197 s_buffer = (char *)PyMem_MALLOC(PyUnicode_GET_SIZE(v)+1);
198 if (s_buffer == NULL)
199 return PyErr_NoMemory();
Tim Petersef14d732000-09-23 03:39:17 +0000200 if (PyUnicode_EncodeDecimal(PyUnicode_AS_UNICODE(v),
Guido van Rossum9e896b32000-04-05 20:11:21 +0000201 PyUnicode_GET_SIZE(v),
Tim Petersd2364e82001-11-01 20:09:42 +0000202 s_buffer,
Guido van Rossum9e896b32000-04-05 20:11:21 +0000203 NULL))
Mark Dickinson8568b192009-10-26 21:11:20 +0000204 goto error;
Guido van Rossum9e896b32000-04-05 20:11:21 +0000205 s = s_buffer;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000206 len = strlen(s);
Guido van Rossum9e896b32000-04-05 20:11:21 +0000207 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000208#endif
Guido van Rossum4c08d552000-03-10 22:55:18 +0000209 else if (PyObject_AsCharBuffer(v, &s, &len)) {
210 PyErr_SetString(PyExc_TypeError,
Mark Dickinson8568b192009-10-26 21:11:20 +0000211 "float() argument must be a string or a number");
Barry Warsaw226ae6c1999-10-12 19:54:53 +0000212 return NULL;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000213 }
Guido van Rossum4c08d552000-03-10 22:55:18 +0000214 last = s + len;
Mark Dickinson6d6b2202009-04-26 16:04:05 +0000215
Mark Dickinson777e4ff2009-05-03 20:59:48 +0000216 while (Py_ISSPACE(*s))
Barry Warsaw226ae6c1999-10-12 19:54:53 +0000217 s++;
Mark Dickinson6d6b2202009-04-26 16:04:05 +0000218 /* We don't care about overflow or underflow. If the platform
219 * supports them, infinities and signed zeroes (on underflow) are
220 * fine. */
Mark Dickinson8568b192009-10-26 21:11:20 +0000221 x = PyOS_string_to_double(s, (char **)&end, NULL);
222 if (x == -1.0 && PyErr_Occurred())
223 goto error;
Mark Dickinson777e4ff2009-05-03 20:59:48 +0000224 while (Py_ISSPACE(*end))
Barry Warsaw226ae6c1999-10-12 19:54:53 +0000225 end++;
Mark Dickinson8568b192009-10-26 21:11:20 +0000226 if (end == last)
227 result = PyFloat_FromDouble(x);
228 else {
229 PyOS_snprintf(buffer, sizeof(buffer),
230 "invalid literal for float(): %.200s", s);
231 PyErr_SetString(PyExc_ValueError, buffer);
232 result = NULL;
Barry Warsaw226ae6c1999-10-12 19:54:53 +0000233 }
Mark Dickinson8568b192009-10-26 21:11:20 +0000234
235 error:
236#ifdef Py_USING_UNICODE
237 if (s_buffer)
238 PyMem_FREE(s_buffer);
239#endif
240 return result;
Barry Warsaw226ae6c1999-10-12 19:54:53 +0000241}
242
Guido van Rossum234f9421993-06-17 12:35:49 +0000243static void
Fred Drakefd99de62000-07-09 05:02:18 +0000244float_dealloc(PyFloatObject *op)
Guido van Rossum3132a5a1992-03-27 17:28:44 +0000245{
Guido van Rossum9475a232001-10-05 20:51:39 +0000246 if (PyFloat_CheckExact(op)) {
Christian Heimese93237d2007-12-19 02:37:44 +0000247 Py_TYPE(op) = (struct _typeobject *)free_list;
Guido van Rossum9475a232001-10-05 20:51:39 +0000248 free_list = op;
249 }
250 else
Christian Heimese93237d2007-12-19 02:37:44 +0000251 Py_TYPE(op)->tp_free((PyObject *)op);
Guido van Rossum3132a5a1992-03-27 17:28:44 +0000252}
253
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000254double
Fred Drakefd99de62000-07-09 05:02:18 +0000255PyFloat_AsDouble(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000256{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000257 PyNumberMethods *nb;
258 PyFloatObject *fo;
Guido van Rossumb6775db1994-08-01 11:34:53 +0000259 double val;
Tim Petersd2364e82001-11-01 20:09:42 +0000260
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000261 if (op && PyFloat_Check(op))
262 return PyFloat_AS_DOUBLE((PyFloatObject*) op);
Tim Petersd2364e82001-11-01 20:09:42 +0000263
Neil Schemenauer2c77e902002-11-18 16:06:21 +0000264 if (op == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000265 PyErr_BadArgument();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000266 return -1;
267 }
Tim Petersd2364e82001-11-01 20:09:42 +0000268
Christian Heimese93237d2007-12-19 02:37:44 +0000269 if ((nb = Py_TYPE(op)->tp_as_number) == NULL || nb->nb_float == NULL) {
Neil Schemenauer2c77e902002-11-18 16:06:21 +0000270 PyErr_SetString(PyExc_TypeError, "a float is required");
271 return -1;
272 }
273
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000274 fo = (PyFloatObject*) (*nb->nb_float) (op);
Guido van Rossumb6775db1994-08-01 11:34:53 +0000275 if (fo == NULL)
276 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000277 if (!PyFloat_Check(fo)) {
278 PyErr_SetString(PyExc_TypeError,
279 "nb_float should return float object");
Guido van Rossumb6775db1994-08-01 11:34:53 +0000280 return -1;
281 }
Tim Petersd2364e82001-11-01 20:09:42 +0000282
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000283 val = PyFloat_AS_DOUBLE(fo);
284 Py_DECREF(fo);
Tim Petersd2364e82001-11-01 20:09:42 +0000285
Guido van Rossumb6775db1994-08-01 11:34:53 +0000286 return val;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000287}
288
289/* Methods */
290
Neil Schemenauer32117e52001-01-04 01:44:34 +0000291/* Macro and helper that convert PyObject obj to a C double and store
292 the value in dbl; this replaces the functionality of the coercion
Tim Peters77d8a4f2001-12-11 20:31:34 +0000293 slot function. If conversion to double raises an exception, obj is
294 set to NULL, and the function invoking this macro returns NULL. If
295 obj is not of float, int or long type, Py_NotImplemented is incref'ed,
296 stored in obj, and returned from the function invoking this macro.
297*/
Raymond Hettinger9c437af2008-06-24 22:46:07 +0000298#define CONVERT_TO_DOUBLE(obj, dbl) \
299 if (PyFloat_Check(obj)) \
300 dbl = PyFloat_AS_DOUBLE(obj); \
301 else if (convert_to_double(&(obj), &(dbl)) < 0) \
302 return obj;
Neil Schemenauer32117e52001-01-04 01:44:34 +0000303
304static int
Tim Peters9fffa3e2001-09-04 05:14:19 +0000305convert_to_double(PyObject **v, double *dbl)
Neil Schemenauer32117e52001-01-04 01:44:34 +0000306{
307 register PyObject *obj = *v;
Tim Peters9fffa3e2001-09-04 05:14:19 +0000308
Neil Schemenauer32117e52001-01-04 01:44:34 +0000309 if (PyInt_Check(obj)) {
310 *dbl = (double)PyInt_AS_LONG(obj);
311 }
312 else if (PyLong_Check(obj)) {
Neil Schemenauer32117e52001-01-04 01:44:34 +0000313 *dbl = PyLong_AsDouble(obj);
Tim Peters9fffa3e2001-09-04 05:14:19 +0000314 if (*dbl == -1.0 && PyErr_Occurred()) {
315 *v = NULL;
316 return -1;
317 }
Neil Schemenauer32117e52001-01-04 01:44:34 +0000318 }
319 else {
320 Py_INCREF(Py_NotImplemented);
321 *v = Py_NotImplemented;
322 return -1;
323 }
324 return 0;
325}
326
Eric Smithcfaf79c2009-10-26 14:48:55 +0000327/* XXX PyFloat_AsString and PyFloat_AsReprString are deprecated:
Tim Peters97019e42001-11-28 22:43:45 +0000328 XXX they pass a char buffer without passing a length.
329*/
Guido van Rossum57072eb1999-12-23 19:00:28 +0000330void
Fred Drakefd99de62000-07-09 05:02:18 +0000331PyFloat_AsString(char *buf, PyFloatObject *v)
Guido van Rossum57072eb1999-12-23 19:00:28 +0000332{
Eric Smithcfaf79c2009-10-26 14:48:55 +0000333 char *tmp = PyOS_double_to_string(v->ob_fval, 'g',
334 PyFloat_STR_PRECISION,
335 Py_DTSF_ADD_DOT_0, NULL);
336 strcpy(buf, tmp);
337 PyMem_Free(tmp);
Guido van Rossum57072eb1999-12-23 19:00:28 +0000338}
339
Tim Peters72f98e92001-05-08 15:19:57 +0000340void
341PyFloat_AsReprString(char *buf, PyFloatObject *v)
342{
Eric Smithcfaf79c2009-10-26 14:48:55 +0000343 char * tmp = PyOS_double_to_string(v->ob_fval, 'r', 0,
344 Py_DTSF_ADD_DOT_0, NULL);
345 strcpy(buf, tmp);
346 PyMem_Free(tmp);
Tim Peters72f98e92001-05-08 15:19:57 +0000347}
348
Guido van Rossum3132a5a1992-03-27 17:28:44 +0000349/* ARGSUSED */
Guido van Rossum90933611991-06-07 16:10:43 +0000350static int
Fred Drakefd99de62000-07-09 05:02:18 +0000351float_print(PyFloatObject *v, FILE *fp, int flags)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000352{
Eric Smithcfaf79c2009-10-26 14:48:55 +0000353 char *buf;
354 if (flags & Py_PRINT_RAW)
355 buf = PyOS_double_to_string(v->ob_fval,
356 'g', PyFloat_STR_PRECISION,
357 Py_DTSF_ADD_DOT_0, NULL);
358 else
359 buf = PyOS_double_to_string(v->ob_fval,
360 'r', 0, Py_DTSF_ADD_DOT_0, NULL);
Brett Cannon01531592007-09-17 03:28:34 +0000361 Py_BEGIN_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000362 fputs(buf, fp);
Brett Cannon01531592007-09-17 03:28:34 +0000363 Py_END_ALLOW_THREADS
Eric Smithcfaf79c2009-10-26 14:48:55 +0000364 PyMem_Free(buf);
Guido van Rossum90933611991-06-07 16:10:43 +0000365 return 0;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000366}
367
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000368static PyObject *
Eric Smithcfaf79c2009-10-26 14:48:55 +0000369float_str_or_repr(PyFloatObject *v, int precision, char format_code)
370{
371 PyObject *result;
372 char *buf = PyOS_double_to_string(PyFloat_AS_DOUBLE(v),
373 format_code, precision,
374 Py_DTSF_ADD_DOT_0,
375 NULL);
376 if (!buf)
377 return PyErr_NoMemory();
378 result = PyString_FromString(buf);
379 PyMem_Free(buf);
380 return result;
381}
382
383static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000384float_repr(PyFloatObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000385{
Eric Smithcfaf79c2009-10-26 14:48:55 +0000386 return float_str_or_repr(v, 0, 'r');
Guido van Rossum57072eb1999-12-23 19:00:28 +0000387}
388
389static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000390float_str(PyFloatObject *v)
Guido van Rossum57072eb1999-12-23 19:00:28 +0000391{
Eric Smithcfaf79c2009-10-26 14:48:55 +0000392 return float_str_or_repr(v, PyFloat_STR_PRECISION, 'g');
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000393}
394
Tim Peters307fa782004-09-23 08:06:40 +0000395/* Comparison is pretty much a nightmare. When comparing float to float,
396 * we do it as straightforwardly (and long-windedly) as conceivable, so
397 * that, e.g., Python x == y delivers the same result as the platform
398 * C x == y when x and/or y is a NaN.
399 * When mixing float with an integer type, there's no good *uniform* approach.
400 * Converting the double to an integer obviously doesn't work, since we
401 * may lose info from fractional bits. Converting the integer to a double
402 * also has two failure modes: (1) a long int may trigger overflow (too
403 * large to fit in the dynamic range of a C double); (2) even a C long may have
404 * more bits than fit in a C double (e.g., on a a 64-bit box long may have
405 * 63 bits of precision, but a C double probably has only 53), and then
406 * we can falsely claim equality when low-order integer bits are lost by
407 * coercion to double. So this part is painful too.
408 */
409
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000410static PyObject*
411float_richcompare(PyObject *v, PyObject *w, int op)
412{
413 double i, j;
414 int r = 0;
415
Tim Peters307fa782004-09-23 08:06:40 +0000416 assert(PyFloat_Check(v));
417 i = PyFloat_AS_DOUBLE(v);
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000418
Tim Peters307fa782004-09-23 08:06:40 +0000419 /* Switch on the type of w. Set i and j to doubles to be compared,
420 * and op to the richcomp to use.
421 */
422 if (PyFloat_Check(w))
423 j = PyFloat_AS_DOUBLE(w);
424
Kristján Valur Jónssonf94323f2006-05-25 15:53:30 +0000425 else if (!Py_IS_FINITE(i)) {
Tim Peters307fa782004-09-23 08:06:40 +0000426 if (PyInt_Check(w) || PyLong_Check(w))
Tim Peterse1c69b32004-09-23 19:22:41 +0000427 /* If i is an infinity, its magnitude exceeds any
428 * finite integer, so it doesn't matter which int we
429 * compare i with. If i is a NaN, similarly.
Tim Peters307fa782004-09-23 08:06:40 +0000430 */
431 j = 0.0;
432 else
433 goto Unimplemented;
434 }
435
436 else if (PyInt_Check(w)) {
437 long jj = PyInt_AS_LONG(w);
438 /* In the worst realistic case I can imagine, C double is a
439 * Cray single with 48 bits of precision, and long has 64
440 * bits.
441 */
Tim Peterse1c69b32004-09-23 19:22:41 +0000442#if SIZEOF_LONG > 6
Tim Peters307fa782004-09-23 08:06:40 +0000443 unsigned long abs = (unsigned long)(jj < 0 ? -jj : jj);
444 if (abs >> 48) {
445 /* Needs more than 48 bits. Make it take the
446 * PyLong path.
447 */
448 PyObject *result;
449 PyObject *ww = PyLong_FromLong(jj);
450
451 if (ww == NULL)
452 return NULL;
453 result = float_richcompare(v, ww, op);
454 Py_DECREF(ww);
455 return result;
456 }
457#endif
458 j = (double)jj;
459 assert((long)j == jj);
460 }
461
462 else if (PyLong_Check(w)) {
463 int vsign = i == 0.0 ? 0 : i < 0.0 ? -1 : 1;
464 int wsign = _PyLong_Sign(w);
465 size_t nbits;
Tim Peters307fa782004-09-23 08:06:40 +0000466 int exponent;
467
468 if (vsign != wsign) {
469 /* Magnitudes are irrelevant -- the signs alone
470 * determine the outcome.
471 */
472 i = (double)vsign;
473 j = (double)wsign;
474 goto Compare;
475 }
476 /* The signs are the same. */
477 /* Convert w to a double if it fits. In particular, 0 fits. */
478 nbits = _PyLong_NumBits(w);
479 if (nbits == (size_t)-1 && PyErr_Occurred()) {
480 /* This long is so large that size_t isn't big enough
Tim Peterse1c69b32004-09-23 19:22:41 +0000481 * to hold the # of bits. Replace with little doubles
482 * that give the same outcome -- w is so large that
483 * its magnitude must exceed the magnitude of any
484 * finite float.
Tim Peters307fa782004-09-23 08:06:40 +0000485 */
486 PyErr_Clear();
487 i = (double)vsign;
488 assert(wsign != 0);
489 j = wsign * 2.0;
490 goto Compare;
491 }
492 if (nbits <= 48) {
493 j = PyLong_AsDouble(w);
494 /* It's impossible that <= 48 bits overflowed. */
495 assert(j != -1.0 || ! PyErr_Occurred());
496 goto Compare;
497 }
498 assert(wsign != 0); /* else nbits was 0 */
499 assert(vsign != 0); /* if vsign were 0, then since wsign is
500 * not 0, we would have taken the
501 * vsign != wsign branch at the start */
502 /* We want to work with non-negative numbers. */
503 if (vsign < 0) {
504 /* "Multiply both sides" by -1; this also swaps the
505 * comparator.
506 */
507 i = -i;
508 op = _Py_SwappedOp[op];
509 }
510 assert(i > 0.0);
Neal Norwitzb2da01b2006-01-08 01:11:25 +0000511 (void) frexp(i, &exponent);
Tim Peters307fa782004-09-23 08:06:40 +0000512 /* exponent is the # of bits in v before the radix point;
513 * we know that nbits (the # of bits in w) > 48 at this point
514 */
515 if (exponent < 0 || (size_t)exponent < nbits) {
516 i = 1.0;
517 j = 2.0;
518 goto Compare;
519 }
520 if ((size_t)exponent > nbits) {
521 i = 2.0;
522 j = 1.0;
523 goto Compare;
524 }
525 /* v and w have the same number of bits before the radix
526 * point. Construct two longs that have the same comparison
527 * outcome.
528 */
529 {
530 double fracpart;
531 double intpart;
532 PyObject *result = NULL;
533 PyObject *one = NULL;
534 PyObject *vv = NULL;
535 PyObject *ww = w;
536
537 if (wsign < 0) {
538 ww = PyNumber_Negative(w);
539 if (ww == NULL)
540 goto Error;
541 }
542 else
543 Py_INCREF(ww);
544
545 fracpart = modf(i, &intpart);
546 vv = PyLong_FromDouble(intpart);
547 if (vv == NULL)
548 goto Error;
549
550 if (fracpart != 0.0) {
551 /* Shift left, and or a 1 bit into vv
552 * to represent the lost fraction.
553 */
554 PyObject *temp;
555
556 one = PyInt_FromLong(1);
557 if (one == NULL)
558 goto Error;
559
560 temp = PyNumber_Lshift(ww, one);
561 if (temp == NULL)
562 goto Error;
563 Py_DECREF(ww);
564 ww = temp;
565
566 temp = PyNumber_Lshift(vv, one);
567 if (temp == NULL)
568 goto Error;
569 Py_DECREF(vv);
570 vv = temp;
571
572 temp = PyNumber_Or(vv, one);
573 if (temp == NULL)
574 goto Error;
575 Py_DECREF(vv);
576 vv = temp;
577 }
578
579 r = PyObject_RichCompareBool(vv, ww, op);
580 if (r < 0)
581 goto Error;
582 result = PyBool_FromLong(r);
583 Error:
584 Py_XDECREF(vv);
585 Py_XDECREF(ww);
586 Py_XDECREF(one);
587 return result;
588 }
589 } /* else if (PyLong_Check(w)) */
590
591 else /* w isn't float, int, or long */
592 goto Unimplemented;
593
594 Compare:
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000595 PyFPE_START_PROTECT("richcompare", return NULL)
596 switch (op) {
597 case Py_EQ:
Tim Peters307fa782004-09-23 08:06:40 +0000598 r = i == j;
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000599 break;
600 case Py_NE:
Tim Peters307fa782004-09-23 08:06:40 +0000601 r = i != j;
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000602 break;
603 case Py_LE:
Tim Peters307fa782004-09-23 08:06:40 +0000604 r = i <= j;
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000605 break;
606 case Py_GE:
Tim Peters307fa782004-09-23 08:06:40 +0000607 r = i >= j;
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000608 break;
609 case Py_LT:
Tim Peters307fa782004-09-23 08:06:40 +0000610 r = i < j;
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000611 break;
612 case Py_GT:
Tim Peters307fa782004-09-23 08:06:40 +0000613 r = i > j;
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000614 break;
615 }
Michael W. Hudson957f9772004-02-26 12:33:09 +0000616 PyFPE_END_PROTECT(r)
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000617 return PyBool_FromLong(r);
Tim Peters307fa782004-09-23 08:06:40 +0000618
619 Unimplemented:
620 Py_INCREF(Py_NotImplemented);
621 return Py_NotImplemented;
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000622}
623
Guido van Rossum9bfef441993-03-29 10:43:31 +0000624static long
Fred Drakefd99de62000-07-09 05:02:18 +0000625float_hash(PyFloatObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000626{
Tim Peters39dce292000-08-15 03:34:48 +0000627 return _Py_HashDouble(v->ob_fval);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000628}
629
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000630static PyObject *
Neil Schemenauer32117e52001-01-04 01:44:34 +0000631float_add(PyObject *v, PyObject *w)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000632{
Neil Schemenauer32117e52001-01-04 01:44:34 +0000633 double a,b;
634 CONVERT_TO_DOUBLE(v, a);
635 CONVERT_TO_DOUBLE(w, b);
Guido van Rossum09e6ad01997-02-14 22:54:21 +0000636 PyFPE_START_PROTECT("add", return 0)
Neil Schemenauer32117e52001-01-04 01:44:34 +0000637 a = a + b;
638 PyFPE_END_PROTECT(a)
639 return PyFloat_FromDouble(a);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000640}
641
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000642static PyObject *
Neil Schemenauer32117e52001-01-04 01:44:34 +0000643float_sub(PyObject *v, PyObject *w)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000644{
Neil Schemenauer32117e52001-01-04 01:44:34 +0000645 double a,b;
646 CONVERT_TO_DOUBLE(v, a);
647 CONVERT_TO_DOUBLE(w, b);
Guido van Rossum09e6ad01997-02-14 22:54:21 +0000648 PyFPE_START_PROTECT("subtract", return 0)
Neil Schemenauer32117e52001-01-04 01:44:34 +0000649 a = a - b;
650 PyFPE_END_PROTECT(a)
651 return PyFloat_FromDouble(a);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000652}
653
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000654static PyObject *
Neil Schemenauer32117e52001-01-04 01:44:34 +0000655float_mul(PyObject *v, PyObject *w)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000656{
Neil Schemenauer32117e52001-01-04 01:44:34 +0000657 double a,b;
658 CONVERT_TO_DOUBLE(v, a);
659 CONVERT_TO_DOUBLE(w, b);
Guido van Rossum09e6ad01997-02-14 22:54:21 +0000660 PyFPE_START_PROTECT("multiply", return 0)
Neil Schemenauer32117e52001-01-04 01:44:34 +0000661 a = a * b;
662 PyFPE_END_PROTECT(a)
663 return PyFloat_FromDouble(a);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000664}
665
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000666static PyObject *
Neil Schemenauer32117e52001-01-04 01:44:34 +0000667float_div(PyObject *v, PyObject *w)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000668{
Neil Schemenauer32117e52001-01-04 01:44:34 +0000669 double a,b;
670 CONVERT_TO_DOUBLE(v, a);
671 CONVERT_TO_DOUBLE(w, b);
Christian Heimes6f341092008-04-18 23:13:07 +0000672#ifdef Py_NAN
Neil Schemenauer32117e52001-01-04 01:44:34 +0000673 if (b == 0.0) {
Christian Heimes6f341092008-04-18 23:13:07 +0000674 PyErr_SetString(PyExc_ZeroDivisionError,
675 "float division");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000676 return NULL;
677 }
Christian Heimes6f341092008-04-18 23:13:07 +0000678#endif
Guido van Rossum09e6ad01997-02-14 22:54:21 +0000679 PyFPE_START_PROTECT("divide", return 0)
Neil Schemenauer32117e52001-01-04 01:44:34 +0000680 a = a / b;
681 PyFPE_END_PROTECT(a)
682 return PyFloat_FromDouble(a);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000683}
684
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000685static PyObject *
Guido van Rossum393661d2001-08-31 17:40:15 +0000686float_classic_div(PyObject *v, PyObject *w)
687{
688 double a,b;
689 CONVERT_TO_DOUBLE(v, a);
690 CONVERT_TO_DOUBLE(w, b);
Guido van Rossum1832de42001-09-04 03:51:09 +0000691 if (Py_DivisionWarningFlag >= 2 &&
Guido van Rossum393661d2001-08-31 17:40:15 +0000692 PyErr_Warn(PyExc_DeprecationWarning, "classic float division") < 0)
693 return NULL;
Christian Heimes6f341092008-04-18 23:13:07 +0000694#ifdef Py_NAN
Guido van Rossum393661d2001-08-31 17:40:15 +0000695 if (b == 0.0) {
Christian Heimes6f341092008-04-18 23:13:07 +0000696 PyErr_SetString(PyExc_ZeroDivisionError,
697 "float division");
Guido van Rossum393661d2001-08-31 17:40:15 +0000698 return NULL;
699 }
Christian Heimes6f341092008-04-18 23:13:07 +0000700#endif
Guido van Rossum393661d2001-08-31 17:40:15 +0000701 PyFPE_START_PROTECT("divide", return 0)
702 a = a / b;
703 PyFPE_END_PROTECT(a)
704 return PyFloat_FromDouble(a);
705}
706
707static PyObject *
Neil Schemenauer32117e52001-01-04 01:44:34 +0000708float_rem(PyObject *v, PyObject *w)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000709{
Guido van Rossum56cd67a1992-01-26 18:16:35 +0000710 double vx, wx;
Guido van Rossum9263e781999-05-06 14:26:34 +0000711 double mod;
Christian Heimes6f341092008-04-18 23:13:07 +0000712 CONVERT_TO_DOUBLE(v, vx);
713 CONVERT_TO_DOUBLE(w, wx);
714#ifdef Py_NAN
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000715 if (wx == 0.0) {
Christian Heimes6f341092008-04-18 23:13:07 +0000716 PyErr_SetString(PyExc_ZeroDivisionError,
717 "float modulo");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000718 return NULL;
719 }
Christian Heimes6f341092008-04-18 23:13:07 +0000720#endif
Guido van Rossum09e6ad01997-02-14 22:54:21 +0000721 PyFPE_START_PROTECT("modulo", return 0)
Guido van Rossum56cd67a1992-01-26 18:16:35 +0000722 mod = fmod(vx, wx);
Guido van Rossum9263e781999-05-06 14:26:34 +0000723 /* note: checking mod*wx < 0 is incorrect -- underflows to
724 0 if wx < sqrt(smallest nonzero double) */
725 if (mod && ((wx < 0) != (mod < 0))) {
Guido van Rossum56cd67a1992-01-26 18:16:35 +0000726 mod += wx;
Guido van Rossum56cd67a1992-01-26 18:16:35 +0000727 }
Guido van Rossum45b83911997-03-14 04:32:50 +0000728 PyFPE_END_PROTECT(mod)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000729 return PyFloat_FromDouble(mod);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000730}
731
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000732static PyObject *
Neil Schemenauer32117e52001-01-04 01:44:34 +0000733float_divmod(PyObject *v, PyObject *w)
Guido van Rossumeba1b5e1991-05-05 20:07:00 +0000734{
Guido van Rossum15ecff41991-10-20 20:16:45 +0000735 double vx, wx;
Guido van Rossum9263e781999-05-06 14:26:34 +0000736 double div, mod, floordiv;
Neil Schemenauer32117e52001-01-04 01:44:34 +0000737 CONVERT_TO_DOUBLE(v, vx);
738 CONVERT_TO_DOUBLE(w, wx);
Guido van Rossum15ecff41991-10-20 20:16:45 +0000739 if (wx == 0.0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000740 PyErr_SetString(PyExc_ZeroDivisionError, "float divmod()");
Guido van Rossum15ecff41991-10-20 20:16:45 +0000741 return NULL;
742 }
Guido van Rossum09e6ad01997-02-14 22:54:21 +0000743 PyFPE_START_PROTECT("divmod", return 0)
Guido van Rossum15ecff41991-10-20 20:16:45 +0000744 mod = fmod(vx, wx);
Tim Peters78fc0b52000-09-16 03:54:24 +0000745 /* fmod is typically exact, so vx-mod is *mathematically* an
Guido van Rossum9263e781999-05-06 14:26:34 +0000746 exact multiple of wx. But this is fp arithmetic, and fp
747 vx - mod is an approximation; the result is that div may
748 not be an exact integral value after the division, although
749 it will always be very close to one.
750 */
Guido van Rossum15ecff41991-10-20 20:16:45 +0000751 div = (vx - mod) / wx;
Tim Petersd2e40d62001-11-01 23:12:27 +0000752 if (mod) {
753 /* ensure the remainder has the same sign as the denominator */
754 if ((wx < 0) != (mod < 0)) {
755 mod += wx;
756 div -= 1.0;
757 }
758 }
759 else {
760 /* the remainder is zero, and in the presence of signed zeroes
761 fmod returns different results across platforms; ensure
762 it has the same sign as the denominator; we'd like to do
763 "mod = wx * 0.0", but that may get optimized away */
Tim Peters4e8ab5d2001-11-01 23:59:56 +0000764 mod *= mod; /* hide "mod = +0" from optimizer */
Tim Petersd2e40d62001-11-01 23:12:27 +0000765 if (wx < 0.0)
766 mod = -mod;
Guido van Rossum15ecff41991-10-20 20:16:45 +0000767 }
Guido van Rossum9263e781999-05-06 14:26:34 +0000768 /* snap quotient to nearest integral value */
Tim Petersd2e40d62001-11-01 23:12:27 +0000769 if (div) {
770 floordiv = floor(div);
771 if (div - floordiv > 0.5)
772 floordiv += 1.0;
773 }
774 else {
775 /* div is zero - get the same sign as the true quotient */
776 div *= div; /* hide "div = +0" from optimizers */
777 floordiv = div * vx / wx; /* zero w/ sign of vx/wx */
778 }
779 PyFPE_END_PROTECT(floordiv)
Guido van Rossum9263e781999-05-06 14:26:34 +0000780 return Py_BuildValue("(dd)", floordiv, mod);
Guido van Rossumeba1b5e1991-05-05 20:07:00 +0000781}
782
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000783static PyObject *
Tim Peters63a35712001-12-11 19:57:24 +0000784float_floor_div(PyObject *v, PyObject *w)
785{
786 PyObject *t, *r;
787
788 t = float_divmod(v, w);
Tim Peters77d8a4f2001-12-11 20:31:34 +0000789 if (t == NULL || t == Py_NotImplemented)
790 return t;
791 assert(PyTuple_CheckExact(t));
792 r = PyTuple_GET_ITEM(t, 0);
793 Py_INCREF(r);
794 Py_DECREF(t);
795 return r;
Tim Peters63a35712001-12-11 19:57:24 +0000796}
797
798static PyObject *
Neil Schemenauer32117e52001-01-04 01:44:34 +0000799float_pow(PyObject *v, PyObject *w, PyObject *z)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000800{
801 double iv, iw, ix;
Tim Peters32f453e2001-09-03 08:35:41 +0000802
803 if ((PyObject *)z != Py_None) {
Tim Peters4c483c42001-09-05 06:24:58 +0000804 PyErr_SetString(PyExc_TypeError, "pow() 3rd argument not "
Tim Peters97f4a332001-09-05 23:49:24 +0000805 "allowed unless all arguments are integers");
Tim Peters32f453e2001-09-03 08:35:41 +0000806 return NULL;
807 }
808
Neil Schemenauer32117e52001-01-04 01:44:34 +0000809 CONVERT_TO_DOUBLE(v, iv);
810 CONVERT_TO_DOUBLE(w, iw);
Tim Petersc54d1902000-10-06 00:36:09 +0000811
812 /* Sort out special cases here instead of relying on pow() */
Tim Peters96685bf2001-08-23 22:31:37 +0000813 if (iw == 0) { /* v**0 is 1, even 0**0 */
Neal Norwitz8b267b52007-05-03 07:20:57 +0000814 return PyFloat_FromDouble(1.0);
Tim Petersc54d1902000-10-06 00:36:09 +0000815 }
Tim Peters96685bf2001-08-23 22:31:37 +0000816 if (iv == 0.0) { /* 0**w is error if w<0, else 1 */
Tim Petersc54d1902000-10-06 00:36:09 +0000817 if (iw < 0.0) {
818 PyErr_SetString(PyExc_ZeroDivisionError,
Fred Drake661ea262000-10-24 19:57:45 +0000819 "0.0 cannot be raised to a negative power");
Tim Petersc54d1902000-10-06 00:36:09 +0000820 return NULL;
821 }
822 return PyFloat_FromDouble(0.0);
823 }
Christian Heimes6f341092008-04-18 23:13:07 +0000824 if (iv == 1.0) { /* 1**w is 1, even 1**inf and 1**nan */
825 return PyFloat_FromDouble(1.0);
826 }
Tim Peterse87568d2003-05-24 20:18:24 +0000827 if (iv < 0.0) {
828 /* Whether this is an error is a mess, and bumps into libm
829 * bugs so we have to figure it out ourselves.
830 */
831 if (iw != floor(iw)) {
Jeffrey Yasskin9871d8f2008-01-05 08:47:13 +0000832 PyErr_SetString(PyExc_ValueError, "negative number "
833 "cannot be raised to a fractional power");
834 return NULL;
Tim Peterse87568d2003-05-24 20:18:24 +0000835 }
836 /* iw is an exact integer, albeit perhaps a very large one.
837 * -1 raised to an exact integer should never be exceptional.
838 * Alas, some libms (chiefly glibc as of early 2003) return
839 * NaN and set EDOM on pow(-1, large_int) if the int doesn't
840 * happen to be representable in a *C* integer. That's a
841 * bug; we let that slide in math.pow() (which currently
842 * reflects all platform accidents), but not for Python's **.
843 */
Kristján Valur Jónssonf94323f2006-05-25 15:53:30 +0000844 if (iv == -1.0 && Py_IS_FINITE(iw)) {
Tim Peterse87568d2003-05-24 20:18:24 +0000845 /* Return 1 if iw is even, -1 if iw is odd; there's
846 * no guarantee that any C integral type is big
847 * enough to hold iw, so we have to check this
848 * indirectly.
849 */
850 ix = floor(iw * 0.5) * 2.0;
851 return PyFloat_FromDouble(ix == iw ? 1.0 : -1.0);
852 }
853 /* Else iv != -1.0, and overflow or underflow are possible.
854 * Unless we're to write pow() ourselves, we have to trust
855 * the platform to do this correctly.
856 */
Guido van Rossum86c04c21996-08-09 20:50:14 +0000857 }
Tim Peters96685bf2001-08-23 22:31:37 +0000858 errno = 0;
859 PyFPE_START_PROTECT("pow", return NULL)
860 ix = pow(iv, iw);
861 PyFPE_END_PROTECT(ix)
Tim Petersdc5a5082002-03-09 04:58:24 +0000862 Py_ADJUST_ERANGE1(ix);
Alex Martelli348dc882006-08-23 22:17:59 +0000863 if (errno != 0) {
Tim Peterse87568d2003-05-24 20:18:24 +0000864 /* We don't expect any errno value other than ERANGE, but
865 * the range of libm bugs appears unbounded.
866 */
Alex Martelli348dc882006-08-23 22:17:59 +0000867 PyErr_SetFromErrno(errno == ERANGE ? PyExc_OverflowError :
868 PyExc_ValueError);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000869 return NULL;
Guido van Rossum2a9096b1990-10-21 22:15:08 +0000870 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000871 return PyFloat_FromDouble(ix);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000872}
873
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000874static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000875float_neg(PyFloatObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000876{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000877 return PyFloat_FromDouble(-v->ob_fval);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000878}
879
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000880static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000881float_abs(PyFloatObject *v)
Guido van Rossumeba1b5e1991-05-05 20:07:00 +0000882{
Tim Petersfaf0cd22001-11-01 21:51:15 +0000883 return PyFloat_FromDouble(fabs(v->ob_fval));
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000884}
885
Guido van Rossum50b4ef61991-05-14 11:57:01 +0000886static int
Fred Drakefd99de62000-07-09 05:02:18 +0000887float_nonzero(PyFloatObject *v)
Guido van Rossum50b4ef61991-05-14 11:57:01 +0000888{
889 return v->ob_fval != 0.0;
890}
891
Guido van Rossum234f9421993-06-17 12:35:49 +0000892static int
Fred Drakefd99de62000-07-09 05:02:18 +0000893float_coerce(PyObject **pv, PyObject **pw)
Guido van Rossume6eefc21992-08-14 12:06:52 +0000894{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000895 if (PyInt_Check(*pw)) {
896 long x = PyInt_AsLong(*pw);
897 *pw = PyFloat_FromDouble((double)x);
898 Py_INCREF(*pv);
Guido van Rossume6eefc21992-08-14 12:06:52 +0000899 return 0;
900 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000901 else if (PyLong_Check(*pw)) {
Neal Norwitzabcb0c02003-01-28 19:21:24 +0000902 double x = PyLong_AsDouble(*pw);
903 if (x == -1.0 && PyErr_Occurred())
904 return -1;
905 *pw = PyFloat_FromDouble(x);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000906 Py_INCREF(*pv);
Guido van Rossume6eefc21992-08-14 12:06:52 +0000907 return 0;
908 }
Guido van Rossum1952e382001-09-19 01:25:16 +0000909 else if (PyFloat_Check(*pw)) {
910 Py_INCREF(*pv);
911 Py_INCREF(*pw);
912 return 0;
913 }
Guido van Rossume6eefc21992-08-14 12:06:52 +0000914 return 1; /* Can't do it */
915}
916
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000917static PyObject *
Christian Heimes6f341092008-04-18 23:13:07 +0000918float_is_integer(PyObject *v)
919{
920 double x = PyFloat_AsDouble(v);
921 PyObject *o;
922
923 if (x == -1.0 && PyErr_Occurred())
924 return NULL;
925 if (!Py_IS_FINITE(x))
926 Py_RETURN_FALSE;
Mark Dickinsone81c3762008-05-09 16:14:15 +0000927 errno = 0;
Christian Heimes6f341092008-04-18 23:13:07 +0000928 PyFPE_START_PROTECT("is_integer", return NULL)
929 o = (floor(x) == x) ? Py_True : Py_False;
930 PyFPE_END_PROTECT(x)
931 if (errno != 0) {
932 PyErr_SetFromErrno(errno == ERANGE ? PyExc_OverflowError :
933 PyExc_ValueError);
934 return NULL;
935 }
936 Py_INCREF(o);
937 return o;
938}
939
940#if 0
941static PyObject *
942float_is_inf(PyObject *v)
943{
944 double x = PyFloat_AsDouble(v);
945 if (x == -1.0 && PyErr_Occurred())
946 return NULL;
947 return PyBool_FromLong((long)Py_IS_INFINITY(x));
948}
949
950static PyObject *
951float_is_nan(PyObject *v)
952{
953 double x = PyFloat_AsDouble(v);
954 if (x == -1.0 && PyErr_Occurred())
955 return NULL;
956 return PyBool_FromLong((long)Py_IS_NAN(x));
957}
958
959static PyObject *
960float_is_finite(PyObject *v)
961{
962 double x = PyFloat_AsDouble(v);
963 if (x == -1.0 && PyErr_Occurred())
964 return NULL;
965 return PyBool_FromLong((long)Py_IS_FINITE(x));
966}
967#endif
968
969static PyObject *
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +0000970float_trunc(PyObject *v)
Guido van Rossum1899c2e1992-09-12 11:09:23 +0000971{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000972 double x = PyFloat_AsDouble(v);
Tim Peters7321ec42001-07-26 20:02:17 +0000973 double wholepart; /* integral portion of x, rounded toward 0 */
Tim Peters7321ec42001-07-26 20:02:17 +0000974
975 (void)modf(x, &wholepart);
Tim Peters7d791242002-11-21 22:26:37 +0000976 /* Try to get out cheap if this fits in a Python int. The attempt
977 * to cast to long must be protected, as C doesn't define what
978 * happens if the double is too big to fit in a long. Some rare
979 * systems raise an exception then (RISCOS was mentioned as one,
980 * and someone using a non-default option on Sun also bumped into
981 * that). Note that checking for >= and <= LONG_{MIN,MAX} would
982 * still be vulnerable: if a long has more bits of precision than
983 * a double, casting MIN/MAX to double may yield an approximation,
984 * and if that's rounded up, then, e.g., wholepart=LONG_MAX+1 would
985 * yield true from the C expression wholepart<=LONG_MAX, despite
986 * that wholepart is actually greater than LONG_MAX.
987 */
988 if (LONG_MIN < wholepart && wholepart < LONG_MAX) {
989 const long aslong = (long)wholepart;
Tim Peters7321ec42001-07-26 20:02:17 +0000990 return PyInt_FromLong(aslong);
Tim Peters7d791242002-11-21 22:26:37 +0000991 }
992 return PyLong_FromDouble(wholepart);
Guido van Rossum1899c2e1992-09-12 11:09:23 +0000993}
994
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000995static PyObject *
Amaury Forgeot d'Arcd3ffb892008-09-09 07:24:30 +0000996float_long(PyObject *v)
997{
998 double x = PyFloat_AsDouble(v);
999 return PyLong_FromDouble(x);
1000}
1001
Mark Dickinsonbd15a062009-11-18 19:33:35 +00001002/* _Py_double_round: rounds a finite nonzero double to the closest multiple of
1003 10**-ndigits; here ndigits is within reasonable bounds (typically, -308 <=
1004 ndigits <= 323). Returns a Python float, or sets a Python error and
1005 returns NULL on failure (OverflowError and memory errors are possible). */
1006
1007#ifndef PY_NO_SHORT_FLOAT_REPR
1008/* version of _Py_double_round that uses the correctly-rounded string<->double
1009 conversions from Python/dtoa.c */
1010
1011/* FIVE_POW_LIMIT is the largest k such that 5**k is exactly representable as
1012 a double. Since we're using the code in Python/dtoa.c, it should be safe
1013 to assume that C doubles are IEEE 754 binary64 format. To be on the safe
1014 side, we check this. */
1015#if DBL_MANT_DIG == 53
1016#define FIVE_POW_LIMIT 22
1017#else
1018#error "C doubles do not appear to be IEEE 754 binary64 format"
1019#endif
1020
1021PyObject *
1022_Py_double_round(double x, int ndigits) {
1023
1024 double rounded, m;
1025 Py_ssize_t buflen, mybuflen=100;
1026 char *buf, *buf_end, shortbuf[100], *mybuf=shortbuf;
1027 int decpt, sign, val, halfway_case;
1028 PyObject *result = NULL;
1029
1030 /* The basic idea is very simple: convert and round the double to a
1031 decimal string using _Py_dg_dtoa, then convert that decimal string
1032 back to a double with _Py_dg_strtod. There's one minor difficulty:
1033 Python 2.x expects round to do round-half-away-from-zero, while
1034 _Py_dg_dtoa does round-half-to-even. So we need some way to detect
1035 and correct the halfway cases.
1036
1037 Detection: a halfway value has the form k * 0.5 * 10**-ndigits for
1038 some odd integer k. Or in other words, a rational number x is
1039 exactly halfway between two multiples of 10**-ndigits if its
1040 2-valuation is exactly -ndigits-1 and its 5-valuation is at least
1041 -ndigits. For ndigits >= 0 the latter condition is automatically
1042 satisfied for a binary float x, since any such float has
1043 nonnegative 5-valuation. For 0 > ndigits >= -22, x needs to be an
1044 integral multiple of 5**-ndigits; we can check this using fmod.
1045 For -22 > ndigits, there are no halfway cases: 5**23 takes 54 bits
1046 to represent exactly, so any odd multiple of 0.5 * 10**n for n >=
1047 23 takes at least 54 bits of precision to represent exactly.
1048
1049 Correction: a simple strategy for dealing with halfway cases is to
1050 (for the halfway cases only) call _Py_dg_dtoa with an argument of
1051 ndigits+1 instead of ndigits (thus doing an exact conversion to
1052 decimal), round the resulting string manually, and then convert
1053 back using _Py_dg_strtod.
1054 */
1055
1056 /* nans, infinities and zeros should have already been dealt
1057 with by the caller (in this case, builtin_round) */
1058 assert(Py_IS_FINITE(x) && x != 0.0);
1059
1060 /* find 2-valuation val of x */
1061 m = frexp(x, &val);
1062 while (m != floor(m)) {
1063 m *= 2.0;
1064 val--;
1065 }
1066
1067 /* determine whether this is a halfway case */
1068 if (val == -ndigits-1) {
1069 if (ndigits >= 0)
1070 halfway_case = 1;
1071 else if (ndigits >= -FIVE_POW_LIMIT) {
1072 double five_pow = 1.0;
1073 int i;
1074 for (i=0; i < -ndigits; i++)
1075 five_pow *= 5.0;
1076 halfway_case = fmod(x, five_pow) == 0.0;
1077 }
1078 else
1079 halfway_case = 0;
1080 }
1081 else
1082 halfway_case = 0;
1083
1084 /* round to a decimal string; use an extra place for halfway case */
1085 buf = _Py_dg_dtoa(x, 3, ndigits+halfway_case, &decpt, &sign, &buf_end);
1086 if (buf == NULL) {
1087 PyErr_NoMemory();
1088 return NULL;
1089 }
1090 buflen = buf_end - buf;
1091
1092 /* in halfway case, do the round-half-away-from-zero manually */
1093 if (halfway_case) {
1094 int i, carry;
1095 /* sanity check: _Py_dg_dtoa should not have stripped
1096 any zeros from the result: there should be exactly
1097 ndigits+1 places following the decimal point, and
1098 the last digit in the buffer should be a '5'.*/
1099 assert(buflen - decpt == ndigits+1);
1100 assert(buf[buflen-1] == '5');
1101
1102 /* increment and shift right at the same time. */
1103 decpt += 1;
1104 carry = 1;
1105 for (i=buflen-1; i-- > 0;) {
1106 carry += buf[i] - '0';
1107 buf[i+1] = carry % 10 + '0';
1108 carry /= 10;
1109 }
1110 buf[0] = carry + '0';
1111 }
1112
1113 /* Get new buffer if shortbuf is too small. Space needed <= buf_end -
1114 buf + 8: (1 extra for '0', 1 for sign, 5 for exp, 1 for '\0'). */
1115 if (buflen + 8 > mybuflen) {
1116 mybuflen = buflen+8;
1117 mybuf = (char *)PyMem_Malloc(mybuflen);
1118 if (mybuf == NULL) {
1119 PyErr_NoMemory();
1120 goto exit;
1121 }
1122 }
1123 /* copy buf to mybuf, adding exponent, sign and leading 0 */
1124 PyOS_snprintf(mybuf, mybuflen, "%s0%se%d", (sign ? "-" : ""),
1125 buf, decpt - (int)buflen);
1126
1127 /* and convert the resulting string back to a double */
1128 errno = 0;
1129 rounded = _Py_dg_strtod(mybuf, NULL);
1130 if (errno == ERANGE && fabs(rounded) >= 1.)
1131 PyErr_SetString(PyExc_OverflowError,
1132 "rounded value too large to represent");
1133 else
1134 result = PyFloat_FromDouble(rounded);
1135
1136 /* done computing value; now clean up */
1137 if (mybuf != shortbuf)
1138 PyMem_Free(mybuf);
1139 exit:
1140 _Py_dg_freedtoa(buf);
1141 return result;
1142}
1143
1144#undef FIVE_POW_LIMIT
1145
1146#else /* PY_NO_SHORT_FLOAT_REPR */
1147
1148/* fallback version, to be used when correctly rounded binary<->decimal
1149 conversions aren't available */
1150
1151PyObject *
1152_Py_double_round(double x, int ndigits) {
1153 double pow1, pow2, y, z;
1154 if (ndigits >= 0) {
1155 if (ndigits > 22) {
1156 /* pow1 and pow2 are each safe from overflow, but
1157 pow1*pow2 ~= pow(10.0, ndigits) might overflow */
1158 pow1 = pow(10.0, (double)(ndigits-22));
1159 pow2 = 1e22;
1160 }
1161 else {
1162 pow1 = pow(10.0, (double)ndigits);
1163 pow2 = 1.0;
1164 }
1165 y = (x*pow1)*pow2;
1166 /* if y overflows, then rounded value is exactly x */
1167 if (!Py_IS_FINITE(y))
1168 return PyFloat_FromDouble(x);
1169 }
1170 else {
1171 pow1 = pow(10.0, (double)-ndigits);
1172 pow2 = 1.0; /* unused; silences a gcc compiler warning */
1173 y = x / pow1;
1174 }
1175
1176 z = round(y);
1177 if (fabs(y-z) == 0.5)
1178 /* halfway between two integers; use round-away-from-zero */
1179 z = y + copysign(0.5, y);
1180
1181 if (ndigits >= 0)
1182 z = (z / pow2) / pow1;
1183 else
1184 z *= pow1;
1185
1186 /* if computation resulted in overflow, raise OverflowError */
1187 if (!Py_IS_FINITE(z)) {
1188 PyErr_SetString(PyExc_OverflowError,
1189 "overflow occurred during round");
1190 return NULL;
1191 }
1192
1193 return PyFloat_FromDouble(z);
1194}
1195
1196#endif /* PY_NO_SHORT_FLOAT_REPR */
1197
Amaury Forgeot d'Arcd3ffb892008-09-09 07:24:30 +00001198static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001199float_float(PyObject *v)
Guido van Rossum1899c2e1992-09-12 11:09:23 +00001200{
Brett Cannonc3647ac2005-04-26 03:45:26 +00001201 if (PyFloat_CheckExact(v))
1202 Py_INCREF(v);
1203 else
1204 v = PyFloat_FromDouble(((PyFloatObject *)v)->ob_fval);
Guido van Rossum1899c2e1992-09-12 11:09:23 +00001205 return v;
1206}
1207
Mark Dickinson7103aa42008-07-15 19:08:33 +00001208/* turn ASCII hex characters into integer values and vice versa */
1209
1210static char
1211char_from_hex(int x)
1212{
1213 assert(0 <= x && x < 16);
1214 return "0123456789abcdef"[x];
1215}
1216
1217static int
1218hex_from_char(char c) {
1219 int x;
Mark Dickinson7103aa42008-07-15 19:08:33 +00001220 switch(c) {
1221 case '0':
1222 x = 0;
1223 break;
1224 case '1':
1225 x = 1;
1226 break;
1227 case '2':
1228 x = 2;
1229 break;
1230 case '3':
1231 x = 3;
1232 break;
1233 case '4':
1234 x = 4;
1235 break;
1236 case '5':
1237 x = 5;
1238 break;
1239 case '6':
1240 x = 6;
1241 break;
1242 case '7':
1243 x = 7;
1244 break;
1245 case '8':
1246 x = 8;
1247 break;
1248 case '9':
1249 x = 9;
1250 break;
1251 case 'a':
1252 case 'A':
1253 x = 10;
1254 break;
1255 case 'b':
1256 case 'B':
1257 x = 11;
1258 break;
1259 case 'c':
1260 case 'C':
1261 x = 12;
1262 break;
1263 case 'd':
1264 case 'D':
1265 x = 13;
1266 break;
1267 case 'e':
1268 case 'E':
1269 x = 14;
1270 break;
1271 case 'f':
1272 case 'F':
1273 x = 15;
1274 break;
1275 default:
1276 x = -1;
1277 break;
1278 }
1279 return x;
1280}
1281
1282/* convert a float to a hexadecimal string */
1283
1284/* TOHEX_NBITS is DBL_MANT_DIG rounded up to the next integer
1285 of the form 4k+1. */
1286#define TOHEX_NBITS DBL_MANT_DIG + 3 - (DBL_MANT_DIG+2)%4
1287
1288static PyObject *
1289float_hex(PyObject *v)
1290{
1291 double x, m;
1292 int e, shift, i, si, esign;
1293 /* Space for 1+(TOHEX_NBITS-1)/4 digits, a decimal point, and the
1294 trailing NUL byte. */
1295 char s[(TOHEX_NBITS-1)/4+3];
1296
1297 CONVERT_TO_DOUBLE(v, x);
1298
1299 if (Py_IS_NAN(x) || Py_IS_INFINITY(x))
1300 return float_str((PyFloatObject *)v);
1301
1302 if (x == 0.0) {
1303 if(copysign(1.0, x) == -1.0)
1304 return PyString_FromString("-0x0.0p+0");
1305 else
1306 return PyString_FromString("0x0.0p+0");
1307 }
1308
1309 m = frexp(fabs(x), &e);
1310 shift = 1 - MAX(DBL_MIN_EXP - e, 0);
1311 m = ldexp(m, shift);
1312 e -= shift;
1313
1314 si = 0;
1315 s[si] = char_from_hex((int)m);
1316 si++;
1317 m -= (int)m;
1318 s[si] = '.';
1319 si++;
1320 for (i=0; i < (TOHEX_NBITS-1)/4; i++) {
1321 m *= 16.0;
1322 s[si] = char_from_hex((int)m);
1323 si++;
1324 m -= (int)m;
1325 }
1326 s[si] = '\0';
1327
1328 if (e < 0) {
1329 esign = (int)'-';
1330 e = -e;
1331 }
1332 else
1333 esign = (int)'+';
1334
1335 if (x < 0.0)
1336 return PyString_FromFormat("-0x%sp%c%d", s, esign, e);
1337 else
1338 return PyString_FromFormat("0x%sp%c%d", s, esign, e);
1339}
1340
1341PyDoc_STRVAR(float_hex_doc,
1342"float.hex() -> string\n\
1343\n\
1344Return a hexadecimal representation of a floating-point number.\n\
1345>>> (-0.1).hex()\n\
1346'-0x1.999999999999ap-4'\n\
1347>>> 3.14159.hex()\n\
1348'0x1.921f9f01b866ep+1'");
1349
Mark Dickinsonb1d45852009-05-11 15:33:08 +00001350/* Case-insensitive locale-independent string match used for nan and inf
1351 detection. t should be lower-case and null-terminated. Return a nonzero
1352 result if the first strlen(t) characters of s match t and 0 otherwise. */
1353
1354static int
1355case_insensitive_match(const char *s, const char *t)
1356{
1357 while(*t && Py_TOLOWER(*s) == *t) {
1358 s++;
1359 t++;
1360 }
1361 return *t ? 0 : 1;
1362}
1363
Mark Dickinson7103aa42008-07-15 19:08:33 +00001364/* Convert a hexadecimal string to a float. */
1365
1366static PyObject *
1367float_fromhex(PyObject *cls, PyObject *arg)
1368{
1369 PyObject *result_as_float, *result;
1370 double x;
1371 long exp, top_exp, lsb, key_digit;
1372 char *s, *coeff_start, *s_store, *coeff_end, *exp_start, *s_end;
1373 int half_eps, digit, round_up, sign=1;
1374 Py_ssize_t length, ndigits, fdigits, i;
1375
1376 /*
1377 * For the sake of simplicity and correctness, we impose an artificial
1378 * limit on ndigits, the total number of hex digits in the coefficient
1379 * The limit is chosen to ensure that, writing exp for the exponent,
1380 *
1381 * (1) if exp > LONG_MAX/2 then the value of the hex string is
1382 * guaranteed to overflow (provided it's nonzero)
1383 *
1384 * (2) if exp < LONG_MIN/2 then the value of the hex string is
1385 * guaranteed to underflow to 0.
1386 *
1387 * (3) if LONG_MIN/2 <= exp <= LONG_MAX/2 then there's no danger of
1388 * overflow in the calculation of exp and top_exp below.
1389 *
1390 * More specifically, ndigits is assumed to satisfy the following
1391 * inequalities:
1392 *
1393 * 4*ndigits <= DBL_MIN_EXP - DBL_MANT_DIG - LONG_MIN/2
1394 * 4*ndigits <= LONG_MAX/2 + 1 - DBL_MAX_EXP
1395 *
1396 * If either of these inequalities is not satisfied, a ValueError is
1397 * raised. Otherwise, write x for the value of the hex string, and
1398 * assume x is nonzero. Then
1399 *
1400 * 2**(exp-4*ndigits) <= |x| < 2**(exp+4*ndigits).
1401 *
1402 * Now if exp > LONG_MAX/2 then:
1403 *
1404 * exp - 4*ndigits >= LONG_MAX/2 + 1 - (LONG_MAX/2 + 1 - DBL_MAX_EXP)
1405 * = DBL_MAX_EXP
1406 *
1407 * so |x| >= 2**DBL_MAX_EXP, which is too large to be stored in C
1408 * double, so overflows. If exp < LONG_MIN/2, then
1409 *
1410 * exp + 4*ndigits <= LONG_MIN/2 - 1 + (
1411 * DBL_MIN_EXP - DBL_MANT_DIG - LONG_MIN/2)
1412 * = DBL_MIN_EXP - DBL_MANT_DIG - 1
1413 *
1414 * and so |x| < 2**(DBL_MIN_EXP-DBL_MANT_DIG-1), hence underflows to 0
1415 * when converted to a C double.
1416 *
1417 * It's easy to show that if LONG_MIN/2 <= exp <= LONG_MAX/2 then both
1418 * exp+4*ndigits and exp-4*ndigits are within the range of a long.
1419 */
1420
1421 if (PyString_AsStringAndSize(arg, &s, &length))
1422 return NULL;
1423 s_end = s + length;
1424
1425 /********************
1426 * Parse the string *
1427 ********************/
1428
1429 /* leading whitespace and optional sign */
Mark Dickinson777e4ff2009-05-03 20:59:48 +00001430 while (Py_ISSPACE(*s))
Mark Dickinson7103aa42008-07-15 19:08:33 +00001431 s++;
1432 if (*s == '-') {
1433 s++;
1434 sign = -1;
1435 }
1436 else if (*s == '+')
1437 s++;
1438
1439 /* infinities and nans */
Mark Dickinsonb1d45852009-05-11 15:33:08 +00001440 if (*s == 'i' || *s == 'I') {
1441 if (!case_insensitive_match(s+1, "nf"))
1442 goto parse_error;
1443 s += 3;
1444 x = Py_HUGE_VAL;
1445 if (case_insensitive_match(s, "inity"))
1446 s += 5;
Mark Dickinson7103aa42008-07-15 19:08:33 +00001447 goto finished;
1448 }
Mark Dickinsonb1d45852009-05-11 15:33:08 +00001449 if (*s == 'n' || *s == 'N') {
1450 if (!case_insensitive_match(s+1, "an"))
1451 goto parse_error;
1452 s += 3;
1453 x = Py_NAN;
Mark Dickinson7103aa42008-07-15 19:08:33 +00001454 goto finished;
1455 }
1456
1457 /* [0x] */
1458 s_store = s;
1459 if (*s == '0') {
1460 s++;
Mark Dickinson777e4ff2009-05-03 20:59:48 +00001461 if (*s == 'x' || *s == 'X')
Mark Dickinson7103aa42008-07-15 19:08:33 +00001462 s++;
1463 else
1464 s = s_store;
1465 }
1466
1467 /* coefficient: <integer> [. <fraction>] */
1468 coeff_start = s;
Mark Dickinson5c2bb1a2008-08-21 21:38:38 +00001469 while (hex_from_char(*s) >= 0)
Mark Dickinson7103aa42008-07-15 19:08:33 +00001470 s++;
1471 s_store = s;
1472 if (*s == '.') {
1473 s++;
Mark Dickinson5c2bb1a2008-08-21 21:38:38 +00001474 while (hex_from_char(*s) >= 0)
Mark Dickinson7103aa42008-07-15 19:08:33 +00001475 s++;
1476 coeff_end = s-1;
1477 }
1478 else
1479 coeff_end = s;
1480
1481 /* ndigits = total # of hex digits; fdigits = # after point */
1482 ndigits = coeff_end - coeff_start;
1483 fdigits = coeff_end - s_store;
1484 if (ndigits == 0)
1485 goto parse_error;
1486 if (ndigits > MIN(DBL_MIN_EXP - DBL_MANT_DIG - LONG_MIN/2,
1487 LONG_MAX/2 + 1 - DBL_MAX_EXP)/4)
1488 goto insane_length_error;
1489
1490 /* [p <exponent>] */
Mark Dickinson777e4ff2009-05-03 20:59:48 +00001491 if (*s == 'p' || *s == 'P') {
Mark Dickinson7103aa42008-07-15 19:08:33 +00001492 s++;
1493 exp_start = s;
1494 if (*s == '-' || *s == '+')
1495 s++;
Mark Dickinson5c2bb1a2008-08-21 21:38:38 +00001496 if (!('0' <= *s && *s <= '9'))
Mark Dickinson7103aa42008-07-15 19:08:33 +00001497 goto parse_error;
1498 s++;
Mark Dickinson5c2bb1a2008-08-21 21:38:38 +00001499 while ('0' <= *s && *s <= '9')
Mark Dickinson7103aa42008-07-15 19:08:33 +00001500 s++;
1501 exp = strtol(exp_start, NULL, 10);
1502 }
1503 else
1504 exp = 0;
1505
Mark Dickinson7103aa42008-07-15 19:08:33 +00001506/* for 0 <= j < ndigits, HEX_DIGIT(j) gives the jth most significant digit */
1507#define HEX_DIGIT(j) hex_from_char(*((j) < fdigits ? \
1508 coeff_end-(j) : \
1509 coeff_end-1-(j)))
1510
1511 /*******************************************
1512 * Compute rounded value of the hex string *
1513 *******************************************/
1514
1515 /* Discard leading zeros, and catch extreme overflow and underflow */
1516 while (ndigits > 0 && HEX_DIGIT(ndigits-1) == 0)
1517 ndigits--;
1518 if (ndigits == 0 || exp < LONG_MIN/2) {
Mark Dickinsonb1d45852009-05-11 15:33:08 +00001519 x = 0.0;
Mark Dickinson7103aa42008-07-15 19:08:33 +00001520 goto finished;
1521 }
1522 if (exp > LONG_MAX/2)
1523 goto overflow_error;
1524
1525 /* Adjust exponent for fractional part. */
1526 exp = exp - 4*((long)fdigits);
1527
1528 /* top_exp = 1 more than exponent of most sig. bit of coefficient */
1529 top_exp = exp + 4*((long)ndigits - 1);
1530 for (digit = HEX_DIGIT(ndigits-1); digit != 0; digit /= 2)
1531 top_exp++;
1532
1533 /* catch almost all nonextreme cases of overflow and underflow here */
1534 if (top_exp < DBL_MIN_EXP - DBL_MANT_DIG) {
Mark Dickinsonb1d45852009-05-11 15:33:08 +00001535 x = 0.0;
Mark Dickinson7103aa42008-07-15 19:08:33 +00001536 goto finished;
1537 }
1538 if (top_exp > DBL_MAX_EXP)
1539 goto overflow_error;
1540
1541 /* lsb = exponent of least significant bit of the *rounded* value.
1542 This is top_exp - DBL_MANT_DIG unless result is subnormal. */
1543 lsb = MAX(top_exp, (long)DBL_MIN_EXP) - DBL_MANT_DIG;
1544
1545 x = 0.0;
1546 if (exp >= lsb) {
1547 /* no rounding required */
1548 for (i = ndigits-1; i >= 0; i--)
1549 x = 16.0*x + HEX_DIGIT(i);
Mark Dickinsonb1d45852009-05-11 15:33:08 +00001550 x = ldexp(x, (int)(exp));
Mark Dickinson7103aa42008-07-15 19:08:33 +00001551 goto finished;
1552 }
1553 /* rounding required. key_digit is the index of the hex digit
1554 containing the first bit to be rounded away. */
1555 half_eps = 1 << (int)((lsb - exp - 1) % 4);
1556 key_digit = (lsb - exp - 1) / 4;
1557 for (i = ndigits-1; i > key_digit; i--)
1558 x = 16.0*x + HEX_DIGIT(i);
1559 digit = HEX_DIGIT(key_digit);
1560 x = 16.0*x + (double)(digit & (16-2*half_eps));
1561
1562 /* round-half-even: round up if bit lsb-1 is 1 and at least one of
1563 bits lsb, lsb-2, lsb-3, lsb-4, ... is 1. */
1564 if ((digit & half_eps) != 0) {
1565 round_up = 0;
1566 if ((digit & (3*half_eps-1)) != 0 ||
1567 (half_eps == 8 && (HEX_DIGIT(key_digit+1) & 1) != 0))
1568 round_up = 1;
1569 else
1570 for (i = key_digit-1; i >= 0; i--)
1571 if (HEX_DIGIT(i) != 0) {
1572 round_up = 1;
1573 break;
1574 }
1575 if (round_up == 1) {
1576 x += 2*half_eps;
1577 if (top_exp == DBL_MAX_EXP &&
1578 x == ldexp((double)(2*half_eps), DBL_MANT_DIG))
1579 /* overflow corner case: pre-rounded value <
1580 2**DBL_MAX_EXP; rounded=2**DBL_MAX_EXP. */
1581 goto overflow_error;
1582 }
1583 }
Mark Dickinsonb1d45852009-05-11 15:33:08 +00001584 x = ldexp(x, (int)(exp+4*key_digit));
Mark Dickinson7103aa42008-07-15 19:08:33 +00001585
1586 finished:
Mark Dickinsonb1d45852009-05-11 15:33:08 +00001587 /* optional trailing whitespace leading to the end of the string */
1588 while (Py_ISSPACE(*s))
1589 s++;
1590 if (s != s_end)
1591 goto parse_error;
1592 result_as_float = Py_BuildValue("(d)", sign * x);
Mark Dickinson7103aa42008-07-15 19:08:33 +00001593 if (result_as_float == NULL)
1594 return NULL;
1595 result = PyObject_CallObject(cls, result_as_float);
1596 Py_DECREF(result_as_float);
1597 return result;
1598
1599 overflow_error:
1600 PyErr_SetString(PyExc_OverflowError,
1601 "hexadecimal value too large to represent as a float");
1602 return NULL;
1603
1604 parse_error:
1605 PyErr_SetString(PyExc_ValueError,
1606 "invalid hexadecimal floating-point string");
1607 return NULL;
1608
1609 insane_length_error:
1610 PyErr_SetString(PyExc_ValueError,
1611 "hexadecimal string too long to convert");
1612 return NULL;
1613}
1614
1615PyDoc_STRVAR(float_fromhex_doc,
1616"float.fromhex(string) -> float\n\
1617\n\
1618Create a floating-point number from a hexadecimal string.\n\
1619>>> float.fromhex('0x1.ffffp10')\n\
16202047.984375\n\
1621>>> float.fromhex('-0x1p-1074')\n\
1622-4.9406564584124654e-324");
1623
1624
Jeffrey Yasskin3ea7b412008-01-27 23:08:46 +00001625static PyObject *
Raymond Hettinger04c96d52008-02-01 21:30:23 +00001626float_as_integer_ratio(PyObject *v, PyObject *unused)
Jeffrey Yasskin3ea7b412008-01-27 23:08:46 +00001627{
1628 double self;
1629 double float_part;
Raymond Hettinger1bcb99a2008-02-01 23:12:19 +00001630 int exponent;
Raymond Hettingerf9859032008-02-01 23:45:44 +00001631 int i;
Raymond Hettinger04c96d52008-02-01 21:30:23 +00001632
Jeffrey Yasskin3ea7b412008-01-27 23:08:46 +00001633 PyObject *prev;
Jeffrey Yasskin3ea7b412008-01-27 23:08:46 +00001634 PyObject *py_exponent = NULL;
1635 PyObject *numerator = NULL;
1636 PyObject *denominator = NULL;
1637 PyObject *result_pair = NULL;
Raymond Hettinger04c96d52008-02-01 21:30:23 +00001638 PyNumberMethods *long_methods = PyLong_Type.tp_as_number;
Jeffrey Yasskin3ea7b412008-01-27 23:08:46 +00001639
1640#define INPLACE_UPDATE(obj, call) \
1641 prev = obj; \
1642 obj = call; \
1643 Py_DECREF(prev); \
1644
1645 CONVERT_TO_DOUBLE(v, self);
1646
1647 if (Py_IS_INFINITY(self)) {
1648 PyErr_SetString(PyExc_OverflowError,
1649 "Cannot pass infinity to float.as_integer_ratio.");
1650 return NULL;
1651 }
1652#ifdef Py_NAN
1653 if (Py_IS_NAN(self)) {
1654 PyErr_SetString(PyExc_ValueError,
Andrew M. Kuchlingbd7c4ca2008-10-04 01:02:29 +00001655 "Cannot pass NaN to float.as_integer_ratio.");
Jeffrey Yasskin3ea7b412008-01-27 23:08:46 +00001656 return NULL;
1657 }
1658#endif
1659
Jeffrey Yasskin3ea7b412008-01-27 23:08:46 +00001660 PyFPE_START_PROTECT("as_integer_ratio", goto error);
Raymond Hettinger04c96d52008-02-01 21:30:23 +00001661 float_part = frexp(self, &exponent); /* self == float_part * 2**exponent exactly */
Jeffrey Yasskin3ea7b412008-01-27 23:08:46 +00001662 PyFPE_END_PROTECT(float_part);
Raymond Hettinger04c96d52008-02-01 21:30:23 +00001663
Raymond Hettingerf9859032008-02-01 23:45:44 +00001664 for (i=0; i<300 && float_part != floor(float_part) ; i++) {
Raymond Hettinger04c96d52008-02-01 21:30:23 +00001665 float_part *= 2.0;
1666 exponent--;
Raymond Hettingerf9859032008-02-01 23:45:44 +00001667 }
Raymond Hettinger2d1aa332008-02-02 05:11:40 +00001668 /* self == float_part * 2**exponent exactly and float_part is integral.
1669 If FLT_RADIX != 2, the 300 steps may leave a tiny fractional part
1670 to be truncated by PyLong_FromDouble(). */
Jeffrey Yasskin3ea7b412008-01-27 23:08:46 +00001671
Raymond Hettinger04c96d52008-02-01 21:30:23 +00001672 numerator = PyLong_FromDouble(float_part);
Jeffrey Yasskin3ea7b412008-01-27 23:08:46 +00001673 if (numerator == NULL) goto error;
1674
Raymond Hettingerf9859032008-02-01 23:45:44 +00001675 /* fold in 2**exponent */
Raymond Hettingerc9e928a2008-02-01 22:15:52 +00001676 denominator = PyLong_FromLong(1);
Raymond Hettinger1bcb99a2008-02-01 23:12:19 +00001677 py_exponent = PyLong_FromLong(labs((long)exponent));
Jeffrey Yasskin3ea7b412008-01-27 23:08:46 +00001678 if (py_exponent == NULL) goto error;
1679 INPLACE_UPDATE(py_exponent,
1680 long_methods->nb_lshift(denominator, py_exponent));
1681 if (py_exponent == NULL) goto error;
1682 if (exponent > 0) {
1683 INPLACE_UPDATE(numerator,
Raymond Hettingerf9859032008-02-01 23:45:44 +00001684 long_methods->nb_multiply(numerator, py_exponent));
Jeffrey Yasskin3ea7b412008-01-27 23:08:46 +00001685 if (numerator == NULL) goto error;
1686 }
1687 else {
1688 Py_DECREF(denominator);
1689 denominator = py_exponent;
1690 py_exponent = NULL;
1691 }
1692
Raymond Hettingerc9e928a2008-02-01 22:15:52 +00001693 /* Returns ints instead of longs where possible */
1694 INPLACE_UPDATE(numerator, PyNumber_Int(numerator));
1695 if (numerator == NULL) goto error;
1696 INPLACE_UPDATE(denominator, PyNumber_Int(denominator));
1697 if (denominator == NULL) goto error;
1698
Jeffrey Yasskin3ea7b412008-01-27 23:08:46 +00001699 result_pair = PyTuple_Pack(2, numerator, denominator);
1700
1701#undef INPLACE_UPDATE
1702error:
1703 Py_XDECREF(py_exponent);
Jeffrey Yasskin3ea7b412008-01-27 23:08:46 +00001704 Py_XDECREF(denominator);
1705 Py_XDECREF(numerator);
1706 return result_pair;
1707}
1708
1709PyDoc_STRVAR(float_as_integer_ratio_doc,
1710"float.as_integer_ratio() -> (int, int)\n"
1711"\n"
Raymond Hettinger04c96d52008-02-01 21:30:23 +00001712"Returns a pair of integers, whose ratio is exactly equal to the original\n"
1713"float and with a positive denominator.\n"
Andrew M. Kuchlingbd7c4ca2008-10-04 01:02:29 +00001714"Raises OverflowError on infinities and a ValueError on NaNs.\n"
Jeffrey Yasskin3ea7b412008-01-27 23:08:46 +00001715"\n"
1716">>> (10.0).as_integer_ratio()\n"
Raymond Hettinger04c96d52008-02-01 21:30:23 +00001717"(10, 1)\n"
Jeffrey Yasskin3ea7b412008-01-27 23:08:46 +00001718">>> (0.0).as_integer_ratio()\n"
1719"(0, 1)\n"
1720">>> (-.25).as_integer_ratio()\n"
Raymond Hettinger04c96d52008-02-01 21:30:23 +00001721"(-1, 4)");
Jeffrey Yasskin3ea7b412008-01-27 23:08:46 +00001722
Guido van Rossum1899c2e1992-09-12 11:09:23 +00001723
Jeremy Hylton938ace62002-07-17 16:30:39 +00001724static PyObject *
Guido van Rossumbef14172001-08-29 15:47:46 +00001725float_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds);
1726
Tim Peters6d6c1a32001-08-02 04:15:00 +00001727static PyObject *
1728float_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
1729{
1730 PyObject *x = Py_False; /* Integer zero */
Martin v. Löwis15e62742006-02-27 16:46:16 +00001731 static char *kwlist[] = {"x", 0};
Tim Peters6d6c1a32001-08-02 04:15:00 +00001732
Guido van Rossumbef14172001-08-29 15:47:46 +00001733 if (type != &PyFloat_Type)
1734 return float_subtype_new(type, args, kwds); /* Wimp out */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001735 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|O:float", kwlist, &x))
1736 return NULL;
Benjamin Peterson99d36f12009-04-15 21:26:36 +00001737 /* If it's a string, but not a string subclass, use
1738 PyFloat_FromString. */
1739 if (PyString_CheckExact(x))
Tim Peters6d6c1a32001-08-02 04:15:00 +00001740 return PyFloat_FromString(x, NULL);
1741 return PyNumber_Float(x);
1742}
1743
Guido van Rossumbef14172001-08-29 15:47:46 +00001744/* Wimpy, slow approach to tp_new calls for subtypes of float:
1745 first create a regular float from whatever arguments we got,
1746 then allocate a subtype instance and initialize its ob_fval
1747 from the regular float. The regular float is then thrown away.
1748*/
1749static PyObject *
1750float_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
1751{
Anthony Baxter377be112006-04-11 06:54:30 +00001752 PyObject *tmp, *newobj;
Guido van Rossumbef14172001-08-29 15:47:46 +00001753
1754 assert(PyType_IsSubtype(type, &PyFloat_Type));
1755 tmp = float_new(&PyFloat_Type, args, kwds);
1756 if (tmp == NULL)
1757 return NULL;
Tim Peters2400fa42001-09-12 19:12:49 +00001758 assert(PyFloat_CheckExact(tmp));
Anthony Baxter377be112006-04-11 06:54:30 +00001759 newobj = type->tp_alloc(type, 0);
1760 if (newobj == NULL) {
Raymond Hettingerf4667932003-06-28 20:04:25 +00001761 Py_DECREF(tmp);
Guido van Rossumbef14172001-08-29 15:47:46 +00001762 return NULL;
Raymond Hettingerf4667932003-06-28 20:04:25 +00001763 }
Anthony Baxter377be112006-04-11 06:54:30 +00001764 ((PyFloatObject *)newobj)->ob_fval = ((PyFloatObject *)tmp)->ob_fval;
Guido van Rossumbef14172001-08-29 15:47:46 +00001765 Py_DECREF(tmp);
Anthony Baxter377be112006-04-11 06:54:30 +00001766 return newobj;
Guido van Rossumbef14172001-08-29 15:47:46 +00001767}
1768
Guido van Rossum5d9113d2003-01-29 17:58:45 +00001769static PyObject *
1770float_getnewargs(PyFloatObject *v)
1771{
1772 return Py_BuildValue("(d)", v->ob_fval);
1773}
1774
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001775/* this is for the benefit of the pack/unpack routines below */
1776
1777typedef enum {
1778 unknown_format, ieee_big_endian_format, ieee_little_endian_format
1779} float_format_type;
1780
1781static float_format_type double_format, float_format;
1782static float_format_type detected_double_format, detected_float_format;
1783
1784static PyObject *
1785float_getformat(PyTypeObject *v, PyObject* arg)
1786{
1787 char* s;
1788 float_format_type r;
1789
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001790 if (!PyString_Check(arg)) {
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001791 PyErr_Format(PyExc_TypeError,
1792 "__getformat__() argument must be string, not %.500s",
Christian Heimese93237d2007-12-19 02:37:44 +00001793 Py_TYPE(arg)->tp_name);
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001794 return NULL;
1795 }
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001796 s = PyString_AS_STRING(arg);
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001797 if (strcmp(s, "double") == 0) {
1798 r = double_format;
1799 }
1800 else if (strcmp(s, "float") == 0) {
1801 r = float_format;
1802 }
1803 else {
1804 PyErr_SetString(PyExc_ValueError,
1805 "__getformat__() argument 1 must be "
1806 "'double' or 'float'");
1807 return NULL;
1808 }
1809
1810 switch (r) {
1811 case unknown_format:
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001812 return PyString_FromString("unknown");
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001813 case ieee_little_endian_format:
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001814 return PyString_FromString("IEEE, little-endian");
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001815 case ieee_big_endian_format:
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001816 return PyString_FromString("IEEE, big-endian");
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001817 default:
1818 Py_FatalError("insane float_format or double_format");
1819 return NULL;
1820 }
1821}
1822
1823PyDoc_STRVAR(float_getformat_doc,
1824"float.__getformat__(typestr) -> string\n"
1825"\n"
1826"You probably don't want to use this function. It exists mainly to be\n"
1827"used in Python's test suite.\n"
1828"\n"
1829"typestr must be 'double' or 'float'. This function returns whichever of\n"
1830"'unknown', 'IEEE, big-endian' or 'IEEE, little-endian' best describes the\n"
1831"format of floating point numbers used by the C type named by typestr.");
1832
1833static PyObject *
1834float_setformat(PyTypeObject *v, PyObject* args)
1835{
1836 char* typestr;
1837 char* format;
1838 float_format_type f;
1839 float_format_type detected;
1840 float_format_type *p;
1841
1842 if (!PyArg_ParseTuple(args, "ss:__setformat__", &typestr, &format))
1843 return NULL;
1844
1845 if (strcmp(typestr, "double") == 0) {
1846 p = &double_format;
1847 detected = detected_double_format;
1848 }
1849 else if (strcmp(typestr, "float") == 0) {
1850 p = &float_format;
1851 detected = detected_float_format;
1852 }
1853 else {
1854 PyErr_SetString(PyExc_ValueError,
1855 "__setformat__() argument 1 must "
1856 "be 'double' or 'float'");
1857 return NULL;
1858 }
1859
1860 if (strcmp(format, "unknown") == 0) {
1861 f = unknown_format;
1862 }
1863 else if (strcmp(format, "IEEE, little-endian") == 0) {
1864 f = ieee_little_endian_format;
1865 }
1866 else if (strcmp(format, "IEEE, big-endian") == 0) {
1867 f = ieee_big_endian_format;
1868 }
1869 else {
1870 PyErr_SetString(PyExc_ValueError,
1871 "__setformat__() argument 2 must be "
1872 "'unknown', 'IEEE, little-endian' or "
1873 "'IEEE, big-endian'");
1874 return NULL;
1875
1876 }
1877
1878 if (f != unknown_format && f != detected) {
1879 PyErr_Format(PyExc_ValueError,
1880 "can only set %s format to 'unknown' or the "
1881 "detected platform value", typestr);
1882 return NULL;
1883 }
1884
1885 *p = f;
1886 Py_RETURN_NONE;
1887}
1888
1889PyDoc_STRVAR(float_setformat_doc,
1890"float.__setformat__(typestr, fmt) -> None\n"
1891"\n"
1892"You probably don't want to use this function. It exists mainly to be\n"
1893"used in Python's test suite.\n"
1894"\n"
1895"typestr must be 'double' or 'float'. fmt must be one of 'unknown',\n"
1896"'IEEE, big-endian' or 'IEEE, little-endian', and in addition can only be\n"
1897"one of the latter two if it appears to match the underlying C reality.\n"
1898"\n"
1899"Overrides the automatic determination of C-level floating point type.\n"
1900"This affects how floats are converted to and from binary strings.");
1901
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00001902static PyObject *
1903float_getzero(PyObject *v, void *closure)
1904{
1905 return PyFloat_FromDouble(0.0);
1906}
1907
Eric Smitha9f7d622008-02-17 19:46:49 +00001908static PyObject *
1909float__format__(PyObject *self, PyObject *args)
1910{
1911 PyObject *format_spec;
1912
1913 if (!PyArg_ParseTuple(args, "O:__format__", &format_spec))
1914 return NULL;
Christian Heimes593daf52008-05-26 12:51:38 +00001915 if (PyBytes_Check(format_spec))
Eric Smithdc13b792008-05-30 18:10:04 +00001916 return _PyFloat_FormatAdvanced(self,
1917 PyBytes_AS_STRING(format_spec),
1918 PyBytes_GET_SIZE(format_spec));
Eric Smitha9f7d622008-02-17 19:46:49 +00001919 if (PyUnicode_Check(format_spec)) {
1920 /* Convert format_spec to a str */
Eric Smithdc13b792008-05-30 18:10:04 +00001921 PyObject *result;
1922 PyObject *str_spec = PyObject_Str(format_spec);
Eric Smitha9f7d622008-02-17 19:46:49 +00001923
Eric Smithdc13b792008-05-30 18:10:04 +00001924 if (str_spec == NULL)
1925 return NULL;
Eric Smitha9f7d622008-02-17 19:46:49 +00001926
Eric Smithdc13b792008-05-30 18:10:04 +00001927 result = _PyFloat_FormatAdvanced(self,
1928 PyBytes_AS_STRING(str_spec),
1929 PyBytes_GET_SIZE(str_spec));
Eric Smitha9f7d622008-02-17 19:46:49 +00001930
Eric Smithdc13b792008-05-30 18:10:04 +00001931 Py_DECREF(str_spec);
Eric Smitha9f7d622008-02-17 19:46:49 +00001932 return result;
1933 }
1934 PyErr_SetString(PyExc_TypeError, "__format__ requires str or unicode");
1935 return NULL;
1936}
1937
1938PyDoc_STRVAR(float__format__doc,
1939"float.__format__(format_spec) -> string\n"
1940"\n"
1941"Formats the float according to format_spec.");
1942
1943
Guido van Rossum5d9113d2003-01-29 17:58:45 +00001944static PyMethodDef float_methods[] = {
Christian Heimes6f341092008-04-18 23:13:07 +00001945 {"conjugate", (PyCFunction)float_float, METH_NOARGS,
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00001946 "Returns self, the complex conjugate of any float."},
1947 {"__trunc__", (PyCFunction)float_trunc, METH_NOARGS,
1948 "Returns the Integral closest to x between 0 and x."},
Jeffrey Yasskin3ea7b412008-01-27 23:08:46 +00001949 {"as_integer_ratio", (PyCFunction)float_as_integer_ratio, METH_NOARGS,
1950 float_as_integer_ratio_doc},
Mark Dickinson7103aa42008-07-15 19:08:33 +00001951 {"fromhex", (PyCFunction)float_fromhex,
1952 METH_O|METH_CLASS, float_fromhex_doc},
1953 {"hex", (PyCFunction)float_hex,
1954 METH_NOARGS, float_hex_doc},
Christian Heimes6f341092008-04-18 23:13:07 +00001955 {"is_integer", (PyCFunction)float_is_integer, METH_NOARGS,
1956 "Returns True if the float is an integer."},
1957#if 0
1958 {"is_inf", (PyCFunction)float_is_inf, METH_NOARGS,
1959 "Returns True if the float is positive or negative infinite."},
1960 {"is_finite", (PyCFunction)float_is_finite, METH_NOARGS,
1961 "Returns True if the float is finite, neither infinite nor NaN."},
1962 {"is_nan", (PyCFunction)float_is_nan, METH_NOARGS,
1963 "Returns True if the float is not a number (NaN)."},
1964#endif
Guido van Rossum5d9113d2003-01-29 17:58:45 +00001965 {"__getnewargs__", (PyCFunction)float_getnewargs, METH_NOARGS},
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001966 {"__getformat__", (PyCFunction)float_getformat,
1967 METH_O|METH_CLASS, float_getformat_doc},
1968 {"__setformat__", (PyCFunction)float_setformat,
1969 METH_VARARGS|METH_CLASS, float_setformat_doc},
Eric Smitha9f7d622008-02-17 19:46:49 +00001970 {"__format__", (PyCFunction)float__format__,
1971 METH_VARARGS, float__format__doc},
Guido van Rossum5d9113d2003-01-29 17:58:45 +00001972 {NULL, NULL} /* sentinel */
1973};
1974
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00001975static PyGetSetDef float_getset[] = {
1976 {"real",
1977 (getter)float_float, (setter)NULL,
1978 "the real part of a complex number",
1979 NULL},
1980 {"imag",
1981 (getter)float_getzero, (setter)NULL,
1982 "the imaginary part of a complex number",
1983 NULL},
1984 {NULL} /* Sentinel */
1985};
1986
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001987PyDoc_STRVAR(float_doc,
Tim Peters6d6c1a32001-08-02 04:15:00 +00001988"float(x) -> floating point number\n\
1989\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001990Convert a string or number to a floating point number, if possible.");
Tim Peters6d6c1a32001-08-02 04:15:00 +00001991
1992
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001993static PyNumberMethods float_as_number = {
Georg Brandl347b3002006-03-30 11:57:00 +00001994 float_add, /*nb_add*/
1995 float_sub, /*nb_subtract*/
1996 float_mul, /*nb_multiply*/
1997 float_classic_div, /*nb_divide*/
1998 float_rem, /*nb_remainder*/
1999 float_divmod, /*nb_divmod*/
2000 float_pow, /*nb_power*/
Guido van Rossumb6775db1994-08-01 11:34:53 +00002001 (unaryfunc)float_neg, /*nb_negative*/
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00002002 (unaryfunc)float_float, /*nb_positive*/
Guido van Rossumb6775db1994-08-01 11:34:53 +00002003 (unaryfunc)float_abs, /*nb_absolute*/
2004 (inquiry)float_nonzero, /*nb_nonzero*/
Guido van Rossum27acb331991-10-24 14:55:28 +00002005 0, /*nb_invert*/
2006 0, /*nb_lshift*/
2007 0, /*nb_rshift*/
2008 0, /*nb_and*/
2009 0, /*nb_xor*/
2010 0, /*nb_or*/
Georg Brandl347b3002006-03-30 11:57:00 +00002011 float_coerce, /*nb_coerce*/
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00002012 float_trunc, /*nb_int*/
Amaury Forgeot d'Arcd3ffb892008-09-09 07:24:30 +00002013 float_long, /*nb_long*/
Georg Brandl347b3002006-03-30 11:57:00 +00002014 float_float, /*nb_float*/
Raymond Hettinger9c437af2008-06-24 22:46:07 +00002015 0, /* nb_oct */
2016 0, /* nb_hex */
Guido van Rossum4668b002001-08-08 05:00:18 +00002017 0, /* nb_inplace_add */
2018 0, /* nb_inplace_subtract */
2019 0, /* nb_inplace_multiply */
2020 0, /* nb_inplace_divide */
2021 0, /* nb_inplace_remainder */
2022 0, /* nb_inplace_power */
2023 0, /* nb_inplace_lshift */
2024 0, /* nb_inplace_rshift */
2025 0, /* nb_inplace_and */
2026 0, /* nb_inplace_xor */
2027 0, /* nb_inplace_or */
Tim Peters63a35712001-12-11 19:57:24 +00002028 float_floor_div, /* nb_floor_divide */
Guido van Rossum4668b002001-08-08 05:00:18 +00002029 float_div, /* nb_true_divide */
2030 0, /* nb_inplace_floor_divide */
2031 0, /* nb_inplace_true_divide */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002032};
2033
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002034PyTypeObject PyFloat_Type = {
Martin v. Löwis68192102007-07-21 06:55:02 +00002035 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002036 "float",
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002037 sizeof(PyFloatObject),
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002038 0,
Tim Peters6d6c1a32001-08-02 04:15:00 +00002039 (destructor)float_dealloc, /* tp_dealloc */
2040 (printfunc)float_print, /* tp_print */
2041 0, /* tp_getattr */
2042 0, /* tp_setattr */
Michael W. Hudson08678a12004-05-26 17:36:12 +00002043 0, /* tp_compare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002044 (reprfunc)float_repr, /* tp_repr */
2045 &float_as_number, /* tp_as_number */
2046 0, /* tp_as_sequence */
2047 0, /* tp_as_mapping */
2048 (hashfunc)float_hash, /* tp_hash */
2049 0, /* tp_call */
2050 (reprfunc)float_str, /* tp_str */
2051 PyObject_GenericGetAttr, /* tp_getattro */
2052 0, /* tp_setattro */
2053 0, /* tp_as_buffer */
Guido van Rossumbef14172001-08-29 15:47:46 +00002054 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
2055 Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002056 float_doc, /* tp_doc */
2057 0, /* tp_traverse */
2058 0, /* tp_clear */
Georg Brandl347b3002006-03-30 11:57:00 +00002059 float_richcompare, /* tp_richcompare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002060 0, /* tp_weaklistoffset */
2061 0, /* tp_iter */
2062 0, /* tp_iternext */
Guido van Rossum5d9113d2003-01-29 17:58:45 +00002063 float_methods, /* tp_methods */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002064 0, /* tp_members */
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00002065 float_getset, /* tp_getset */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002066 0, /* tp_base */
2067 0, /* tp_dict */
2068 0, /* tp_descr_get */
2069 0, /* tp_descr_set */
2070 0, /* tp_dictoffset */
2071 0, /* tp_init */
2072 0, /* tp_alloc */
2073 float_new, /* tp_new */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002074};
Guido van Rossumfbbd57e1997-08-05 02:16:08 +00002075
2076void
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002077_PyFloat_Init(void)
2078{
2079 /* We attempt to determine if this machine is using IEEE
2080 floating point formats by peering at the bits of some
2081 carefully chosen values. If it looks like we are on an
2082 IEEE platform, the float packing/unpacking routines can
2083 just copy bits, if not they resort to arithmetic & shifts
2084 and masks. The shifts & masks approach works on all finite
2085 values, but what happens to infinities, NaNs and signed
2086 zeroes on packing is an accident, and attempting to unpack
2087 a NaN or an infinity will raise an exception.
2088
2089 Note that if we're on some whacked-out platform which uses
2090 IEEE formats but isn't strictly little-endian or big-
2091 endian, we will fall back to the portable shifts & masks
2092 method. */
2093
2094#if SIZEOF_DOUBLE == 8
2095 {
2096 double x = 9006104071832581.0;
2097 if (memcmp(&x, "\x43\x3f\xff\x01\x02\x03\x04\x05", 8) == 0)
2098 detected_double_format = ieee_big_endian_format;
2099 else if (memcmp(&x, "\x05\x04\x03\x02\x01\xff\x3f\x43", 8) == 0)
2100 detected_double_format = ieee_little_endian_format;
2101 else
2102 detected_double_format = unknown_format;
2103 }
2104#else
2105 detected_double_format = unknown_format;
2106#endif
2107
2108#if SIZEOF_FLOAT == 4
2109 {
2110 float y = 16711938.0;
2111 if (memcmp(&y, "\x4b\x7f\x01\x02", 4) == 0)
2112 detected_float_format = ieee_big_endian_format;
2113 else if (memcmp(&y, "\x02\x01\x7f\x4b", 4) == 0)
2114 detected_float_format = ieee_little_endian_format;
2115 else
2116 detected_float_format = unknown_format;
2117 }
2118#else
2119 detected_float_format = unknown_format;
2120#endif
2121
2122 double_format = detected_double_format;
2123 float_format = detected_float_format;
Christian Heimesf15c66e2007-12-11 00:54:34 +00002124
Christian Heimes796fc312008-01-30 18:58:29 +00002125 /* Init float info */
2126 if (FloatInfoType.tp_name == 0)
2127 PyStructSequence_InitType(&FloatInfoType, &floatinfo_desc);
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002128}
2129
Gregory P. Smith2fe77062008-07-06 03:35:58 +00002130int
2131PyFloat_ClearFreeList(void)
Guido van Rossumfbbd57e1997-08-05 02:16:08 +00002132{
Guido van Rossum3fce8831999-03-12 19:43:17 +00002133 PyFloatObject *p;
2134 PyFloatBlock *list, *next;
Gregory P. Smith2fe77062008-07-06 03:35:58 +00002135 int i;
2136 int u; /* remaining unfreed ints per block */
2137 int freelist_size = 0;
Guido van Rossumf61bbc81999-03-12 00:12:21 +00002138
Guido van Rossumf61bbc81999-03-12 00:12:21 +00002139 list = block_list;
2140 block_list = NULL;
Guido van Rossumd7b5fb81999-03-19 20:59:40 +00002141 free_list = NULL;
Guido van Rossumf61bbc81999-03-12 00:12:21 +00002142 while (list != NULL) {
Gregory P. Smith2fe77062008-07-06 03:35:58 +00002143 u = 0;
Guido van Rossumd7b5fb81999-03-19 20:59:40 +00002144 for (i = 0, p = &list->objects[0];
2145 i < N_FLOATOBJECTS;
2146 i++, p++) {
Christian Heimese93237d2007-12-19 02:37:44 +00002147 if (PyFloat_CheckExact(p) && Py_REFCNT(p) != 0)
Gregory P. Smith2fe77062008-07-06 03:35:58 +00002148 u++;
Guido van Rossumf61bbc81999-03-12 00:12:21 +00002149 }
Guido van Rossum3fce8831999-03-12 19:43:17 +00002150 next = list->next;
Gregory P. Smith2fe77062008-07-06 03:35:58 +00002151 if (u) {
Guido van Rossum3fce8831999-03-12 19:43:17 +00002152 list->next = block_list;
2153 block_list = list;
Guido van Rossumd7b5fb81999-03-19 20:59:40 +00002154 for (i = 0, p = &list->objects[0];
2155 i < N_FLOATOBJECTS;
2156 i++, p++) {
Guido van Rossumdea6ef92001-09-11 16:13:52 +00002157 if (!PyFloat_CheckExact(p) ||
Christian Heimese93237d2007-12-19 02:37:44 +00002158 Py_REFCNT(p) == 0) {
2159 Py_TYPE(p) = (struct _typeobject *)
Guido van Rossumd7b5fb81999-03-19 20:59:40 +00002160 free_list;
2161 free_list = p;
2162 }
2163 }
Guido van Rossumf61bbc81999-03-12 00:12:21 +00002164 }
2165 else {
Gregory P. Smith2fe77062008-07-06 03:35:58 +00002166 PyMem_FREE(list);
Guido van Rossumf61bbc81999-03-12 00:12:21 +00002167 }
Gregory P. Smith2fe77062008-07-06 03:35:58 +00002168 freelist_size += u;
Guido van Rossum3fce8831999-03-12 19:43:17 +00002169 list = next;
Guido van Rossumf61bbc81999-03-12 00:12:21 +00002170 }
Gregory P. Smith2fe77062008-07-06 03:35:58 +00002171 return freelist_size;
Christian Heimes422051a2008-02-04 18:00:12 +00002172}
2173
2174void
2175PyFloat_Fini(void)
2176{
2177 PyFloatObject *p;
2178 PyFloatBlock *list;
Gregory P. Smith2fe77062008-07-06 03:35:58 +00002179 int i;
2180 int u; /* total unfreed floats per block */
Christian Heimes422051a2008-02-04 18:00:12 +00002181
Gregory P. Smith2fe77062008-07-06 03:35:58 +00002182 u = PyFloat_ClearFreeList();
Christian Heimes422051a2008-02-04 18:00:12 +00002183
Guido van Rossum3fce8831999-03-12 19:43:17 +00002184 if (!Py_VerboseFlag)
2185 return;
2186 fprintf(stderr, "# cleanup floats");
Gregory P. Smith2fe77062008-07-06 03:35:58 +00002187 if (!u) {
Guido van Rossum3fce8831999-03-12 19:43:17 +00002188 fprintf(stderr, "\n");
2189 }
2190 else {
2191 fprintf(stderr,
Gregory P. Smith2fe77062008-07-06 03:35:58 +00002192 ": %d unfreed float%s\n",
2193 u, u == 1 ? "" : "s");
Guido van Rossum3fce8831999-03-12 19:43:17 +00002194 }
2195 if (Py_VerboseFlag > 1) {
2196 list = block_list;
2197 while (list != NULL) {
Guido van Rossumd7b5fb81999-03-19 20:59:40 +00002198 for (i = 0, p = &list->objects[0];
2199 i < N_FLOATOBJECTS;
2200 i++, p++) {
Guido van Rossumdea6ef92001-09-11 16:13:52 +00002201 if (PyFloat_CheckExact(p) &&
Christian Heimese93237d2007-12-19 02:37:44 +00002202 Py_REFCNT(p) != 0) {
Eric Smithb3272582009-10-16 14:26:36 +00002203 char *buf = PyOS_double_to_string(
2204 PyFloat_AS_DOUBLE(p), 'r',
2205 0, 0, NULL);
2206 if (buf) {
2207 /* XXX(twouters) cast
2208 refcount to long
2209 until %zd is
2210 universally
2211 available
2212 */
2213 fprintf(stderr,
Thomas Wouters8b87a0b2006-03-01 05:41:20 +00002214 "# <float at %p, refcnt=%ld, val=%s>\n",
Christian Heimese93237d2007-12-19 02:37:44 +00002215 p, (long)Py_REFCNT(p), buf);
Eric Smithb3272582009-10-16 14:26:36 +00002216 PyMem_Free(buf);
2217 }
Guido van Rossum3fce8831999-03-12 19:43:17 +00002218 }
2219 }
2220 list = list->next;
Guido van Rossumf61bbc81999-03-12 00:12:21 +00002221 }
2222 }
Guido van Rossumfbbd57e1997-08-05 02:16:08 +00002223}
Tim Peters9905b942003-03-20 20:53:32 +00002224
2225/*----------------------------------------------------------------------------
2226 * _PyFloat_{Pack,Unpack}{4,8}. See floatobject.h.
Tim Peters9905b942003-03-20 20:53:32 +00002227 */
2228int
2229_PyFloat_Pack4(double x, unsigned char *p, int le)
2230{
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002231 if (float_format == unknown_format) {
2232 unsigned char sign;
2233 int e;
2234 double f;
2235 unsigned int fbits;
2236 int incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00002237
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002238 if (le) {
2239 p += 3;
2240 incr = -1;
2241 }
Tim Peters9905b942003-03-20 20:53:32 +00002242
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002243 if (x < 0) {
2244 sign = 1;
2245 x = -x;
2246 }
2247 else
2248 sign = 0;
Tim Peters9905b942003-03-20 20:53:32 +00002249
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002250 f = frexp(x, &e);
Tim Peters9905b942003-03-20 20:53:32 +00002251
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002252 /* Normalize f to be in the range [1.0, 2.0) */
2253 if (0.5 <= f && f < 1.0) {
2254 f *= 2.0;
2255 e--;
2256 }
2257 else if (f == 0.0)
2258 e = 0;
2259 else {
2260 PyErr_SetString(PyExc_SystemError,
2261 "frexp() result out of range");
2262 return -1;
2263 }
2264
2265 if (e >= 128)
2266 goto Overflow;
2267 else if (e < -126) {
2268 /* Gradual underflow */
2269 f = ldexp(f, 126 + e);
2270 e = 0;
2271 }
2272 else if (!(e == 0 && f == 0.0)) {
2273 e += 127;
2274 f -= 1.0; /* Get rid of leading 1 */
2275 }
2276
2277 f *= 8388608.0; /* 2**23 */
2278 fbits = (unsigned int)(f + 0.5); /* Round */
2279 assert(fbits <= 8388608);
2280 if (fbits >> 23) {
2281 /* The carry propagated out of a string of 23 1 bits. */
2282 fbits = 0;
2283 ++e;
2284 if (e >= 255)
2285 goto Overflow;
2286 }
2287
2288 /* First byte */
2289 *p = (sign << 7) | (e >> 1);
2290 p += incr;
2291
2292 /* Second byte */
2293 *p = (char) (((e & 1) << 7) | (fbits >> 16));
2294 p += incr;
2295
2296 /* Third byte */
2297 *p = (fbits >> 8) & 0xFF;
2298 p += incr;
2299
2300 /* Fourth byte */
2301 *p = fbits & 0xFF;
2302
2303 /* Done */
2304 return 0;
2305
Tim Peters9905b942003-03-20 20:53:32 +00002306 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002307 else {
Michael W. Hudson3095ad02005-06-30 00:02:26 +00002308 float y = (float)x;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002309 const char *s = (char*)&y;
2310 int i, incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00002311
Mark Dickinsonc23b8a72008-03-14 14:23:37 +00002312 if (Py_IS_INFINITY(y) && !Py_IS_INFINITY(x))
2313 goto Overflow;
2314
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002315 if ((float_format == ieee_little_endian_format && !le)
2316 || (float_format == ieee_big_endian_format && le)) {
2317 p += 3;
2318 incr = -1;
2319 }
Mark Dickinsonc23b8a72008-03-14 14:23:37 +00002320
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002321 for (i = 0; i < 4; i++) {
2322 *p = *s++;
2323 p += incr;
2324 }
2325 return 0;
Tim Peters9905b942003-03-20 20:53:32 +00002326 }
Mark Dickinsonc23b8a72008-03-14 14:23:37 +00002327 Overflow:
2328 PyErr_SetString(PyExc_OverflowError,
2329 "float too large to pack with f format");
2330 return -1;
Tim Peters9905b942003-03-20 20:53:32 +00002331}
2332
2333int
2334_PyFloat_Pack8(double x, unsigned char *p, int le)
2335{
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002336 if (double_format == unknown_format) {
2337 unsigned char sign;
2338 int e;
2339 double f;
2340 unsigned int fhi, flo;
2341 int incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00002342
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002343 if (le) {
2344 p += 7;
2345 incr = -1;
2346 }
Tim Peters9905b942003-03-20 20:53:32 +00002347
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002348 if (x < 0) {
2349 sign = 1;
2350 x = -x;
2351 }
2352 else
2353 sign = 0;
Tim Peters9905b942003-03-20 20:53:32 +00002354
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002355 f = frexp(x, &e);
Tim Peters9905b942003-03-20 20:53:32 +00002356
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002357 /* Normalize f to be in the range [1.0, 2.0) */
2358 if (0.5 <= f && f < 1.0) {
2359 f *= 2.0;
2360 e--;
2361 }
2362 else if (f == 0.0)
2363 e = 0;
2364 else {
2365 PyErr_SetString(PyExc_SystemError,
2366 "frexp() result out of range");
2367 return -1;
2368 }
2369
2370 if (e >= 1024)
2371 goto Overflow;
2372 else if (e < -1022) {
2373 /* Gradual underflow */
2374 f = ldexp(f, 1022 + e);
2375 e = 0;
2376 }
2377 else if (!(e == 0 && f == 0.0)) {
2378 e += 1023;
2379 f -= 1.0; /* Get rid of leading 1 */
2380 }
2381
2382 /* fhi receives the high 28 bits; flo the low 24 bits (== 52 bits) */
2383 f *= 268435456.0; /* 2**28 */
2384 fhi = (unsigned int)f; /* Truncate */
2385 assert(fhi < 268435456);
2386
2387 f -= (double)fhi;
2388 f *= 16777216.0; /* 2**24 */
2389 flo = (unsigned int)(f + 0.5); /* Round */
2390 assert(flo <= 16777216);
2391 if (flo >> 24) {
2392 /* The carry propagated out of a string of 24 1 bits. */
2393 flo = 0;
2394 ++fhi;
2395 if (fhi >> 28) {
2396 /* And it also progagated out of the next 28 bits. */
2397 fhi = 0;
2398 ++e;
2399 if (e >= 2047)
2400 goto Overflow;
2401 }
2402 }
2403
2404 /* First byte */
2405 *p = (sign << 7) | (e >> 4);
2406 p += incr;
2407
2408 /* Second byte */
2409 *p = (unsigned char) (((e & 0xF) << 4) | (fhi >> 24));
2410 p += incr;
2411
2412 /* Third byte */
2413 *p = (fhi >> 16) & 0xFF;
2414 p += incr;
2415
2416 /* Fourth byte */
2417 *p = (fhi >> 8) & 0xFF;
2418 p += incr;
2419
2420 /* Fifth byte */
2421 *p = fhi & 0xFF;
2422 p += incr;
2423
2424 /* Sixth byte */
2425 *p = (flo >> 16) & 0xFF;
2426 p += incr;
2427
2428 /* Seventh byte */
2429 *p = (flo >> 8) & 0xFF;
2430 p += incr;
2431
2432 /* Eighth byte */
2433 *p = flo & 0xFF;
2434 p += incr;
2435
2436 /* Done */
2437 return 0;
2438
2439 Overflow:
2440 PyErr_SetString(PyExc_OverflowError,
2441 "float too large to pack with d format");
Tim Peters9905b942003-03-20 20:53:32 +00002442 return -1;
2443 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002444 else {
2445 const char *s = (char*)&x;
2446 int i, incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00002447
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002448 if ((double_format == ieee_little_endian_format && !le)
2449 || (double_format == ieee_big_endian_format && le)) {
2450 p += 7;
2451 incr = -1;
Tim Peters9905b942003-03-20 20:53:32 +00002452 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002453
2454 for (i = 0; i < 8; i++) {
2455 *p = *s++;
2456 p += incr;
2457 }
2458 return 0;
Tim Peters9905b942003-03-20 20:53:32 +00002459 }
Tim Peters9905b942003-03-20 20:53:32 +00002460}
2461
2462double
2463_PyFloat_Unpack4(const unsigned char *p, int le)
2464{
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002465 if (float_format == unknown_format) {
2466 unsigned char sign;
2467 int e;
2468 unsigned int f;
2469 double x;
2470 int incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00002471
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002472 if (le) {
2473 p += 3;
2474 incr = -1;
2475 }
2476
2477 /* First byte */
2478 sign = (*p >> 7) & 1;
2479 e = (*p & 0x7F) << 1;
2480 p += incr;
2481
2482 /* Second byte */
2483 e |= (*p >> 7) & 1;
2484 f = (*p & 0x7F) << 16;
2485 p += incr;
2486
2487 if (e == 255) {
2488 PyErr_SetString(
2489 PyExc_ValueError,
2490 "can't unpack IEEE 754 special value "
2491 "on non-IEEE platform");
2492 return -1;
2493 }
2494
2495 /* Third byte */
2496 f |= *p << 8;
2497 p += incr;
2498
2499 /* Fourth byte */
2500 f |= *p;
2501
2502 x = (double)f / 8388608.0;
2503
2504 /* XXX This sadly ignores Inf/NaN issues */
2505 if (e == 0)
2506 e = -126;
2507 else {
2508 x += 1.0;
2509 e -= 127;
2510 }
2511 x = ldexp(x, e);
2512
2513 if (sign)
2514 x = -x;
2515
2516 return x;
Tim Peters9905b942003-03-20 20:53:32 +00002517 }
Tim Peters9905b942003-03-20 20:53:32 +00002518 else {
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00002519 float x;
2520
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002521 if ((float_format == ieee_little_endian_format && !le)
2522 || (float_format == ieee_big_endian_format && le)) {
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00002523 char buf[4];
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002524 char *d = &buf[3];
2525 int i;
Tim Peters9905b942003-03-20 20:53:32 +00002526
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002527 for (i = 0; i < 4; i++) {
2528 *d-- = *p++;
2529 }
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00002530 memcpy(&x, buf, 4);
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002531 }
2532 else {
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00002533 memcpy(&x, p, 4);
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002534 }
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00002535
2536 return x;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002537 }
Tim Peters9905b942003-03-20 20:53:32 +00002538}
2539
2540double
2541_PyFloat_Unpack8(const unsigned char *p, int le)
2542{
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002543 if (double_format == unknown_format) {
2544 unsigned char sign;
2545 int e;
2546 unsigned int fhi, flo;
2547 double x;
2548 int incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00002549
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002550 if (le) {
2551 p += 7;
2552 incr = -1;
2553 }
2554
2555 /* First byte */
2556 sign = (*p >> 7) & 1;
2557 e = (*p & 0x7F) << 4;
2558
2559 p += incr;
2560
2561 /* Second byte */
2562 e |= (*p >> 4) & 0xF;
2563 fhi = (*p & 0xF) << 24;
2564 p += incr;
2565
2566 if (e == 2047) {
2567 PyErr_SetString(
2568 PyExc_ValueError,
2569 "can't unpack IEEE 754 special value "
2570 "on non-IEEE platform");
2571 return -1.0;
2572 }
2573
2574 /* Third byte */
2575 fhi |= *p << 16;
2576 p += incr;
2577
2578 /* Fourth byte */
2579 fhi |= *p << 8;
2580 p += incr;
2581
2582 /* Fifth byte */
2583 fhi |= *p;
2584 p += incr;
2585
2586 /* Sixth byte */
2587 flo = *p << 16;
2588 p += incr;
2589
2590 /* Seventh byte */
2591 flo |= *p << 8;
2592 p += incr;
2593
2594 /* Eighth byte */
2595 flo |= *p;
2596
2597 x = (double)fhi + (double)flo / 16777216.0; /* 2**24 */
2598 x /= 268435456.0; /* 2**28 */
2599
2600 if (e == 0)
2601 e = -1022;
2602 else {
2603 x += 1.0;
2604 e -= 1023;
2605 }
2606 x = ldexp(x, e);
2607
2608 if (sign)
2609 x = -x;
2610
2611 return x;
Tim Peters9905b942003-03-20 20:53:32 +00002612 }
Tim Peters9905b942003-03-20 20:53:32 +00002613 else {
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00002614 double x;
2615
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002616 if ((double_format == ieee_little_endian_format && !le)
2617 || (double_format == ieee_big_endian_format && le)) {
2618 char buf[8];
2619 char *d = &buf[7];
2620 int i;
2621
2622 for (i = 0; i < 8; i++) {
2623 *d-- = *p++;
2624 }
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00002625 memcpy(&x, buf, 8);
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002626 }
2627 else {
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00002628 memcpy(&x, p, 8);
Michael W. Hudsonba283e22005-05-27 15:23:20 +00002629 }
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00002630
2631 return x;
Tim Peters9905b942003-03-20 20:53:32 +00002632 }
Tim Peters9905b942003-03-20 20:53:32 +00002633}