floatobject.c 47.1 KB
Newer Older
1

Guido van Rossum's avatar
Guido van Rossum committed
2 3
/* Float object implementation */

Guido van Rossum's avatar
Guido van Rossum committed
4 5 6
/* XXX There should be overflow checks here, but it's hard to check
   for any kind of float exception without losing portability. */

7
#include "Python.h"
8
#include "structseq.h"
Guido van Rossum's avatar
Guido van Rossum committed
9

Guido van Rossum's avatar
Guido van Rossum committed
10
#include <ctype.h>
11
#include <float.h>
Guido van Rossum's avatar
Guido van Rossum committed
12

13 14 15 16
#ifdef HAVE_IEEEFP_H
#include <ieeefp.h>
#endif

17

18 19 20 21 22
#ifdef _OSF_SOURCE
/* OSF1 5.1 doesn't make this available with XOPEN_SOURCE_EXTENDED defined */
extern int finite(double);
#endif

23 24
/* Special free list -- see comments for same code in intobject.c. */
#define BLOCK_SIZE	1000	/* 1K less typical malloc overhead */
25
#define BHEAD_SIZE	8	/* Enough for a 64-bit pointer */
26
#define N_FLOATOBJECTS	((BLOCK_SIZE - BHEAD_SIZE) / sizeof(PyFloatObject))
27 28 29 30 31 32 33 34 35 36 37

struct _floatblock {
	struct _floatblock *next;
	PyFloatObject objects[N_FLOATOBJECTS];
};

typedef struct _floatblock PyFloatBlock;

static PyFloatBlock *block_list = NULL;
static PyFloatObject *free_list = NULL;

38
static PyFloatObject *
39
fill_free_list(void)
40 41
{
	PyFloatObject *p, *q;
42 43
	/* XXX Float blocks escape the object heap. Use PyObject_MALLOC ??? */
	p = (PyFloatObject *) PyMem_MALLOC(sizeof(PyFloatBlock));
44
	if (p == NULL)
45
		return (PyFloatObject *) PyErr_NoMemory();
46 47 48
	((PyFloatBlock *)p)->next = block_list;
	block_list = (PyFloatBlock *)p;
	p = &((PyFloatBlock *)p)->objects[0];
49 50
	q = p + N_FLOATOBJECTS;
	while (--q > p)
51 52
		Py_TYPE(q) = (struct _typeobject *)(q-1);
	Py_TYPE(q) = NULL;
53 54 55
	return p + N_FLOATOBJECTS - 1;
}

56 57 58 59 60 61 62 63 64 65 66 67
double
PyFloat_GetMax(void)
{
	return DBL_MAX;
}

double
PyFloat_GetMin(void)
{
	return DBL_MIN;
}

68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
static PyTypeObject FloatInfoType;

PyDoc_STRVAR(floatinfo__doc__,
"sys.floatinfo\n\
\n\
A structseq holding information about the float type. It contains low level\n\
information about the precision and internal representation. Please study\n\
your system's :file:`float.h` for more information.");

static PyStructSequence_Field floatinfo_fields[] = {
	{"max",		"DBL_MAX -- maximum representable finite float"},
	{"max_exp",	"DBL_MAX_EXP -- maximum int e such that radix**(e-1) "
			"is representable"},
	{"max_10_exp",	"DBL_MAX_10_EXP -- maximum int e such that 10**e "
			"is representable"},
	{"min",		"DBL_MIN -- Minimum positive normalizer float"},
	{"min_exp",	"DBL_MIN_EXP -- minimum int e such that radix**(e-1) "
			"is a normalized float"},
	{"min_10_exp",	"DBL_MIN_10_EXP -- minimum int e such that 10**e is "
			"a normalized"},
	{"dig",		"DBL_DIG -- digits"},
	{"mant_dig",	"DBL_MANT_DIG -- mantissa digits"},
	{"epsilon",	"DBL_EPSILON -- Difference between 1 and the next "
			"representable float"},
	{"radix",	"FLT_RADIX -- radix of exponent"},
	{"rounds",	"FLT_ROUNDS -- addition rounds"},
	{0}
};

static PyStructSequence_Desc floatinfo_desc = {
	"sys.floatinfo",	/* name */
	floatinfo__doc__,	/* doc */
	floatinfo_fields,	/* fields */
	11
};

104 105 106
PyObject *
PyFloat_GetInfo(void)
{
107
	PyObject* floatinfo;
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
	int pos = 0;

	floatinfo = PyStructSequence_New(&FloatInfoType);
	if (floatinfo == NULL) {
		return NULL;
	}

#define SetIntFlag(flag) \
	PyStructSequence_SET_ITEM(floatinfo, pos++, PyLong_FromLong(flag))
#define SetDblFlag(flag) \
	PyStructSequence_SET_ITEM(floatinfo, pos++, PyFloat_FromDouble(flag))

	SetDblFlag(DBL_MAX);
	SetIntFlag(DBL_MAX_EXP);
	SetIntFlag(DBL_MAX_10_EXP);
	SetDblFlag(DBL_MIN);
	SetIntFlag(DBL_MIN_EXP);
	SetIntFlag(DBL_MIN_10_EXP);
	SetIntFlag(DBL_DIG);
	SetIntFlag(DBL_MANT_DIG);
	SetDblFlag(DBL_EPSILON);
	SetIntFlag(FLT_RADIX);
	SetIntFlag(FLT_ROUNDS);
#undef SetIntFlag
#undef SetDblFlag
	
	if (PyErr_Occurred()) {
		Py_CLEAR(floatinfo);
		return NULL;
	}
	return floatinfo;
139 140
}

141 142
PyObject *
PyFloat_FromDouble(double fval)
Guido van Rossum's avatar
Guido van Rossum committed
143
{
144 145 146 147 148
	register PyFloatObject *op;
	if (free_list == NULL) {
		if ((free_list = fill_free_list()) == NULL)
			return NULL;
	}
149
	/* Inline PyObject_New */
150
	op = free_list;
151
	free_list = (PyFloatObject *)Py_TYPE(op);
152
	PyObject_INIT(op, &PyFloat_Type);
Guido van Rossum's avatar
Guido van Rossum committed
153
	op->ob_fval = fval;
154
	return (PyObject *) op;
Guido van Rossum's avatar
Guido van Rossum committed
155 156
}

157
PyObject *
158
PyFloat_FromString(PyObject *v)
159
{
160
	const char *s, *last, *end, *sp;
161
	double x;
162
	char buffer[256]; /* for errors */
163
	char *s_buffer = NULL;
Martin v. Löwis's avatar
Martin v. Löwis committed
164
	Py_ssize_t len;
165
	PyObject *result = NULL;
166

167
	if (PyUnicode_Check(v)) {
168 169 170
		s_buffer = (char *)PyMem_MALLOC(PyUnicode_GET_SIZE(v)+1);
		if (s_buffer == NULL)
			return PyErr_NoMemory();
171
		if (PyUnicode_EncodeDecimal(PyUnicode_AS_UNICODE(v),
172
					    PyUnicode_GET_SIZE(v),
173
					    s_buffer,
174
					    NULL))
Neal Norwitz's avatar
Neal Norwitz committed
175
			goto error;
176
		s = s_buffer;
Martin v. Löwis's avatar
Martin v. Löwis committed
177
		len = strlen(s);
178
	}
179 180
	else if (PyObject_AsCharBuffer(v, &s, &len)) {
		PyErr_SetString(PyExc_TypeError,
181
				"float() argument must be a string or a number");
182
		return NULL;
183
	}
184

185
	last = s + len;
186 187
	while (*s && isspace(Py_CHARMASK(*s)))
		s++;
188
	if (*s == '\0') {
189
		PyErr_SetString(PyExc_ValueError, "empty string for float()");
190
		goto error;
191
	}
192
	sp = s;
193 194 195 196 197 198 199
	/* We don't care about overflow or underflow.  If the platform supports
	 * them, infinities and signed zeroes (on underflow) are fine.
	 * However, strtod can return 0 for denormalized numbers, where atof
	 * does not.  So (alas!) we special-case a zero result.  Note that
	 * whether strtod sets errno on underflow is not defined, so we can't
	 * key off errno.
         */
200
	PyFPE_START_PROTECT("strtod", goto error)
201
	x = PyOS_ascii_strtod(s, (char **)&end);
202
	PyFPE_END_PROTECT(x)
203 204
	errno = 0;
	/* Believe it or not, Solaris 2.6 can move end *beyond* the null
205
	   byte at the end of the string, when the input is inf(inity). */
206 207
	if (end > last)
		end = last;
208
	/* Check for inf and nan. This is done late because it rarely happens. */
209
	if (end == s) {
210 211 212 213 214 215 216 217 218 219 220
		char *p = (char*)sp;
		int sign = 1;

		if (*p == '-') {
			sign = -1;
			p++;
		}
		if (*p == '+') {
			p++;
		}
		if (PyOS_strnicmp(p, "inf", 4) == 0) {
221
			Py_RETURN_INF(sign);
222 223 224
		}
#ifdef Py_NAN
		if(PyOS_strnicmp(p, "nan", 4) == 0) {
225
			Py_RETURN_NAN;
226 227
		}
#endif
228 229
		PyOS_snprintf(buffer, sizeof(buffer),
			      "invalid literal for float(): %.200s", s);
230
		PyErr_SetString(PyExc_ValueError, buffer);
231
		goto error;
232 233 234
	}
	/* Since end != s, the platform made *some* kind of sense out
	   of the input.  Trust it. */
235 236 237
	while (*end && isspace(Py_CHARMASK(*end)))
		end++;
	if (*end != '\0') {
238 239
		PyOS_snprintf(buffer, sizeof(buffer),
			      "invalid literal for float(): %.200s", s);
240
		PyErr_SetString(PyExc_ValueError, buffer);
241
		goto error;
242
	}
243
	else if (end != last) {
244 245
		PyErr_SetString(PyExc_ValueError,
				"null byte in argument for float()");
246
		goto error;
247
	}
248 249 250
	if (x == 0.0) {
		/* See above -- may have been strtod being anal
		   about denorms. */
251
		PyFPE_START_PROTECT("atof", goto error)
252
		x = PyOS_ascii_atof(s);
253
		PyFPE_END_PROTECT(x)
254
		errno = 0;    /* whether atof ever set errno is undefined */
255
	}
256 257 258 259 260
	result = PyFloat_FromDouble(x);
  error:
	if (s_buffer)
		PyMem_FREE(s_buffer);
	return result;
261 262
}

