blob: 4dd7d03190676dcc159d249ef76e0cbc16e2f77c [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"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00008
Guido van Rossum3f5da241990-12-20 15:06:42 +00009#include <ctype.h>
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000010
Jack Janseneddc1442003-11-20 01:44:59 +000011#if !defined(__STDC__)
Tim Petersdbd9ba62000-07-09 03:09:57 +000012extern double fmod(double, double);
13extern double pow(double, double);
Guido van Rossum6923e131990-11-02 17:50:43 +000014#endif
15
Guido van Rossum93ad0df1997-05-13 21:00:42 +000016/* Special free list -- see comments for same code in intobject.c. */
Guido van Rossum93ad0df1997-05-13 21:00:42 +000017#define BLOCK_SIZE 1000 /* 1K less typical malloc overhead */
Guido van Rossum3fce8831999-03-12 19:43:17 +000018#define BHEAD_SIZE 8 /* Enough for a 64-bit pointer */
Guido van Rossumf61bbc81999-03-12 00:12:21 +000019#define N_FLOATOBJECTS ((BLOCK_SIZE - BHEAD_SIZE) / sizeof(PyFloatObject))
Guido van Rossum3fce8831999-03-12 19:43:17 +000020
Guido van Rossum3fce8831999-03-12 19:43:17 +000021struct _floatblock {
22 struct _floatblock *next;
23 PyFloatObject objects[N_FLOATOBJECTS];
24};
25
26typedef struct _floatblock PyFloatBlock;
27
28static PyFloatBlock *block_list = NULL;
29static PyFloatObject *free_list = NULL;
30
Guido van Rossum93ad0df1997-05-13 21:00:42 +000031static PyFloatObject *
Fred Drakefd99de62000-07-09 05:02:18 +000032fill_free_list(void)
Guido van Rossum93ad0df1997-05-13 21:00:42 +000033{
34 PyFloatObject *p, *q;
Guido van Rossumb18618d2000-05-03 23:44:39 +000035 /* XXX Float blocks escape the object heap. Use PyObject_MALLOC ??? */
36 p = (PyFloatObject *) PyMem_MALLOC(sizeof(PyFloatBlock));
Guido van Rossum93ad0df1997-05-13 21:00:42 +000037 if (p == NULL)
Guido van Rossumb18618d2000-05-03 23:44:39 +000038 return (PyFloatObject *) PyErr_NoMemory();
Guido van Rossum3fce8831999-03-12 19:43:17 +000039 ((PyFloatBlock *)p)->next = block_list;
40 block_list = (PyFloatBlock *)p;
41 p = &((PyFloatBlock *)p)->objects[0];
Guido van Rossum93ad0df1997-05-13 21:00:42 +000042 q = p + N_FLOATOBJECTS;
43 while (--q > p)
Martin v. Löwis68192102007-07-21 06:55:02 +000044 Py_Type(q) = (struct _typeobject *)(q-1);
45 Py_Type(q) = NULL;
Guido van Rossum93ad0df1997-05-13 21:00:42 +000046 return p + N_FLOATOBJECTS - 1;
47}
48
Guido van Rossumc0b618a1997-05-02 03:12:38 +000049PyObject *
Guido van Rossumc0b618a1997-05-02 03:12:38 +000050PyFloat_FromDouble(double fval)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000051{
Guido van Rossum93ad0df1997-05-13 21:00:42 +000052 register PyFloatObject *op;
53 if (free_list == NULL) {
54 if ((free_list = fill_free_list()) == NULL)
55 return NULL;
56 }
Guido van Rossume3a8e7e2002-08-19 19:26:42 +000057 /* Inline PyObject_New */
Guido van Rossum93ad0df1997-05-13 21:00:42 +000058 op = free_list;
Martin v. Löwis68192102007-07-21 06:55:02 +000059 free_list = (PyFloatObject *)Py_Type(op);
Guido van Rossumb18618d2000-05-03 23:44:39 +000060 PyObject_INIT(op, &PyFloat_Type);
Guido van Rossum2a9096b1990-10-21 22:15:08 +000061 op->ob_fval = fval;
Guido van Rossumc0b618a1997-05-02 03:12:38 +000062 return (PyObject *) op;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000063}
64
Tim Petersef14d732000-09-23 03:39:17 +000065/**************************************************************************
66RED_FLAG 22-Sep-2000 tim
67PyFloat_FromString's pend argument is braindead. Prior to this RED_FLAG,
68
691. If v was a regular string, *pend was set to point to its terminating
70 null byte. That's useless (the caller can find that without any
71 help from this function!).
72
732. If v was a Unicode string, or an object convertible to a character
74 buffer, *pend was set to point into stack trash (the auto temp
75 vector holding the character buffer). That was downright dangerous.
76
77Since we can't change the interface of a public API function, pend is
78still supported but now *officially* useless: if pend is not NULL,
79*pend is set to NULL.
80**************************************************************************/
Barry Warsaw226ae6c1999-10-12 19:54:53 +000081PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +000082PyFloat_FromString(PyObject *v, char **pend)
Barry Warsaw226ae6c1999-10-12 19:54:53 +000083{
Guido van Rossum4c08d552000-03-10 22:55:18 +000084 const char *s, *last, *end;
Barry Warsaw226ae6c1999-10-12 19:54:53 +000085 double x;
Tim Petersef14d732000-09-23 03:39:17 +000086 char buffer[256]; /* for errors */
Martin v. Löwis339d0f72001-08-17 18:39:25 +000087#ifdef Py_USING_UNICODE
Tim Petersef14d732000-09-23 03:39:17 +000088 char s_buffer[256]; /* for objects convertible to a char buffer */
Martin v. Löwis339d0f72001-08-17 18:39:25 +000089#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +000090 Py_ssize_t len;
Barry Warsaw226ae6c1999-10-12 19:54:53 +000091
Tim Petersef14d732000-09-23 03:39:17 +000092 if (pend)
93 *pend = NULL;
Guido van Rossum4c08d552000-03-10 22:55:18 +000094 if (PyString_Check(v)) {
95 s = PyString_AS_STRING(v);
96 len = PyString_GET_SIZE(v);
97 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +000098#ifdef Py_USING_UNICODE
Guido van Rossum9e896b32000-04-05 20:11:21 +000099 else if (PyUnicode_Check(v)) {
Skip Montanaro429433b2006-04-18 00:35:43 +0000100 if (PyUnicode_GET_SIZE(v) >= (Py_ssize_t)sizeof(s_buffer)) {
Guido van Rossum9e896b32000-04-05 20:11:21 +0000101 PyErr_SetString(PyExc_ValueError,
Tim Petersef14d732000-09-23 03:39:17 +0000102 "Unicode float() literal too long to convert");
Guido van Rossum9e896b32000-04-05 20:11:21 +0000103 return NULL;
104 }
Tim Petersef14d732000-09-23 03:39:17 +0000105 if (PyUnicode_EncodeDecimal(PyUnicode_AS_UNICODE(v),
Guido van Rossum9e896b32000-04-05 20:11:21 +0000106 PyUnicode_GET_SIZE(v),
Tim Petersd2364e82001-11-01 20:09:42 +0000107 s_buffer,
Guido van Rossum9e896b32000-04-05 20:11:21 +0000108 NULL))
109 return NULL;
110 s = s_buffer;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000111 len = strlen(s);
Guido van Rossum9e896b32000-04-05 20:11:21 +0000112 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000113#endif
Guido van Rossum4c08d552000-03-10 22:55:18 +0000114 else if (PyObject_AsCharBuffer(v, &s, &len)) {
115 PyErr_SetString(PyExc_TypeError,
Skip Montanaro71390a92002-05-02 13:03:22 +0000116 "float() argument must be a string or a number");
Barry Warsaw226ae6c1999-10-12 19:54:53 +0000117 return NULL;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000118 }
Barry Warsaw226ae6c1999-10-12 19:54:53 +0000119
Guido van Rossum4c08d552000-03-10 22:55:18 +0000120 last = s + len;
Barry Warsaw226ae6c1999-10-12 19:54:53 +0000121 while (*s && isspace(Py_CHARMASK(*s)))
122 s++;
Tim Petersef14d732000-09-23 03:39:17 +0000123 if (*s == '\0') {
Barry Warsaw226ae6c1999-10-12 19:54:53 +0000124 PyErr_SetString(PyExc_ValueError, "empty string for float()");
125 return NULL;
126 }
Tim Petersef14d732000-09-23 03:39:17 +0000127 /* We don't care about overflow or underflow. If the platform supports
128 * them, infinities and signed zeroes (on underflow) are fine.
129 * However, strtod can return 0 for denormalized numbers, where atof
130 * does not. So (alas!) we special-case a zero result. Note that
131 * whether strtod sets errno on underflow is not defined, so we can't
132 * key off errno.
133 */
Tim Peters858346e2000-09-25 21:01:28 +0000134 PyFPE_START_PROTECT("strtod", return NULL)
Martin v. Löwis737ea822004-06-08 18:52:54 +0000135 x = PyOS_ascii_strtod(s, (char **)&end);
Tim Peters858346e2000-09-25 21:01:28 +0000136 PyFPE_END_PROTECT(x)
Barry Warsaw226ae6c1999-10-12 19:54:53 +0000137 errno = 0;
Barry Warsaw226ae6c1999-10-12 19:54:53 +0000138 /* Believe it or not, Solaris 2.6 can move end *beyond* the null
Tim Petersef14d732000-09-23 03:39:17 +0000139 byte at the end of the string, when the input is inf(inity). */
Barry Warsaw226ae6c1999-10-12 19:54:53 +0000140 if (end > last)
141 end = last;
Tim Petersef14d732000-09-23 03:39:17 +0000142 if (end == s) {
Barry Warsawaf8aef92001-11-28 20:52:21 +0000143 PyOS_snprintf(buffer, sizeof(buffer),
144 "invalid literal for float(): %.200s", s);
Tim Petersef14d732000-09-23 03:39:17 +0000145 PyErr_SetString(PyExc_ValueError, buffer);
146 return NULL;
147 }
148 /* Since end != s, the platform made *some* kind of sense out
149 of the input. Trust it. */
Barry Warsaw226ae6c1999-10-12 19:54:53 +0000150 while (*end && isspace(Py_CHARMASK(*end)))
151 end++;
152 if (*end != '\0') {
Barry Warsawaf8aef92001-11-28 20:52:21 +0000153 PyOS_snprintf(buffer, sizeof(buffer),
154 "invalid literal for float(): %.200s", s);
Barry Warsaw226ae6c1999-10-12 19:54:53 +0000155 PyErr_SetString(PyExc_ValueError, buffer);
156 return NULL;
157 }
Guido van Rossum4c08d552000-03-10 22:55:18 +0000158 else if (end != last) {
Barry Warsaw226ae6c1999-10-12 19:54:53 +0000159 PyErr_SetString(PyExc_ValueError,
160 "null byte in argument for float()");
161 return NULL;
162 }
Tim Petersef14d732000-09-23 03:39:17 +0000163 if (x == 0.0) {
164 /* See above -- may have been strtod being anal
165 about denorms. */
Tim Peters858346e2000-09-25 21:01:28 +0000166 PyFPE_START_PROTECT("atof", return NULL)
Martin v. Löwis737ea822004-06-08 18:52:54 +0000167 x = PyOS_ascii_atof(s);
Tim Peters858346e2000-09-25 21:01:28 +0000168 PyFPE_END_PROTECT(x)
Tim Petersef14d732000-09-23 03:39:17 +0000169 errno = 0; /* whether atof ever set errno is undefined */
Barry Warsaw226ae6c1999-10-12 19:54:53 +0000170 }
Barry Warsaw226ae6c1999-10-12 19:54:53 +0000171 return PyFloat_FromDouble(x);
172}
173
Guido van Rossum234f9421993-06-17 12:35:49 +0000174static void
Fred Drakefd99de62000-07-09 05:02:18 +0000175float_dealloc(PyFloatObject *op)
Guido van Rossum3132a5a1992-03-27 17:28:44 +0000176{
Guido van Rossum9475a232001-10-05 20:51:39 +0000177 if (PyFloat_CheckExact(op)) {
Martin v. Löwis68192102007-07-21 06:55:02 +0000178 Py_Type(op) = (struct _typeobject *)free_list;
Guido van Rossum9475a232001-10-05 20:51:39 +0000179 free_list = op;
180 }
181 else
Martin v. Löwis68192102007-07-21 06:55:02 +0000182 Py_Type(op)->tp_free((PyObject *)op);
Guido van Rossum3132a5a1992-03-27 17:28:44 +0000183}
184
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000185double
Fred Drakefd99de62000-07-09 05:02:18 +0000186PyFloat_AsDouble(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000187{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000188 PyNumberMethods *nb;
189 PyFloatObject *fo;
Guido van Rossumb6775db1994-08-01 11:34:53 +0000190 double val;
Tim Petersd2364e82001-11-01 20:09:42 +0000191
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000192 if (op && PyFloat_Check(op))
193 return PyFloat_AS_DOUBLE((PyFloatObject*) op);
Tim Petersd2364e82001-11-01 20:09:42 +0000194
Neil Schemenauer2c77e902002-11-18 16:06:21 +0000195 if (op == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000196 PyErr_BadArgument();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000197 return -1;
198 }
Tim Petersd2364e82001-11-01 20:09:42 +0000199
Martin v. Löwis68192102007-07-21 06:55:02 +0000200 if ((nb = Py_Type(op)->tp_as_number) == NULL || nb->nb_float == NULL) {
Neil Schemenauer2c77e902002-11-18 16:06:21 +0000201 PyErr_SetString(PyExc_TypeError, "a float is required");
202 return -1;
203 }
204
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000205 fo = (PyFloatObject*) (*nb->nb_float) (op);
Guido van Rossumb6775db1994-08-01 11:34:53 +0000206 if (fo == NULL)
207 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000208 if (!PyFloat_Check(fo)) {
209 PyErr_SetString(PyExc_TypeError,
210 "nb_float should return float object");
Guido van Rossumb6775db1994-08-01 11:34:53 +0000211 return -1;
212 }
Tim Petersd2364e82001-11-01 20:09:42 +0000213
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000214 val = PyFloat_AS_DOUBLE(fo);
215 Py_DECREF(fo);
Tim Petersd2364e82001-11-01 20:09:42 +0000216
Guido van Rossumb6775db1994-08-01 11:34:53 +0000217 return val;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000218}
219
220/* Methods */
221
Tim Peters97019e42001-11-28 22:43:45 +0000222static void
223format_float(char *buf, size_t buflen, PyFloatObject *v, int precision)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000224{
225 register char *cp;
Martin v. Löwis737ea822004-06-08 18:52:54 +0000226 char format[32];
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000227 /* Subroutine for float_repr and float_print.
228 We want float numbers to be recognizable as such,
229 i.e., they should contain a decimal point or an exponent.
230 However, %g may print the number as an integer;
231 in such cases, we append ".0" to the string. */
Tim Peters97019e42001-11-28 22:43:45 +0000232
233 assert(PyFloat_Check(v));
Martin v. Löwis737ea822004-06-08 18:52:54 +0000234 PyOS_snprintf(format, 32, "%%.%ig", precision);
235 PyOS_ascii_formatd(buf, buflen, format, v->ob_fval);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000236 cp = buf;
237 if (*cp == '-')
238 cp++;
239 for (; *cp != '\0'; cp++) {
240 /* Any non-digit means it's not an integer;
241 this takes care of NAN and INF as well. */
Guido van Rossum9fa2c111995-02-10 17:00:37 +0000242 if (!isdigit(Py_CHARMASK(*cp)))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000243 break;
244 }
245 if (*cp == '\0') {
246 *cp++ = '.';
247 *cp++ = '0';
248 *cp++ = '\0';
249 }
250}
251
Tim Peters97019e42001-11-28 22:43:45 +0000252/* XXX PyFloat_AsStringEx should not be a public API function (for one
253 XXX thing, its signature passes a buffer without a length; for another,
254 XXX it isn't useful outside this file).
255*/
256void
257PyFloat_AsStringEx(char *buf, PyFloatObject *v, int precision)
258{
259 format_float(buf, 100, v, precision);
260}
261
Neil Schemenauer32117e52001-01-04 01:44:34 +0000262/* Macro and helper that convert PyObject obj to a C double and store
263 the value in dbl; this replaces the functionality of the coercion
Tim Peters77d8a4f2001-12-11 20:31:34 +0000264 slot function. If conversion to double raises an exception, obj is
265 set to NULL, and the function invoking this macro returns NULL. If
266 obj is not of float, int or long type, Py_NotImplemented is incref'ed,
267 stored in obj, and returned from the function invoking this macro.
268*/
Neil Schemenauer32117e52001-01-04 01:44:34 +0000269#define CONVERT_TO_DOUBLE(obj, dbl) \
270 if (PyFloat_Check(obj)) \
271 dbl = PyFloat_AS_DOUBLE(obj); \
272 else if (convert_to_double(&(obj), &(dbl)) < 0) \
273 return obj;
274
275static int
Tim Peters9fffa3e2001-09-04 05:14:19 +0000276convert_to_double(PyObject **v, double *dbl)
Neil Schemenauer32117e52001-01-04 01:44:34 +0000277{
278 register PyObject *obj = *v;
Tim Peters9fffa3e2001-09-04 05:14:19 +0000279
Neil Schemenauer32117e52001-01-04 01:44:34 +0000280 if (PyInt_Check(obj)) {
281 *dbl = (double)PyInt_AS_LONG(obj);
282 }
283 else if (PyLong_Check(obj)) {
Neil Schemenauer32117e52001-01-04 01:44:34 +0000284 *dbl = PyLong_AsDouble(obj);
Tim Peters9fffa3e2001-09-04 05:14:19 +0000285 if (*dbl == -1.0 && PyErr_Occurred()) {
286 *v = NULL;
287 return -1;
288 }
Neil Schemenauer32117e52001-01-04 01:44:34 +0000289 }
290 else {
291 Py_INCREF(Py_NotImplemented);
292 *v = Py_NotImplemented;
293 return -1;
294 }
295 return 0;
296}
297
Guido van Rossum57072eb1999-12-23 19:00:28 +0000298/* Precisions used by repr() and str(), respectively.
299
300 The repr() precision (17 significant decimal digits) is the minimal number
301 that is guaranteed to have enough precision so that if the number is read
302 back in the exact same binary value is recreated. This is true for IEEE
303 floating point by design, and also happens to work for all other modern
304 hardware.
305
306 The str() precision is chosen so that in most cases, the rounding noise
307 created by various operations is suppressed, while giving plenty of
308 precision for practical use.
309
310*/
311
312#define PREC_REPR 17
313#define PREC_STR 12
314
Tim Peters97019e42001-11-28 22:43:45 +0000315/* XXX PyFloat_AsString and PyFloat_AsReprString should be deprecated:
316 XXX they pass a char buffer without passing a length.
317*/
Guido van Rossum57072eb1999-12-23 19:00:28 +0000318void
Fred Drakefd99de62000-07-09 05:02:18 +0000319PyFloat_AsString(char *buf, PyFloatObject *v)
Guido van Rossum57072eb1999-12-23 19:00:28 +0000320{
Tim Peters97019e42001-11-28 22:43:45 +0000321 format_float(buf, 100, v, PREC_STR);
Guido van Rossum57072eb1999-12-23 19:00:28 +0000322}
323
Tim Peters72f98e92001-05-08 15:19:57 +0000324void
325PyFloat_AsReprString(char *buf, PyFloatObject *v)
326{
Tim Peters97019e42001-11-28 22:43:45 +0000327 format_float(buf, 100, v, PREC_REPR);
Tim Peters72f98e92001-05-08 15:19:57 +0000328}
329
Guido van Rossum3132a5a1992-03-27 17:28:44 +0000330/* ARGSUSED */
Guido van Rossum90933611991-06-07 16:10:43 +0000331static int
Fred Drakefd99de62000-07-09 05:02:18 +0000332float_print(PyFloatObject *v, FILE *fp, int flags)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000333{
334 char buf[100];
Tim Peters97019e42001-11-28 22:43:45 +0000335 format_float(buf, sizeof(buf), v,
336 (flags & Py_PRINT_RAW) ? PREC_STR : PREC_REPR);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000337 fputs(buf, fp);
Guido van Rossum90933611991-06-07 16:10:43 +0000338 return 0;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000339}
340
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000341static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000342float_repr(PyFloatObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000343{
344 char buf[100];
Tim Peters97019e42001-11-28 22:43:45 +0000345 format_float(buf, sizeof(buf), v, PREC_REPR);
Guido van Rossum57072eb1999-12-23 19:00:28 +0000346 return PyString_FromString(buf);
347}
348
349static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000350float_str(PyFloatObject *v)
Guido van Rossum57072eb1999-12-23 19:00:28 +0000351{
352 char buf[100];
Tim Peters97019e42001-11-28 22:43:45 +0000353 format_float(buf, sizeof(buf), v, PREC_STR);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000354 return PyString_FromString(buf);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000355}
356
Tim Peters307fa782004-09-23 08:06:40 +0000357/* Comparison is pretty much a nightmare. When comparing float to float,
358 * we do it as straightforwardly (and long-windedly) as conceivable, so
359 * that, e.g., Python x == y delivers the same result as the platform
360 * C x == y when x and/or y is a NaN.
361 * When mixing float with an integer type, there's no good *uniform* approach.
362 * Converting the double to an integer obviously doesn't work, since we
363 * may lose info from fractional bits. Converting the integer to a double
364 * also has two failure modes: (1) a long int may trigger overflow (too
365 * large to fit in the dynamic range of a C double); (2) even a C long may have
366 * more bits than fit in a C double (e.g., on a a 64-bit box long may have
367 * 63 bits of precision, but a C double probably has only 53), and then
368 * we can falsely claim equality when low-order integer bits are lost by
369 * coercion to double. So this part is painful too.
370 */
371
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000372static PyObject*
373float_richcompare(PyObject *v, PyObject *w, int op)
374{
375 double i, j;
376 int r = 0;
377
Tim Peters307fa782004-09-23 08:06:40 +0000378 assert(PyFloat_Check(v));
379 i = PyFloat_AS_DOUBLE(v);
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000380
Tim Peters307fa782004-09-23 08:06:40 +0000381 /* Switch on the type of w. Set i and j to doubles to be compared,
382 * and op to the richcomp to use.
383 */
384 if (PyFloat_Check(w))
385 j = PyFloat_AS_DOUBLE(w);
386
Kristján Valur Jónssonf94323f2006-05-25 15:53:30 +0000387 else if (!Py_IS_FINITE(i)) {
Tim Peters307fa782004-09-23 08:06:40 +0000388 if (PyInt_Check(w) || PyLong_Check(w))
Tim Peterse1c69b32004-09-23 19:22:41 +0000389 /* If i is an infinity, its magnitude exceeds any
390 * finite integer, so it doesn't matter which int we
391 * compare i with. If i is a NaN, similarly.
Tim Peters307fa782004-09-23 08:06:40 +0000392 */
393 j = 0.0;
394 else
395 goto Unimplemented;
396 }
397
398 else if (PyInt_Check(w)) {
399 long jj = PyInt_AS_LONG(w);
400 /* In the worst realistic case I can imagine, C double is a
401 * Cray single with 48 bits of precision, and long has 64
402 * bits.
403 */
Tim Peterse1c69b32004-09-23 19:22:41 +0000404#if SIZEOF_LONG > 6
Tim Peters307fa782004-09-23 08:06:40 +0000405 unsigned long abs = (unsigned long)(jj < 0 ? -jj : jj);
406 if (abs >> 48) {
407 /* Needs more than 48 bits. Make it take the
408 * PyLong path.
409 */
410 PyObject *result;
411 PyObject *ww = PyLong_FromLong(jj);
412
413 if (ww == NULL)
414 return NULL;
415 result = float_richcompare(v, ww, op);
416 Py_DECREF(ww);
417 return result;
418 }
419#endif
420 j = (double)jj;
421 assert((long)j == jj);
422 }
423
424 else if (PyLong_Check(w)) {
425 int vsign = i == 0.0 ? 0 : i < 0.0 ? -1 : 1;
426 int wsign = _PyLong_Sign(w);
427 size_t nbits;
Tim Peters307fa782004-09-23 08:06:40 +0000428 int exponent;
429
430 if (vsign != wsign) {
431 /* Magnitudes are irrelevant -- the signs alone
432 * determine the outcome.
433 */
434 i = (double)vsign;
435 j = (double)wsign;
436 goto Compare;
437 }
438 /* The signs are the same. */
439 /* Convert w to a double if it fits. In particular, 0 fits. */
440 nbits = _PyLong_NumBits(w);
441 if (nbits == (size_t)-1 && PyErr_Occurred()) {
442 /* This long is so large that size_t isn't big enough
Tim Peterse1c69b32004-09-23 19:22:41 +0000443 * to hold the # of bits. Replace with little doubles
444 * that give the same outcome -- w is so large that
445 * its magnitude must exceed the magnitude of any
446 * finite float.
Tim Peters307fa782004-09-23 08:06:40 +0000447 */
448 PyErr_Clear();
449 i = (double)vsign;
450 assert(wsign != 0);
451 j = wsign * 2.0;
452 goto Compare;
453 }
454 if (nbits <= 48) {
455 j = PyLong_AsDouble(w);
456 /* It's impossible that <= 48 bits overflowed. */
457 assert(j != -1.0 || ! PyErr_Occurred());
458 goto Compare;
459 }
460 assert(wsign != 0); /* else nbits was 0 */
461 assert(vsign != 0); /* if vsign were 0, then since wsign is
462 * not 0, we would have taken the
463 * vsign != wsign branch at the start */
464 /* We want to work with non-negative numbers. */
465 if (vsign < 0) {
466 /* "Multiply both sides" by -1; this also swaps the
467 * comparator.
468 */
469 i = -i;
470 op = _Py_SwappedOp[op];
471 }
472 assert(i > 0.0);
Neal Norwitzb2da01b2006-01-08 01:11:25 +0000473 (void) frexp(i, &exponent);
Tim Peters307fa782004-09-23 08:06:40 +0000474 /* exponent is the # of bits in v before the radix point;
475 * we know that nbits (the # of bits in w) > 48 at this point
476 */
477 if (exponent < 0 || (size_t)exponent < nbits) {
478 i = 1.0;
479 j = 2.0;
480 goto Compare;
481 }
482 if ((size_t)exponent > nbits) {
483 i = 2.0;
484 j = 1.0;
485 goto Compare;
486 }
487 /* v and w have the same number of bits before the radix
488 * point. Construct two longs that have the same comparison
489 * outcome.
490 */
491 {
492 double fracpart;
493 double intpart;
494 PyObject *result = NULL;
495 PyObject *one = NULL;
496 PyObject *vv = NULL;
497 PyObject *ww = w;
498
499 if (wsign < 0) {
500 ww = PyNumber_Negative(w);
501 if (ww == NULL)
502 goto Error;
503 }
504 else
505 Py_INCREF(ww);
506
507 fracpart = modf(i, &intpart);
508 vv = PyLong_FromDouble(intpart);
509 if (vv == NULL)
510 goto Error;
511
512 if (fracpart != 0.0) {
513 /* Shift left, and or a 1 bit into vv
514 * to represent the lost fraction.
515 */
516 PyObject *temp;
517
518 one = PyInt_FromLong(1);
519 if (one == NULL)
520 goto Error;
521
522 temp = PyNumber_Lshift(ww, one);
523 if (temp == NULL)
524 goto Error;
525 Py_DECREF(ww);
526 ww = temp;
527
528 temp = PyNumber_Lshift(vv, one);
529 if (temp == NULL)
530 goto Error;
531 Py_DECREF(vv);
532 vv = temp;
533
534 temp = PyNumber_Or(vv, one);
535 if (temp == NULL)
536 goto Error;
537 Py_DECREF(vv);
538 vv = temp;
539 }
540
541 r = PyObject_RichCompareBool(vv, ww, op);
542 if (r < 0)
543 goto Error;
544 result = PyBool_FromLong(r);
545 Error:
546 Py_XDECREF(vv);
547 Py_XDECREF(ww);
548 Py_XDECREF(one);
549 return result;
550 }
551 } /* else if (PyLong_Check(w)) */
552
553 else /* w isn't float, int, or long */
554 goto Unimplemented;
555
556 Compare:
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000557 PyFPE_START_PROTECT("richcompare", return NULL)
558 switch (op) {
559 case Py_EQ:
Tim Peters307fa782004-09-23 08:06:40 +0000560 r = i == j;
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000561 break;
562 case Py_NE:
Tim Peters307fa782004-09-23 08:06:40 +0000563 r = i != j;
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000564 break;
565 case Py_LE:
Tim Peters307fa782004-09-23 08:06:40 +0000566 r = i <= j;
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000567 break;
568 case Py_GE:
Tim Peters307fa782004-09-23 08:06:40 +0000569 r = i >= j;
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000570 break;
571 case Py_LT:
Tim Peters307fa782004-09-23 08:06:40 +0000572 r = i < j;
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000573 break;
574 case Py_GT:
Tim Peters307fa782004-09-23 08:06:40 +0000575 r = i > j;
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000576 break;
577 }
Michael W. Hudson957f9772004-02-26 12:33:09 +0000578 PyFPE_END_PROTECT(r)
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000579 return PyBool_FromLong(r);
Tim Peters307fa782004-09-23 08:06:40 +0000580
581 Unimplemented:
582 Py_INCREF(Py_NotImplemented);
583 return Py_NotImplemented;
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000584}
585
Guido van Rossum9bfef441993-03-29 10:43:31 +0000586static long
Fred Drakefd99de62000-07-09 05:02:18 +0000587float_hash(PyFloatObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000588{
Tim Peters39dce292000-08-15 03:34:48 +0000589 return _Py_HashDouble(v->ob_fval);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000590}
591
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000592static PyObject *
Neil Schemenauer32117e52001-01-04 01:44:34 +0000593float_add(PyObject *v, PyObject *w)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000594{
Neil Schemenauer32117e52001-01-04 01:44:34 +0000595 double a,b;
596 CONVERT_TO_DOUBLE(v, a);
597 CONVERT_TO_DOUBLE(w, b);
Guido van Rossum09e6ad01997-02-14 22:54:21 +0000598 PyFPE_START_PROTECT("add", return 0)
Neil Schemenauer32117e52001-01-04 01:44:34 +0000599 a = a + b;
600 PyFPE_END_PROTECT(a)
601 return PyFloat_FromDouble(a);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000602}
603
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000604static PyObject *
Neil Schemenauer32117e52001-01-04 01:44:34 +0000605float_sub(PyObject *v, PyObject *w)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000606{
Neil Schemenauer32117e52001-01-04 01:44:34 +0000607 double a,b;
608 CONVERT_TO_DOUBLE(v, a);
609 CONVERT_TO_DOUBLE(w, b);
Guido van Rossum09e6ad01997-02-14 22:54:21 +0000610 PyFPE_START_PROTECT("subtract", return 0)
Neil Schemenauer32117e52001-01-04 01:44:34 +0000611 a = a - b;
612 PyFPE_END_PROTECT(a)
613 return PyFloat_FromDouble(a);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000614}
615
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000616static PyObject *
Neil Schemenauer32117e52001-01-04 01:44:34 +0000617float_mul(PyObject *v, PyObject *w)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000618{
Neil Schemenauer32117e52001-01-04 01:44:34 +0000619 double a,b;
620 CONVERT_TO_DOUBLE(v, a);
621 CONVERT_TO_DOUBLE(w, b);
Guido van Rossum09e6ad01997-02-14 22:54:21 +0000622 PyFPE_START_PROTECT("multiply", return 0)
Neil Schemenauer32117e52001-01-04 01:44:34 +0000623 a = a * b;
624 PyFPE_END_PROTECT(a)
625 return PyFloat_FromDouble(a);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000626}
627
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000628static PyObject *
Neil Schemenauer32117e52001-01-04 01:44:34 +0000629float_div(PyObject *v, PyObject *w)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000630{
Neil Schemenauer32117e52001-01-04 01:44:34 +0000631 double a,b;
632 CONVERT_TO_DOUBLE(v, a);
633 CONVERT_TO_DOUBLE(w, b);
634 if (b == 0.0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000635 PyErr_SetString(PyExc_ZeroDivisionError, "float division");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000636 return NULL;
637 }
Guido van Rossum09e6ad01997-02-14 22:54:21 +0000638 PyFPE_START_PROTECT("divide", return 0)
Neil Schemenauer32117e52001-01-04 01:44:34 +0000639 a = a / b;
640 PyFPE_END_PROTECT(a)
641 return PyFloat_FromDouble(a);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000642}
643
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000644static PyObject *
Guido van Rossum393661d2001-08-31 17:40:15 +0000645float_classic_div(PyObject *v, PyObject *w)
646{
647 double a,b;
648 CONVERT_TO_DOUBLE(v, a);
649 CONVERT_TO_DOUBLE(w, b);
Guido van Rossum1832de42001-09-04 03:51:09 +0000650 if (Py_DivisionWarningFlag >= 2 &&
Guido van Rossum393661d2001-08-31 17:40:15 +0000651 PyErr_Warn(PyExc_DeprecationWarning, "classic float division") < 0)
652 return NULL;
653 if (b == 0.0) {
654 PyErr_SetString(PyExc_ZeroDivisionError, "float division");
655 return NULL;
656 }
657 PyFPE_START_PROTECT("divide", return 0)
658 a = a / b;
659 PyFPE_END_PROTECT(a)
660 return PyFloat_FromDouble(a);
661}
662
663static PyObject *
Neil Schemenauer32117e52001-01-04 01:44:34 +0000664float_rem(PyObject *v, PyObject *w)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000665{
Guido van Rossum56cd67a1992-01-26 18:16:35 +0000666 double vx, wx;
Guido van Rossum9263e781999-05-06 14:26:34 +0000667 double mod;
Neil Schemenauer32117e52001-01-04 01:44:34 +0000668 CONVERT_TO_DOUBLE(v, vx);
669 CONVERT_TO_DOUBLE(w, wx);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000670 if (wx == 0.0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000671 PyErr_SetString(PyExc_ZeroDivisionError, "float modulo");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000672 return NULL;
673 }
Guido van Rossum09e6ad01997-02-14 22:54:21 +0000674 PyFPE_START_PROTECT("modulo", return 0)
Guido van Rossum56cd67a1992-01-26 18:16:35 +0000675 mod = fmod(vx, wx);
Guido van Rossum9263e781999-05-06 14:26:34 +0000676 /* note: checking mod*wx < 0 is incorrect -- underflows to
677 0 if wx < sqrt(smallest nonzero double) */
678 if (mod && ((wx < 0) != (mod < 0))) {
Guido van Rossum56cd67a1992-01-26 18:16:35 +0000679 mod += wx;
Guido van Rossum56cd67a1992-01-26 18:16:35 +0000680 }
Guido van Rossum45b83911997-03-14 04:32:50 +0000681 PyFPE_END_PROTECT(mod)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000682 return PyFloat_FromDouble(mod);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000683}
684
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000685static PyObject *
Neil Schemenauer32117e52001-01-04 01:44:34 +0000686float_divmod(PyObject *v, PyObject *w)
Guido van Rossumeba1b5e1991-05-05 20:07:00 +0000687{
Guido van Rossum15ecff41991-10-20 20:16:45 +0000688 double vx, wx;
Guido van Rossum9263e781999-05-06 14:26:34 +0000689 double div, mod, floordiv;
Neil Schemenauer32117e52001-01-04 01:44:34 +0000690 CONVERT_TO_DOUBLE(v, vx);
691 CONVERT_TO_DOUBLE(w, wx);
Guido van Rossum15ecff41991-10-20 20:16:45 +0000692 if (wx == 0.0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000693 PyErr_SetString(PyExc_ZeroDivisionError, "float divmod()");
Guido van Rossum15ecff41991-10-20 20:16:45 +0000694 return NULL;
695 }
Guido van Rossum09e6ad01997-02-14 22:54:21 +0000696 PyFPE_START_PROTECT("divmod", return 0)
Guido van Rossum15ecff41991-10-20 20:16:45 +0000697 mod = fmod(vx, wx);
Tim Peters78fc0b52000-09-16 03:54:24 +0000698 /* fmod is typically exact, so vx-mod is *mathematically* an
Guido van Rossum9263e781999-05-06 14:26:34 +0000699 exact multiple of wx. But this is fp arithmetic, and fp
700 vx - mod is an approximation; the result is that div may
701 not be an exact integral value after the division, although
702 it will always be very close to one.
703 */
Guido van Rossum15ecff41991-10-20 20:16:45 +0000704 div = (vx - mod) / wx;
Tim Petersd2e40d62001-11-01 23:12:27 +0000705 if (mod) {
706 /* ensure the remainder has the same sign as the denominator */
707 if ((wx < 0) != (mod < 0)) {
708 mod += wx;
709 div -= 1.0;
710 }
711 }
712 else {
713 /* the remainder is zero, and in the presence of signed zeroes
714 fmod returns different results across platforms; ensure
715 it has the same sign as the denominator; we'd like to do
716 "mod = wx * 0.0", but that may get optimized away */
Tim Peters4e8ab5d2001-11-01 23:59:56 +0000717 mod *= mod; /* hide "mod = +0" from optimizer */
Tim Petersd2e40d62001-11-01 23:12:27 +0000718 if (wx < 0.0)
719 mod = -mod;
Guido van Rossum15ecff41991-10-20 20:16:45 +0000720 }
Guido van Rossum9263e781999-05-06 14:26:34 +0000721 /* snap quotient to nearest integral value */
Tim Petersd2e40d62001-11-01 23:12:27 +0000722 if (div) {
723 floordiv = floor(div);
724 if (div - floordiv > 0.5)
725 floordiv += 1.0;
726 }
727 else {
728 /* div is zero - get the same sign as the true quotient */
729 div *= div; /* hide "div = +0" from optimizers */
730 floordiv = div * vx / wx; /* zero w/ sign of vx/wx */
731 }
732 PyFPE_END_PROTECT(floordiv)
Guido van Rossum9263e781999-05-06 14:26:34 +0000733 return Py_BuildValue("(dd)", floordiv, mod);
Guido van Rossumeba1b5e1991-05-05 20:07:00 +0000734}
735
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000736static PyObject *
Tim Peters63a35712001-12-11 19:57:24 +0000737float_floor_div(PyObject *v, PyObject *w)
738{
739 PyObject *t, *r;
740
741 t = float_divmod(v, w);
Tim Peters77d8a4f2001-12-11 20:31:34 +0000742 if (t == NULL || t == Py_NotImplemented)
743 return t;
744 assert(PyTuple_CheckExact(t));
745 r = PyTuple_GET_ITEM(t, 0);
746 Py_INCREF(r);
747 Py_DECREF(t);
748 return r;
Tim Peters63a35712001-12-11 19:57:24 +0000749}
750
751static PyObject *
Neil Schemenauer32117e52001-01-04 01:44:34 +0000752float_pow(PyObject *v, PyObject *w, PyObject *z)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000753{
754 double iv, iw, ix;
Tim Peters32f453e2001-09-03 08:35:41 +0000755
756 if ((PyObject *)z != Py_None) {
Tim Peters4c483c42001-09-05 06:24:58 +0000757 PyErr_SetString(PyExc_TypeError, "pow() 3rd argument not "
Tim Peters97f4a332001-09-05 23:49:24 +0000758 "allowed unless all arguments are integers");
Tim Peters32f453e2001-09-03 08:35:41 +0000759 return NULL;
760 }
761
Neil Schemenauer32117e52001-01-04 01:44:34 +0000762 CONVERT_TO_DOUBLE(v, iv);
763 CONVERT_TO_DOUBLE(w, iw);
Tim Petersc54d1902000-10-06 00:36:09 +0000764
765 /* Sort out special cases here instead of relying on pow() */
Tim Peters96685bf2001-08-23 22:31:37 +0000766 if (iw == 0) { /* v**0 is 1, even 0**0 */
Neal Norwitz8b267b52007-05-03 07:20:57 +0000767 return PyFloat_FromDouble(1.0);
Tim Petersc54d1902000-10-06 00:36:09 +0000768 }
Tim Peters96685bf2001-08-23 22:31:37 +0000769 if (iv == 0.0) { /* 0**w is error if w<0, else 1 */
Tim Petersc54d1902000-10-06 00:36:09 +0000770 if (iw < 0.0) {
771 PyErr_SetString(PyExc_ZeroDivisionError,
Fred Drake661ea262000-10-24 19:57:45 +0000772 "0.0 cannot be raised to a negative power");
Tim Petersc54d1902000-10-06 00:36:09 +0000773 return NULL;
774 }
775 return PyFloat_FromDouble(0.0);
776 }
Tim Peterse87568d2003-05-24 20:18:24 +0000777 if (iv < 0.0) {
778 /* Whether this is an error is a mess, and bumps into libm
779 * bugs so we have to figure it out ourselves.
780 */
781 if (iw != floor(iw)) {
782 PyErr_SetString(PyExc_ValueError, "negative number "
783 "cannot be raised to a fractional power");
784 return NULL;
785 }
786 /* iw is an exact integer, albeit perhaps a very large one.
787 * -1 raised to an exact integer should never be exceptional.
788 * Alas, some libms (chiefly glibc as of early 2003) return
789 * NaN and set EDOM on pow(-1, large_int) if the int doesn't
790 * happen to be representable in a *C* integer. That's a
791 * bug; we let that slide in math.pow() (which currently
792 * reflects all platform accidents), but not for Python's **.
793 */
Kristján Valur Jónssonf94323f2006-05-25 15:53:30 +0000794 if (iv == -1.0 && Py_IS_FINITE(iw)) {
Tim Peterse87568d2003-05-24 20:18:24 +0000795 /* Return 1 if iw is even, -1 if iw is odd; there's
796 * no guarantee that any C integral type is big
797 * enough to hold iw, so we have to check this
798 * indirectly.
799 */
800 ix = floor(iw * 0.5) * 2.0;
801 return PyFloat_FromDouble(ix == iw ? 1.0 : -1.0);
802 }
803 /* Else iv != -1.0, and overflow or underflow are possible.
804 * Unless we're to write pow() ourselves, we have to trust
805 * the platform to do this correctly.
806 */
Guido van Rossum86c04c21996-08-09 20:50:14 +0000807 }
Tim Peters96685bf2001-08-23 22:31:37 +0000808 errno = 0;
809 PyFPE_START_PROTECT("pow", return NULL)
810 ix = pow(iv, iw);
811 PyFPE_END_PROTECT(ix)
Tim Petersdc5a5082002-03-09 04:58:24 +0000812 Py_ADJUST_ERANGE1(ix);
Alex Martelli348dc882006-08-23 22:17:59 +0000813 if (errno != 0) {
Tim Peterse87568d2003-05-24 20:18:24 +0000814 /* We don't expect any errno value other than ERANGE, but
815 * the range of libm bugs appears unbounded.
816 */
Alex Martelli348dc882006-08-23 22:17:59 +0000817 PyErr_SetFromErrno(errno == ERANGE ? PyExc_OverflowError :
818 PyExc_ValueError);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000819 return NULL;
Guido van Rossum2a9096b1990-10-21 22:15:08 +0000820 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000821 return PyFloat_FromDouble(ix);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000822}
823
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000824static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000825float_neg(PyFloatObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000826{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000827 return PyFloat_FromDouble(-v->ob_fval);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000828}
829
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000830static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000831float_pos(PyFloatObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000832{
Tim Peters0280cf72001-09-11 21:53:35 +0000833 if (PyFloat_CheckExact(v)) {
834 Py_INCREF(v);
835 return (PyObject *)v;
836 }
837 else
838 return PyFloat_FromDouble(v->ob_fval);
Guido van Rossumeba1b5e1991-05-05 20:07:00 +0000839}
840
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000841static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000842float_abs(PyFloatObject *v)
Guido van Rossumeba1b5e1991-05-05 20:07:00 +0000843{
Tim Petersfaf0cd22001-11-01 21:51:15 +0000844 return PyFloat_FromDouble(fabs(v->ob_fval));
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000845}
846
Guido van Rossum50b4ef61991-05-14 11:57:01 +0000847static int
Fred Drakefd99de62000-07-09 05:02:18 +0000848float_nonzero(PyFloatObject *v)
Guido van Rossum50b4ef61991-05-14 11:57:01 +0000849{
850 return v->ob_fval != 0.0;
851}
852
Guido van Rossum234f9421993-06-17 12:35:49 +0000853static int
Fred Drakefd99de62000-07-09 05:02:18 +0000854float_coerce(PyObject **pv, PyObject **pw)
Guido van Rossume6eefc21992-08-14 12:06:52 +0000855{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000856 if (PyInt_Check(*pw)) {
857 long x = PyInt_AsLong(*pw);
858 *pw = PyFloat_FromDouble((double)x);
859 Py_INCREF(*pv);
Guido van Rossume6eefc21992-08-14 12:06:52 +0000860 return 0;
861 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000862 else if (PyLong_Check(*pw)) {
Neal Norwitzabcb0c02003-01-28 19:21:24 +0000863 double x = PyLong_AsDouble(*pw);
864 if (x == -1.0 && PyErr_Occurred())
865 return -1;
866 *pw = PyFloat_FromDouble(x);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000867 Py_INCREF(*pv);
Guido van Rossume6eefc21992-08-14 12:06:52 +0000868 return 0;
869 }
Guido van Rossum1952e382001-09-19 01:25:16 +0000870 else if (PyFloat_Check(*pw)) {
871 Py_INCREF(*pv);
872 Py_INCREF(*pw);
873 return 0;
874 }
Guido van Rossume6eefc21992-08-14 12:06:52 +0000875 return 1; /* Can't do it */
876}
877
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000878static PyObject *
Walter Dörwaldf1715402002-11-19 20:49:15 +0000879float_long(PyObject *v)
880{
881 double x = PyFloat_AsDouble(v);
882 return PyLong_FromDouble(x);
883}
884
885static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000886float_int(PyObject *v)
Guido van Rossum1899c2e1992-09-12 11:09:23 +0000887{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000888 double x = PyFloat_AsDouble(v);
Tim Peters7321ec42001-07-26 20:02:17 +0000889 double wholepart; /* integral portion of x, rounded toward 0 */
Tim Peters7321ec42001-07-26 20:02:17 +0000890
891 (void)modf(x, &wholepart);
Tim Peters7d791242002-11-21 22:26:37 +0000892 /* Try to get out cheap if this fits in a Python int. The attempt
893 * to cast to long must be protected, as C doesn't define what
894 * happens if the double is too big to fit in a long. Some rare
895 * systems raise an exception then (RISCOS was mentioned as one,
896 * and someone using a non-default option on Sun also bumped into
897 * that). Note that checking for >= and <= LONG_{MIN,MAX} would
898 * still be vulnerable: if a long has more bits of precision than
899 * a double, casting MIN/MAX to double may yield an approximation,
900 * and if that's rounded up, then, e.g., wholepart=LONG_MAX+1 would
901 * yield true from the C expression wholepart<=LONG_MAX, despite
902 * that wholepart is actually greater than LONG_MAX.
903 */
904 if (LONG_MIN < wholepart && wholepart < LONG_MAX) {
905 const long aslong = (long)wholepart;
Tim Peters7321ec42001-07-26 20:02:17 +0000906 return PyInt_FromLong(aslong);
Tim Peters7d791242002-11-21 22:26:37 +0000907 }
908 return PyLong_FromDouble(wholepart);
Guido van Rossum1899c2e1992-09-12 11:09:23 +0000909}
910
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000911static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000912float_float(PyObject *v)
Guido van Rossum1899c2e1992-09-12 11:09:23 +0000913{
Brett Cannonc3647ac2005-04-26 03:45:26 +0000914 if (PyFloat_CheckExact(v))
915 Py_INCREF(v);
916 else
917 v = PyFloat_FromDouble(((PyFloatObject *)v)->ob_fval);
Guido van Rossum1899c2e1992-09-12 11:09:23 +0000918 return v;
919}
920
921
Jeremy Hylton938ace62002-07-17 16:30:39 +0000922static PyObject *
Guido van Rossumbef14172001-08-29 15:47:46 +0000923float_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds);
924
Tim Peters6d6c1a32001-08-02 04:15:00 +0000925static PyObject *
926float_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
927{
928 PyObject *x = Py_False; /* Integer zero */
Martin v. Löwis15e62742006-02-27 16:46:16 +0000929 static char *kwlist[] = {"x", 0};
Tim Peters6d6c1a32001-08-02 04:15:00 +0000930
Guido van Rossumbef14172001-08-29 15:47:46 +0000931 if (type != &PyFloat_Type)
932 return float_subtype_new(type, args, kwds); /* Wimp out */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000933 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|O:float", kwlist, &x))
934 return NULL;
935 if (PyString_Check(x))
936 return PyFloat_FromString(x, NULL);
937 return PyNumber_Float(x);
938}
939
Guido van Rossumbef14172001-08-29 15:47:46 +0000940/* Wimpy, slow approach to tp_new calls for subtypes of float:
941 first create a regular float from whatever arguments we got,
942 then allocate a subtype instance and initialize its ob_fval
943 from the regular float. The regular float is then thrown away.
944*/
945static PyObject *
946float_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
947{
Anthony Baxter377be112006-04-11 06:54:30 +0000948 PyObject *tmp, *newobj;
Guido van Rossumbef14172001-08-29 15:47:46 +0000949
950 assert(PyType_IsSubtype(type, &PyFloat_Type));
951 tmp = float_new(&PyFloat_Type, args, kwds);
952 if (tmp == NULL)
953 return NULL;
Tim Peters2400fa42001-09-12 19:12:49 +0000954 assert(PyFloat_CheckExact(tmp));
Anthony Baxter377be112006-04-11 06:54:30 +0000955 newobj = type->tp_alloc(type, 0);
956 if (newobj == NULL) {
Raymond Hettingerf4667932003-06-28 20:04:25 +0000957 Py_DECREF(tmp);
Guido van Rossumbef14172001-08-29 15:47:46 +0000958 return NULL;
Raymond Hettingerf4667932003-06-28 20:04:25 +0000959 }
Anthony Baxter377be112006-04-11 06:54:30 +0000960 ((PyFloatObject *)newobj)->ob_fval = ((PyFloatObject *)tmp)->ob_fval;
Guido van Rossumbef14172001-08-29 15:47:46 +0000961 Py_DECREF(tmp);
Anthony Baxter377be112006-04-11 06:54:30 +0000962 return newobj;
Guido van Rossumbef14172001-08-29 15:47:46 +0000963}
964
Guido van Rossum5d9113d2003-01-29 17:58:45 +0000965static PyObject *
966float_getnewargs(PyFloatObject *v)
967{
968 return Py_BuildValue("(d)", v->ob_fval);
969}
970
Michael W. Hudsonba283e22005-05-27 15:23:20 +0000971/* this is for the benefit of the pack/unpack routines below */
972
973typedef enum {
974 unknown_format, ieee_big_endian_format, ieee_little_endian_format
975} float_format_type;
976
977static float_format_type double_format, float_format;
978static float_format_type detected_double_format, detected_float_format;
979
980static PyObject *
981float_getformat(PyTypeObject *v, PyObject* arg)
982{
983 char* s;
984 float_format_type r;
985
986 if (!PyString_Check(arg)) {
987 PyErr_Format(PyExc_TypeError,
988 "__getformat__() argument must be string, not %.500s",
Martin v. Löwis68192102007-07-21 06:55:02 +0000989 Py_Type(arg)->tp_name);
Michael W. Hudsonba283e22005-05-27 15:23:20 +0000990 return NULL;
991 }
992 s = PyString_AS_STRING(arg);
993 if (strcmp(s, "double") == 0) {
994 r = double_format;
995 }
996 else if (strcmp(s, "float") == 0) {
997 r = float_format;
998 }
999 else {
1000 PyErr_SetString(PyExc_ValueError,
1001 "__getformat__() argument 1 must be "
1002 "'double' or 'float'");
1003 return NULL;
1004 }
1005
1006 switch (r) {
1007 case unknown_format:
1008 return PyString_FromString("unknown");
1009 case ieee_little_endian_format:
1010 return PyString_FromString("IEEE, little-endian");
1011 case ieee_big_endian_format:
1012 return PyString_FromString("IEEE, big-endian");
1013 default:
1014 Py_FatalError("insane float_format or double_format");
1015 return NULL;
1016 }
1017}
1018
1019PyDoc_STRVAR(float_getformat_doc,
1020"float.__getformat__(typestr) -> string\n"
1021"\n"
1022"You probably don't want to use this function. It exists mainly to be\n"
1023"used in Python's test suite.\n"
1024"\n"
1025"typestr must be 'double' or 'float'. This function returns whichever of\n"
1026"'unknown', 'IEEE, big-endian' or 'IEEE, little-endian' best describes the\n"
1027"format of floating point numbers used by the C type named by typestr.");
1028
1029static PyObject *
1030float_setformat(PyTypeObject *v, PyObject* args)
1031{
1032 char* typestr;
1033 char* format;
1034 float_format_type f;
1035 float_format_type detected;
1036 float_format_type *p;
1037
1038 if (!PyArg_ParseTuple(args, "ss:__setformat__", &typestr, &format))
1039 return NULL;
1040
1041 if (strcmp(typestr, "double") == 0) {
1042 p = &double_format;
1043 detected = detected_double_format;
1044 }
1045 else if (strcmp(typestr, "float") == 0) {
1046 p = &float_format;
1047 detected = detected_float_format;
1048 }
1049 else {
1050 PyErr_SetString(PyExc_ValueError,
1051 "__setformat__() argument 1 must "
1052 "be 'double' or 'float'");
1053 return NULL;
1054 }
1055
1056 if (strcmp(format, "unknown") == 0) {
1057 f = unknown_format;
1058 }
1059 else if (strcmp(format, "IEEE, little-endian") == 0) {
1060 f = ieee_little_endian_format;
1061 }
1062 else if (strcmp(format, "IEEE, big-endian") == 0) {
1063 f = ieee_big_endian_format;
1064 }
1065 else {
1066 PyErr_SetString(PyExc_ValueError,
1067 "__setformat__() argument 2 must be "
1068 "'unknown', 'IEEE, little-endian' or "
1069 "'IEEE, big-endian'");
1070 return NULL;
1071
1072 }
1073
1074 if (f != unknown_format && f != detected) {
1075 PyErr_Format(PyExc_ValueError,
1076 "can only set %s format to 'unknown' or the "
1077 "detected platform value", typestr);
1078 return NULL;
1079 }
1080
1081 *p = f;
1082 Py_RETURN_NONE;
1083}
1084
1085PyDoc_STRVAR(float_setformat_doc,
1086"float.__setformat__(typestr, fmt) -> None\n"
1087"\n"
1088"You probably don't want to use this function. It exists mainly to be\n"
1089"used in Python's test suite.\n"
1090"\n"
1091"typestr must be 'double' or 'float'. fmt must be one of 'unknown',\n"
1092"'IEEE, big-endian' or 'IEEE, little-endian', and in addition can only be\n"
1093"one of the latter two if it appears to match the underlying C reality.\n"
1094"\n"
1095"Overrides the automatic determination of C-level floating point type.\n"
1096"This affects how floats are converted to and from binary strings.");
1097
Guido van Rossum5d9113d2003-01-29 17:58:45 +00001098static PyMethodDef float_methods[] = {
1099 {"__getnewargs__", (PyCFunction)float_getnewargs, METH_NOARGS},
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001100 {"__getformat__", (PyCFunction)float_getformat,
1101 METH_O|METH_CLASS, float_getformat_doc},
1102 {"__setformat__", (PyCFunction)float_setformat,
1103 METH_VARARGS|METH_CLASS, float_setformat_doc},
Guido van Rossum5d9113d2003-01-29 17:58:45 +00001104 {NULL, NULL} /* sentinel */
1105};
1106
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001107PyDoc_STRVAR(float_doc,
Tim Peters6d6c1a32001-08-02 04:15:00 +00001108"float(x) -> floating point number\n\
1109\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001110Convert a string or number to a floating point number, if possible.");
Tim Peters6d6c1a32001-08-02 04:15:00 +00001111
1112
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001113static PyNumberMethods float_as_number = {
Georg Brandl347b3002006-03-30 11:57:00 +00001114 float_add, /*nb_add*/
1115 float_sub, /*nb_subtract*/
1116 float_mul, /*nb_multiply*/
1117 float_classic_div, /*nb_divide*/
1118 float_rem, /*nb_remainder*/
1119 float_divmod, /*nb_divmod*/
1120 float_pow, /*nb_power*/
Guido van Rossumb6775db1994-08-01 11:34:53 +00001121 (unaryfunc)float_neg, /*nb_negative*/
1122 (unaryfunc)float_pos, /*nb_positive*/
1123 (unaryfunc)float_abs, /*nb_absolute*/
1124 (inquiry)float_nonzero, /*nb_nonzero*/
Guido van Rossum27acb331991-10-24 14:55:28 +00001125 0, /*nb_invert*/
1126 0, /*nb_lshift*/
1127 0, /*nb_rshift*/
1128 0, /*nb_and*/
1129 0, /*nb_xor*/
1130 0, /*nb_or*/
Georg Brandl347b3002006-03-30 11:57:00 +00001131 float_coerce, /*nb_coerce*/
1132 float_int, /*nb_int*/
1133 float_long, /*nb_long*/
1134 float_float, /*nb_float*/
Guido van Rossum4668b002001-08-08 05:00:18 +00001135 0, /* nb_oct */
1136 0, /* nb_hex */
1137 0, /* nb_inplace_add */
1138 0, /* nb_inplace_subtract */
1139 0, /* nb_inplace_multiply */
1140 0, /* nb_inplace_divide */
1141 0, /* nb_inplace_remainder */
1142 0, /* nb_inplace_power */
1143 0, /* nb_inplace_lshift */
1144 0, /* nb_inplace_rshift */
1145 0, /* nb_inplace_and */
1146 0, /* nb_inplace_xor */
1147 0, /* nb_inplace_or */
Tim Peters63a35712001-12-11 19:57:24 +00001148 float_floor_div, /* nb_floor_divide */
Guido van Rossum4668b002001-08-08 05:00:18 +00001149 float_div, /* nb_true_divide */
1150 0, /* nb_inplace_floor_divide */
1151 0, /* nb_inplace_true_divide */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001152};
1153
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001154PyTypeObject PyFloat_Type = {
Martin v. Löwis68192102007-07-21 06:55:02 +00001155 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001156 "float",
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001157 sizeof(PyFloatObject),
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001158 0,
Tim Peters6d6c1a32001-08-02 04:15:00 +00001159 (destructor)float_dealloc, /* tp_dealloc */
1160 (printfunc)float_print, /* tp_print */
1161 0, /* tp_getattr */
1162 0, /* tp_setattr */
Michael W. Hudson08678a12004-05-26 17:36:12 +00001163 0, /* tp_compare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001164 (reprfunc)float_repr, /* tp_repr */
1165 &float_as_number, /* tp_as_number */
1166 0, /* tp_as_sequence */
1167 0, /* tp_as_mapping */
1168 (hashfunc)float_hash, /* tp_hash */
1169 0, /* tp_call */
1170 (reprfunc)float_str, /* tp_str */
1171 PyObject_GenericGetAttr, /* tp_getattro */
1172 0, /* tp_setattro */
1173 0, /* tp_as_buffer */
Guido van Rossumbef14172001-08-29 15:47:46 +00001174 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
1175 Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001176 float_doc, /* tp_doc */
1177 0, /* tp_traverse */
1178 0, /* tp_clear */
Georg Brandl347b3002006-03-30 11:57:00 +00001179 float_richcompare, /* tp_richcompare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001180 0, /* tp_weaklistoffset */
1181 0, /* tp_iter */
1182 0, /* tp_iternext */
Guido van Rossum5d9113d2003-01-29 17:58:45 +00001183 float_methods, /* tp_methods */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001184 0, /* tp_members */
1185 0, /* tp_getset */
1186 0, /* tp_base */
1187 0, /* tp_dict */
1188 0, /* tp_descr_get */
1189 0, /* tp_descr_set */
1190 0, /* tp_dictoffset */
1191 0, /* tp_init */
1192 0, /* tp_alloc */
1193 float_new, /* tp_new */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001194};
Guido van Rossumfbbd57e1997-08-05 02:16:08 +00001195
1196void
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001197_PyFloat_Init(void)
1198{
1199 /* We attempt to determine if this machine is using IEEE
1200 floating point formats by peering at the bits of some
1201 carefully chosen values. If it looks like we are on an
1202 IEEE platform, the float packing/unpacking routines can
1203 just copy bits, if not they resort to arithmetic & shifts
1204 and masks. The shifts & masks approach works on all finite
1205 values, but what happens to infinities, NaNs and signed
1206 zeroes on packing is an accident, and attempting to unpack
1207 a NaN or an infinity will raise an exception.
1208
1209 Note that if we're on some whacked-out platform which uses
1210 IEEE formats but isn't strictly little-endian or big-
1211 endian, we will fall back to the portable shifts & masks
1212 method. */
1213
1214#if SIZEOF_DOUBLE == 8
1215 {
1216 double x = 9006104071832581.0;
1217 if (memcmp(&x, "\x43\x3f\xff\x01\x02\x03\x04\x05", 8) == 0)
1218 detected_double_format = ieee_big_endian_format;
1219 else if (memcmp(&x, "\x05\x04\x03\x02\x01\xff\x3f\x43", 8) == 0)
1220 detected_double_format = ieee_little_endian_format;
1221 else
1222 detected_double_format = unknown_format;
1223 }
1224#else
1225 detected_double_format = unknown_format;
1226#endif
1227
1228#if SIZEOF_FLOAT == 4
1229 {
1230 float y = 16711938.0;
1231 if (memcmp(&y, "\x4b\x7f\x01\x02", 4) == 0)
1232 detected_float_format = ieee_big_endian_format;
1233 else if (memcmp(&y, "\x02\x01\x7f\x4b", 4) == 0)
1234 detected_float_format = ieee_little_endian_format;
1235 else
1236 detected_float_format = unknown_format;
1237 }
1238#else
1239 detected_float_format = unknown_format;
1240#endif
1241
1242 double_format = detected_double_format;
1243 float_format = detected_float_format;
1244}
1245
1246void
Fred Drakefd99de62000-07-09 05:02:18 +00001247PyFloat_Fini(void)
Guido van Rossumfbbd57e1997-08-05 02:16:08 +00001248{
Guido van Rossum3fce8831999-03-12 19:43:17 +00001249 PyFloatObject *p;
1250 PyFloatBlock *list, *next;
Neal Norwitz739a8f82004-07-08 01:55:58 +00001251 unsigned i;
Guido van Rossumf61bbc81999-03-12 00:12:21 +00001252 int bc, bf; /* block count, number of freed blocks */
1253 int frem, fsum; /* remaining unfreed floats per block, total */
1254
1255 bc = 0;
1256 bf = 0;
1257 fsum = 0;
1258 list = block_list;
1259 block_list = NULL;
Guido van Rossumd7b5fb81999-03-19 20:59:40 +00001260 free_list = NULL;
Guido van Rossumf61bbc81999-03-12 00:12:21 +00001261 while (list != NULL) {
Guido van Rossumf61bbc81999-03-12 00:12:21 +00001262 bc++;
1263 frem = 0;
Guido van Rossumd7b5fb81999-03-19 20:59:40 +00001264 for (i = 0, p = &list->objects[0];
1265 i < N_FLOATOBJECTS;
1266 i++, p++) {
Martin v. Löwis68192102007-07-21 06:55:02 +00001267 if (PyFloat_CheckExact(p) && Py_Refcnt(p) != 0)
Guido van Rossumf61bbc81999-03-12 00:12:21 +00001268 frem++;
1269 }
Guido van Rossum3fce8831999-03-12 19:43:17 +00001270 next = list->next;
Guido van Rossumf61bbc81999-03-12 00:12:21 +00001271 if (frem) {
Guido van Rossum3fce8831999-03-12 19:43:17 +00001272 list->next = block_list;
1273 block_list = list;
Guido van Rossumd7b5fb81999-03-19 20:59:40 +00001274 for (i = 0, p = &list->objects[0];
1275 i < N_FLOATOBJECTS;
1276 i++, p++) {
Guido van Rossumdea6ef92001-09-11 16:13:52 +00001277 if (!PyFloat_CheckExact(p) ||
Martin v. Löwis68192102007-07-21 06:55:02 +00001278 Py_Refcnt(p) == 0) {
1279 Py_Type(p) = (struct _typeobject *)
Guido van Rossumd7b5fb81999-03-19 20:59:40 +00001280 free_list;
1281 free_list = p;
1282 }
1283 }
Guido van Rossumf61bbc81999-03-12 00:12:21 +00001284 }
1285 else {
Guido van Rossumb18618d2000-05-03 23:44:39 +00001286 PyMem_FREE(list); /* XXX PyObject_FREE ??? */
Guido van Rossumf61bbc81999-03-12 00:12:21 +00001287 bf++;
1288 }
1289 fsum += frem;
Guido van Rossum3fce8831999-03-12 19:43:17 +00001290 list = next;
Guido van Rossumf61bbc81999-03-12 00:12:21 +00001291 }
Guido van Rossum3fce8831999-03-12 19:43:17 +00001292 if (!Py_VerboseFlag)
1293 return;
1294 fprintf(stderr, "# cleanup floats");
1295 if (!fsum) {
1296 fprintf(stderr, "\n");
1297 }
1298 else {
1299 fprintf(stderr,
1300 ": %d unfreed float%s in %d out of %d block%s\n",
1301 fsum, fsum == 1 ? "" : "s",
1302 bc - bf, bc, bc == 1 ? "" : "s");
1303 }
1304 if (Py_VerboseFlag > 1) {
1305 list = block_list;
1306 while (list != NULL) {
Guido van Rossumd7b5fb81999-03-19 20:59:40 +00001307 for (i = 0, p = &list->objects[0];
1308 i < N_FLOATOBJECTS;
1309 i++, p++) {
Guido van Rossumdea6ef92001-09-11 16:13:52 +00001310 if (PyFloat_CheckExact(p) &&
Martin v. Löwis68192102007-07-21 06:55:02 +00001311 Py_Refcnt(p) != 0) {
Guido van Rossum3fce8831999-03-12 19:43:17 +00001312 char buf[100];
1313 PyFloat_AsString(buf, p);
Thomas Wouters8b87a0b2006-03-01 05:41:20 +00001314 /* XXX(twouters) cast refcount to
1315 long until %zd is universally
1316 available
1317 */
Guido van Rossum3fce8831999-03-12 19:43:17 +00001318 fprintf(stderr,
Thomas Wouters8b87a0b2006-03-01 05:41:20 +00001319 "# <float at %p, refcnt=%ld, val=%s>\n",
Martin v. Löwis68192102007-07-21 06:55:02 +00001320 p, (long)Py_Refcnt(p), buf);
Guido van Rossum3fce8831999-03-12 19:43:17 +00001321 }
1322 }
1323 list = list->next;
Guido van Rossumf61bbc81999-03-12 00:12:21 +00001324 }
1325 }
Guido van Rossumfbbd57e1997-08-05 02:16:08 +00001326}
Tim Peters9905b942003-03-20 20:53:32 +00001327
1328/*----------------------------------------------------------------------------
1329 * _PyFloat_{Pack,Unpack}{4,8}. See floatobject.h.
1330 *
1331 * TODO: On platforms that use the standard IEEE-754 single and double
1332 * formats natively, these routines could simply copy the bytes.
1333 */
1334int
1335_PyFloat_Pack4(double x, unsigned char *p, int le)
1336{
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001337 if (float_format == unknown_format) {
1338 unsigned char sign;
1339 int e;
1340 double f;
1341 unsigned int fbits;
1342 int incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00001343
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001344 if (le) {
1345 p += 3;
1346 incr = -1;
1347 }
Tim Peters9905b942003-03-20 20:53:32 +00001348
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001349 if (x < 0) {
1350 sign = 1;
1351 x = -x;
1352 }
1353 else
1354 sign = 0;
Tim Peters9905b942003-03-20 20:53:32 +00001355
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001356 f = frexp(x, &e);
Tim Peters9905b942003-03-20 20:53:32 +00001357
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001358 /* Normalize f to be in the range [1.0, 2.0) */
1359 if (0.5 <= f && f < 1.0) {
1360 f *= 2.0;
1361 e--;
1362 }
1363 else if (f == 0.0)
1364 e = 0;
1365 else {
1366 PyErr_SetString(PyExc_SystemError,
1367 "frexp() result out of range");
1368 return -1;
1369 }
1370
1371 if (e >= 128)
1372 goto Overflow;
1373 else if (e < -126) {
1374 /* Gradual underflow */
1375 f = ldexp(f, 126 + e);
1376 e = 0;
1377 }
1378 else if (!(e == 0 && f == 0.0)) {
1379 e += 127;
1380 f -= 1.0; /* Get rid of leading 1 */
1381 }
1382
1383 f *= 8388608.0; /* 2**23 */
1384 fbits = (unsigned int)(f + 0.5); /* Round */
1385 assert(fbits <= 8388608);
1386 if (fbits >> 23) {
1387 /* The carry propagated out of a string of 23 1 bits. */
1388 fbits = 0;
1389 ++e;
1390 if (e >= 255)
1391 goto Overflow;
1392 }
1393
1394 /* First byte */
1395 *p = (sign << 7) | (e >> 1);
1396 p += incr;
1397
1398 /* Second byte */
1399 *p = (char) (((e & 1) << 7) | (fbits >> 16));
1400 p += incr;
1401
1402 /* Third byte */
1403 *p = (fbits >> 8) & 0xFF;
1404 p += incr;
1405
1406 /* Fourth byte */
1407 *p = fbits & 0xFF;
1408
1409 /* Done */
1410 return 0;
1411
1412 Overflow:
1413 PyErr_SetString(PyExc_OverflowError,
1414 "float too large to pack with f format");
Tim Peters9905b942003-03-20 20:53:32 +00001415 return -1;
1416 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001417 else {
Michael W. Hudson3095ad02005-06-30 00:02:26 +00001418 float y = (float)x;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001419 const char *s = (char*)&y;
1420 int i, incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00001421
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001422 if ((float_format == ieee_little_endian_format && !le)
1423 || (float_format == ieee_big_endian_format && le)) {
1424 p += 3;
1425 incr = -1;
1426 }
1427
1428 for (i = 0; i < 4; i++) {
1429 *p = *s++;
1430 p += incr;
1431 }
1432 return 0;
Tim Peters9905b942003-03-20 20:53:32 +00001433 }
Tim Peters9905b942003-03-20 20:53:32 +00001434}
1435
1436int
1437_PyFloat_Pack8(double x, unsigned char *p, int le)
1438{
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001439 if (double_format == unknown_format) {
1440 unsigned char sign;
1441 int e;
1442 double f;
1443 unsigned int fhi, flo;
1444 int incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00001445
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001446 if (le) {
1447 p += 7;
1448 incr = -1;
1449 }
Tim Peters9905b942003-03-20 20:53:32 +00001450
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001451 if (x < 0) {
1452 sign = 1;
1453 x = -x;
1454 }
1455 else
1456 sign = 0;
Tim Peters9905b942003-03-20 20:53:32 +00001457
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001458 f = frexp(x, &e);
Tim Peters9905b942003-03-20 20:53:32 +00001459
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001460 /* Normalize f to be in the range [1.0, 2.0) */
1461 if (0.5 <= f && f < 1.0) {
1462 f *= 2.0;
1463 e--;
1464 }
1465 else if (f == 0.0)
1466 e = 0;
1467 else {
1468 PyErr_SetString(PyExc_SystemError,
1469 "frexp() result out of range");
1470 return -1;
1471 }
1472
1473 if (e >= 1024)
1474 goto Overflow;
1475 else if (e < -1022) {
1476 /* Gradual underflow */
1477 f = ldexp(f, 1022 + e);
1478 e = 0;
1479 }
1480 else if (!(e == 0 && f == 0.0)) {
1481 e += 1023;
1482 f -= 1.0; /* Get rid of leading 1 */
1483 }
1484
1485 /* fhi receives the high 28 bits; flo the low 24 bits (== 52 bits) */
1486 f *= 268435456.0; /* 2**28 */
1487 fhi = (unsigned int)f; /* Truncate */
1488 assert(fhi < 268435456);
1489
1490 f -= (double)fhi;
1491 f *= 16777216.0; /* 2**24 */
1492 flo = (unsigned int)(f + 0.5); /* Round */
1493 assert(flo <= 16777216);
1494 if (flo >> 24) {
1495 /* The carry propagated out of a string of 24 1 bits. */
1496 flo = 0;
1497 ++fhi;
1498 if (fhi >> 28) {
1499 /* And it also progagated out of the next 28 bits. */
1500 fhi = 0;
1501 ++e;
1502 if (e >= 2047)
1503 goto Overflow;
1504 }
1505 }
1506
1507 /* First byte */
1508 *p = (sign << 7) | (e >> 4);
1509 p += incr;
1510
1511 /* Second byte */
1512 *p = (unsigned char) (((e & 0xF) << 4) | (fhi >> 24));
1513 p += incr;
1514
1515 /* Third byte */
1516 *p = (fhi >> 16) & 0xFF;
1517 p += incr;
1518
1519 /* Fourth byte */
1520 *p = (fhi >> 8) & 0xFF;
1521 p += incr;
1522
1523 /* Fifth byte */
1524 *p = fhi & 0xFF;
1525 p += incr;
1526
1527 /* Sixth byte */
1528 *p = (flo >> 16) & 0xFF;
1529 p += incr;
1530
1531 /* Seventh byte */
1532 *p = (flo >> 8) & 0xFF;
1533 p += incr;
1534
1535 /* Eighth byte */
1536 *p = flo & 0xFF;
1537 p += incr;
1538
1539 /* Done */
1540 return 0;
1541
1542 Overflow:
1543 PyErr_SetString(PyExc_OverflowError,
1544 "float too large to pack with d format");
Tim Peters9905b942003-03-20 20:53:32 +00001545 return -1;
1546 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001547 else {
1548 const char *s = (char*)&x;
1549 int i, incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00001550
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001551 if ((double_format == ieee_little_endian_format && !le)
1552 || (double_format == ieee_big_endian_format && le)) {
1553 p += 7;
1554 incr = -1;
Tim Peters9905b942003-03-20 20:53:32 +00001555 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001556
1557 for (i = 0; i < 8; i++) {
1558 *p = *s++;
1559 p += incr;
1560 }
1561 return 0;
Tim Peters9905b942003-03-20 20:53:32 +00001562 }
Tim Peters9905b942003-03-20 20:53:32 +00001563}
1564
1565double
1566_PyFloat_Unpack4(const unsigned char *p, int le)
1567{
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001568 if (float_format == unknown_format) {
1569 unsigned char sign;
1570 int e;
1571 unsigned int f;
1572 double x;
1573 int incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00001574
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001575 if (le) {
1576 p += 3;
1577 incr = -1;
1578 }
1579
1580 /* First byte */
1581 sign = (*p >> 7) & 1;
1582 e = (*p & 0x7F) << 1;
1583 p += incr;
1584
1585 /* Second byte */
1586 e |= (*p >> 7) & 1;
1587 f = (*p & 0x7F) << 16;
1588 p += incr;
1589
1590 if (e == 255) {
1591 PyErr_SetString(
1592 PyExc_ValueError,
1593 "can't unpack IEEE 754 special value "
1594 "on non-IEEE platform");
1595 return -1;
1596 }
1597
1598 /* Third byte */
1599 f |= *p << 8;
1600 p += incr;
1601
1602 /* Fourth byte */
1603 f |= *p;
1604
1605 x = (double)f / 8388608.0;
1606
1607 /* XXX This sadly ignores Inf/NaN issues */
1608 if (e == 0)
1609 e = -126;
1610 else {
1611 x += 1.0;
1612 e -= 127;
1613 }
1614 x = ldexp(x, e);
1615
1616 if (sign)
1617 x = -x;
1618
1619 return x;
Tim Peters9905b942003-03-20 20:53:32 +00001620 }
Tim Peters9905b942003-03-20 20:53:32 +00001621 else {
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00001622 float x;
1623
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001624 if ((float_format == ieee_little_endian_format && !le)
1625 || (float_format == ieee_big_endian_format && le)) {
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00001626 char buf[4];
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001627 char *d = &buf[3];
1628 int i;
Tim Peters9905b942003-03-20 20:53:32 +00001629
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001630 for (i = 0; i < 4; i++) {
1631 *d-- = *p++;
1632 }
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00001633 memcpy(&x, buf, 4);
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001634 }
1635 else {
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00001636 memcpy(&x, p, 4);
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001637 }
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00001638
1639 return x;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001640 }
Tim Peters9905b942003-03-20 20:53:32 +00001641}
1642
1643double
1644_PyFloat_Unpack8(const unsigned char *p, int le)
1645{
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001646 if (double_format == unknown_format) {
1647 unsigned char sign;
1648 int e;
1649 unsigned int fhi, flo;
1650 double x;
1651 int incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00001652
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001653 if (le) {
1654 p += 7;
1655 incr = -1;
1656 }
1657
1658 /* First byte */
1659 sign = (*p >> 7) & 1;
1660 e = (*p & 0x7F) << 4;
1661
1662 p += incr;
1663
1664 /* Second byte */
1665 e |= (*p >> 4) & 0xF;
1666 fhi = (*p & 0xF) << 24;
1667 p += incr;
1668
1669 if (e == 2047) {
1670 PyErr_SetString(
1671 PyExc_ValueError,
1672 "can't unpack IEEE 754 special value "
1673 "on non-IEEE platform");
1674 return -1.0;
1675 }
1676
1677 /* Third byte */
1678 fhi |= *p << 16;
1679 p += incr;
1680
1681 /* Fourth byte */
1682 fhi |= *p << 8;
1683 p += incr;
1684
1685 /* Fifth byte */
1686 fhi |= *p;
1687 p += incr;
1688
1689 /* Sixth byte */
1690 flo = *p << 16;
1691 p += incr;
1692
1693 /* Seventh byte */
1694 flo |= *p << 8;
1695 p += incr;
1696
1697 /* Eighth byte */
1698 flo |= *p;
1699
1700 x = (double)fhi + (double)flo / 16777216.0; /* 2**24 */
1701 x /= 268435456.0; /* 2**28 */
1702
1703 if (e == 0)
1704 e = -1022;
1705 else {
1706 x += 1.0;
1707 e -= 1023;
1708 }
1709 x = ldexp(x, e);
1710
1711 if (sign)
1712 x = -x;
1713
1714 return x;
Tim Peters9905b942003-03-20 20:53:32 +00001715 }
Tim Peters9905b942003-03-20 20:53:32 +00001716 else {
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00001717 double x;
1718
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001719 if ((double_format == ieee_little_endian_format && !le)
1720 || (double_format == ieee_big_endian_format && le)) {
1721 char buf[8];
1722 char *d = &buf[7];
1723 int i;
1724
1725 for (i = 0; i < 8; i++) {
1726 *d-- = *p++;
1727 }
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00001728 memcpy(&x, buf, 8);
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001729 }
1730 else {
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00001731 memcpy(&x, p, 8);
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001732 }
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00001733
1734 return x;
Tim Peters9905b942003-03-20 20:53:32 +00001735 }
Tim Peters9905b942003-03-20 20:53:32 +00001736}