blob: bc19a5b7b9c8f50d222dcf244cf2a2b6914ddf35 [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)
Guido van Rossumf61bbc81999-03-12 00:12:21 +000044 q->ob_type = (struct _typeobject *)(q-1);
45 q->ob_type = 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;
Guido van Rossumf61bbc81999-03-12 00:12:21 +000059 free_list = (PyFloatObject *)op->ob_type;
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)) {
Guido van Rossum9e896b32000-04-05 20:11:21 +0000100 if (PyUnicode_GET_SIZE(v) >= sizeof(s_buffer)) {
101 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)) {
178 op->ob_type = (struct _typeobject *)free_list;
179 free_list = op;
180 }
181 else
182 op->ob_type->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
Neil Schemenauer2c77e902002-11-18 16:06:21 +0000200 if ((nb = op->ob_type->tp_as_number) == NULL || nb->nb_float == NULL) {
201 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
Tim Peterse1c69b32004-09-23 19:22:41 +0000387 else if (Py_IS_INFINITY(i) || Py_IS_NAN(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 */
Tim Petersc54d1902000-10-06 00:36:09 +0000767 PyFPE_START_PROTECT("pow", return NULL)
768 if ((PyObject *)z != Py_None) {
Neil Schemenauer32117e52001-01-04 01:44:34 +0000769 double iz;
Neil Schemenauer010b0cc2001-01-08 06:29:50 +0000770 CONVERT_TO_DOUBLE(z, iz);
Tim Peters96685bf2001-08-23 22:31:37 +0000771 ix = fmod(1.0, iz);
772 if (ix != 0 && iz < 0)
773 ix += iz;
Guido van Rossum70d93461991-05-28 21:57:39 +0000774 }
Tim Petersc54d1902000-10-06 00:36:09 +0000775 else
776 ix = 1.0;
777 PyFPE_END_PROTECT(ix)
Tim Petersd2364e82001-11-01 20:09:42 +0000778 return PyFloat_FromDouble(ix);
Tim Petersc54d1902000-10-06 00:36:09 +0000779 }
Tim Peters96685bf2001-08-23 22:31:37 +0000780 if (iv == 0.0) { /* 0**w is error if w<0, else 1 */
Tim Petersc54d1902000-10-06 00:36:09 +0000781 if (iw < 0.0) {
782 PyErr_SetString(PyExc_ZeroDivisionError,
Fred Drake661ea262000-10-24 19:57:45 +0000783 "0.0 cannot be raised to a negative power");
Tim Petersc54d1902000-10-06 00:36:09 +0000784 return NULL;
785 }
786 return PyFloat_FromDouble(0.0);
787 }
Tim Peterse87568d2003-05-24 20:18:24 +0000788 if (iv < 0.0) {
789 /* Whether this is an error is a mess, and bumps into libm
790 * bugs so we have to figure it out ourselves.
791 */
792 if (iw != floor(iw)) {
793 PyErr_SetString(PyExc_ValueError, "negative number "
794 "cannot be raised to a fractional power");
795 return NULL;
796 }
797 /* iw is an exact integer, albeit perhaps a very large one.
798 * -1 raised to an exact integer should never be exceptional.
799 * Alas, some libms (chiefly glibc as of early 2003) return
800 * NaN and set EDOM on pow(-1, large_int) if the int doesn't
801 * happen to be representable in a *C* integer. That's a
802 * bug; we let that slide in math.pow() (which currently
803 * reflects all platform accidents), but not for Python's **.
804 */
805 if (iv == -1.0 && !Py_IS_INFINITY(iw) && iw == iw) {
806 /* XXX the "iw == iw" was to weed out NaNs. This
807 * XXX doesn't actually work on all platforms.
808 */
809 /* Return 1 if iw is even, -1 if iw is odd; there's
810 * no guarantee that any C integral type is big
811 * enough to hold iw, so we have to check this
812 * indirectly.
813 */
814 ix = floor(iw * 0.5) * 2.0;
815 return PyFloat_FromDouble(ix == iw ? 1.0 : -1.0);
816 }
817 /* Else iv != -1.0, and overflow or underflow are possible.
818 * Unless we're to write pow() ourselves, we have to trust
819 * the platform to do this correctly.
820 */
Guido van Rossum86c04c21996-08-09 20:50:14 +0000821 }
Tim Peters96685bf2001-08-23 22:31:37 +0000822 errno = 0;
823 PyFPE_START_PROTECT("pow", return NULL)
824 ix = pow(iv, iw);
825 PyFPE_END_PROTECT(ix)
Tim Petersdc5a5082002-03-09 04:58:24 +0000826 Py_ADJUST_ERANGE1(ix);
Guido van Rossum2a9096b1990-10-21 22:15:08 +0000827 if (errno != 0) {
Tim Peterse87568d2003-05-24 20:18:24 +0000828 /* We don't expect any errno value other than ERANGE, but
829 * the range of libm bugs appears unbounded.
830 */
831 PyErr_SetFromErrno(errno == ERANGE ? PyExc_OverflowError :
832 PyExc_ValueError);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000833 return NULL;
Guido van Rossum2a9096b1990-10-21 22:15:08 +0000834 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000835 return PyFloat_FromDouble(ix);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000836}
837
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000838static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000839float_neg(PyFloatObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000840{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000841 return PyFloat_FromDouble(-v->ob_fval);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000842}
843
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000844static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000845float_pos(PyFloatObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000846{
Tim Peters0280cf72001-09-11 21:53:35 +0000847 if (PyFloat_CheckExact(v)) {
848 Py_INCREF(v);
849 return (PyObject *)v;
850 }
851 else
852 return PyFloat_FromDouble(v->ob_fval);
Guido van Rossumeba1b5e1991-05-05 20:07:00 +0000853}
854
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000855static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000856float_abs(PyFloatObject *v)
Guido van Rossumeba1b5e1991-05-05 20:07:00 +0000857{
Tim Petersfaf0cd22001-11-01 21:51:15 +0000858 return PyFloat_FromDouble(fabs(v->ob_fval));
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000859}
860
Guido van Rossum50b4ef61991-05-14 11:57:01 +0000861static int
Fred Drakefd99de62000-07-09 05:02:18 +0000862float_nonzero(PyFloatObject *v)
Guido van Rossum50b4ef61991-05-14 11:57:01 +0000863{
864 return v->ob_fval != 0.0;
865}
866
Guido van Rossum234f9421993-06-17 12:35:49 +0000867static int
Fred Drakefd99de62000-07-09 05:02:18 +0000868float_coerce(PyObject **pv, PyObject **pw)
Guido van Rossume6eefc21992-08-14 12:06:52 +0000869{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000870 if (PyInt_Check(*pw)) {
871 long x = PyInt_AsLong(*pw);
872 *pw = PyFloat_FromDouble((double)x);
873 Py_INCREF(*pv);
Guido van Rossume6eefc21992-08-14 12:06:52 +0000874 return 0;
875 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000876 else if (PyLong_Check(*pw)) {
Neal Norwitzabcb0c02003-01-28 19:21:24 +0000877 double x = PyLong_AsDouble(*pw);
878 if (x == -1.0 && PyErr_Occurred())
879 return -1;
880 *pw = PyFloat_FromDouble(x);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000881 Py_INCREF(*pv);
Guido van Rossume6eefc21992-08-14 12:06:52 +0000882 return 0;
883 }
Guido van Rossum1952e382001-09-19 01:25:16 +0000884 else if (PyFloat_Check(*pw)) {
885 Py_INCREF(*pv);
886 Py_INCREF(*pw);
887 return 0;
888 }
Guido van Rossume6eefc21992-08-14 12:06:52 +0000889 return 1; /* Can't do it */
890}
891
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000892static PyObject *
Walter Dörwaldf1715402002-11-19 20:49:15 +0000893float_long(PyObject *v)
894{
895 double x = PyFloat_AsDouble(v);
896 return PyLong_FromDouble(x);
897}
898
899static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000900float_int(PyObject *v)
Guido van Rossum1899c2e1992-09-12 11:09:23 +0000901{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000902 double x = PyFloat_AsDouble(v);
Tim Peters7321ec42001-07-26 20:02:17 +0000903 double wholepart; /* integral portion of x, rounded toward 0 */
Tim Peters7321ec42001-07-26 20:02:17 +0000904
905 (void)modf(x, &wholepart);
Tim Peters7d791242002-11-21 22:26:37 +0000906 /* Try to get out cheap if this fits in a Python int. The attempt
907 * to cast to long must be protected, as C doesn't define what
908 * happens if the double is too big to fit in a long. Some rare
909 * systems raise an exception then (RISCOS was mentioned as one,
910 * and someone using a non-default option on Sun also bumped into
911 * that). Note that checking for >= and <= LONG_{MIN,MAX} would
912 * still be vulnerable: if a long has more bits of precision than
913 * a double, casting MIN/MAX to double may yield an approximation,
914 * and if that's rounded up, then, e.g., wholepart=LONG_MAX+1 would
915 * yield true from the C expression wholepart<=LONG_MAX, despite
916 * that wholepart is actually greater than LONG_MAX.
917 */
918 if (LONG_MIN < wholepart && wholepart < LONG_MAX) {
919 const long aslong = (long)wholepart;
Tim Peters7321ec42001-07-26 20:02:17 +0000920 return PyInt_FromLong(aslong);
Tim Peters7d791242002-11-21 22:26:37 +0000921 }
922 return PyLong_FromDouble(wholepart);
Guido van Rossum1899c2e1992-09-12 11:09:23 +0000923}
924
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000925static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000926float_float(PyObject *v)
Guido van Rossum1899c2e1992-09-12 11:09:23 +0000927{
Brett Cannonc3647ac2005-04-26 03:45:26 +0000928 if (PyFloat_CheckExact(v))
929 Py_INCREF(v);
930 else
931 v = PyFloat_FromDouble(((PyFloatObject *)v)->ob_fval);
Guido van Rossum1899c2e1992-09-12 11:09:23 +0000932 return v;
933}
934
935
Jeremy Hylton938ace62002-07-17 16:30:39 +0000936static PyObject *
Guido van Rossumbef14172001-08-29 15:47:46 +0000937float_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds);
938
Tim Peters6d6c1a32001-08-02 04:15:00 +0000939static PyObject *
940float_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
941{
942 PyObject *x = Py_False; /* Integer zero */
Martin v. Löwis15e62742006-02-27 16:46:16 +0000943 static char *kwlist[] = {"x", 0};
Tim Peters6d6c1a32001-08-02 04:15:00 +0000944
Guido van Rossumbef14172001-08-29 15:47:46 +0000945 if (type != &PyFloat_Type)
946 return float_subtype_new(type, args, kwds); /* Wimp out */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000947 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|O:float", kwlist, &x))
948 return NULL;
949 if (PyString_Check(x))
950 return PyFloat_FromString(x, NULL);
951 return PyNumber_Float(x);
952}
953
Guido van Rossumbef14172001-08-29 15:47:46 +0000954/* Wimpy, slow approach to tp_new calls for subtypes of float:
955 first create a regular float from whatever arguments we got,
956 then allocate a subtype instance and initialize its ob_fval
957 from the regular float. The regular float is then thrown away.
958*/
959static PyObject *
960float_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
961{
962 PyObject *tmp, *new;
963
964 assert(PyType_IsSubtype(type, &PyFloat_Type));
965 tmp = float_new(&PyFloat_Type, args, kwds);
966 if (tmp == NULL)
967 return NULL;
Tim Peters2400fa42001-09-12 19:12:49 +0000968 assert(PyFloat_CheckExact(tmp));
Guido van Rossumd93dce12001-08-30 03:09:31 +0000969 new = type->tp_alloc(type, 0);
Raymond Hettingerf4667932003-06-28 20:04:25 +0000970 if (new == NULL) {
971 Py_DECREF(tmp);
Guido van Rossumbef14172001-08-29 15:47:46 +0000972 return NULL;
Raymond Hettingerf4667932003-06-28 20:04:25 +0000973 }
Guido van Rossumbef14172001-08-29 15:47:46 +0000974 ((PyFloatObject *)new)->ob_fval = ((PyFloatObject *)tmp)->ob_fval;
975 Py_DECREF(tmp);
976 return new;
977}
978
Guido van Rossum5d9113d2003-01-29 17:58:45 +0000979static PyObject *
980float_getnewargs(PyFloatObject *v)
981{
982 return Py_BuildValue("(d)", v->ob_fval);
983}
984
Michael W. Hudsonba283e22005-05-27 15:23:20 +0000985/* this is for the benefit of the pack/unpack routines below */
986
987typedef enum {
988 unknown_format, ieee_big_endian_format, ieee_little_endian_format
989} float_format_type;
990
991static float_format_type double_format, float_format;
992static float_format_type detected_double_format, detected_float_format;
993
994static PyObject *
995float_getformat(PyTypeObject *v, PyObject* arg)
996{
997 char* s;
998 float_format_type r;
999
1000 if (!PyString_Check(arg)) {
1001 PyErr_Format(PyExc_TypeError,
1002 "__getformat__() argument must be string, not %.500s",
1003 arg->ob_type->tp_name);
1004 return NULL;
1005 }
1006 s = PyString_AS_STRING(arg);
1007 if (strcmp(s, "double") == 0) {
1008 r = double_format;
1009 }
1010 else if (strcmp(s, "float") == 0) {
1011 r = float_format;
1012 }
1013 else {
1014 PyErr_SetString(PyExc_ValueError,
1015 "__getformat__() argument 1 must be "
1016 "'double' or 'float'");
1017 return NULL;
1018 }
1019
1020 switch (r) {
1021 case unknown_format:
1022 return PyString_FromString("unknown");
1023 case ieee_little_endian_format:
1024 return PyString_FromString("IEEE, little-endian");
1025 case ieee_big_endian_format:
1026 return PyString_FromString("IEEE, big-endian");
1027 default:
1028 Py_FatalError("insane float_format or double_format");
1029 return NULL;
1030 }
1031}
1032
1033PyDoc_STRVAR(float_getformat_doc,
1034"float.__getformat__(typestr) -> string\n"
1035"\n"
1036"You probably don't want to use this function. It exists mainly to be\n"
1037"used in Python's test suite.\n"
1038"\n"
1039"typestr must be 'double' or 'float'. This function returns whichever of\n"
1040"'unknown', 'IEEE, big-endian' or 'IEEE, little-endian' best describes the\n"
1041"format of floating point numbers used by the C type named by typestr.");
1042
1043static PyObject *
1044float_setformat(PyTypeObject *v, PyObject* args)
1045{
1046 char* typestr;
1047 char* format;
1048 float_format_type f;
1049 float_format_type detected;
1050 float_format_type *p;
1051
1052 if (!PyArg_ParseTuple(args, "ss:__setformat__", &typestr, &format))
1053 return NULL;
1054
1055 if (strcmp(typestr, "double") == 0) {
1056 p = &double_format;
1057 detected = detected_double_format;
1058 }
1059 else if (strcmp(typestr, "float") == 0) {
1060 p = &float_format;
1061 detected = detected_float_format;
1062 }
1063 else {
1064 PyErr_SetString(PyExc_ValueError,
1065 "__setformat__() argument 1 must "
1066 "be 'double' or 'float'");
1067 return NULL;
1068 }
1069
1070 if (strcmp(format, "unknown") == 0) {
1071 f = unknown_format;
1072 }
1073 else if (strcmp(format, "IEEE, little-endian") == 0) {
1074 f = ieee_little_endian_format;
1075 }
1076 else if (strcmp(format, "IEEE, big-endian") == 0) {
1077 f = ieee_big_endian_format;
1078 }
1079 else {
1080 PyErr_SetString(PyExc_ValueError,
1081 "__setformat__() argument 2 must be "
1082 "'unknown', 'IEEE, little-endian' or "
1083 "'IEEE, big-endian'");
1084 return NULL;
1085
1086 }
1087
1088 if (f != unknown_format && f != detected) {
1089 PyErr_Format(PyExc_ValueError,
1090 "can only set %s format to 'unknown' or the "
1091 "detected platform value", typestr);
1092 return NULL;
1093 }
1094
1095 *p = f;
1096 Py_RETURN_NONE;
1097}
1098
1099PyDoc_STRVAR(float_setformat_doc,
1100"float.__setformat__(typestr, fmt) -> None\n"
1101"\n"
1102"You probably don't want to use this function. It exists mainly to be\n"
1103"used in Python's test suite.\n"
1104"\n"
1105"typestr must be 'double' or 'float'. fmt must be one of 'unknown',\n"
1106"'IEEE, big-endian' or 'IEEE, little-endian', and in addition can only be\n"
1107"one of the latter two if it appears to match the underlying C reality.\n"
1108"\n"
1109"Overrides the automatic determination of C-level floating point type.\n"
1110"This affects how floats are converted to and from binary strings.");
1111
Guido van Rossum5d9113d2003-01-29 17:58:45 +00001112static PyMethodDef float_methods[] = {
1113 {"__getnewargs__", (PyCFunction)float_getnewargs, METH_NOARGS},
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001114 {"__getformat__", (PyCFunction)float_getformat,
1115 METH_O|METH_CLASS, float_getformat_doc},
1116 {"__setformat__", (PyCFunction)float_setformat,
1117 METH_VARARGS|METH_CLASS, float_setformat_doc},
Guido van Rossum5d9113d2003-01-29 17:58:45 +00001118 {NULL, NULL} /* sentinel */
1119};
1120
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001121PyDoc_STRVAR(float_doc,
Tim Peters6d6c1a32001-08-02 04:15:00 +00001122"float(x) -> floating point number\n\
1123\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001124Convert a string or number to a floating point number, if possible.");
Tim Peters6d6c1a32001-08-02 04:15:00 +00001125
1126
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001127static PyNumberMethods float_as_number = {
Guido van Rossumb6775db1994-08-01 11:34:53 +00001128 (binaryfunc)float_add, /*nb_add*/
1129 (binaryfunc)float_sub, /*nb_subtract*/
1130 (binaryfunc)float_mul, /*nb_multiply*/
Guido van Rossum393661d2001-08-31 17:40:15 +00001131 (binaryfunc)float_classic_div, /*nb_divide*/
Guido van Rossumb6775db1994-08-01 11:34:53 +00001132 (binaryfunc)float_rem, /*nb_remainder*/
1133 (binaryfunc)float_divmod, /*nb_divmod*/
Guido van Rossum0b7d02a1994-08-12 12:52:35 +00001134 (ternaryfunc)float_pow, /*nb_power*/
Guido van Rossumb6775db1994-08-01 11:34:53 +00001135 (unaryfunc)float_neg, /*nb_negative*/
1136 (unaryfunc)float_pos, /*nb_positive*/
1137 (unaryfunc)float_abs, /*nb_absolute*/
1138 (inquiry)float_nonzero, /*nb_nonzero*/
Guido van Rossum27acb331991-10-24 14:55:28 +00001139 0, /*nb_invert*/
1140 0, /*nb_lshift*/
1141 0, /*nb_rshift*/
1142 0, /*nb_and*/
1143 0, /*nb_xor*/
1144 0, /*nb_or*/
Guido van Rossumb6775db1994-08-01 11:34:53 +00001145 (coercion)float_coerce, /*nb_coerce*/
1146 (unaryfunc)float_int, /*nb_int*/
1147 (unaryfunc)float_long, /*nb_long*/
1148 (unaryfunc)float_float, /*nb_float*/
Guido van Rossum4668b002001-08-08 05:00:18 +00001149 0, /* nb_oct */
1150 0, /* nb_hex */
1151 0, /* nb_inplace_add */
1152 0, /* nb_inplace_subtract */
1153 0, /* nb_inplace_multiply */
1154 0, /* nb_inplace_divide */
1155 0, /* nb_inplace_remainder */
1156 0, /* nb_inplace_power */
1157 0, /* nb_inplace_lshift */
1158 0, /* nb_inplace_rshift */
1159 0, /* nb_inplace_and */
1160 0, /* nb_inplace_xor */
1161 0, /* nb_inplace_or */
Tim Peters63a35712001-12-11 19:57:24 +00001162 float_floor_div, /* nb_floor_divide */
Guido van Rossum4668b002001-08-08 05:00:18 +00001163 float_div, /* nb_true_divide */
1164 0, /* nb_inplace_floor_divide */
1165 0, /* nb_inplace_true_divide */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001166};
1167
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001168PyTypeObject PyFloat_Type = {
1169 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001170 0,
1171 "float",
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001172 sizeof(PyFloatObject),
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001173 0,
Tim Peters6d6c1a32001-08-02 04:15:00 +00001174 (destructor)float_dealloc, /* tp_dealloc */
1175 (printfunc)float_print, /* tp_print */
1176 0, /* tp_getattr */
1177 0, /* tp_setattr */
Michael W. Hudson08678a12004-05-26 17:36:12 +00001178 0, /* tp_compare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001179 (reprfunc)float_repr, /* tp_repr */
1180 &float_as_number, /* tp_as_number */
1181 0, /* tp_as_sequence */
1182 0, /* tp_as_mapping */
1183 (hashfunc)float_hash, /* tp_hash */
1184 0, /* tp_call */
1185 (reprfunc)float_str, /* tp_str */
1186 PyObject_GenericGetAttr, /* tp_getattro */
1187 0, /* tp_setattro */
1188 0, /* tp_as_buffer */
Guido van Rossumbef14172001-08-29 15:47:46 +00001189 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
1190 Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001191 float_doc, /* tp_doc */
1192 0, /* tp_traverse */
1193 0, /* tp_clear */
Michael W. Hudsond3b33b52004-02-19 19:35:22 +00001194 (richcmpfunc)float_richcompare, /* tp_richcompare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001195 0, /* tp_weaklistoffset */
1196 0, /* tp_iter */
1197 0, /* tp_iternext */
Guido van Rossum5d9113d2003-01-29 17:58:45 +00001198 float_methods, /* tp_methods */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001199 0, /* tp_members */
1200 0, /* tp_getset */
1201 0, /* tp_base */
1202 0, /* tp_dict */
1203 0, /* tp_descr_get */
1204 0, /* tp_descr_set */
1205 0, /* tp_dictoffset */
1206 0, /* tp_init */
1207 0, /* tp_alloc */
1208 float_new, /* tp_new */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001209};
Guido van Rossumfbbd57e1997-08-05 02:16:08 +00001210
1211void
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001212_PyFloat_Init(void)
1213{
1214 /* We attempt to determine if this machine is using IEEE
1215 floating point formats by peering at the bits of some
1216 carefully chosen values. If it looks like we are on an
1217 IEEE platform, the float packing/unpacking routines can
1218 just copy bits, if not they resort to arithmetic & shifts
1219 and masks. The shifts & masks approach works on all finite
1220 values, but what happens to infinities, NaNs and signed
1221 zeroes on packing is an accident, and attempting to unpack
1222 a NaN or an infinity will raise an exception.
1223
1224 Note that if we're on some whacked-out platform which uses
1225 IEEE formats but isn't strictly little-endian or big-
1226 endian, we will fall back to the portable shifts & masks
1227 method. */
1228
1229#if SIZEOF_DOUBLE == 8
1230 {
1231 double x = 9006104071832581.0;
1232 if (memcmp(&x, "\x43\x3f\xff\x01\x02\x03\x04\x05", 8) == 0)
1233 detected_double_format = ieee_big_endian_format;
1234 else if (memcmp(&x, "\x05\x04\x03\x02\x01\xff\x3f\x43", 8) == 0)
1235 detected_double_format = ieee_little_endian_format;
1236 else
1237 detected_double_format = unknown_format;
1238 }
1239#else
1240 detected_double_format = unknown_format;
1241#endif
1242
1243#if SIZEOF_FLOAT == 4
1244 {
1245 float y = 16711938.0;
1246 if (memcmp(&y, "\x4b\x7f\x01\x02", 4) == 0)
1247 detected_float_format = ieee_big_endian_format;
1248 else if (memcmp(&y, "\x02\x01\x7f\x4b", 4) == 0)
1249 detected_float_format = ieee_little_endian_format;
1250 else
1251 detected_float_format = unknown_format;
1252 }
1253#else
1254 detected_float_format = unknown_format;
1255#endif
1256
1257 double_format = detected_double_format;
1258 float_format = detected_float_format;
1259}
1260
1261void
Fred Drakefd99de62000-07-09 05:02:18 +00001262PyFloat_Fini(void)
Guido van Rossumfbbd57e1997-08-05 02:16:08 +00001263{
Guido van Rossum3fce8831999-03-12 19:43:17 +00001264 PyFloatObject *p;
1265 PyFloatBlock *list, *next;
Neal Norwitz739a8f82004-07-08 01:55:58 +00001266 unsigned i;
Guido van Rossumf61bbc81999-03-12 00:12:21 +00001267 int bc, bf; /* block count, number of freed blocks */
1268 int frem, fsum; /* remaining unfreed floats per block, total */
1269
1270 bc = 0;
1271 bf = 0;
1272 fsum = 0;
1273 list = block_list;
1274 block_list = NULL;
Guido van Rossumd7b5fb81999-03-19 20:59:40 +00001275 free_list = NULL;
Guido van Rossumf61bbc81999-03-12 00:12:21 +00001276 while (list != NULL) {
Guido van Rossumf61bbc81999-03-12 00:12:21 +00001277 bc++;
1278 frem = 0;
Guido van Rossumd7b5fb81999-03-19 20:59:40 +00001279 for (i = 0, p = &list->objects[0];
1280 i < N_FLOATOBJECTS;
1281 i++, p++) {
Guido van Rossumdea6ef92001-09-11 16:13:52 +00001282 if (PyFloat_CheckExact(p) && p->ob_refcnt != 0)
Guido van Rossumf61bbc81999-03-12 00:12:21 +00001283 frem++;
1284 }
Guido van Rossum3fce8831999-03-12 19:43:17 +00001285 next = list->next;
Guido van Rossumf61bbc81999-03-12 00:12:21 +00001286 if (frem) {
Guido van Rossum3fce8831999-03-12 19:43:17 +00001287 list->next = block_list;
1288 block_list = list;
Guido van Rossumd7b5fb81999-03-19 20:59:40 +00001289 for (i = 0, p = &list->objects[0];
1290 i < N_FLOATOBJECTS;
1291 i++, p++) {
Guido van Rossumdea6ef92001-09-11 16:13:52 +00001292 if (!PyFloat_CheckExact(p) ||
Guido van Rossumbef14172001-08-29 15:47:46 +00001293 p->ob_refcnt == 0) {
Guido van Rossumd7b5fb81999-03-19 20:59:40 +00001294 p->ob_type = (struct _typeobject *)
1295 free_list;
1296 free_list = p;
1297 }
1298 }
Guido van Rossumf61bbc81999-03-12 00:12:21 +00001299 }
1300 else {
Guido van Rossumb18618d2000-05-03 23:44:39 +00001301 PyMem_FREE(list); /* XXX PyObject_FREE ??? */
Guido van Rossumf61bbc81999-03-12 00:12:21 +00001302 bf++;
1303 }
1304 fsum += frem;
Guido van Rossum3fce8831999-03-12 19:43:17 +00001305 list = next;
Guido van Rossumf61bbc81999-03-12 00:12:21 +00001306 }
Guido van Rossum3fce8831999-03-12 19:43:17 +00001307 if (!Py_VerboseFlag)
1308 return;
1309 fprintf(stderr, "# cleanup floats");
1310 if (!fsum) {
1311 fprintf(stderr, "\n");
1312 }
1313 else {
1314 fprintf(stderr,
1315 ": %d unfreed float%s in %d out of %d block%s\n",
1316 fsum, fsum == 1 ? "" : "s",
1317 bc - bf, bc, bc == 1 ? "" : "s");
1318 }
1319 if (Py_VerboseFlag > 1) {
1320 list = block_list;
1321 while (list != NULL) {
Guido van Rossumd7b5fb81999-03-19 20:59:40 +00001322 for (i = 0, p = &list->objects[0];
1323 i < N_FLOATOBJECTS;
1324 i++, p++) {
Guido van Rossumdea6ef92001-09-11 16:13:52 +00001325 if (PyFloat_CheckExact(p) &&
Guido van Rossumbef14172001-08-29 15:47:46 +00001326 p->ob_refcnt != 0) {
Guido van Rossum3fce8831999-03-12 19:43:17 +00001327 char buf[100];
1328 PyFloat_AsString(buf, p);
1329 fprintf(stderr,
Fred Drakea44d3532000-06-30 15:01:00 +00001330 "# <float at %p, refcnt=%d, val=%s>\n",
1331 p, p->ob_refcnt, buf);
Guido van Rossum3fce8831999-03-12 19:43:17 +00001332 }
1333 }
1334 list = list->next;
Guido van Rossumf61bbc81999-03-12 00:12:21 +00001335 }
1336 }
Guido van Rossumfbbd57e1997-08-05 02:16:08 +00001337}
Tim Peters9905b942003-03-20 20:53:32 +00001338
1339/*----------------------------------------------------------------------------
1340 * _PyFloat_{Pack,Unpack}{4,8}. See floatobject.h.
1341 *
1342 * TODO: On platforms that use the standard IEEE-754 single and double
1343 * formats natively, these routines could simply copy the bytes.
1344 */
1345int
1346_PyFloat_Pack4(double x, unsigned char *p, int le)
1347{
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001348 if (float_format == unknown_format) {
1349 unsigned char sign;
1350 int e;
1351 double f;
1352 unsigned int fbits;
1353 int incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00001354
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001355 if (le) {
1356 p += 3;
1357 incr = -1;
1358 }
Tim Peters9905b942003-03-20 20:53:32 +00001359
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001360 if (x < 0) {
1361 sign = 1;
1362 x = -x;
1363 }
1364 else
1365 sign = 0;
Tim Peters9905b942003-03-20 20:53:32 +00001366
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001367 f = frexp(x, &e);
Tim Peters9905b942003-03-20 20:53:32 +00001368
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001369 /* Normalize f to be in the range [1.0, 2.0) */
1370 if (0.5 <= f && f < 1.0) {
1371 f *= 2.0;
1372 e--;
1373 }
1374 else if (f == 0.0)
1375 e = 0;
1376 else {
1377 PyErr_SetString(PyExc_SystemError,
1378 "frexp() result out of range");
1379 return -1;
1380 }
1381
1382 if (e >= 128)
1383 goto Overflow;
1384 else if (e < -126) {
1385 /* Gradual underflow */
1386 f = ldexp(f, 126 + e);
1387 e = 0;
1388 }
1389 else if (!(e == 0 && f == 0.0)) {
1390 e += 127;
1391 f -= 1.0; /* Get rid of leading 1 */
1392 }
1393
1394 f *= 8388608.0; /* 2**23 */
1395 fbits = (unsigned int)(f + 0.5); /* Round */
1396 assert(fbits <= 8388608);
1397 if (fbits >> 23) {
1398 /* The carry propagated out of a string of 23 1 bits. */
1399 fbits = 0;
1400 ++e;
1401 if (e >= 255)
1402 goto Overflow;
1403 }
1404
1405 /* First byte */
1406 *p = (sign << 7) | (e >> 1);
1407 p += incr;
1408
1409 /* Second byte */
1410 *p = (char) (((e & 1) << 7) | (fbits >> 16));
1411 p += incr;
1412
1413 /* Third byte */
1414 *p = (fbits >> 8) & 0xFF;
1415 p += incr;
1416
1417 /* Fourth byte */
1418 *p = fbits & 0xFF;
1419
1420 /* Done */
1421 return 0;
1422
1423 Overflow:
1424 PyErr_SetString(PyExc_OverflowError,
1425 "float too large to pack with f format");
Tim Peters9905b942003-03-20 20:53:32 +00001426 return -1;
1427 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001428 else {
Michael W. Hudson3095ad02005-06-30 00:02:26 +00001429 float y = (float)x;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001430 const char *s = (char*)&y;
1431 int i, incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00001432
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001433 if ((float_format == ieee_little_endian_format && !le)
1434 || (float_format == ieee_big_endian_format && le)) {
1435 p += 3;
1436 incr = -1;
1437 }
1438
1439 for (i = 0; i < 4; i++) {
1440 *p = *s++;
1441 p += incr;
1442 }
1443 return 0;
Tim Peters9905b942003-03-20 20:53:32 +00001444 }
Tim Peters9905b942003-03-20 20:53:32 +00001445}
1446
1447int
1448_PyFloat_Pack8(double x, unsigned char *p, int le)
1449{
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001450 if (double_format == unknown_format) {
1451 unsigned char sign;
1452 int e;
1453 double f;
1454 unsigned int fhi, flo;
1455 int incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00001456
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001457 if (le) {
1458 p += 7;
1459 incr = -1;
1460 }
Tim Peters9905b942003-03-20 20:53:32 +00001461
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001462 if (x < 0) {
1463 sign = 1;
1464 x = -x;
1465 }
1466 else
1467 sign = 0;
Tim Peters9905b942003-03-20 20:53:32 +00001468
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001469 f = frexp(x, &e);
Tim Peters9905b942003-03-20 20:53:32 +00001470
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001471 /* Normalize f to be in the range [1.0, 2.0) */
1472 if (0.5 <= f && f < 1.0) {
1473 f *= 2.0;
1474 e--;
1475 }
1476 else if (f == 0.0)
1477 e = 0;
1478 else {
1479 PyErr_SetString(PyExc_SystemError,
1480 "frexp() result out of range");
1481 return -1;
1482 }
1483
1484 if (e >= 1024)
1485 goto Overflow;
1486 else if (e < -1022) {
1487 /* Gradual underflow */
1488 f = ldexp(f, 1022 + e);
1489 e = 0;
1490 }
1491 else if (!(e == 0 && f == 0.0)) {
1492 e += 1023;
1493 f -= 1.0; /* Get rid of leading 1 */
1494 }
1495
1496 /* fhi receives the high 28 bits; flo the low 24 bits (== 52 bits) */
1497 f *= 268435456.0; /* 2**28 */
1498 fhi = (unsigned int)f; /* Truncate */
1499 assert(fhi < 268435456);
1500
1501 f -= (double)fhi;
1502 f *= 16777216.0; /* 2**24 */
1503 flo = (unsigned int)(f + 0.5); /* Round */
1504 assert(flo <= 16777216);
1505 if (flo >> 24) {
1506 /* The carry propagated out of a string of 24 1 bits. */
1507 flo = 0;
1508 ++fhi;
1509 if (fhi >> 28) {
1510 /* And it also progagated out of the next 28 bits. */
1511 fhi = 0;
1512 ++e;
1513 if (e >= 2047)
1514 goto Overflow;
1515 }
1516 }
1517
1518 /* First byte */
1519 *p = (sign << 7) | (e >> 4);
1520 p += incr;
1521
1522 /* Second byte */
1523 *p = (unsigned char) (((e & 0xF) << 4) | (fhi >> 24));
1524 p += incr;
1525
1526 /* Third byte */
1527 *p = (fhi >> 16) & 0xFF;
1528 p += incr;
1529
1530 /* Fourth byte */
1531 *p = (fhi >> 8) & 0xFF;
1532 p += incr;
1533
1534 /* Fifth byte */
1535 *p = fhi & 0xFF;
1536 p += incr;
1537
1538 /* Sixth byte */
1539 *p = (flo >> 16) & 0xFF;
1540 p += incr;
1541
1542 /* Seventh byte */
1543 *p = (flo >> 8) & 0xFF;
1544 p += incr;
1545
1546 /* Eighth byte */
1547 *p = flo & 0xFF;
1548 p += incr;
1549
1550 /* Done */
1551 return 0;
1552
1553 Overflow:
1554 PyErr_SetString(PyExc_OverflowError,
1555 "float too large to pack with d format");
Tim Peters9905b942003-03-20 20:53:32 +00001556 return -1;
1557 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001558 else {
1559 const char *s = (char*)&x;
1560 int i, incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00001561
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001562 if ((double_format == ieee_little_endian_format && !le)
1563 || (double_format == ieee_big_endian_format && le)) {
1564 p += 7;
1565 incr = -1;
Tim Peters9905b942003-03-20 20:53:32 +00001566 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001567
1568 for (i = 0; i < 8; i++) {
1569 *p = *s++;
1570 p += incr;
1571 }
1572 return 0;
Tim Peters9905b942003-03-20 20:53:32 +00001573 }
Tim Peters9905b942003-03-20 20:53:32 +00001574}
1575
1576double
1577_PyFloat_Unpack4(const unsigned char *p, int le)
1578{
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001579 if (float_format == unknown_format) {
1580 unsigned char sign;
1581 int e;
1582 unsigned int f;
1583 double x;
1584 int incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00001585
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001586 if (le) {
1587 p += 3;
1588 incr = -1;
1589 }
1590
1591 /* First byte */
1592 sign = (*p >> 7) & 1;
1593 e = (*p & 0x7F) << 1;
1594 p += incr;
1595
1596 /* Second byte */
1597 e |= (*p >> 7) & 1;
1598 f = (*p & 0x7F) << 16;
1599 p += incr;
1600
1601 if (e == 255) {
1602 PyErr_SetString(
1603 PyExc_ValueError,
1604 "can't unpack IEEE 754 special value "
1605 "on non-IEEE platform");
1606 return -1;
1607 }
1608
1609 /* Third byte */
1610 f |= *p << 8;
1611 p += incr;
1612
1613 /* Fourth byte */
1614 f |= *p;
1615
1616 x = (double)f / 8388608.0;
1617
1618 /* XXX This sadly ignores Inf/NaN issues */
1619 if (e == 0)
1620 e = -126;
1621 else {
1622 x += 1.0;
1623 e -= 127;
1624 }
1625 x = ldexp(x, e);
1626
1627 if (sign)
1628 x = -x;
1629
1630 return x;
Tim Peters9905b942003-03-20 20:53:32 +00001631 }
Tim Peters9905b942003-03-20 20:53:32 +00001632 else {
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00001633 float x;
1634
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001635 if ((float_format == ieee_little_endian_format && !le)
1636 || (float_format == ieee_big_endian_format && le)) {
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00001637 char buf[4];
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001638 char *d = &buf[3];
1639 int i;
Tim Peters9905b942003-03-20 20:53:32 +00001640
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001641 for (i = 0; i < 4; i++) {
1642 *d-- = *p++;
1643 }
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00001644 memcpy(&x, buf, 4);
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001645 }
1646 else {
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00001647 memcpy(&x, p, 4);
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001648 }
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00001649
1650 return x;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001651 }
Tim Peters9905b942003-03-20 20:53:32 +00001652}
1653
1654double
1655_PyFloat_Unpack8(const unsigned char *p, int le)
1656{
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001657 if (double_format == unknown_format) {
1658 unsigned char sign;
1659 int e;
1660 unsigned int fhi, flo;
1661 double x;
1662 int incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00001663
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001664 if (le) {
1665 p += 7;
1666 incr = -1;
1667 }
1668
1669 /* First byte */
1670 sign = (*p >> 7) & 1;
1671 e = (*p & 0x7F) << 4;
1672
1673 p += incr;
1674
1675 /* Second byte */
1676 e |= (*p >> 4) & 0xF;
1677 fhi = (*p & 0xF) << 24;
1678 p += incr;
1679
1680 if (e == 2047) {
1681 PyErr_SetString(
1682 PyExc_ValueError,
1683 "can't unpack IEEE 754 special value "
1684 "on non-IEEE platform");
1685 return -1.0;
1686 }
1687
1688 /* Third byte */
1689 fhi |= *p << 16;
1690 p += incr;
1691
1692 /* Fourth byte */
1693 fhi |= *p << 8;
1694 p += incr;
1695
1696 /* Fifth byte */
1697 fhi |= *p;
1698 p += incr;
1699
1700 /* Sixth byte */
1701 flo = *p << 16;
1702 p += incr;
1703
1704 /* Seventh byte */
1705 flo |= *p << 8;
1706 p += incr;
1707
1708 /* Eighth byte */
1709 flo |= *p;
1710
1711 x = (double)fhi + (double)flo / 16777216.0; /* 2**24 */
1712 x /= 268435456.0; /* 2**28 */
1713
1714 if (e == 0)
1715 e = -1022;
1716 else {
1717 x += 1.0;
1718 e -= 1023;
1719 }
1720 x = ldexp(x, e);
1721
1722 if (sign)
1723 x = -x;
1724
1725 return x;
Tim Peters9905b942003-03-20 20:53:32 +00001726 }
Tim Peters9905b942003-03-20 20:53:32 +00001727 else {
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00001728 double x;
1729
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001730 if ((double_format == ieee_little_endian_format && !le)
1731 || (double_format == ieee_big_endian_format && le)) {
1732 char buf[8];
1733 char *d = &buf[7];
1734 int i;
1735
1736 for (i = 0; i < 8; i++) {
1737 *d-- = *p++;
1738 }
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00001739 memcpy(&x, buf, 8);
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001740 }
1741 else {
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00001742 memcpy(&x, p, 8);
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001743 }
Michael W. Hudsonb78a5fc2005-12-05 00:27:49 +00001744
1745 return x;
Tim Peters9905b942003-03-20 20:53:32 +00001746 }
Tim Peters9905b942003-03-20 20:53:32 +00001747}