263
static void
264
float_dealloc(PyFloatObject *op)
265
{
266
	if (PyFloat_CheckExact(op)) {
267
		Py_TYPE(op) = (struct _typeobject *)free_list;
268 269 270
		free_list = op;
	}
	else
271
		Py_TYPE(op)->tp_free((PyObject *)op);
272 273
}

Guido van Rossum's avatar
Guido van Rossum committed
274
double
275
PyFloat_AsDouble(PyObject *op)
Guido van Rossum's avatar
Guido van Rossum committed
276
{
277 278
	PyNumberMethods *nb;
	PyFloatObject *fo;
279
	double val;
280

281 282
	if (op && PyFloat_Check(op))
		return PyFloat_AS_DOUBLE((PyFloatObject*) op);
283

284
	if (op == NULL) {
285
		PyErr_BadArgument();
Guido van Rossum's avatar
Guido van Rossum committed
286 287
		return -1;
	}
288

289
	if ((nb = Py_TYPE(op)->tp_as_number) == NULL || nb->nb_float == NULL) {
290 291 292 293
		PyErr_SetString(PyExc_TypeError, "a float is required");
		return -1;
	}

294
	fo = (PyFloatObject*) (*nb->nb_float) (op);
295 296
	if (fo == NULL)
		return -1;
297 298 299
	if (!PyFloat_Check(fo)) {
		PyErr_SetString(PyExc_TypeError,
				"nb_float should return float object");
300 301
		return -1;
	}
302

303 304
	val = PyFloat_AS_DOUBLE(fo);
	Py_DECREF(fo);
305

306
	return val;
Guido van Rossum's avatar
Guido van Rossum committed
307 308 309 310
}

/* Methods */

311
static void
312
format_double(char *buf, size_t buflen, double ob_fval, int precision)
Guido van Rossum's avatar
Guido van Rossum committed
313 314
{
	register char *cp;
315
	char format[32];
316 317 318
	int i;

	/* Subroutine for float_repr, float_str and float_print.
Guido van Rossum's avatar
Guido van Rossum committed
319 320 321 322
	   We want float numbers to be recognizable as such,
	   i.e., they should contain a decimal point or an exponent.
	   However, %g may print the number as an integer;
	   in such cases, we append ".0" to the string. */
323

324
	PyOS_snprintf(format, 32, "%%.%ig", precision);
325
	PyOS_ascii_formatd(buf, buflen, format, ob_fval);
Guido van Rossum's avatar
Guido van Rossum committed
326 327 328 329 330 331
	cp = buf;
	if (*cp == '-')
		cp++;
	for (; *cp != '\0'; cp++) {
		/* Any non-digit means it's not an integer;
		   this takes care of NAN and INF as well. */
332
		if (!isdigit(Py_CHARMASK(*cp)))
Guido van Rossum's avatar
Guido van Rossum committed
333 334 335 336 337 338
			break;
	}
	if (*cp == '\0') {
		*cp++ = '.';
		*cp++ = '0';
		*cp++ = '\0';
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
		return;
	}
	/* Checking the next three chars should be more than enough to
	 * detect inf or nan, even on Windows. We check for inf or nan
	 * at last because they are rare cases.
	 */
	for (i=0; *cp != '\0' && i<3; cp++, i++) {
		if (isdigit(Py_CHARMASK(*cp)) || *cp == '.')
			continue;
		/* found something that is neither a digit nor point
		 * it might be a NaN or INF
		 */
#ifdef Py_NAN
		if (Py_IS_NAN(ob_fval)) {
			strcpy(buf, "nan");
		}
                else
#endif
		if (Py_IS_INFINITY(ob_fval)) {
			cp = buf;
			if (*cp == '-')
				cp++;
			strcpy(cp, "inf");
		}
		break;
Guido van Rossum's avatar
Guido van Rossum committed
364
	}
365

Guido van Rossum's avatar
Guido van Rossum committed
366 367
}

368 369
static void
format_float(char *buf, size_t buflen, PyFloatObject *v, int precision)
370
{
371 372
	assert(PyFloat_Check(v));
	format_double(buf, buflen, PyFloat_AS_DOUBLE(v), precision);
373 374
}

375
/* Macro and helper that convert PyObject obj to a C double and store
376
   the value in dbl.  If conversion to double raises an exception, obj is
377 378 379 380
   set to NULL, and the function invoking this macro returns NULL.  If
   obj is not of float, int or long type, Py_NotImplemented is incref'ed,
   stored in obj, and returned from the function invoking this macro.
*/
381 382 383 384 385 386 387
#define CONVERT_TO_DOUBLE(obj, dbl)			\
	if (PyFloat_Check(obj))				\
		dbl = PyFloat_AS_DOUBLE(obj);		\
	else if (convert_to_double(&(obj), &(dbl)) < 0)	\
		return obj;

static int
388
convert_to_double(PyObject **v, double *dbl)
389 390
{
	register PyObject *obj = *v;
391

392
	if (PyLong_Check(obj)) {
393
		*dbl = PyLong_AsDouble(obj);
394 395 396 397
		if (*dbl == -1.0 && PyErr_Occurred()) {
			*v = NULL;
			return -1;
		}
398 399 400 401 402 403 404 405 406
	}
	else {
		Py_INCREF(Py_NotImplemented);
		*v = Py_NotImplemented;
		return -1;
	}
	return 0;
}

407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
/* Precisions used by repr() and str(), respectively.

   The repr() precision (17 significant decimal digits) is the minimal number
   that is guaranteed to have enough precision so that if the number is read
   back in the exact same binary value is recreated.  This is true for IEEE
   floating point by design, and also happens to work for all other modern
   hardware.

   The str() precision is chosen so that in most cases, the rounding noise
   created by various operations is suppressed, while giving plenty of
   precision for practical use.

*/

#define PREC_REPR	17
#define PREC_STR	12

424
static PyObject *
425
float_repr(PyFloatObject *v)
Guido van Rossum's avatar
Guido van Rossum committed
426
{
427 428 429
	char buf[100];
	format_float(buf, sizeof(buf), v, PREC_REPR);

430
	return PyUnicode_FromString(buf);
431 432 433
}

static PyObject *
434
float_str(PyFloatObject *v)
435 436
{
	char buf[100];
437
	format_float(buf, sizeof(buf), v, PREC_STR);
438
	return PyUnicode_FromString(buf);
Guido van Rossum's avatar
Guido van Rossum committed
439 440
}

441 442 443 444 445 446 447 448 449 450 451 452 453 454 455
/* Comparison is pretty much a nightmare.  When comparing float to float,
 * we do it as straightforwardly (and long-windedly) as conceivable, so
 * that, e.g., Python x == y delivers the same result as the platform
 * C x == y when x and/or y is a NaN.
 * When mixing float with an integer type, there's no good *uniform* approach.
 * Converting the double to an integer obviously doesn't work, since we
 * may lose info from fractional bits.  Converting the integer to a double
 * also has two failure modes:  (1) a long int may trigger overflow (too
 * large to fit in the dynamic range of a C double); (2) even a C long may have
 * more bits than fit in a C double (e.g., on a a 64-bit box long may have
 * 63 bits of precision, but a C double probably has only 53), and then
 * we can falsely claim equality when low-order integer bits are lost by
 * coercion to double.  So this part is painful too.
 */

