blob: d02e053c8d42b5817bf63939df2c52e37d43a194 [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
Guido van Rossum4c08d552000-03-10 22:55:18 +000090 int 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;
Trent Micka248fb62000-08-12 21:37:39 +0000111 len = (int)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;
428 double mant;
429 int exponent;
430
431 if (vsign != wsign) {
432 /* Magnitudes are irrelevant -- the signs alone
433 * determine the outcome.
434 */
435 i = (double)vsign;
436 j = (double)wsign;
437 goto Compare;
438 }
439 /* The signs are the same. */
440 /* Convert w to a double if it fits. In particular, 0 fits. */
441 nbits = _PyLong_NumBits(w);
442 if (nbits == (size_t)-1 && PyErr_Occurred()) {
443 /* This long is so large that size_t isn't big enough
Tim Peterse1c69b32004-09-23 19:22:41 +0000444 * to hold the # of bits. Replace with little doubles
445 * that give the same outcome -- w is so large that
446 * its magnitude must exceed the magnitude of any
447 * finite float.
Tim Peters307fa782004-09-23 08:06:40 +0000448 */
449 PyErr_Clear();
450 i = (double)vsign;
451 assert(wsign != 0);
452 j = wsign * 2.0;
453 goto Compare;
454 }
455 if (nbits <= 48) {
456 j = PyLong_AsDouble(w);
457 /* It's impossible that <= 48 bits overflowed. */
458 assert(j != -1.0 || ! PyErr_Occurred());
459 goto Compare;
460 }
461 assert(wsign != 0); /* else nbits was 0 */
462 assert(vsign != 0); /* if vsign were 0, then since wsign is
463 * not 0, we would have taken the
464 * vsign != wsign branch at the start */
465 /* We want to work with non-negative numbers. */
466 if (vsign < 0) {
467 /* "Multiply both sides" by -1; this also swaps the
468 * comparator.
469 */
470 i = -i;
471 op = _Py_SwappedOp[op];
472 }
473 assert(i > 0.0);
474 mant = frexp(i, &exponent);
475 /* exponent is the # of bits in v before the radix point;
476 * we know that nbits (the # of bits in w) > 48 at this point
477 */
478 if (exponent < 0 || (size_t)exponent < nbits) {
479 i = 1.0;
480 j = 2.0;
481 goto Compare;
482 }
483 if ((size_t)exponent > nbits) {
484 i = 2.0;
485 j = 1.0;
486 goto Compare;
487 }
488 /* v and w have the same number of bits before the radix
489 * point. Construct two longs that have the same comparison
490 * outcome.
491 */
492 {
493 double fracpart;
494 double intpart;
495 PyObject *result = NULL;
496 PyObject *one = NULL;
497 PyObject *vv = NULL;
498 PyObject *ww = w;
499
500 if (wsign < 0) {
501 ww = PyNumber_Negative(w);
502 if (ww == NULL)
503 goto Error;
504 }
505 else
506 Py_INCREF(ww);
507
508 fracpart = modf(i, &intpart);
509 vv = PyLong_FromDouble(intpart);
510 if (vv == NULL)
511 goto Error;
512
513 if (fracpart != 0.0) {
514 /* Shift left, and or a 1 bit into vv
515 * to represent the lost fraction.
516 */
517 PyObject *temp;
518
519 one = PyInt_FromLong(1);
520 if (one == NULL)
521 goto Error;
522
523 temp = PyNumber_Lshift(ww, one);
524 if (temp == NULL)
525 goto Error;
526 Py_DECREF(ww);
527 ww = temp;
528
529 temp = PyNumber_Lshift(vv, one);
530 if (temp == NULL)
531 goto Error;
532 Py_DECREF(vv);
533 vv = temp;
534
535 temp = PyNumber_Or(vv, one);
536 if (temp == NULL)
537 goto Error;
538 Py_DECREF(vv);
539 vv = temp;
540 }
541
542 r = PyObject_RichCompareBool(vv, ww, op);
543 if (r < 0)
544 goto Error;
545 result = PyBool_FromLong(r);
546 Error:
547 Py_XDECREF(vv);
548 Py_XDECREF(ww);
549 Py_XDECREF(one);
550 return result;
551 }
552 } /* else if (PyLong_Check(w)) */
553
554 else /* w isn't float, int, or long */
555 goto Unimplemented;
556
557 Compare:
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000558 PyFPE_START_PROTECT("richcompare", return NULL)
559 switch (op) {
560 case Py_EQ:
Tim Peters307fa782004-09-23 08:06:40 +0000561 r = i == j;
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000562 break;
563 case Py_NE:
Tim Peters307fa782004-09-23 08:06:40 +0000564 r = i != j;
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000565 break;
566 case Py_LE:
Tim Peters307fa782004-09-23 08:06:40 +0000567 r = i <= j;
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000568 break;
569 case Py_GE:
Tim Peters307fa782004-09-23 08:06:40 +0000570 r = i >= j;
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000571 break;
572 case Py_LT:
Tim Peters307fa782004-09-23 08:06:40 +0000573 r = i < j;
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000574 break;
575 case Py_GT:
Tim Peters307fa782004-09-23 08:06:40 +0000576 r = i > j;
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000577 break;
578 }
Michael W. Hudson957f9772004-02-26 12:33:09 +0000579 PyFPE_END_PROTECT(r)
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000580 return PyBool_FromLong(r);
Tim Peters307fa782004-09-23 08:06:40 +0000581
582 Unimplemented:
583 Py_INCREF(Py_NotImplemented);
584 return Py_NotImplemented;
Michael W. Hudsond3b33b52004-02-19 19:35:22 +0000585}
586
Guido van Rossum9bfef441993-03-29 10:43:31 +0000587static long
Fred Drakefd99de62000-07-09 05:02:18 +0000588float_hash(PyFloatObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000589{
Tim Peters39dce292000-08-15 03:34:48 +0000590 return _Py_HashDouble(v->ob_fval);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000591}
592
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000593static PyObject *
Neil Schemenauer32117e52001-01-04 01:44:34 +0000594float_add(PyObject *v, PyObject *w)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000595{
Neil Schemenauer32117e52001-01-04 01:44:34 +0000596 double a,b;
597 CONVERT_TO_DOUBLE(v, a);
598 CONVERT_TO_DOUBLE(w, b);
Guido van Rossum09e6ad01997-02-14 22:54:21 +0000599 PyFPE_START_PROTECT("add", return 0)
Neil Schemenauer32117e52001-01-04 01:44:34 +0000600 a = a + b;
601 PyFPE_END_PROTECT(a)
602 return PyFloat_FromDouble(a);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000603}
604
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000605static PyObject *
Neil Schemenauer32117e52001-01-04 01:44:34 +0000606float_sub(PyObject *v, PyObject *w)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000607{
Neil Schemenauer32117e52001-01-04 01:44:34 +0000608 double a,b;
609 CONVERT_TO_DOUBLE(v, a);
610 CONVERT_TO_DOUBLE(w, b);
Guido van Rossum09e6ad01997-02-14 22:54:21 +0000611 PyFPE_START_PROTECT("subtract", return 0)
Neil Schemenauer32117e52001-01-04 01:44:34 +0000612 a = a - b;
613 PyFPE_END_PROTECT(a)
614 return PyFloat_FromDouble(a);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000615}
616
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000617static PyObject *
Neil Schemenauer32117e52001-01-04 01:44:34 +0000618float_mul(PyObject *v, PyObject *w)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000619{
Neil Schemenauer32117e52001-01-04 01:44:34 +0000620 double a,b;
621 CONVERT_TO_DOUBLE(v, a);
622 CONVERT_TO_DOUBLE(w, b);
Guido van Rossum09e6ad01997-02-14 22:54:21 +0000623 PyFPE_START_PROTECT("multiply", return 0)
Neil Schemenauer32117e52001-01-04 01:44:34 +0000624 a = a * b;
625 PyFPE_END_PROTECT(a)
626 return PyFloat_FromDouble(a);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000627}
628
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000629static PyObject *
Neil Schemenauer32117e52001-01-04 01:44:34 +0000630float_div(PyObject *v, PyObject *w)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000631{
Neil Schemenauer32117e52001-01-04 01:44:34 +0000632 double a,b;
633 CONVERT_TO_DOUBLE(v, a);
634 CONVERT_TO_DOUBLE(w, b);
635 if (b == 0.0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000636 PyErr_SetString(PyExc_ZeroDivisionError, "float division");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000637 return NULL;
638 }
Guido van Rossum09e6ad01997-02-14 22:54:21 +0000639 PyFPE_START_PROTECT("divide", return 0)
Neil Schemenauer32117e52001-01-04 01:44:34 +0000640 a = a / b;
641 PyFPE_END_PROTECT(a)
642 return PyFloat_FromDouble(a);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000643}
644
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000645static PyObject *
Guido van Rossum393661d2001-08-31 17:40:15 +0000646float_classic_div(PyObject *v, PyObject *w)
647{
648 double a,b;
649 CONVERT_TO_DOUBLE(v, a);
650 CONVERT_TO_DOUBLE(w, b);
Guido van Rossum1832de42001-09-04 03:51:09 +0000651 if (Py_DivisionWarningFlag >= 2 &&
Guido van Rossum393661d2001-08-31 17:40:15 +0000652 PyErr_Warn(PyExc_DeprecationWarning, "classic float division") < 0)
653 return NULL;
654 if (b == 0.0) {
655 PyErr_SetString(PyExc_ZeroDivisionError, "float division");
656 return NULL;
657 }
658 PyFPE_START_PROTECT("divide", return 0)
659 a = a / b;
660 PyFPE_END_PROTECT(a)
661 return PyFloat_FromDouble(a);
662}
663
664static PyObject *
Neil Schemenauer32117e52001-01-04 01:44:34 +0000665float_rem(PyObject *v, PyObject *w)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000666{
Guido van Rossum56cd67a1992-01-26 18:16:35 +0000667 double vx, wx;
Guido van Rossum9263e781999-05-06 14:26:34 +0000668 double mod;
Neil Schemenauer32117e52001-01-04 01:44:34 +0000669 CONVERT_TO_DOUBLE(v, vx);
670 CONVERT_TO_DOUBLE(w, wx);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000671 if (wx == 0.0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000672 PyErr_SetString(PyExc_ZeroDivisionError, "float modulo");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000673 return NULL;
674 }
Guido van Rossum09e6ad01997-02-14 22:54:21 +0000675 PyFPE_START_PROTECT("modulo", return 0)
Guido van Rossum56cd67a1992-01-26 18:16:35 +0000676 mod = fmod(vx, wx);
Guido van Rossum9263e781999-05-06 14:26:34 +0000677 /* note: checking mod*wx < 0 is incorrect -- underflows to
678 0 if wx < sqrt(smallest nonzero double) */
679 if (mod && ((wx < 0) != (mod < 0))) {
Guido van Rossum56cd67a1992-01-26 18:16:35 +0000680 mod += wx;
Guido van Rossum56cd67a1992-01-26 18:16:35 +0000681 }
Guido van Rossum45b83911997-03-14 04:32:50 +0000682 PyFPE_END_PROTECT(mod)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000683 return PyFloat_FromDouble(mod);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000684}
685
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000686static PyObject *
Neil Schemenauer32117e52001-01-04 01:44:34 +0000687float_divmod(PyObject *v, PyObject *w)
Guido van Rossumeba1b5e1991-05-05 20:07:00 +0000688{
Guido van Rossum15ecff41991-10-20 20:16:45 +0000689 double vx, wx;
Guido van Rossum9263e781999-05-06 14:26:34 +0000690 double div, mod, floordiv;
Neil Schemenauer32117e52001-01-04 01:44:34 +0000691 CONVERT_TO_DOUBLE(v, vx);
692 CONVERT_TO_DOUBLE(w, wx);
Guido van Rossum15ecff41991-10-20 20:16:45 +0000693 if (wx == 0.0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000694 PyErr_SetString(PyExc_ZeroDivisionError, "float divmod()");
Guido van Rossum15ecff41991-10-20 20:16:45 +0000695 return NULL;
696 }
Guido van Rossum09e6ad01997-02-14 22:54:21 +0000697 PyFPE_START_PROTECT("divmod", return 0)
Guido van Rossum15ecff41991-10-20 20:16:45 +0000698 mod = fmod(vx, wx);
Tim Peters78fc0b52000-09-16 03:54:24 +0000699 /* fmod is typically exact, so vx-mod is *mathematically* an
Guido van Rossum9263e781999-05-06 14:26:34 +0000700 exact multiple of wx. But this is fp arithmetic, and fp
701 vx - mod is an approximation; the result is that div may
702 not be an exact integral value after the division, although
703 it will always be very close to one.
704 */
Guido van Rossum15ecff41991-10-20 20:16:45 +0000705 div = (vx - mod) / wx;
Tim Petersd2e40d62001-11-01 23:12:27 +0000706 if (mod) {
707 /* ensure the remainder has the same sign as the denominator */
708 if ((wx < 0) != (mod < 0)) {
709 mod += wx;
710 div -= 1.0;
711 }
712 }
713 else {
714 /* the remainder is zero, and in the presence of signed zeroes
715 fmod returns different results across platforms; ensure
716 it has the same sign as the denominator; we'd like to do
717 "mod = wx * 0.0", but that may get optimized away */
Tim Peters4e8ab5d2001-11-01 23:59:56 +0000718 mod *= mod; /* hide "mod = +0" from optimizer */
Tim Petersd2e40d62001-11-01 23:12:27 +0000719 if (wx < 0.0)
720 mod = -mod;
Guido van Rossum15ecff41991-10-20 20:16:45 +0000721 }
Guido van Rossum9263e781999-05-06 14:26:34 +0000722 /* snap quotient to nearest integral value */
Tim Petersd2e40d62001-11-01 23:12:27 +0000723 if (div) {
724 floordiv = floor(div);
725 if (div - floordiv > 0.5)
726 floordiv += 1.0;
727 }
728 else {
729 /* div is zero - get the same sign as the true quotient */
730 div *= div; /* hide "div = +0" from optimizers */
731 floordiv = div * vx / wx; /* zero w/ sign of vx/wx */
732 }
733 PyFPE_END_PROTECT(floordiv)
Guido van Rossum9263e781999-05-06 14:26:34 +0000734 return Py_BuildValue("(dd)", floordiv, mod);
Guido van Rossumeba1b5e1991-05-05 20:07:00 +0000735}
736
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000737static PyObject *
Tim Peters63a35712001-12-11 19:57:24 +0000738float_floor_div(PyObject *v, PyObject *w)
739{
740 PyObject *t, *r;
741
742 t = float_divmod(v, w);
Tim Peters77d8a4f2001-12-11 20:31:34 +0000743 if (t == NULL || t == Py_NotImplemented)
744 return t;
745 assert(PyTuple_CheckExact(t));
746 r = PyTuple_GET_ITEM(t, 0);
747 Py_INCREF(r);
748 Py_DECREF(t);
749 return r;
Tim Peters63a35712001-12-11 19:57:24 +0000750}
751
752static PyObject *
Neil Schemenauer32117e52001-01-04 01:44:34 +0000753float_pow(PyObject *v, PyObject *w, PyObject *z)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000754{
755 double iv, iw, ix;
Tim Peters32f453e2001-09-03 08:35:41 +0000756
757 if ((PyObject *)z != Py_None) {
Tim Peters4c483c42001-09-05 06:24:58 +0000758 PyErr_SetString(PyExc_TypeError, "pow() 3rd argument not "
Tim Peters97f4a332001-09-05 23:49:24 +0000759 "allowed unless all arguments are integers");
Tim Peters32f453e2001-09-03 08:35:41 +0000760 return NULL;
761 }
762
Neil Schemenauer32117e52001-01-04 01:44:34 +0000763 CONVERT_TO_DOUBLE(v, iv);
764 CONVERT_TO_DOUBLE(w, iw);
Tim Petersc54d1902000-10-06 00:36:09 +0000765
766 /* Sort out special cases here instead of relying on pow() */
Tim Peters96685bf2001-08-23 22:31:37 +0000767 if (iw == 0) { /* v**0 is 1, even 0**0 */
Tim Petersc54d1902000-10-06 00:36:09 +0000768 PyFPE_START_PROTECT("pow", return NULL)
769 if ((PyObject *)z != Py_None) {
Neil Schemenauer32117e52001-01-04 01:44:34 +0000770 double iz;
Neil Schemenauer010b0cc2001-01-08 06:29:50 +0000771 CONVERT_TO_DOUBLE(z, iz);
Tim Peters96685bf2001-08-23 22:31:37 +0000772 ix = fmod(1.0, iz);
773 if (ix != 0 && iz < 0)
774 ix += iz;
Guido van Rossum70d93461991-05-28 21:57:39 +0000775 }
Tim Petersc54d1902000-10-06 00:36:09 +0000776 else
777 ix = 1.0;
778 PyFPE_END_PROTECT(ix)
Tim Petersd2364e82001-11-01 20:09:42 +0000779 return PyFloat_FromDouble(ix);
Tim Petersc54d1902000-10-06 00:36:09 +0000780 }
Tim Peters96685bf2001-08-23 22:31:37 +0000781 if (iv == 0.0) { /* 0**w is error if w<0, else 1 */
Tim Petersc54d1902000-10-06 00:36:09 +0000782 if (iw < 0.0) {
783 PyErr_SetString(PyExc_ZeroDivisionError,
Fred Drake661ea262000-10-24 19:57:45 +0000784 "0.0 cannot be raised to a negative power");
Tim Petersc54d1902000-10-06 00:36:09 +0000785 return NULL;
786 }
787 return PyFloat_FromDouble(0.0);
788 }
Tim Peterse87568d2003-05-24 20:18:24 +0000789 if (iv < 0.0) {
790 /* Whether this is an error is a mess, and bumps into libm
791 * bugs so we have to figure it out ourselves.
792 */
793 if (iw != floor(iw)) {
794 PyErr_SetString(PyExc_ValueError, "negative number "
795 "cannot be raised to a fractional power");
796 return NULL;
797 }
798 /* iw is an exact integer, albeit perhaps a very large one.
799 * -1 raised to an exact integer should never be exceptional.
800 * Alas, some libms (chiefly glibc as of early 2003) return
801 * NaN and set EDOM on pow(-1, large_int) if the int doesn't
802 * happen to be representable in a *C* integer. That's a
803 * bug; we let that slide in math.pow() (which currently
804 * reflects all platform accidents), but not for Python's **.
805 */
806 if (iv == -1.0 && !Py_IS_INFINITY(iw) && iw == iw) {
807 /* XXX the "iw == iw" was to weed out NaNs. This
808 * XXX doesn't actually work on all platforms.
809 */
810 /* Return 1 if iw is even, -1 if iw is odd; there's
811 * no guarantee that any C integral type is big
812 * enough to hold iw, so we have to check this
813 * indirectly.
814 */
815 ix = floor(iw * 0.5) * 2.0;
816 return PyFloat_FromDouble(ix == iw ? 1.0 : -1.0);
817 }
818 /* Else iv != -1.0, and overflow or underflow are possible.
819 * Unless we're to write pow() ourselves, we have to trust
820 * the platform to do this correctly.
821 */
Guido van Rossum86c04c21996-08-09 20:50:14 +0000822 }
Tim Peters96685bf2001-08-23 22:31:37 +0000823 errno = 0;
824 PyFPE_START_PROTECT("pow", return NULL)
825 ix = pow(iv, iw);
826 PyFPE_END_PROTECT(ix)
Tim Petersdc5a5082002-03-09 04:58:24 +0000827 Py_ADJUST_ERANGE1(ix);
Guido van Rossum2a9096b1990-10-21 22:15:08 +0000828 if (errno != 0) {
Tim Peterse87568d2003-05-24 20:18:24 +0000829 /* We don't expect any errno value other than ERANGE, but
830 * the range of libm bugs appears unbounded.
831 */
832 PyErr_SetFromErrno(errno == ERANGE ? PyExc_OverflowError :
833 PyExc_ValueError);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000834 return NULL;
Guido van Rossum2a9096b1990-10-21 22:15:08 +0000835 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000836 return PyFloat_FromDouble(ix);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000837}
838
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000839static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000840float_neg(PyFloatObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000841{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000842 return PyFloat_FromDouble(-v->ob_fval);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000843}
844
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000845static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000846float_pos(PyFloatObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000847{
Tim Peters0280cf72001-09-11 21:53:35 +0000848 if (PyFloat_CheckExact(v)) {
849 Py_INCREF(v);
850 return (PyObject *)v;
851 }
852 else
853 return PyFloat_FromDouble(v->ob_fval);
Guido van Rossumeba1b5e1991-05-05 20:07:00 +0000854}
855
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000856static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000857float_abs(PyFloatObject *v)
Guido van Rossumeba1b5e1991-05-05 20:07:00 +0000858{
Tim Petersfaf0cd22001-11-01 21:51:15 +0000859 return PyFloat_FromDouble(fabs(v->ob_fval));
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000860}
861
Guido van Rossum50b4ef61991-05-14 11:57:01 +0000862static int
Fred Drakefd99de62000-07-09 05:02:18 +0000863float_nonzero(PyFloatObject *v)
Guido van Rossum50b4ef61991-05-14 11:57:01 +0000864{
865 return v->ob_fval != 0.0;
866}
867
Guido van Rossum234f9421993-06-17 12:35:49 +0000868static int
Fred Drakefd99de62000-07-09 05:02:18 +0000869float_coerce(PyObject **pv, PyObject **pw)
Guido van Rossume6eefc21992-08-14 12:06:52 +0000870{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000871 if (PyInt_Check(*pw)) {
872 long x = PyInt_AsLong(*pw);
873 *pw = PyFloat_FromDouble((double)x);
874 Py_INCREF(*pv);
Guido van Rossume6eefc21992-08-14 12:06:52 +0000875 return 0;
876 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000877 else if (PyLong_Check(*pw)) {
Neal Norwitzabcb0c02003-01-28 19:21:24 +0000878 double x = PyLong_AsDouble(*pw);
879 if (x == -1.0 && PyErr_Occurred())
880 return -1;
881 *pw = PyFloat_FromDouble(x);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000882 Py_INCREF(*pv);
Guido van Rossume6eefc21992-08-14 12:06:52 +0000883 return 0;
884 }
Guido van Rossum1952e382001-09-19 01:25:16 +0000885 else if (PyFloat_Check(*pw)) {
886 Py_INCREF(*pv);
887 Py_INCREF(*pw);
888 return 0;
889 }
Guido van Rossume6eefc21992-08-14 12:06:52 +0000890 return 1; /* Can't do it */
891}
892
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000893static PyObject *
Walter Dörwaldf1715402002-11-19 20:49:15 +0000894float_long(PyObject *v)
895{
896 double x = PyFloat_AsDouble(v);
897 return PyLong_FromDouble(x);
898}
899
900static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000901float_int(PyObject *v)
Guido van Rossum1899c2e1992-09-12 11:09:23 +0000902{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000903 double x = PyFloat_AsDouble(v);
Tim Peters7321ec42001-07-26 20:02:17 +0000904 double wholepart; /* integral portion of x, rounded toward 0 */
Tim Peters7321ec42001-07-26 20:02:17 +0000905
906 (void)modf(x, &wholepart);
Tim Peters7d791242002-11-21 22:26:37 +0000907 /* Try to get out cheap if this fits in a Python int. The attempt
908 * to cast to long must be protected, as C doesn't define what
909 * happens if the double is too big to fit in a long. Some rare
910 * systems raise an exception then (RISCOS was mentioned as one,
911 * and someone using a non-default option on Sun also bumped into
912 * that). Note that checking for >= and <= LONG_{MIN,MAX} would
913 * still be vulnerable: if a long has more bits of precision than
914 * a double, casting MIN/MAX to double may yield an approximation,
915 * and if that's rounded up, then, e.g., wholepart=LONG_MAX+1 would
916 * yield true from the C expression wholepart<=LONG_MAX, despite
917 * that wholepart is actually greater than LONG_MAX.
918 */
919 if (LONG_MIN < wholepart && wholepart < LONG_MAX) {
920 const long aslong = (long)wholepart;
Tim Peters7321ec42001-07-26 20:02:17 +0000921 return PyInt_FromLong(aslong);
Tim Peters7d791242002-11-21 22:26:37 +0000922 }
923 return PyLong_FromDouble(wholepart);
Guido van Rossum1899c2e1992-09-12 11:09:23 +0000924}
925
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000926static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000927float_float(PyObject *v)
Guido van Rossum1899c2e1992-09-12 11:09:23 +0000928{
Brett Cannonc3647ac2005-04-26 03:45:26 +0000929 if (PyFloat_CheckExact(v))
930 Py_INCREF(v);
931 else
932 v = PyFloat_FromDouble(((PyFloatObject *)v)->ob_fval);
Guido van Rossum1899c2e1992-09-12 11:09:23 +0000933 return v;
934}
935
936
Jeremy Hylton938ace62002-07-17 16:30:39 +0000937static PyObject *
Guido van Rossumbef14172001-08-29 15:47:46 +0000938float_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds);
939
Tim Peters6d6c1a32001-08-02 04:15:00 +0000940static PyObject *
941float_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
942{
943 PyObject *x = Py_False; /* Integer zero */
944 static char *kwlist[] = {"x", 0};
945
Guido van Rossumbef14172001-08-29 15:47:46 +0000946 if (type != &PyFloat_Type)
947 return float_subtype_new(type, args, kwds); /* Wimp out */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000948 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|O:float", kwlist, &x))
949 return NULL;
950 if (PyString_Check(x))
951 return PyFloat_FromString(x, NULL);
952 return PyNumber_Float(x);
953}
954
Guido van Rossumbef14172001-08-29 15:47:46 +0000955/* Wimpy, slow approach to tp_new calls for subtypes of float:
956 first create a regular float from whatever arguments we got,
957 then allocate a subtype instance and initialize its ob_fval
958 from the regular float. The regular float is then thrown away.
959*/
960static PyObject *
961float_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
962{
963 PyObject *tmp, *new;
964
965 assert(PyType_IsSubtype(type, &PyFloat_Type));
966 tmp = float_new(&PyFloat_Type, args, kwds);
967 if (tmp == NULL)
968 return NULL;
Tim Peters2400fa42001-09-12 19:12:49 +0000969 assert(PyFloat_CheckExact(tmp));
Guido van Rossumd93dce12001-08-30 03:09:31 +0000970 new = type->tp_alloc(type, 0);
Raymond Hettingerf4667932003-06-28 20:04:25 +0000971 if (new == NULL) {
972 Py_DECREF(tmp);
Guido van Rossumbef14172001-08-29 15:47:46 +0000973 return NULL;
Raymond Hettingerf4667932003-06-28 20:04:25 +0000974 }
Guido van Rossumbef14172001-08-29 15:47:46 +0000975 ((PyFloatObject *)new)->ob_fval = ((PyFloatObject *)tmp)->ob_fval;
976 Py_DECREF(tmp);
977 return new;
978}
979
Guido van Rossum5d9113d2003-01-29 17:58:45 +0000980static PyObject *
981float_getnewargs(PyFloatObject *v)
982{
983 return Py_BuildValue("(d)", v->ob_fval);
984}
985
Michael W. Hudsonba283e22005-05-27 15:23:20 +0000986/* this is for the benefit of the pack/unpack routines below */
987
988typedef enum {
989 unknown_format, ieee_big_endian_format, ieee_little_endian_format
990} float_format_type;
991
992static float_format_type double_format, float_format;
993static float_format_type detected_double_format, detected_float_format;
994
995static PyObject *
996float_getformat(PyTypeObject *v, PyObject* arg)
997{
998 char* s;
999 float_format_type r;
1000
1001 if (!PyString_Check(arg)) {
1002 PyErr_Format(PyExc_TypeError,
1003 "__getformat__() argument must be string, not %.500s",
1004 arg->ob_type->tp_name);
1005 return NULL;
1006 }
1007 s = PyString_AS_STRING(arg);
1008 if (strcmp(s, "double") == 0) {
1009 r = double_format;
1010 }
1011 else if (strcmp(s, "float") == 0) {
1012 r = float_format;
1013 }
1014 else {
1015 PyErr_SetString(PyExc_ValueError,
1016 "__getformat__() argument 1 must be "
1017 "'double' or 'float'");
1018 return NULL;
1019 }
1020
1021 switch (r) {
1022 case unknown_format:
1023 return PyString_FromString("unknown");
1024 case ieee_little_endian_format:
1025 return PyString_FromString("IEEE, little-endian");
1026 case ieee_big_endian_format:
1027 return PyString_FromString("IEEE, big-endian");
1028 default:
1029 Py_FatalError("insane float_format or double_format");
1030 return NULL;
1031 }
1032}
1033
1034PyDoc_STRVAR(float_getformat_doc,
1035"float.__getformat__(typestr) -> string\n"
1036"\n"
1037"You probably don't want to use this function. It exists mainly to be\n"
1038"used in Python's test suite.\n"
1039"\n"
1040"typestr must be 'double' or 'float'. This function returns whichever of\n"
1041"'unknown', 'IEEE, big-endian' or 'IEEE, little-endian' best describes the\n"
1042"format of floating point numbers used by the C type named by typestr.");
1043
1044static PyObject *
1045float_setformat(PyTypeObject *v, PyObject* args)
1046{
1047 char* typestr;
1048 char* format;
1049 float_format_type f;
1050 float_format_type detected;
1051 float_format_type *p;
1052
1053 if (!PyArg_ParseTuple(args, "ss:__setformat__", &typestr, &format))
1054 return NULL;
1055
1056 if (strcmp(typestr, "double") == 0) {
1057 p = &double_format;
1058 detected = detected_double_format;
1059 }
1060 else if (strcmp(typestr, "float") == 0) {
1061 p = &float_format;
1062 detected = detected_float_format;
1063 }
1064 else {
1065 PyErr_SetString(PyExc_ValueError,
1066 "__setformat__() argument 1 must "
1067 "be 'double' or 'float'");
1068 return NULL;
1069 }
1070
1071 if (strcmp(format, "unknown") == 0) {
1072 f = unknown_format;
1073 }
1074 else if (strcmp(format, "IEEE, little-endian") == 0) {
1075 f = ieee_little_endian_format;
1076 }
1077 else if (strcmp(format, "IEEE, big-endian") == 0) {
1078 f = ieee_big_endian_format;
1079 }
1080 else {
1081 PyErr_SetString(PyExc_ValueError,
1082 "__setformat__() argument 2 must be "
1083 "'unknown', 'IEEE, little-endian' or "
1084 "'IEEE, big-endian'");
1085 return NULL;
1086
1087 }
1088
1089 if (f != unknown_format && f != detected) {
1090 PyErr_Format(PyExc_ValueError,
1091 "can only set %s format to 'unknown' or the "
1092 "detected platform value", typestr);
1093 return NULL;
1094 }
1095
1096 *p = f;
1097 Py_RETURN_NONE;
1098}
1099
1100PyDoc_STRVAR(float_setformat_doc,
1101"float.__setformat__(typestr, fmt) -> None\n"
1102"\n"
1103"You probably don't want to use this function. It exists mainly to be\n"
1104"used in Python's test suite.\n"
1105"\n"
1106"typestr must be 'double' or 'float'. fmt must be one of 'unknown',\n"
1107"'IEEE, big-endian' or 'IEEE, little-endian', and in addition can only be\n"
1108"one of the latter two if it appears to match the underlying C reality.\n"
1109"\n"
1110"Overrides the automatic determination of C-level floating point type.\n"
1111"This affects how floats are converted to and from binary strings.");
1112
Guido van Rossum5d9113d2003-01-29 17:58:45 +00001113static PyMethodDef float_methods[] = {
1114 {"__getnewargs__", (PyCFunction)float_getnewargs, METH_NOARGS},
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001115 {"__getformat__", (PyCFunction)float_getformat,
1116 METH_O|METH_CLASS, float_getformat_doc},
1117 {"__setformat__", (PyCFunction)float_setformat,
1118 METH_VARARGS|METH_CLASS, float_setformat_doc},
Guido van Rossum5d9113d2003-01-29 17:58:45 +00001119 {NULL, NULL} /* sentinel */
1120};
1121
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001122PyDoc_STRVAR(float_doc,
Tim Peters6d6c1a32001-08-02 04:15:00 +00001123"float(x) -> floating point number\n\
1124\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001125Convert a string or number to a floating point number, if possible.");
Tim Peters6d6c1a32001-08-02 04:15:00 +00001126
1127
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001128static PyNumberMethods float_as_number = {
Guido van Rossumb6775db1994-08-01 11:34:53 +00001129 (binaryfunc)float_add, /*nb_add*/
1130 (binaryfunc)float_sub, /*nb_subtract*/
1131 (binaryfunc)float_mul, /*nb_multiply*/
Guido van Rossum393661d2001-08-31 17:40:15 +00001132 (binaryfunc)float_classic_div, /*nb_divide*/
Guido van Rossumb6775db1994-08-01 11:34:53 +00001133 (binaryfunc)float_rem, /*nb_remainder*/
1134 (binaryfunc)float_divmod, /*nb_divmod*/
Guido van Rossum0b7d02a1994-08-12 12:52:35 +00001135 (ternaryfunc)float_pow, /*nb_power*/
Guido van Rossumb6775db1994-08-01 11:34:53 +00001136 (unaryfunc)float_neg, /*nb_negative*/
1137 (unaryfunc)float_pos, /*nb_positive*/
1138 (unaryfunc)float_abs, /*nb_absolute*/
1139 (inquiry)float_nonzero, /*nb_nonzero*/
Guido van Rossum27acb331991-10-24 14:55:28 +00001140 0, /*nb_invert*/
1141 0, /*nb_lshift*/
1142 0, /*nb_rshift*/
1143 0, /*nb_and*/
1144 0, /*nb_xor*/
1145 0, /*nb_or*/
Guido van Rossumb6775db1994-08-01 11:34:53 +00001146 (coercion)float_coerce, /*nb_coerce*/
1147 (unaryfunc)float_int, /*nb_int*/
1148 (unaryfunc)float_long, /*nb_long*/
1149 (unaryfunc)float_float, /*nb_float*/
Guido van Rossum4668b002001-08-08 05:00:18 +00001150 0, /* nb_oct */
1151 0, /* nb_hex */
1152 0, /* nb_inplace_add */
1153 0, /* nb_inplace_subtract */
1154 0, /* nb_inplace_multiply */
1155 0, /* nb_inplace_divide */
1156 0, /* nb_inplace_remainder */
1157 0, /* nb_inplace_power */
1158 0, /* nb_inplace_lshift */
1159 0, /* nb_inplace_rshift */
1160 0, /* nb_inplace_and */
1161 0, /* nb_inplace_xor */
1162 0, /* nb_inplace_or */
Tim Peters63a35712001-12-11 19:57:24 +00001163 float_floor_div, /* nb_floor_divide */
Guido van Rossum4668b002001-08-08 05:00:18 +00001164 float_div, /* nb_true_divide */
1165 0, /* nb_inplace_floor_divide */
1166 0, /* nb_inplace_true_divide */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001167};
1168
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001169PyTypeObject PyFloat_Type = {
1170 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001171 0,
1172 "float",
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001173 sizeof(PyFloatObject),
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001174 0,
Tim Peters6d6c1a32001-08-02 04:15:00 +00001175 (destructor)float_dealloc, /* tp_dealloc */
1176 (printfunc)float_print, /* tp_print */
1177 0, /* tp_getattr */
1178 0, /* tp_setattr */
Michael W. Hudson08678a12004-05-26 17:36:12 +00001179 0, /* tp_compare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001180 (reprfunc)float_repr, /* tp_repr */
1181 &float_as_number, /* tp_as_number */
1182 0, /* tp_as_sequence */
1183 0, /* tp_as_mapping */
1184 (hashfunc)float_hash, /* tp_hash */
1185 0, /* tp_call */
1186 (reprfunc)float_str, /* tp_str */
1187 PyObject_GenericGetAttr, /* tp_getattro */
1188 0, /* tp_setattro */
1189 0, /* tp_as_buffer */
Guido van Rossumbef14172001-08-29 15:47:46 +00001190 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
1191 Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001192 float_doc, /* tp_doc */
1193 0, /* tp_traverse */
1194 0, /* tp_clear */
Michael W. Hudsond3b33b52004-02-19 19:35:22 +00001195 (richcmpfunc)float_richcompare, /* tp_richcompare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001196 0, /* tp_weaklistoffset */
1197 0, /* tp_iter */
1198 0, /* tp_iternext */
Guido van Rossum5d9113d2003-01-29 17:58:45 +00001199 float_methods, /* tp_methods */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001200 0, /* tp_members */
1201 0, /* tp_getset */
1202 0, /* tp_base */
1203 0, /* tp_dict */
1204 0, /* tp_descr_get */
1205 0, /* tp_descr_set */
1206 0, /* tp_dictoffset */
1207 0, /* tp_init */
1208 0, /* tp_alloc */
1209 float_new, /* tp_new */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001210};
Guido van Rossumfbbd57e1997-08-05 02:16:08 +00001211
1212void
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001213_PyFloat_Init(void)
1214{
1215 /* We attempt to determine if this machine is using IEEE
1216 floating point formats by peering at the bits of some
1217 carefully chosen values. If it looks like we are on an
1218 IEEE platform, the float packing/unpacking routines can
1219 just copy bits, if not they resort to arithmetic & shifts
1220 and masks. The shifts & masks approach works on all finite
1221 values, but what happens to infinities, NaNs and signed
1222 zeroes on packing is an accident, and attempting to unpack
1223 a NaN or an infinity will raise an exception.
1224
1225 Note that if we're on some whacked-out platform which uses
1226 IEEE formats but isn't strictly little-endian or big-
1227 endian, we will fall back to the portable shifts & masks
1228 method. */
1229
1230#if SIZEOF_DOUBLE == 8
1231 {
1232 double x = 9006104071832581.0;
1233 if (memcmp(&x, "\x43\x3f\xff\x01\x02\x03\x04\x05", 8) == 0)
1234 detected_double_format = ieee_big_endian_format;
1235 else if (memcmp(&x, "\x05\x04\x03\x02\x01\xff\x3f\x43", 8) == 0)
1236 detected_double_format = ieee_little_endian_format;
1237 else
1238 detected_double_format = unknown_format;
1239 }
1240#else
1241 detected_double_format = unknown_format;
1242#endif
1243
1244#if SIZEOF_FLOAT == 4
1245 {
1246 float y = 16711938.0;
1247 if (memcmp(&y, "\x4b\x7f\x01\x02", 4) == 0)
1248 detected_float_format = ieee_big_endian_format;
1249 else if (memcmp(&y, "\x02\x01\x7f\x4b", 4) == 0)
1250 detected_float_format = ieee_little_endian_format;
1251 else
1252 detected_float_format = unknown_format;
1253 }
1254#else
1255 detected_float_format = unknown_format;
1256#endif
1257
1258 double_format = detected_double_format;
1259 float_format = detected_float_format;
1260}
1261
1262void
Fred Drakefd99de62000-07-09 05:02:18 +00001263PyFloat_Fini(void)
Guido van Rossumfbbd57e1997-08-05 02:16:08 +00001264{
Guido van Rossum3fce8831999-03-12 19:43:17 +00001265 PyFloatObject *p;
1266 PyFloatBlock *list, *next;
Neal Norwitz739a8f82004-07-08 01:55:58 +00001267 unsigned i;
Guido van Rossumf61bbc81999-03-12 00:12:21 +00001268 int bc, bf; /* block count, number of freed blocks */
1269 int frem, fsum; /* remaining unfreed floats per block, total */
1270
1271 bc = 0;
1272 bf = 0;
1273 fsum = 0;
1274 list = block_list;
1275 block_list = NULL;
Guido van Rossumd7b5fb81999-03-19 20:59:40 +00001276 free_list = NULL;
Guido van Rossumf61bbc81999-03-12 00:12:21 +00001277 while (list != NULL) {
Guido van Rossumf61bbc81999-03-12 00:12:21 +00001278 bc++;
1279 frem = 0;
Guido van Rossumd7b5fb81999-03-19 20:59:40 +00001280 for (i = 0, p = &list->objects[0];
1281 i < N_FLOATOBJECTS;
1282 i++, p++) {
Guido van Rossumdea6ef92001-09-11 16:13:52 +00001283 if (PyFloat_CheckExact(p) && p->ob_refcnt != 0)
Guido van Rossumf61bbc81999-03-12 00:12:21 +00001284 frem++;
1285 }
Guido van Rossum3fce8831999-03-12 19:43:17 +00001286 next = list->next;
Guido van Rossumf61bbc81999-03-12 00:12:21 +00001287 if (frem) {
Guido van Rossum3fce8831999-03-12 19:43:17 +00001288 list->next = block_list;
1289 block_list = list;
Guido van Rossumd7b5fb81999-03-19 20:59:40 +00001290 for (i = 0, p = &list->objects[0];
1291 i < N_FLOATOBJECTS;
1292 i++, p++) {
Guido van Rossumdea6ef92001-09-11 16:13:52 +00001293 if (!PyFloat_CheckExact(p) ||
Guido van Rossumbef14172001-08-29 15:47:46 +00001294 p->ob_refcnt == 0) {
Guido van Rossumd7b5fb81999-03-19 20:59:40 +00001295 p->ob_type = (struct _typeobject *)
1296 free_list;
1297 free_list = p;
1298 }
1299 }
Guido van Rossumf61bbc81999-03-12 00:12:21 +00001300 }
1301 else {
Guido van Rossumb18618d2000-05-03 23:44:39 +00001302 PyMem_FREE(list); /* XXX PyObject_FREE ??? */
Guido van Rossumf61bbc81999-03-12 00:12:21 +00001303 bf++;
1304 }
1305 fsum += frem;
Guido van Rossum3fce8831999-03-12 19:43:17 +00001306 list = next;
Guido van Rossumf61bbc81999-03-12 00:12:21 +00001307 }
Guido van Rossum3fce8831999-03-12 19:43:17 +00001308 if (!Py_VerboseFlag)
1309 return;
1310 fprintf(stderr, "# cleanup floats");
1311 if (!fsum) {
1312 fprintf(stderr, "\n");
1313 }
1314 else {
1315 fprintf(stderr,
1316 ": %d unfreed float%s in %d out of %d block%s\n",
1317 fsum, fsum == 1 ? "" : "s",
1318 bc - bf, bc, bc == 1 ? "" : "s");
1319 }
1320 if (Py_VerboseFlag > 1) {
1321 list = block_list;
1322 while (list != NULL) {
Guido van Rossumd7b5fb81999-03-19 20:59:40 +00001323 for (i = 0, p = &list->objects[0];
1324 i < N_FLOATOBJECTS;
1325 i++, p++) {
Guido van Rossumdea6ef92001-09-11 16:13:52 +00001326 if (PyFloat_CheckExact(p) &&
Guido van Rossumbef14172001-08-29 15:47:46 +00001327 p->ob_refcnt != 0) {
Guido van Rossum3fce8831999-03-12 19:43:17 +00001328 char buf[100];
1329 PyFloat_AsString(buf, p);
1330 fprintf(stderr,
Fred Drakea44d3532000-06-30 15:01:00 +00001331 "# <float at %p, refcnt=%d, val=%s>\n",
1332 p, p->ob_refcnt, buf);
Guido van Rossum3fce8831999-03-12 19:43:17 +00001333 }
1334 }
1335 list = list->next;
Guido van Rossumf61bbc81999-03-12 00:12:21 +00001336 }
1337 }
Guido van Rossumfbbd57e1997-08-05 02:16:08 +00001338}
Tim Peters9905b942003-03-20 20:53:32 +00001339
1340/*----------------------------------------------------------------------------
1341 * _PyFloat_{Pack,Unpack}{4,8}. See floatobject.h.
1342 *
1343 * TODO: On platforms that use the standard IEEE-754 single and double
1344 * formats natively, these routines could simply copy the bytes.
1345 */
1346int
1347_PyFloat_Pack4(double x, unsigned char *p, int le)
1348{
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001349 if (float_format == unknown_format) {
1350 unsigned char sign;
1351 int e;
1352 double f;
1353 unsigned int fbits;
1354 int incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00001355
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001356 if (le) {
1357 p += 3;
1358 incr = -1;
1359 }
Tim Peters9905b942003-03-20 20:53:32 +00001360
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001361 if (x < 0) {
1362 sign = 1;
1363 x = -x;
1364 }
1365 else
1366 sign = 0;
Tim Peters9905b942003-03-20 20:53:32 +00001367
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001368 f = frexp(x, &e);
Tim Peters9905b942003-03-20 20:53:32 +00001369
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001370 /* Normalize f to be in the range [1.0, 2.0) */
1371 if (0.5 <= f && f < 1.0) {
1372 f *= 2.0;
1373 e--;
1374 }
1375 else if (f == 0.0)
1376 e = 0;
1377 else {
1378 PyErr_SetString(PyExc_SystemError,
1379 "frexp() result out of range");
1380 return -1;
1381 }
1382
1383 if (e >= 128)
1384 goto Overflow;
1385 else if (e < -126) {
1386 /* Gradual underflow */
1387 f = ldexp(f, 126 + e);
1388 e = 0;
1389 }
1390 else if (!(e == 0 && f == 0.0)) {
1391 e += 127;
1392 f -= 1.0; /* Get rid of leading 1 */
1393 }
1394
1395 f *= 8388608.0; /* 2**23 */
1396 fbits = (unsigned int)(f + 0.5); /* Round */
1397 assert(fbits <= 8388608);
1398 if (fbits >> 23) {
1399 /* The carry propagated out of a string of 23 1 bits. */
1400 fbits = 0;
1401 ++e;
1402 if (e >= 255)
1403 goto Overflow;
1404 }
1405
1406 /* First byte */
1407 *p = (sign << 7) | (e >> 1);
1408 p += incr;
1409
1410 /* Second byte */
1411 *p = (char) (((e & 1) << 7) | (fbits >> 16));
1412 p += incr;
1413
1414 /* Third byte */
1415 *p = (fbits >> 8) & 0xFF;
1416 p += incr;
1417
1418 /* Fourth byte */
1419 *p = fbits & 0xFF;
1420
1421 /* Done */
1422 return 0;
1423
1424 Overflow:
1425 PyErr_SetString(PyExc_OverflowError,
1426 "float too large to pack with f format");
Tim Peters9905b942003-03-20 20:53:32 +00001427 return -1;
1428 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001429 else {
Michael W. Hudson3095ad02005-06-30 00:02:26 +00001430 float y = (float)x;
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001431 const char *s = (char*)&y;
1432 int i, incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00001433
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001434 if ((float_format == ieee_little_endian_format && !le)
1435 || (float_format == ieee_big_endian_format && le)) {
1436 p += 3;
1437 incr = -1;
1438 }
1439
1440 for (i = 0; i < 4; i++) {
1441 *p = *s++;
1442 p += incr;
1443 }
1444 return 0;
Tim Peters9905b942003-03-20 20:53:32 +00001445 }
Tim Peters9905b942003-03-20 20:53:32 +00001446}
1447
1448int
1449_PyFloat_Pack8(double x, unsigned char *p, int le)
1450{
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001451 if (double_format == unknown_format) {
1452 unsigned char sign;
1453 int e;
1454 double f;
1455 unsigned int fhi, flo;
1456 int incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00001457
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001458 if (le) {
1459 p += 7;
1460 incr = -1;
1461 }
Tim Peters9905b942003-03-20 20:53:32 +00001462
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001463 if (x < 0) {
1464 sign = 1;
1465 x = -x;
1466 }
1467 else
1468 sign = 0;
Tim Peters9905b942003-03-20 20:53:32 +00001469
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001470 f = frexp(x, &e);
Tim Peters9905b942003-03-20 20:53:32 +00001471
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001472 /* Normalize f to be in the range [1.0, 2.0) */
1473 if (0.5 <= f && f < 1.0) {
1474 f *= 2.0;
1475 e--;
1476 }
1477 else if (f == 0.0)
1478 e = 0;
1479 else {
1480 PyErr_SetString(PyExc_SystemError,
1481 "frexp() result out of range");
1482 return -1;
1483 }
1484
1485 if (e >= 1024)
1486 goto Overflow;
1487 else if (e < -1022) {
1488 /* Gradual underflow */
1489 f = ldexp(f, 1022 + e);
1490 e = 0;
1491 }
1492 else if (!(e == 0 && f == 0.0)) {
1493 e += 1023;
1494 f -= 1.0; /* Get rid of leading 1 */
1495 }
1496
1497 /* fhi receives the high 28 bits; flo the low 24 bits (== 52 bits) */
1498 f *= 268435456.0; /* 2**28 */
1499 fhi = (unsigned int)f; /* Truncate */
1500 assert(fhi < 268435456);
1501
1502 f -= (double)fhi;
1503 f *= 16777216.0; /* 2**24 */
1504 flo = (unsigned int)(f + 0.5); /* Round */
1505 assert(flo <= 16777216);
1506 if (flo >> 24) {
1507 /* The carry propagated out of a string of 24 1 bits. */
1508 flo = 0;
1509 ++fhi;
1510 if (fhi >> 28) {
1511 /* And it also progagated out of the next 28 bits. */
1512 fhi = 0;
1513 ++e;
1514 if (e >= 2047)
1515 goto Overflow;
1516 }
1517 }
1518
1519 /* First byte */
1520 *p = (sign << 7) | (e >> 4);
1521 p += incr;
1522
1523 /* Second byte */
1524 *p = (unsigned char) (((e & 0xF) << 4) | (fhi >> 24));
1525 p += incr;
1526
1527 /* Third byte */
1528 *p = (fhi >> 16) & 0xFF;
1529 p += incr;
1530
1531 /* Fourth byte */
1532 *p = (fhi >> 8) & 0xFF;
1533 p += incr;
1534
1535 /* Fifth byte */
1536 *p = fhi & 0xFF;
1537 p += incr;
1538
1539 /* Sixth byte */
1540 *p = (flo >> 16) & 0xFF;
1541 p += incr;
1542
1543 /* Seventh byte */
1544 *p = (flo >> 8) & 0xFF;
1545 p += incr;
1546
1547 /* Eighth byte */
1548 *p = flo & 0xFF;
1549 p += incr;
1550
1551 /* Done */
1552 return 0;
1553
1554 Overflow:
1555 PyErr_SetString(PyExc_OverflowError,
1556 "float too large to pack with d format");
Tim Peters9905b942003-03-20 20:53:32 +00001557 return -1;
1558 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001559 else {
1560 const char *s = (char*)&x;
1561 int i, incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00001562
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001563 if ((double_format == ieee_little_endian_format && !le)
1564 || (double_format == ieee_big_endian_format && le)) {
1565 p += 7;
1566 incr = -1;
Tim Peters9905b942003-03-20 20:53:32 +00001567 }
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001568
1569 for (i = 0; i < 8; i++) {
1570 *p = *s++;
1571 p += incr;
1572 }
1573 return 0;
Tim Peters9905b942003-03-20 20:53:32 +00001574 }
Tim Peters9905b942003-03-20 20:53:32 +00001575}
1576
1577double
1578_PyFloat_Unpack4(const unsigned char *p, int le)
1579{
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001580 if (float_format == unknown_format) {
1581 unsigned char sign;
1582 int e;
1583 unsigned int f;
1584 double x;
1585 int incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00001586
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001587 if (le) {
1588 p += 3;
1589 incr = -1;
1590 }
1591
1592 /* First byte */
1593 sign = (*p >> 7) & 1;
1594 e = (*p & 0x7F) << 1;
1595 p += incr;
1596
1597 /* Second byte */
1598 e |= (*p >> 7) & 1;
1599 f = (*p & 0x7F) << 16;
1600 p += incr;
1601
1602 if (e == 255) {
1603 PyErr_SetString(
1604 PyExc_ValueError,
1605 "can't unpack IEEE 754 special value "
1606 "on non-IEEE platform");
1607 return -1;
1608 }
1609
1610 /* Third byte */
1611 f |= *p << 8;
1612 p += incr;
1613
1614 /* Fourth byte */
1615 f |= *p;
1616
1617 x = (double)f / 8388608.0;
1618
1619 /* XXX This sadly ignores Inf/NaN issues */
1620 if (e == 0)
1621 e = -126;
1622 else {
1623 x += 1.0;
1624 e -= 127;
1625 }
1626 x = ldexp(x, e);
1627
1628 if (sign)
1629 x = -x;
1630
1631 return x;
Tim Peters9905b942003-03-20 20:53:32 +00001632 }
Tim Peters9905b942003-03-20 20:53:32 +00001633 else {
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001634 if ((float_format == ieee_little_endian_format && !le)
1635 || (float_format == ieee_big_endian_format && le)) {
1636 char buf[8];
1637 char *d = &buf[3];
1638 int i;
Tim Peters9905b942003-03-20 20:53:32 +00001639
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001640 for (i = 0; i < 4; i++) {
1641 *d-- = *p++;
1642 }
1643 return *(float*)&buf[0];
1644 }
1645 else {
1646 return *(float*)p;
1647 }
1648 }
Tim Peters9905b942003-03-20 20:53:32 +00001649}
1650
1651double
1652_PyFloat_Unpack8(const unsigned char *p, int le)
1653{
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001654 if (double_format == unknown_format) {
1655 unsigned char sign;
1656 int e;
1657 unsigned int fhi, flo;
1658 double x;
1659 int incr = 1;
Tim Peters9905b942003-03-20 20:53:32 +00001660
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001661 if (le) {
1662 p += 7;
1663 incr = -1;
1664 }
1665
1666 /* First byte */
1667 sign = (*p >> 7) & 1;
1668 e = (*p & 0x7F) << 4;
1669
1670 p += incr;
1671
1672 /* Second byte */
1673 e |= (*p >> 4) & 0xF;
1674 fhi = (*p & 0xF) << 24;
1675 p += incr;
1676
1677 if (e == 2047) {
1678 PyErr_SetString(
1679 PyExc_ValueError,
1680 "can't unpack IEEE 754 special value "
1681 "on non-IEEE platform");
1682 return -1.0;
1683 }
1684
1685 /* Third byte */
1686 fhi |= *p << 16;
1687 p += incr;
1688
1689 /* Fourth byte */
1690 fhi |= *p << 8;
1691 p += incr;
1692
1693 /* Fifth byte */
1694 fhi |= *p;
1695 p += incr;
1696
1697 /* Sixth byte */
1698 flo = *p << 16;
1699 p += incr;
1700
1701 /* Seventh byte */
1702 flo |= *p << 8;
1703 p += incr;
1704
1705 /* Eighth byte */
1706 flo |= *p;
1707
1708 x = (double)fhi + (double)flo / 16777216.0; /* 2**24 */
1709 x /= 268435456.0; /* 2**28 */
1710
1711 if (e == 0)
1712 e = -1022;
1713 else {
1714 x += 1.0;
1715 e -= 1023;
1716 }
1717 x = ldexp(x, e);
1718
1719 if (sign)
1720 x = -x;
1721
1722 return x;
Tim Peters9905b942003-03-20 20:53:32 +00001723 }
Tim Peters9905b942003-03-20 20:53:32 +00001724 else {
Michael W. Hudsonba283e22005-05-27 15:23:20 +00001725 if ((double_format == ieee_little_endian_format && !le)
1726 || (double_format == ieee_big_endian_format && le)) {
1727 char buf[8];
1728 char *d = &buf[7];
1729 int i;
1730
1731 for (i = 0; i < 8; i++) {
1732 *d-- = *p++;
1733 }
1734 return *(double*)&buf[0];
1735 }
1736 else {
1737 return *(double*)p;
1738 }
Tim Peters9905b942003-03-20 20:53:32 +00001739 }
Tim Peters9905b942003-03-20 20:53:32 +00001740}