456 457 458 459 460 461
static PyObject*
float_richcompare(PyObject *v, PyObject *w, int op)
{
	double i, j;
	int r = 0;

462 463 464 465 466 467 468 469 470
	assert(PyFloat_Check(v));
	i = PyFloat_AS_DOUBLE(v);

	/* Switch on the type of w.  Set i and j to doubles to be compared,
	 * and op to the richcomp to use.
	 */
	if (PyFloat_Check(w))
		j = PyFloat_AS_DOUBLE(w);

471
	else if (!Py_IS_FINITE(i)) {
472
		if (PyLong_Check(w))
473 474 475
			/* If i is an infinity, its magnitude exceeds any
			 * finite integer, so it doesn't matter which int we
			 * compare i with.  If i is a NaN, similarly.
476 477 478 479 480
			 */
			j = 0.0;
		else
			goto Unimplemented;
	}
481

482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
	else if (PyLong_Check(w)) {
		int vsign = i == 0.0 ? 0 : i < 0.0 ? -1 : 1;
		int wsign = _PyLong_Sign(w);
		size_t nbits;
		int exponent;

		if (vsign != wsign) {
			/* Magnitudes are irrelevant -- the signs alone
			 * determine the outcome.
			 */
			i = (double)vsign;
			j = (double)wsign;
			goto Compare;
		}
		/* The signs are the same. */
		/* Convert w to a double if it fits.  In particular, 0 fits. */
		nbits = _PyLong_NumBits(w);
		if (nbits == (size_t)-1 && PyErr_Occurred()) {
			/* This long is so large that size_t isn't big enough
501 502 503 504
			 * to hold the # of bits.  Replace with little doubles
			 * that give the same outcome -- w is so large that
			 * its magnitude must exceed the magnitude of any
			 * finite float.
505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530
			 */
			PyErr_Clear();
			i = (double)vsign;
			assert(wsign != 0);
			j = wsign * 2.0;
			goto Compare;
		}
		if (nbits <= 48) {
			j = PyLong_AsDouble(w);
			/* It's impossible that <= 48 bits overflowed. */
			assert(j != -1.0 || ! PyErr_Occurred());
			goto Compare;
		}
		assert(wsign != 0); /* else nbits was 0 */
		assert(vsign != 0); /* if vsign were 0, then since wsign is
		                     * not 0, we would have taken the
		                     * vsign != wsign branch at the start */
		/* We want to work with non-negative numbers. */
		if (vsign < 0) {
			/* "Multiply both sides" by -1; this also swaps the
			 * comparator.
			 */
			i = -i;
			op = _Py_SwappedOp[op];
		}
		assert(i > 0.0);
531
		(void) frexp(i, &exponent);
532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575
		/* exponent is the # of bits in v before the radix point;
		 * we know that nbits (the # of bits in w) > 48 at this point
		 */
		if (exponent < 0 || (size_t)exponent < nbits) {
			i = 1.0;
			j = 2.0;
			goto Compare;
		}
		if ((size_t)exponent > nbits) {
			i = 2.0;
			j = 1.0;
			goto Compare;
		}
		/* v and w have the same number of bits before the radix
		 * point.  Construct two longs that have the same comparison
		 * outcome.
		 */
		{
			double fracpart;
			double intpart;
			PyObject *result = NULL;
			PyObject *one = NULL;
			PyObject *vv = NULL;
			PyObject *ww = w;

			if (wsign < 0) {
				ww = PyNumber_Negative(w);
				if (ww == NULL)
					goto Error;
			}
			else
				Py_INCREF(ww);

			fracpart = modf(i, &intpart);
			vv = PyLong_FromDouble(intpart);
			if (vv == NULL)
				goto Error;

			if (fracpart != 0.0) {
				/* Shift left, and or a 1 bit into vv
				 * to represent the lost fraction.
				 */
				PyObject *temp;

576
				one = PyLong_FromLong(1);
577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614
				if (one == NULL)
					goto Error;

				temp = PyNumber_Lshift(ww, one);
				if (temp == NULL)
					goto Error;
				Py_DECREF(ww);
				ww = temp;

				temp = PyNumber_Lshift(vv, one);
				if (temp == NULL)
					goto Error;
				Py_DECREF(vv);
				vv = temp;

				temp = PyNumber_Or(vv, one);
				if (temp == NULL)
					goto Error;
				Py_DECREF(vv);
				vv = temp;
			}

			r = PyObject_RichCompareBool(vv, ww, op);
			if (r < 0)
				goto Error;
			result = PyBool_FromLong(r);
 		 Error:
 		 	Py_XDECREF(vv);
 		 	Py_XDECREF(ww);
 		 	Py_XDECREF(one);
 		 	return result;
		}
	} /* else if (PyLong_Check(w)) */

	else	/* w isn't float, int, or long */
		goto Unimplemented;

 Compare:
615 616 617
	PyFPE_START_PROTECT("richcompare", return NULL)
	switch (op) {
	case Py_EQ:
618
		r = i == j;
619 620
		break;
	case Py_NE:
621
		r = i != j;
622 623
		break;
	case Py_LE:
624
		r = i <= j;
625 626
		break;
	case Py_GE:
627
		r = i >= j;
628 629
		break;
	case Py_LT:
630
		r = i < j;
631 632
		break;
	case Py_GT:
633
		r = i > j;
634 635
		break;
	}
636
	PyFPE_END_PROTECT(r)
637
	return PyBool_FromLong(r);
638 639 640 641

 Unimplemented:
	Py_INCREF(Py_NotImplemented);
	return Py_NotImplemented;
642 643
}

644
static long
645
float_hash(PyFloatObject *v)
646
{
647
	return _Py_HashDouble(v->ob_fval);
648 649
}

650
static PyObject *
651
float_add(PyObject *v, PyObject *w)
Guido van Rossum's avatar
Guido van Rossum committed
652
{
653 654 655
	double a,b;
	CONVERT_TO_DOUBLE(v, a);
	CONVERT_TO_DOUBLE(w, b);
656
	PyFPE_START_PROTECT("add", return 0)
657 658 659
	a = a + b;
	PyFPE_END_PROTECT(a)
	return PyFloat_FromDouble(a);
Guido van Rossum's avatar
Guido van Rossum committed
660 661
}

662
static PyObject *
663
float_sub(PyObject *v, PyObject *w)
Guido van Rossum's avatar
Guido van Rossum committed
664
{
665 666 667
	double a,b;
	CONVERT_TO_DOUBLE(v, a);
	CONVERT_TO_DOUBLE(w, b);
668
	PyFPE_START_PROTECT("subtract", return 0)
669 670 671
	a = a - b;
	PyFPE_END_PROTECT(a)
	return PyFloat_FromDouble(a);
Guido van Rossum's avatar
Guido van Rossum committed
672 673
}

674
static PyObject *
675
float_mul(PyObject *v, PyObject *w)
Guido van Rossum's avatar
Guido van Rossum committed
676
{
677 678 679
	double a,b;
	CONVERT_TO_DOUBLE(v, a);
	CONVERT_TO_DOUBLE(w, b);
680
	PyFPE_START_PROTECT("multiply", return 0)
681 682 683
	a = a * b;
	PyFPE_END_PROTECT(a)
	return PyFloat_FromDouble(a);
Guido van Rossum's avatar
Guido van Rossum committed
684 685
}

686
static PyObject *
687
float_div(PyObject *v, PyObject *w)
Guido van Rossum's avatar
Guido van Rossum committed
688
{
689 690 691
	double a,b;
	CONVERT_TO_DOUBLE(v, a);
	CONVERT_TO_DOUBLE(w, b);
692
#ifdef Py_NAN
693
	if (b == 0.0) {
694 695
		PyErr_SetString(PyExc_ZeroDivisionError,
				"float division");
Guido van Rossum's avatar
Guido van Rossum committed
696 697
		return NULL;
	}
698
#endif
699
	PyFPE_START_PROTECT("divide", return 0)
700 701 702
	a = a / b;
	PyFPE_END_PROTECT(a)
	return PyFloat_FromDouble(a);
Guido van Rossum's avatar
Guido van Rossum committed
703 704
}

705
static PyObject *
706
float_rem(PyObject *v, PyObject *w)
Guido van Rossum's avatar
Guido van Rossum committed
707
{
708
	double vx, wx;
Guido van Rossum's avatar
Guido van Rossum committed
709
	double mod;
710 711 712
	CONVERT_TO_DOUBLE(v, vx);
	CONVERT_TO_DOUBLE(w, wx);
#ifdef Py_NAN
Guido van Rossum's avatar
Guido van Rossum committed
713
	if (wx == 0.0) {
714 715
		PyErr_SetString(PyExc_ZeroDivisionError,
				"float modulo");
Guido van Rossum's avatar
Guido van Rossum committed
716 717
		return NULL;
	}
718
#endif
719
	PyFPE_START_PROTECT("modulo", return 0)
720
	mod = fmod(vx, wx);
Guido van Rossum's avatar
Guido van Rossum committed
721 722 723
	/* note: checking mod*wx < 0 is incorrect -- underflows to
	   0 if wx < sqrt(smallest nonzero double) */
	if (mod && ((wx < 0) != (mod < 0))) {
724 725
		mod += wx;
	}
726
	PyFPE_END_PROTECT(mod)
727
	return PyFloat_FromDouble(mod);
Guido van Rossum's avatar
Guido van Rossum committed
728 729
}

730
static PyObject *
731
float_divmod(PyObject *v, PyObject *w)
732
{
733
	double vx, wx;
Guido van Rossum's avatar
Guido van Rossum committed
734
	double div, mod, floordiv;
735 736
 	CONVERT_TO_DOUBLE(v, vx);
 	CONVERT_TO_DOUBLE(w, wx);
737
	if (wx == 0.0) {
738
		PyErr_SetString(PyExc_ZeroDivisionError, "float divmod()");
739 740
		return NULL;
	}
741
	PyFPE_START_PROTECT("divmod", return 0)
742
	mod = fmod(vx, wx);
743
	/* fmod is typically exact, so vx-mod is *mathematically* an
Guido van Rossum's avatar
Guido van Rossum committed
744 745 746 747 748
	   exact multiple of wx.  But this is fp arithmetic, and fp
	   vx - mod is an approximation; the result is that div may
	   not be an exact integral value after the division, although
	   it will always be very close to one.
	*/
749
	div = (vx - mod) / wx;
750 751 752 753 754 755 756 757 758 759 760 761
	if (mod) {
		/* ensure the remainder has the same sign as the denominator */
		if ((wx < 0) != (mod < 0)) {
			mod += wx;
			div -= 1.0;
		}
	}
	else {
		/* the remainder is zero, and in the presence of signed zeroes
		   fmod returns different results across platforms; ensure
		   it has the same sign as the denominator; we'd like to do
		   "mod = wx * 0.0", but that may get optimized away */
762
		mod *= mod;  /* hide "mod = +0" from optimizer */
763 764
		if (wx < 0.0)
			mod = -mod;
765
	}
Guido van Rossum's avatar
Guido van Rossum committed
766
	/* snap quotient to nearest integral value */
767 768 769 770 771 772 773 774 775 776 777
	if (div) {
		floordiv = floor(div);
		if (div - floordiv > 0.5)
			floordiv += 1.0;
	}
	else {
		/* div is zero - get the same sign as the true quotient */
		div *= div;	/* hide "div = +0" from optimizers */
		floordiv = div * vx / wx; /* zero w/ sign of vx/wx */
	}
	PyFPE_END_PROTECT(floordiv)
Guido van Rossum's avatar
Guido van Rossum committed
778
	return Py_BuildValue("(dd)", floordiv, mod);
779 780
}

781 782 783 784 785 786
static PyObject *
float_floor_div(PyObject *v, PyObject *w)
{
	PyObject *t, *r;

	t = float_divmod(v, w);
787 788 789 790 791 792 793
	if (t == NULL || t == Py_NotImplemented)
		return t;
	assert(PyTuple_CheckExact(t));
	r = PyTuple_GET_ITEM(t, 0);
	Py_INCREF(r);
	Py_DECREF(t);
	return r;
794 795
}

796
static PyObject *
797
float_pow(PyObject *v, PyObject *w, PyObject *z)
Guido van Rossum's avatar
Guido van Rossum committed
798 799
{
	double iv, iw, ix;
800 801

	if ((PyObject *)z != Py_None) {
802
		PyErr_SetString(PyExc_TypeError, "pow() 3rd argument not "
803
			"allowed unless all arguments are integers");
804 805 806
		return NULL;
	}

807 808
	CONVERT_TO_DOUBLE(v, iv);
	CONVERT_TO_DOUBLE(w, iw);
809 810

	/* Sort out special cases here instead of relying on pow() */
811
	if (iw == 0) { 		/* v**0 is 1, even 0**0 */
812
		return PyFloat_FromDouble(1.0);
813
	}
814
	if (iv == 0.0) {  /* 0**w is error if w<0, else 1 */
815 816
		if (iw < 0.0) {
			PyErr_SetString(PyExc_ZeroDivisionError,
Fred Drake's avatar
Fred Drake committed
817
					"0.0 cannot be raised to a negative power");
818 819 820 821
			return NULL;
		}
		return PyFloat_FromDouble(0.0);
	}
822 823 824
	if (iv == 1.0) { /* 1**w is 1, even 1**inf and 1**nan */
		return PyFloat_FromDouble(1.0);
	}
825 826 827 828 829
	if (iv < 0.0) {
		/* Whether this is an error is a mess, and bumps into libm
		 * bugs so we have to figure it out ourselves.
		 */
		if (iw != floor(iw)) {
830 831 832 833
			/* Negative numbers raised to fractional powers
			 * become complex.
			 */
			return PyComplex_Type.tp_as_number->nb_power(v, w, z);
834 835 836 837 838 839 840 841 842
		}
		/* iw is an exact integer, albeit perhaps a very large one.
		 * -1 raised to an exact integer should never be exceptional.
		 * Alas, some libms (chiefly glibc as of early 2003) return
		 * NaN and set EDOM on pow(-1, large_int) if the int doesn't
		 * happen to be representable in a *C* integer.  That's a
		 * bug; we let that slide in math.pow() (which currently
		 * reflects all platform accidents), but not for Python's **.
		 */
843
		 if (iv == -1.0 && Py_IS_FINITE(iw)) {
844 845 846 847 848 849 850 851 852 853 854 855
		 	/* Return 1 if iw is even, -1 if iw is odd; there's
		 	 * no guarantee that any C integral type is big
		 	 * enough to hold iw, so we have to check this
		 	 * indirectly.
		 	 */
		 	ix = floor(iw * 0.5) * 2.0;
			return PyFloat_FromDouble(ix == iw ? 1.0 : -1.0);
		}
		/* Else iv != -1.0, and overflow or underflow are possible.
		 * Unless we're to write pow() ourselves, we have to trust
		 * the platform to do this correctly.
		 */
856
	}
857 858 859 860
	errno = 0;
	PyFPE_START_PROTECT("pow", return NULL)
	ix = pow(iv, iw);
	PyFPE_END_PROTECT(ix)
861
	Py_ADJUST_ERANGE1(ix);
Guido van Rossum's avatar
Guido van Rossum committed
862
	if (errno != 0) {
863 864 865 866 867
		/* We don't expect any errno value other than ERANGE, but
		 * the range of libm bugs appears unbounded.
		 */
		PyErr_SetFromErrno(errno == ERANGE ? PyExc_OverflowError :
						     PyExc_ValueError);
Guido van Rossum's avatar
Guido van Rossum committed
868
		return NULL;
Guido van Rossum's avatar
Guido van Rossum committed
869
	}
870
	return PyFloat_FromDouble(ix);
Guido van Rossum's avatar
Guido van Rossum committed
871 872
}

873
static PyObject *
874
float_neg(PyFloatObject *v)
Guido van Rossum's avatar
Guido van Rossum committed
875
{
876
	return PyFloat_FromDouble(-v->ob_fval);
Guido van Rossum's avatar
Guido van Rossum committed
877 878
}

879
static PyObject *
880
float_abs(PyFloatObject *v)
881
{
882
	return PyFloat_FromDouble(fabs(v->ob_fval));
Guido van Rossum's avatar
Guido van Rossum committed
883 884
}

Guido van Rossum's avatar
Guido van Rossum committed
885
static int
886
float_bool(PyFloatObject *v)
Guido van Rossum's avatar
Guido van Rossum committed
887 888 889 890
{
	return v->ob_fval != 0.0;
}

891 892 893 894 895 896 897 898 899 900
static PyObject *
float_is_integer(PyObject *v)
{
	double x = PyFloat_AsDouble(v);
	PyObject *o;
	
	if (x == -1.0 && PyErr_Occurred())
		return NULL;
	if (!Py_IS_FINITE(x))
		Py_RETURN_FALSE;
901
	errno = 0;
902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942
	PyFPE_START_PROTECT("is_integer", return NULL)
	o = (floor(x) == x) ? Py_True : Py_False;
	PyFPE_END_PROTECT(x)
	if (errno != 0) {
		PyErr_SetFromErrno(errno == ERANGE ? PyExc_OverflowError :
						     PyExc_ValueError);
		return NULL;
	}
	Py_INCREF(o);
	return o;
}

#if 0
static PyObject *
float_is_inf(PyObject *v)
{
	double x = PyFloat_AsDouble(v);
	if (x == -1.0 && PyErr_Occurred())
		return NULL;
	return PyBool_FromLong((long)Py_IS_INFINITY(x));
}

static PyObject *
float_is_nan(PyObject *v)
{
	double x = PyFloat_AsDouble(v);
	if (x == -1.0 && PyErr_Occurred())
		return NULL;
	return PyBool_FromLong((long)Py_IS_NAN(x));
}

static PyObject *
float_is_finite(PyObject *v)
{
	double x = PyFloat_AsDouble(v);
	if (x == -1.0 && PyErr_Occurred())
		return NULL;
	return PyBool_FromLong((long)Py_IS_FINITE(x));
}
#endif

943
static PyObject *
944
float_trunc(PyObject *v)
945
{
946
	double x = PyFloat_AsDouble(v);
947 948 949
	double wholepart;	/* integral portion of x, rounded toward 0 */

	(void)modf(x, &wholepart);
950 951 952 953 954 955 956 957 958 959 960 961 962 963
	/* Try to get out cheap if this fits in a Python int.  The attempt
	 * to cast to long must be protected, as C doesn't define what
	 * happens if the double is too big to fit in a long.  Some rare
	 * systems raise an exception then (RISCOS was mentioned as one,
	 * and someone using a non-default option on Sun also bumped into
	 * that).  Note that checking for >= and <= LONG_{MIN,MAX} would
	 * still be vulnerable:  if a long has more bits of precision than
	 * a double, casting MIN/MAX to double may yield an approximation,
	 * and if that's rounded up, then, e.g., wholepart=LONG_MAX+1 would
	 * yield true from the C expression wholepart<=LONG_MAX, despite
	 * that wholepart is actually greater than LONG_MAX.
	 */
	if (LONG_MIN < wholepart && wholepart < LONG_MAX) {
		const long aslong = (long)wholepart;
964
		return PyLong_FromLong(aslong);
965 966
	}
	return PyLong_FromDouble(wholepart);
967 968
}

969 970 971 972 973
static PyObject *
float_round(PyObject *v, PyObject *args)
{
#define UNDEF_NDIGITS (-0x7fffffff) /* Unlikely ndigits value */
	double x;
974
	double f = 1.0;
975 976 977 978 979 980 981 982 983 984
	double flr, cil;
	double rounded;
	int ndigits = UNDEF_NDIGITS;

	if (!PyArg_ParseTuple(args, "|i", &ndigits))
		return NULL;

	x = PyFloat_AsDouble(v);

	if (ndigits != UNDEF_NDIGITS) {
985 986
		f = pow(10.0, ndigits);
		x *= f;
987 988 989 990 991 992 993
	}

	flr = floor(x);
	cil = ceil(x);

	if (x-flr > 0.5)
		rounded = cil;
994
	else if (x-flr == 0.5)
995 996 997 998 999
		rounded = fmod(flr, 2) == 0 ? flr : cil;
	else
		rounded = flr;

	if (ndigits != UNDEF_NDIGITS) {
1000
		rounded /= f;
1001 1002 1003 1004 1005 1006 1007
		return PyFloat_FromDouble(rounded);
	}

	return PyLong_FromDouble(rounded);
#undef UNDEF_NDIGITS
}

1008
static PyObject *
1009
float_float(PyObject *v)
1010
{
1011 1012 1013 1014
	if (PyFloat_CheckExact(v))
		Py_INCREF(v);
	else
		v = PyFloat_FromDouble(((PyFloatObject *)v)->ob_fval);
1015 1016 1017
	return v;
}

1018
static PyObject *
Christian Heimes's avatar
Christian Heimes committed
1019
float_as_integer_ratio(PyObject *v, PyObject *unused)
1020 1021 1022 1023
{
	double self;
	double float_part;
	int exponent;
Christian Heimes's avatar
Christian Heimes committed
1024 1025
	int i;

1026 1027 1028 1029 1030
	PyObject *prev;
	PyObject *py_exponent = NULL;
	PyObject *numerator = NULL;
	PyObject *denominator = NULL;
	PyObject *result_pair = NULL;
Christian Heimes's avatar
Christian Heimes committed
1031
	PyNumberMethods *long_methods = PyLong_Type.tp_as_number;
1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053

#define INPLACE_UPDATE(obj, call) \
	prev = obj; \
	obj = call; \
	Py_DECREF(prev); \

	CONVERT_TO_DOUBLE(v, self);

	if (Py_IS_INFINITY(self)) {
	  PyErr_SetString(PyExc_OverflowError,
			  "Cannot pass infinity to float.as_integer_ratio.");
	  return NULL;
	}
#ifdef Py_NAN
	if (Py_IS_NAN(self)) {
	  PyErr_SetString(PyExc_ValueError,
			  "Cannot pass nan to float.as_integer_ratio.");
	  return NULL;
	}
#endif

	PyFPE_START_PROTECT("as_integer_ratio", goto error);
Christian Heimes's avatar
Christian Heimes committed
1054
	float_part = frexp(self, &exponent);  	/* self == float_part * 2**exponent exactly */
1055
	PyFPE_END_PROTECT(float_part);
Christian Heimes's avatar
Christian Heimes committed
1056 1057 1058 1059 1060 1061 1062 1063 1064 1065
	
	for (i=0; i<300 && float_part != floor(float_part) ; i++) {
		float_part *= 2.0;
		exponent--;
	}	
	/* self == float_part * 2**exponent exactly and float_part is integral.
           If FLT_RADIX != 2, the 300 steps may leave a tiny fractional part
           to be truncated by PyLong_FromDouble(). */

	numerator = PyLong_FromDouble(float_part);
1066 1067
	if (numerator == NULL) goto error;

Christian Heimes's avatar
Christian Heimes committed
1068
	/* fold in 2**exponent */
1069
	denominator = PyLong_FromLong(1);
Christian Heimes's avatar
Christian Heimes committed
1070
	py_exponent = PyLong_FromLong(labs((long)exponent));
1071 1072 1073 1074 1075 1076
	if (py_exponent == NULL) goto error;
	INPLACE_UPDATE(py_exponent,
		       long_methods->nb_lshift(denominator, py_exponent));
	if (py_exponent == NULL) goto error;
	if (exponent > 0) {
		INPLACE_UPDATE(numerator,
Christian Heimes's avatar
Christian Heimes committed
1077
			       long_methods->nb_multiply(numerator, py_exponent));
1078 1079 1080 1081 1082 1083 1084 1085
		if (numerator == NULL) goto error;
	}
	else {
		Py_DECREF(denominator);
		denominator = py_exponent;
		py_exponent = NULL;
	}

Christian Heimes's avatar
Christian Heimes committed
1086 1087 1088 1089 1090 1091
	/* Returns ints instead of longs where possible */
	INPLACE_UPDATE(numerator, PyNumber_Int(numerator));
	if (numerator == NULL) goto error;
	INPLACE_UPDATE(denominator, PyNumber_Int(denominator));
	if (denominator == NULL) goto error;

1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104
	result_pair = PyTuple_Pack(2, numerator, denominator);

#undef INPLACE_UPDATE
error:
	Py_XDECREF(py_exponent);
	Py_XDECREF(denominator);
	Py_XDECREF(numerator);
	return result_pair;
}

PyDoc_STRVAR(float_as_integer_ratio_doc,
"float.as_integer_ratio() -> (int, int)\n"
"\n"
Christian Heimes's avatar
Christian Heimes committed
1105 1106 1107
"Returns a pair of integers, whose ratio is exactly equal to the original\n"
"float and with a positive denominator.\n"
"Raises OverflowError on infinities and a ValueError on nans.\n"
1108 1109
"\n"
">>> (10.0).as_integer_ratio()\n"
Christian Heimes's avatar
Christian Heimes committed
1110
"(10, 1)\n"
1111 1112 1113
">>> (0.0).as_integer_ratio()\n"
"(0, 1)\n"
">>> (-.25).as_integer_ratio()\n"
Christian Heimes's avatar
Christian Heimes committed
1114
"(-1, 4)");
1115

1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145
PyObject *
_float_to_base(PyObject *v, int base)
{
	PyObject *mant, *conv, *result;
	double x, fr;
	int i, exp;

	if (!PyFloat_Check(v)) {
		PyErr_BadInternalCall();
		return NULL;
	}
	CONVERT_TO_DOUBLE(v, x);
	if (!Py_IS_FINITE(x))
		return PyObject_Repr(v);
	fr = frexp(x, &exp);
	for (i=0; i<300 && fr != floor(fr) ; i++) {
		fr *= 2.0;
		exp--;
	}
	mant = PyLong_FromDouble(floor(fr));
	if (mant == NULL)
		return NULL;
	conv = PyNumber_ToBase(mant, base);
	Py_DECREF(mant);
	if (conv == NULL)
		return NULL;
	result = PyUnicode_FromFormat("%U * 2.0 ** %d", conv, exp);
	Py_DECREF(conv);
	return result;
}
1146

1147
static PyObject *
1148 1149
float_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds);

1150 1151 1152 1153
static PyObject *
float_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
{
	PyObject *x = Py_False; /* Integer zero */
1154
	static char *kwlist[] = {"x", 0};
1155

1156 1157
	if (type != &PyFloat_Type)
		return float_subtype_new(type, args, kwds); /* Wimp out */
1158 1159
	if (!PyArg_ParseTupleAndKeywords(args, kwds, "|O:float", kwlist, &x))
		return NULL;
1160
	if (PyUnicode_Check(x))
1161
		return PyFloat_FromString(x);
1162 1163 1164
	return PyNumber_Float(x);
}

1165 1166 1167 1168 1169 1170 1171 1172
/* Wimpy, slow approach to tp_new calls for subtypes of float:
   first create a regular float from whatever arguments we got,
   then allocate a subtype instance and initialize its ob_fval
   from the regular float.  The regular float is then thrown away.
*/
static PyObject *
float_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
{
1173
	PyObject *tmp, *newobj;
1174 1175 1176 1177 1178

	assert(PyType_IsSubtype(type, &PyFloat_Type));
	tmp = float_new(&PyFloat_Type, args, kwds);
	if (tmp == NULL)
		return NULL;
1179
	assert(PyFloat_CheckExact(tmp));
1180 1181
	newobj = type->tp_alloc(type, 0);
	if (newobj == NULL) {
1182
		Py_DECREF(tmp);
1183
		return NULL;
1184
	}
1185
	((PyFloatObject *)newobj)->ob_fval = ((PyFloatObject *)tmp)->ob_fval;
1186
	Py_DECREF(tmp);
1187
	return newobj;
1188 1189
}

1190 1191 1192 1193 1194 1195
static PyObject *
float_getnewargs(PyFloatObject *v)
{
	return Py_BuildValue("(d)", v->ob_fval);
}

Michael W. Hudson's avatar
Michael W. Hudson committed
1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210
/* this is for the benefit of the pack/unpack routines below */

typedef enum {
	unknown_format, ieee_big_endian_format, ieee_little_endian_format
} float_format_type;

static float_format_type double_format, float_format;
static float_format_type detected_double_format, detected_float_format;

static PyObject *
float_getformat(PyTypeObject *v, PyObject* arg)
{
	char* s;
	float_format_type r;

1211
	if (!PyUnicode_Check(arg)) {
Michael W. Hudson's avatar
Michael W. Hudson committed
1212 1213
		PyErr_Format(PyExc_TypeError,
	     "__getformat__() argument must be string, not %.500s",
1214
			     Py_TYPE(arg)->tp_name);
Michael W. Hudson's avatar
Michael W. Hudson committed
1215 1216
		return NULL;
	}
1217 1218 1219
	s = PyUnicode_AsString(arg);
	if (s == NULL)
		return NULL;
Michael W. Hudson's avatar
Michael W. Hudson committed
1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234
	if (strcmp(s, "double") == 0) {
		r = double_format;
	}
	else if (strcmp(s, "float") == 0) {
		r = float_format;
	}
	else {
		PyErr_SetString(PyExc_ValueError,
				"__getformat__() argument 1 must be "
				"'double' or 'float'");
		return NULL;
	}
	
	switch (r) {
	case unknown_format:
1235
		return PyUnicode_FromString("unknown");
Michael W. Hudson's avatar
Michael W. Hudson committed
1236
	case ieee_little_endian_format:
1237
		return PyUnicode_FromString("IEEE, little-endian");
Michael W. Hudson's avatar
Michael W. Hudson committed
1238
	case ieee_big_endian_format:
1239
		return PyUnicode_FromString("IEEE, big-endian");
Michael W. Hudson's avatar
Michael W. Hudson committed
1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324
	default:
		Py_FatalError("insane float_format or double_format");
		return NULL;
	}
}

PyDoc_STRVAR(float_getformat_doc,
"float.__getformat__(typestr) -> string\n"
"\n"
"You probably don't want to use this function.  It exists mainly to be\n"
"used in Python's test suite.\n"
"\n"
"typestr must be 'double' or 'float'.  This function returns whichever of\n"
"'unknown', 'IEEE, big-endian' or 'IEEE, little-endian' best describes the\n"
"format of floating point numbers used by the C type named by typestr.");

static PyObject *
float_setformat(PyTypeObject *v, PyObject* args)
{
	char* typestr;
	char* format;
	float_format_type f;
	float_format_type detected;
	float_format_type *p;

	if (!PyArg_ParseTuple(args, "ss:__setformat__", &typestr, &format))
		return NULL;

	if (strcmp(typestr, "double") == 0) {
		p = &double_format;
		detected = detected_double_format;
	}
	else if (strcmp(typestr, "float") == 0) {
		p = &float_format;
		detected = detected_float_format;
	}
	else {
		PyErr_SetString(PyExc_ValueError,
				"__setformat__() argument 1 must "
				"be 'double' or 'float'");
		return NULL;
	}
	
	if (strcmp(format, "unknown") == 0) {
		f = unknown_format;
	}
	else if (strcmp(format, "IEEE, little-endian") == 0) {
		f = ieee_little_endian_format;
	}
	else if (strcmp(format, "IEEE, big-endian") == 0) {
		f = ieee_big_endian_format;
	}
	else {
		PyErr_SetString(PyExc_ValueError,
				"__setformat__() argument 2 must be "
				"'unknown', 'IEEE, little-endian' or "
				"'IEEE, big-endian'");
		return NULL;

	}

	if (f != unknown_format && f != detected) {
		PyErr_Format(PyExc_ValueError,
			     "can only set %s format to 'unknown' or the "
			     "detected platform value", typestr);
		return NULL;
	}

	*p = f;
	Py_RETURN_NONE;
}

PyDoc_STRVAR(float_setformat_doc,
"float.__setformat__(typestr, fmt) -> None\n"
"\n"
"You probably don't want to use this function.  It exists mainly to be\n"
"used in Python's test suite.\n"
"\n"
"typestr must be 'double' or 'float'.  fmt must be one of 'unknown',\n"
"'IEEE, big-endian' or 'IEEE, little-endian', and in addition can only be\n"
"one of the latter two if it appears to match the underlying C reality.\n"
"\n"
"Overrides the automatic determination of C-level floating point type.\n"
"This affects how floats are converted to and from binary strings.");

1325 1326 1327 1328 1329 1330
static PyObject *
float_getzero(PyObject *v, void *closure)
{
	return PyFloat_FromDouble(0.0);
}

1331 1332 1333
static PyObject *
float__format__(PyObject *self, PyObject *args)
{
1334 1335 1336 1337 1338 1339 1340
	PyObject *format_spec;

	if (!PyArg_ParseTuple(args, "U:__format__", &format_spec))
		return NULL;
	return _PyFloat_FormatAdvanced(self,
				       PyUnicode_AS_UNICODE(format_spec),
				       PyUnicode_GET_SIZE(format_spec));
1341 1342 1343 1344 1345 1346 1347 1348
}

PyDoc_STRVAR(float__format__doc,
"float.__format__(format_spec) -> string\n"
"\n"
"Formats the float according to format_spec.");


1349
static PyMethodDef float_methods[] = {
1350
	{"conjugate",	(PyCFunction)float_float,	METH_NOARGS,
1351
	 "Returns self, the complex conjugate of any float."},
1352 1353 1354 1355 1356
	{"__trunc__",	(PyCFunction)float_trunc, METH_NOARGS,
         "Returns the Integral closest to x between 0 and x."},
	{"__round__",	(PyCFunction)float_round, METH_VARARGS,
         "Returns the Integral closest to x, rounding half toward even.\n"
         "When an argument is passed, works like built-in round(x, ndigits)."},
1357 1358
	{"as_integer_ratio", (PyCFunction)float_as_integer_ratio, METH_NOARGS,
	 float_as_integer_ratio_doc},
1359 1360 1361 1362 1363 1364 1365 1366 1367 1368
	{"is_integer",	(PyCFunction)float_is_integer,	METH_NOARGS,
	 "Returns True if the float is an integer."},
#if 0
	{"is_inf",	(PyCFunction)float_is_inf,	METH_NOARGS,
	 "Returns True if the float is positive or negative infinite."},
	{"is_finite",	(PyCFunction)float_is_finite,	METH_NOARGS,
	 "Returns True if the float is finite, neither infinite nor NaN."},
	{"is_nan",	(PyCFunction)float_is_nan,	METH_NOARGS,
	 "Returns True if the float is not a number (NaN)."},
#endif
1369
	{"__getnewargs__",	(PyCFunction)float_getnewargs,	METH_NOARGS},
Michael W. Hudson's avatar
Michael W. Hudson committed
1370 1371 1372 1373
	{"__getformat__",	(PyCFunction)float_getformat,	
	 METH_O|METH_CLASS,		float_getformat_doc},
	{"__setformat__",	(PyCFunction)float_setformat,	
	 METH_VARARGS|METH_CLASS,	float_setformat_doc},
1374 1375
        {"__format__",          (PyCFunction)float__format__,
         METH_VARARGS,                  float__format__doc},
1376 1377 1378
	{NULL,		NULL}		/* sentinel */
};

1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390
static PyGetSetDef float_getset[] = {
    {"real", 
     (getter)float_float, (setter)NULL,
     "the real part of a complex number",
     NULL},
    {"imag", 
     (getter)float_getzero, (setter)NULL,
     "the imaginary part of a complex number",
     NULL},
    {NULL}  /* Sentinel */
};

1391
PyDoc_STRVAR(float_doc,
1392 1393
"float(x) -> floating point number\n\
\n\
1394
Convert a string or number to a floating point number, if possible.");
1395 1396


1397
static PyNumberMethods float_as_number = {
1398 1399 1400 1401 1402 1403
	float_add, 	/*nb_add*/
	float_sub, 	/*nb_subtract*/
	float_mul, 	/*nb_multiply*/
	float_rem, 	/*nb_remainder*/
	float_divmod, 	/*nb_divmod*/
	float_pow, 	/*nb_power*/
1404
	(unaryfunc)float_neg, /*nb_negative*/
1405
	(unaryfunc)float_float, /*nb_positive*/
1406
	(unaryfunc)float_abs, /*nb_absolute*/
1407
	(inquiry)float_bool, /*nb_bool*/
1408 1409 1410 1411 1412 1413
	0,		/*nb_invert*/
	0,		/*nb_lshift*/
	0,		/*nb_rshift*/
	0,		/*nb_and*/
	0,		/*nb_xor*/
	0,		/*nb_or*/
1414 1415
	float_trunc,	/*nb_int*/
	float_trunc,	/*nb_long*/
1416
	float_float,	/*nb_float*/
1417 1418 1419 1420 1421 1422 1423 1424 1425 1426
	0,		/* nb_inplace_add */
	0,		/* nb_inplace_subtract */
	0,		/* nb_inplace_multiply */
	0,		/* nb_inplace_remainder */
	0, 		/* nb_inplace_power */
	0,		/* nb_inplace_lshift */
	0,		/* nb_inplace_rshift */
	0,		/* nb_inplace_and */
	0,		/* nb_inplace_xor */
	0,		/* nb_inplace_or */
1427
	float_floor_div, /* nb_floor_divide */
1428 1429 1430
	float_div,	/* nb_true_divide */
	0,		/* nb_inplace_floor_divide */
	0,		/* nb_inplace_true_divide */
Guido van Rossum's avatar
Guido van Rossum committed
1431 1432
};

1433
PyTypeObject PyFloat_Type = {
1434
	PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossum's avatar
Guido van Rossum committed
1435
	"float",
1436
	sizeof(PyFloatObject),
Guido van Rossum's avatar
Guido van Rossum committed
1437
	0,
1438
	(destructor)float_dealloc,		/* tp_dealloc */
1439
	0,			 		/* tp_print */
1440 1441
	0,					/* tp_getattr */
	0,					/* tp_setattr */
1442
	0,			 		/* tp_compare */
1443 1444 1445 1446 1447 1448 1449 1450 1451 1452
	(reprfunc)float_repr,			/* tp_repr */
	&float_as_number,			/* tp_as_number */
	0,					/* tp_as_sequence */
	0,					/* tp_as_mapping */
	(hashfunc)float_hash,			/* tp_hash */
	0,					/* tp_call */
	(reprfunc)float_str,			/* tp_str */
	PyObject_GenericGetAttr,		/* tp_getattro */
	0,					/* tp_setattro */
	0,					/* tp_as_buffer */
1453
	Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
1454 1455 1456
	float_doc,				/* tp_doc */
 	0,					/* tp_traverse */
	0,					/* tp_clear */
1457
	float_richcompare,			/* tp_richcompare */
1458 1459 1460
	0,					/* tp_weaklistoffset */
	0,					/* tp_iter */
	0,					/* tp_iternext */
1461
	float_methods,				/* tp_methods */
1462
	0,					/* tp_members */
1463
	float_getset,				/* tp_getset */
1464 1465 1466 1467 1468 1469 1470 1471
	0,					/* tp_base */
	0,					/* tp_dict */
	0,					/* tp_descr_get */
	0,					/* tp_descr_set */
	0,					/* tp_dictoffset */
	0,					/* tp_init */
	0,					/* tp_alloc */
	float_new,				/* tp_new */
Guido van Rossum's avatar
Guido van Rossum committed
1472
};
1473

Michael W. Hudson's avatar
Michael W. Hudson committed
1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521
void
_PyFloat_Init(void)
{
	/* We attempt to determine if this machine is using IEEE
	   floating point formats by peering at the bits of some
	   carefully chosen values.  If it looks like we are on an
	   IEEE platform, the float packing/unpacking routines can
	   just copy bits, if not they resort to arithmetic & shifts
	   and masks.  The shifts & masks approach works on all finite
	   values, but what happens to infinities, NaNs and signed
	   zeroes on packing is an accident, and attempting to unpack
	   a NaN or an infinity will raise an exception.

	   Note that if we're on some whacked-out platform which uses
	   IEEE formats but isn't strictly little-endian or big-
	   endian, we will fall back to the portable shifts & masks
	   method. */

#if SIZEOF_DOUBLE == 8
	{
		double x = 9006104071832581.0;
		if (memcmp(&x, "\x43\x3f\xff\x01\x02\x03\x04\x05", 8) == 0)
			detected_double_format = ieee_big_endian_format;
		else if (memcmp(&x, "\x05\x04\x03\x02\x01\xff\x3f\x43", 8) == 0)
			detected_double_format = ieee_little_endian_format;
		else 
			detected_double_format = unknown_format;
	}
#else
	detected_double_format = unknown_format;
#endif

#if SIZEOF_FLOAT == 4
	{
		float y = 16711938.0;
		if (memcmp(&y, "\x4b\x7f\x01\x02", 4) == 0)
			detected_float_format = ieee_big_endian_format;
		else if (memcmp(&y, "\x02\x01\x7f\x4b", 4) == 0)
			detected_float_format = ieee_little_endian_format;
		else 
			detected_float_format = unknown_format;
	}
#else
	detected_float_format = unknown_format;
#endif

	double_format = detected_double_format;
	float_format = detected_float_format;
1522

1523 1524 1525
	/* Init float info */
	if (FloatInfoType.tp_name == 0)
		PyStructSequence_InitType(&FloatInfoType, &floatinfo_desc);
Michael W. Hudson's avatar
Michael W. Hudson committed
1526 1527
}

1528
void
Christian Heimes's avatar
Christian Heimes committed
1529
PyFloat_CompactFreeList(size_t *pbc, size_t *pbf, size_t *bsum)
1530
{
1531 1532
	PyFloatObject *p;
	PyFloatBlock *list, *next;
1533
	unsigned i;
Christian Heimes's avatar
Christian Heimes committed
1534 1535 1536
	size_t bc = 0, bf = 0;	/* block count, number of freed blocks */
	size_t fsum = 0;	/* total unfreed ints */
	int frem;		/* remaining unfreed ints per block */
1537 1538 1539

	list = block_list;
	block_list = NULL;
1540
	free_list = NULL;
1541 1542 1543
	while (list != NULL) {
		bc++;
		frem = 0;
1544 1545 1546
		for (i = 0, p = &list->objects[0];
		     i < N_FLOATOBJECTS;
		     i++, p++) {
1547
			if (PyFloat_CheckExact(p) && Py_REFCNT(p) != 0)
1548 1549
				frem++;
		}
1550
		next = list->next;
1551
		if (frem) {
1552 1553
			list->next = block_list;
			block_list = list;
1554 1555 1556
			for (i = 0, p = &list->objects[0];
			     i < N_FLOATOBJECTS;
			     i++, p++) {
1557
				if (!PyFloat_CheckExact(p) ||
1558 1559
				    Py_REFCNT(p) == 0) {
					Py_TYPE(p) = (struct _typeobject *)
1560 1561 1562 1563
						free_list;
					free_list = p;
				}
			}
1564 1565
		}
		else {
1566
			PyMem_FREE(list); /* XXX PyObject_FREE ??? */
1567 1568 1569
			bf++;
		}
		fsum += frem;
1570
		list = next;
1571
	}
Christian Heimes's avatar
Christian Heimes committed
1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587
	*pbc = bc;
	*pbf = bf;
	*bsum = fsum;
}

void
PyFloat_Fini(void)
{
	PyFloatObject *p;
	PyFloatBlock *list;
	unsigned i;
	size_t bc, bf;	/* block count, number of freed blocks */
	size_t fsum;	/* total unfreed floats per block */

	PyFloat_CompactFreeList(&bc, &bf, &fsum);

1588 1589 1590 1591 1592 1593 1594 1595
	if (!Py_VerboseFlag)
		return;
	fprintf(stderr, "# cleanup floats");
	if (!fsum) {
		fprintf(stderr, "\n");
	}
	else {
		fprintf(stderr,
1596
			": %" PY_FORMAT_SIZE_T "d unfreed float%s in %"
Christian Heimes's avatar
Christian Heimes committed
1597 1598
			PY_FORMAT_SIZE_T "d out of %"
			PY_FORMAT_SIZE_T "d block%s\n",
1599 1600 1601 1602 1603 1604
			fsum, fsum == 1 ? "" : "s",
			bc - bf, bc, bc == 1 ? "" : "s");
	}
	if (Py_VerboseFlag > 1) {
		list = block_list;
		while (list != NULL) {
1605 1606 1607
			for (i = 0, p = &list->objects[0];
			     i < N_FLOATOBJECTS;
			     i++, p++) {
1608
				if (PyFloat_CheckExact(p) &&
1609
				    Py_REFCNT(p) != 0) {
1610
					char buf[100];
1611
					format_float(buf, sizeof(buf), p, PREC_STR);
1612 1613 1614 1615
					/* XXX(twouters) cast refcount to
					   long until %zd is universally
					   available
					 */
1616
					fprintf(stderr,
1617
			     "#   <float at %p, refcnt=%ld, val=%s>\n",
1618
						p, (long)Py_REFCNT(p), buf);
1619 1620 1621
				}
			}
			list = list->next;
1622 1623
		}
	}
1624
}
1625 1626 1627 1628 1629 1630 1631

/*----------------------------------------------------------------------------
 * _PyFloat_{Pack,Unpack}{4,8}.  See floatobject.h.
 */
int
_PyFloat_Pack4(double x, unsigned char *p, int le)
{
Michael W. Hudson's avatar
Michael W. Hudson committed
1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642
	if (float_format == unknown_format) {
		unsigned char sign;
		int e;
		double f;
		unsigned int fbits;
		int incr = 1;

		if (le) {
			p += 3;
			incr = -1;
		}
1643

Michael W. Hudson's avatar
Michael W. Hudson committed
1644 1645 1646 1647 1648 1649
		if (x < 0) {
			sign = 1;
			x = -x;
		}
		else
			sign = 0;
1650

Michael W. Hudson's avatar
Michael W. Hudson committed
1651
		f = frexp(x, &e);
1652

Michael W. Hudson's avatar
Michael W. Hudson committed
1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664
		/* Normalize f to be in the range [1.0, 2.0) */
		if (0.5 <= f && f < 1.0) {
			f *= 2.0;
			e--;
		}
		else if (f == 0.0)
			e = 0;
		else {
			PyErr_SetString(PyExc_SystemError,
					"frexp() result out of range");
			return -1;
		}
1665

Michael W. Hudson's avatar
Michael W. Hudson committed
1666
		if (e >= 128)
1667
			goto Overflow;
Michael W. Hudson's avatar
Michael W. Hudson committed
1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687
		else if (e < -126) {
			/* Gradual underflow */
			f = ldexp(f, 126 + e);
			e = 0;
		}
		else if (!(e == 0 && f == 0.0)) {
			e += 127;
			f -= 1.0; /* Get rid of leading 1 */
		}

		f *= 8388608.0; /* 2**23 */
		fbits = (unsigned int)(f + 0.5); /* Round */
		assert(fbits <= 8388608);
		if (fbits >> 23) {
			/* The carry propagated out of a string of 23 1 bits. */
			fbits = 0;
			++e;
			if (e >= 255)
				goto Overflow;
		}
1688

Michael W. Hudson's avatar
Michael W. Hudson committed
1689 1690 1691
		/* First byte */
		*p = (sign << 7) | (e >> 1);
		p += incr;
1692

Michael W. Hudson's avatar
Michael W. Hudson committed
1693 1694 1695
		/* Second byte */
		*p = (char) (((e & 1) << 7) | (fbits >> 16));
		p += incr;
1696

Michael W. Hudson's avatar
Michael W. Hudson committed
1697 1698 1699
		/* Third byte */
		*p = (fbits >> 8) & 0xFF;
		p += incr;
1700

Michael W. Hudson's avatar
Michael W. Hudson committed
1701 1702
		/* Fourth byte */
		*p = fbits & 0xFF;
1703

Michael W. Hudson's avatar
Michael W. Hudson committed
1704 1705
		/* Done */
		return 0;
1706

Michael W. Hudson's avatar
Michael W. Hudson committed
1707 1708
	}
	else {
1709
		float y = (float)x;
Michael W. Hudson's avatar
Michael W. Hudson committed
1710 1711 1712
		const char *s = (char*)&y;
		int i, incr = 1;

Christian Heimes's avatar
Christian Heimes committed
1713 1714 1715
		if (Py_IS_INFINITY(y) && !Py_IS_INFINITY(x))
			goto Overflow;

Michael W. Hudson's avatar
Michael W. Hudson committed
1716 1717 1718 1719 1720
		if ((float_format == ieee_little_endian_format && !le)
		    || (float_format == ieee_big_endian_format && le)) {
			p += 3;
			incr = -1;
		}
Christian Heimes's avatar
Christian Heimes committed
1721

Michael W. Hudson's avatar
Michael W. Hudson committed
1722 1723 1724 1725 1726 1727
		for (i = 0; i < 4; i++) {
			*p = *s++;
			p += incr;
		}
		return 0;
	}
Christian Heimes's avatar
Christian Heimes committed
1728 1729 1730 1731
  Overflow:
	PyErr_SetString(PyExc_OverflowError,
			"float too large to pack with f format");
	return -1;
1732 1733 1734 1735 1736
}

int
_PyFloat_Pack8(double x, unsigned char *p, int le)
{
Michael W. Hudson's avatar
Michael W. Hudson committed
1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747
	if (double_format == unknown_format) {
		unsigned char sign;
		int e;
		double f;
		unsigned int fhi, flo;
		int incr = 1;

		if (le) {
			p += 7;
			incr = -1;
		}
1748

Michael W. Hudson's avatar
Michael W. Hudson committed
1749 1750 1751 1752 1753 1754
		if (x < 0) {
			sign = 1;
			x = -x;
		}
		else
			sign = 0;
1755

Michael W. Hudson's avatar
Michael W. Hudson committed
1756
		f = frexp(x, &e);
1757

Michael W. Hudson's avatar
Michael W. Hudson committed
1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769
		/* Normalize f to be in the range [1.0, 2.0) */
		if (0.5 <= f && f < 1.0) {
			f *= 2.0;
			e--;
		}
		else if (f == 0.0)
			e = 0;
		else {
			PyErr_SetString(PyExc_SystemError,
					"frexp() result out of range");
			return -1;
		}
1770

Michael W. Hudson's avatar
Michael W. Hudson committed
1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781
		if (e >= 1024)
			goto Overflow;
		else if (e < -1022) {
			/* Gradual underflow */
			f = ldexp(f, 1022 + e);
			e = 0;
		}
		else if (!(e == 0 && f == 0.0)) {
			e += 1023;
			f -= 1.0; /* Get rid of leading 1 */
		}
1782

Michael W. Hudson's avatar
Michael W. Hudson committed
1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802
		/* fhi receives the high 28 bits; flo the low 24 bits (== 52 bits) */
		f *= 268435456.0; /* 2**28 */
		fhi = (unsigned int)f; /* Truncate */
		assert(fhi < 268435456);

		f -= (double)fhi;
		f *= 16777216.0; /* 2**24 */
		flo = (unsigned int)(f + 0.5); /* Round */
		assert(flo <= 16777216);
		if (flo >> 24) {
			/* The carry propagated out of a string of 24 1 bits. */
			flo = 0;
			++fhi;
			if (fhi >> 28) {
				/* And it also progagated out of the next 28 bits. */
				fhi = 0;
				++e;
				if (e >= 2047)
					goto Overflow;
			}
1803 1804
		}

Michael W. Hudson's avatar
Michael W. Hudson committed
1805 1806 1807
		/* First byte */
		*p = (sign << 7) | (e >> 4);
		p += incr;
1808

Michael W. Hudson's avatar
Michael W. Hudson committed
1809 1810 1811
		/* Second byte */
		*p = (unsigned char) (((e & 0xF) << 4) | (fhi >> 24));
		p += incr;
1812

Michael W. Hudson's avatar
Michael W. Hudson committed
1813 1814 1815
		/* Third byte */
		*p = (fhi >> 16) & 0xFF;
		p += incr;
1816

Michael W. Hudson's avatar
Michael W. Hudson committed
1817 1818 1819
		/* Fourth byte */
		*p = (fhi >> 8) & 0xFF;
		p += incr;
1820

Michael W. Hudson's avatar
Michael W. Hudson committed
1821 1822 1823
		/* Fifth byte */
		*p = fhi & 0xFF;
		p += incr;
1824

Michael W. Hudson's avatar
Michael W. Hudson committed
1825 1826 1827
		/* Sixth byte */
		*p = (flo >> 16) & 0xFF;
		p += incr;
1828

Michael W. Hudson's avatar
Michael W. Hudson committed
1829 1830 1831
		/* Seventh byte */
		*p = (flo >> 8) & 0xFF;
		p += incr;
1832

Michael W. Hudson's avatar
Michael W. Hudson committed
1833 1834 1835
		/* Eighth byte */
		*p = flo & 0xFF;
		p += incr;
1836

Michael W. Hudson's avatar
Michael W. Hudson committed
1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847
		/* Done */
		return 0;

	  Overflow:
		PyErr_SetString(PyExc_OverflowError,
				"float too large to pack with d format");
		return -1;
	}
	else {
		const char *s = (char*)&x;
		int i, incr = 1;
1848

Michael W. Hudson's avatar
Michael W. Hudson committed
1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860
		if ((double_format == ieee_little_endian_format && !le)
		    || (double_format == ieee_big_endian_format && le)) {
			p += 7;
			incr = -1;
		}
		
		for (i = 0; i < 8; i++) {
			*p = *s++;
			p += incr;
		}
		return 0;
	}
1861 1862
}

1863 1864 1865 1866 1867 1868 1869 1870
/* Should only be used by marshal. */
int
_PyFloat_Repr(double x, char *p, size_t len)
{
	format_double(p, len, x, PREC_REPR);
	return (int)strlen(p);
}

1871 1872 1873
double
_PyFloat_Unpack4(const unsigned char *p, int le)
{
Michael W. Hudson's avatar
Michael W. Hudson committed
1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884
	if (float_format == unknown_format) {
		unsigned char sign;
		int e;
		unsigned int f;
		double x;
		int incr = 1;

		if (le) {
			p += 3;
			incr = -1;
		}
1885

Michael W. Hudson's avatar
Michael W. Hudson committed
1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902
		/* First byte */
		sign = (*p >> 7) & 1;
		e = (*p & 0x7F) << 1;
		p += incr;

		/* Second byte */
		e |= (*p >> 7) & 1;
		f = (*p & 0x7F) << 16;
		p += incr;

		if (e == 255) {
			PyErr_SetString(
				PyExc_ValueError,
				"can't unpack IEEE 754 special value "
				"on non-IEEE platform");
			return -1;
		}
1903

Michael W. Hudson's avatar
Michael W. Hudson committed
1904 1905 1906
		/* Third byte */
		f |= *p << 8;
		p += incr;
1907

Michael W. Hudson's avatar
Michael W. Hudson committed
1908 1909
		/* Fourth byte */
		f |= *p;
1910

Michael W. Hudson's avatar
Michael W. Hudson committed
1911
		x = (double)f / 8388608.0;
1912

Michael W. Hudson's avatar
Michael W. Hudson committed
1913 1914 1915 1916 1917 1918 1919 1920
		/* XXX This sadly ignores Inf/NaN issues */
		if (e == 0)
			e = -126;
		else {
			x += 1.0;
			e -= 127;
		}
		x = ldexp(x, e);
1921

Michael W. Hudson's avatar
Michael W. Hudson committed
1922 1923
		if (sign)
			x = -x;
1924

Michael W. Hudson's avatar
Michael W. Hudson committed
1925
		return x;
1926
	}
Michael W. Hudson's avatar
Michael W. Hudson committed
1927
	else {
Michael W. Hudson's avatar
Michael W. Hudson committed
1928 1929
		float x;

Michael W. Hudson's avatar
Michael W. Hudson committed
1930 1931
		if ((float_format == ieee_little_endian_format && !le)
		    || (float_format == ieee_big_endian_format && le)) {
Michael W. Hudson's avatar
Michael W. Hudson committed
1932
			char buf[4];
Michael W. Hudson's avatar
Michael W. Hudson committed
1933 1934 1935 1936 1937 1938
			char *d = &buf[3];
			int i;

			for (i = 0; i < 4; i++) {
				*d-- = *p++;
			}
Michael W. Hudson's avatar
Michael W. Hudson committed
1939
			memcpy(&x, buf, 4);
Michael W. Hudson's avatar
Michael W. Hudson committed
1940 1941
		}
		else {
Michael W. Hudson's avatar
Michael W. Hudson committed
1942
			memcpy(&x, p, 4);
Michael W. Hudson's avatar
Michael W. Hudson committed
1943
		}
Michael W. Hudson's avatar
Michael W. Hudson committed
1944 1945

		return x;
Michael W. Hudson's avatar
Michael W. Hudson committed
1946
	}		
1947 1948 1949 1950 1951
}

double
_PyFloat_Unpack8(const unsigned char *p, int le)
{
Michael W. Hudson's avatar
Michael W. Hudson committed
1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962
	if (double_format == unknown_format) {
		unsigned char sign;
		int e;
		unsigned int fhi, flo;
		double x;
		int incr = 1;

		if (le) {
			p += 7;
			incr = -1;
		}
1963

Michael W. Hudson's avatar
Michael W. Hudson committed
1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981
		/* First byte */
		sign = (*p >> 7) & 1;
		e = (*p & 0x7F) << 4;
		
		p += incr;

		/* Second byte */
		e |= (*p >> 4) & 0xF;
		fhi = (*p & 0xF) << 24;
		p += incr;

		if (e == 2047) {
			PyErr_SetString(
				PyExc_ValueError,
				"can't unpack IEEE 754 special value "
				"on non-IEEE platform");
			return -1.0;
		}
1982

Michael W. Hudson's avatar
Michael W. Hudson committed
1983 1984 1985
		/* Third byte */
		fhi |= *p << 16;
		p += incr;
1986

Michael W. Hudson's avatar
Michael W. Hudson committed
1987 1988 1989
		/* Fourth byte */
		fhi |= *p  << 8;
		p += incr;
1990

Michael W. Hudson's avatar
Michael W. Hudson committed
1991 1992 1993
		/* Fifth byte */
		fhi |= *p;
		p += incr;
1994

Michael W. Hudson's avatar
Michael W. Hudson committed
1995 1996 1997
		/* Sixth byte */
		flo = *p << 16;
		p += incr;
1998

Michael W. Hudson's avatar
Michael W. Hudson committed
1999 2000 2001
		/* Seventh byte */
		flo |= *p << 8;
		p += incr;
2002

Michael W. Hudson's avatar
Michael W. Hudson committed
2003 2004
		/* Eighth byte */
		flo |= *p;
2005

Michael W. Hudson's avatar
Michael W. Hudson committed
2006 2007
		x = (double)fhi + (double)flo / 16777216.0; /* 2**24 */
		x /= 268435456.0; /* 2**28 */
2008

Michael W. Hudson's avatar
Michael W. Hudson committed
2009 2010 2011 2012 2013 2014 2015
		if (e == 0)
			e = -1022;
		else {
			x += 1.0;
			e -= 1023;
		}
		x = ldexp(x, e);
2016

Michael W. Hudson's avatar
Michael W. Hudson committed
2017 2018
		if (sign)
			x = -x;
2019

Michael W. Hudson's avatar
Michael W. Hudson committed
2020 2021
		return x;
	}
2022
	else {
Michael W. Hudson's avatar
Michael W. Hudson committed
2023 2024
		double x;

Michael W. Hudson's avatar
Michael W. Hudson committed
2025 2026 2027 2028 2029 2030 2031 2032 2033
		if ((double_format == ieee_little_endian_format && !le)
		    || (double_format == ieee_big_endian_format && le)) {
			char buf[8];
			char *d = &buf[7];
			int i;
			
			for (i = 0; i < 8; i++) {
				*d-- = *p++;
			}
Michael W. Hudson's avatar
Michael W. Hudson committed
2034
			memcpy(&x, buf, 8);
Michael W. Hudson's avatar
Michael W. Hudson committed
2035 2036
		}
		else {
Michael W. Hudson's avatar
Michael W. Hudson committed
2037
			memcpy(&x, p, 8);
Michael W. Hudson's avatar
Michael W. Hudson committed
2038
		}
Michael W. Hudson's avatar
Michael W. Hudson committed
2039 2040

		return x;
2041 2042
	}
}