Skip to content

Commit 99d652e

Browse files
committed
Issue python#7534: Fix handling of nans, infinities, and negative zero in **
operator, on IEEE 754 platforms. Thanks Marcos Donolo for original patch.
1 parent 569e61f commit 99d652e

4 files changed

Lines changed: 294 additions & 25 deletions

File tree

‎Lib/test/ieee754.txt‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ False
7272
>>> NAN >= 0
7373
False
7474

75-
All operations involving a NaN return a NaN except for the power of *0* and *1*.
75+
All operations involving a NaN return a NaN except for nan**0 and 1**nan.
7676
>>> 1 + NAN
7777
nan
7878
>>> 1 * NAN
@@ -81,8 +81,10 @@ nan
8181
nan
8282
>>> 1 ** NAN
8383
1.0
84+
>>> NAN ** 0
85+
1.0
8486
>>> 0 ** NAN
85-
0.0
87+
nan
8688
>>> (1.0 + FI.epsilon) * NAN
8789
nan
8890

‎Lib/test/test_float.py‎

Lines changed: 212 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,11 @@
1212
INF = float("inf")
1313
NAN = float("nan")
1414

15+
# decorator for skipping tests on non-IEEE 754 platforms
16+
requires_IEEE_754 = unittest.skipUnless(
17+
float.__getformat__("double").startswith("IEEE"),
18+
"test requires IEEE 754 doubles")
19+
1520
#locate file with float format test values
1621
test_dir = os.path.dirname(__file__) or os.curdir
1722
format_testfile = os.path.join(test_dir, 'formatfloat_testcases.txt')
@@ -142,6 +147,213 @@ def test_floatasratio(self):
142147
self.assertRaises(OverflowError, float('-inf').as_integer_ratio)
143148
self.assertRaises(ValueError, float('nan').as_integer_ratio)
144149

150+
def assertEqualAndEqualSign(self, a, b):
151+
# fail unless a == b and a and b have the same sign bit;
152+
# the only difference from assertEqual is that this test
153+
# distingishes -0.0 and 0.0.
154+
self.assertEqual((a, copysign(1.0, a)), (b, copysign(1.0, b)))
155+
156+
@requires_IEEE_754
157+
def test_float_pow(self):
158+
# test builtin pow and ** operator for IEEE 754 special cases.
159+
# Special cases taken from section F.9.4.4 of the C99 specification
160+
161+
for pow_op in pow, operator.pow:
162+
# x**NAN is NAN for any x except 1
163+
self.assertTrue(isnan(pow_op(-INF, NAN)))
164+
self.assertTrue(isnan(pow_op(-2.0, NAN)))
165+
self.assertTrue(isnan(pow_op(-1.0, NAN)))
166+
self.assertTrue(isnan(pow_op(-0.5, NAN)))
167+
self.assertTrue(isnan(pow_op(-0.0, NAN)))
168+
self.assertTrue(isnan(pow_op(0.0, NAN)))
169+
self.assertTrue(isnan(pow_op(0.5, NAN)))
170+
self.assertTrue(isnan(pow_op(2.0, NAN)))
171+
self.assertTrue(isnan(pow_op(INF, NAN)))
172+
self.assertTrue(isnan(pow_op(NAN, NAN)))
173+
174+
# NAN**y is NAN for any y except +-0
175+
self.assertTrue(isnan(pow_op(NAN, -INF)))
176+
self.assertTrue(isnan(pow_op(NAN, -2.0)))
177+
self.assertTrue(isnan(pow_op(NAN, -1.0)))
178+
self.assertTrue(isnan(pow_op(NAN, -0.5)))
179+
self.assertTrue(isnan(pow_op(NAN, 0.5)))
180+
self.assertTrue(isnan(pow_op(NAN, 1.0)))
181+
self.assertTrue(isnan(pow_op(NAN, 2.0)))
182+
self.assertTrue(isnan(pow_op(NAN, INF)))
183+
184+
# (+-0)**y raises ZeroDivisionError for y a negative odd integer
185+
self.assertRaises(ZeroDivisionError, pow_op, -0.0, -1.0)
186+
self.assertRaises(ZeroDivisionError, pow_op, 0.0, -1.0)
187+
188+
# (+-0)**y raises ZeroDivisionError for y finite and negative
189+
# but not an odd integer
190+
self.assertRaises(ZeroDivisionError, pow_op, -0.0, -2.0)
191+
self.assertRaises(ZeroDivisionError, pow_op, -0.0, -0.5)
192+
self.assertRaises(ZeroDivisionError, pow_op, 0.0, -2.0)
193+
self.assertRaises(ZeroDivisionError, pow_op, 0.0, -0.5)
194+
195+
# (+-0)**y is +-0 for y a positive odd integer
196+
self.assertEqualAndEqualSign(pow_op(-0.0, 1.0), -0.0)
197+
self.assertEqualAndEqualSign(pow_op(0.0, 1.0), 0.0)
198+
199+
# (+-0)**y is 0 for y finite and positive but not an odd integer
200+
self.assertEqualAndEqualSign(pow_op(-0.0, 0.5), 0.0)
201+
self.assertEqualAndEqualSign(pow_op(-0.0, 2.0), 0.0)
202+
self.assertEqualAndEqualSign(pow_op(0.0, 0.5), 0.0)
203+
self.assertEqualAndEqualSign(pow_op(0.0, 2.0), 0.0)
204+
205+
# (-1)**+-inf is 1
206+
self.assertEqualAndEqualSign(pow_op(-1.0, -INF), 1.0)
207+
self.assertEqualAndEqualSign(pow_op(-1.0, INF), 1.0)
208+
209+
# 1**y is 1 for any y, even if y is an infinity or nan
210+
self.assertEqualAndEqualSign(pow_op(1.0, -INF), 1.0)
211+
self.assertEqualAndEqualSign(pow_op(1.0, -2.0), 1.0)
212+
self.assertEqualAndEqualSign(pow_op(1.0, -1.0), 1.0)
213+
self.assertEqualAndEqualSign(pow_op(1.0, -0.5), 1.0)
214+
self.assertEqualAndEqualSign(pow_op(1.0, -0.0), 1.0)
215+
self.assertEqualAndEqualSign(pow_op(1.0, 0.0), 1.0)
216+
self.assertEqualAndEqualSign(pow_op(1.0, 0.5), 1.0)
217+
self.assertEqualAndEqualSign(pow_op(1.0, 1.0), 1.0)
218+
self.assertEqualAndEqualSign(pow_op(1.0, 2.0), 1.0)
219+
self.assertEqualAndEqualSign(pow_op(1.0, INF), 1.0)
220+
self.assertEqualAndEqualSign(pow_op(1.0, NAN), 1.0)
221+
222+
# x**+-0 is 1 for any x, even if x is a zero, infinity, or nan
223+
self.assertEqualAndEqualSign(pow_op(-INF, 0.0), 1.0)
224+
self.assertEqualAndEqualSign(pow_op(-2.0, 0.0), 1.0)
225+
self.assertEqualAndEqualSign(pow_op(-1.0, 0.0), 1.0)
226+
self.assertEqualAndEqualSign(pow_op(-0.5, 0.0), 1.0)
227+
self.assertEqualAndEqualSign(pow_op(-0.0, 0.0), 1.0)
228+
self.assertEqualAndEqualSign(pow_op(0.0, 0.0), 1.0)
229+
self.assertEqualAndEqualSign(pow_op(0.5, 0.0), 1.0)
230+
self.assertEqualAndEqualSign(pow_op(1.0, 0.0), 1.0)
231+
self.assertEqualAndEqualSign(pow_op(2.0, 0.0), 1.0)
232+
self.assertEqualAndEqualSign(pow_op(INF, 0.0), 1.0)
233+
self.assertEqualAndEqualSign(pow_op(NAN, 0.0), 1.0)
234+
self.assertEqualAndEqualSign(pow_op(-INF, -0.0), 1.0)
235+
self.assertEqualAndEqualSign(pow_op(-2.0, -0.0), 1.0)
236+
self.assertEqualAndEqualSign(pow_op(-1.0, -0.0), 1.0)
237+
self.assertEqualAndEqualSign(pow_op(-0.5, -0.0), 1.0)
238+
self.assertEqualAndEqualSign(pow_op(-0.0, -0.0), 1.0)
239+
self.assertEqualAndEqualSign(pow_op(0.0, -0.0), 1.0)
240+
self.assertEqualAndEqualSign(pow_op(0.5, -0.0), 1.0)
241+
self.assertEqualAndEqualSign(pow_op(1.0, -0.0), 1.0)
242+
self.assertEqualAndEqualSign(pow_op(2.0, -0.0), 1.0)
243+
self.assertEqualAndEqualSign(pow_op(INF, -0.0), 1.0)
244+
self.assertEqualAndEqualSign(pow_op(NAN, -0.0), 1.0)
245+
246+
# x**y raises ValueError for finite negative x and non-integral y
247+
self.assertRaises(ValueError, pow_op, -2.0, -0.5)
248+
self.assertRaises(ValueError, pow_op, -2.0, 0.5)
249+
self.assertRaises(ValueError, pow_op, -1.0, -0.5)
250+
self.assertRaises(ValueError, pow_op, -1.0, 0.5)
251+
self.assertRaises(ValueError, pow_op, -0.5, -0.5)
252+
self.assertRaises(ValueError, pow_op, -0.5, 0.5)
253+
254+
# x**-INF is INF for abs(x) < 1
255+
self.assertEqualAndEqualSign(pow_op(-0.5, -INF), INF)
256+
self.assertEqualAndEqualSign(pow_op(-0.0, -INF), INF)
257+
self.assertEqualAndEqualSign(pow_op(0.0, -INF), INF)
258+
self.assertEqualAndEqualSign(pow_op(0.5, -INF), INF)
259+
260+
# x**-INF is 0 for abs(x) > 1
261+
self.assertEqualAndEqualSign(pow_op(-INF, -INF), 0.0)
262+
self.assertEqualAndEqualSign(pow_op(-2.0, -INF), 0.0)
263+
self.assertEqualAndEqualSign(pow_op(2.0, -INF), 0.0)
264+
self.assertEqualAndEqualSign(pow_op(INF, -INF), 0.0)
265+
266+
# x**INF is 0 for abs(x) < 1
267+
self.assertEqualAndEqualSign(pow_op(-0.5, INF), 0.0)
268+
self.assertEqualAndEqualSign(pow_op(-0.0, INF), 0.0)
269+
self.assertEqualAndEqualSign(pow_op(0.0, INF), 0.0)
270+
self.assertEqualAndEqualSign(pow_op(0.5, INF), 0.0)
271+
272+
# x**INF is INF for abs(x) > 1
273+
self.assertEqualAndEqualSign(pow_op(-INF, INF), INF)
274+
self.assertEqualAndEqualSign(pow_op(-2.0, INF), INF)
275+
self.assertEqualAndEqualSign(pow_op(2.0, INF), INF)
276+
self.assertEqualAndEqualSign(pow_op(INF, INF), INF)
277+
278+
# (-INF)**y is -0.0 for y a negative odd integer
279+
self.assertEqualAndEqualSign(pow_op(-INF, -1.0), -0.0)
280+
281+
# (-INF)**y is 0.0 for y negative but not an odd integer
282+
self.assertEqualAndEqualSign(pow_op(-INF, -0.5), 0.0)
283+
self.assertEqualAndEqualSign(pow_op(-INF, -2.0), 0.0)
284+
285+
# (-INF)**y is -INF for y a positive odd integer
286+
self.assertEqualAndEqualSign(pow_op(-INF, 1.0), -INF)
287+
288+
# (-INF)**y is INF for y positive but not an odd integer
289+
self.assertEqualAndEqualSign(pow_op(-INF, 0.5), INF)
290+
self.assertEqualAndEqualSign(pow_op(-INF, 2.0), INF)
291+
292+
# INF**y is INF for y positive
293+
self.assertEqualAndEqualSign(pow_op(INF, 0.5), INF)
294+
self.assertEqualAndEqualSign(pow_op(INF, 1.0), INF)
295+
self.assertEqualAndEqualSign(pow_op(INF, 2.0), INF)
296+
297+
# INF**y is 0.0 for y negative
298+
self.assertEqualAndEqualSign(pow_op(INF, -2.0), 0.0)
299+
self.assertEqualAndEqualSign(pow_op(INF, -1.0), 0.0)
300+
self.assertEqualAndEqualSign(pow_op(INF, -0.5), 0.0)
301+
302+
# basic checks not covered by the special cases above
303+
self.assertEqualAndEqualSign(pow_op(-2.0, -2.0), 0.25)
304+
self.assertEqualAndEqualSign(pow_op(-2.0, -1.0), -0.5)
305+
self.assertEqualAndEqualSign(pow_op(-2.0, -0.0), 1.0)
306+
self.assertEqualAndEqualSign(pow_op(-2.0, 0.0), 1.0)
307+
self.assertEqualAndEqualSign(pow_op(-2.0, 1.0), -2.0)
308+
self.assertEqualAndEqualSign(pow_op(-2.0, 2.0), 4.0)
309+
self.assertEqualAndEqualSign(pow_op(-1.0, -2.0), 1.0)
310+
self.assertEqualAndEqualSign(pow_op(-1.0, -1.0), -1.0)
311+
self.assertEqualAndEqualSign(pow_op(-1.0, -0.0), 1.0)
312+
self.assertEqualAndEqualSign(pow_op(-1.0, 0.0), 1.0)
313+
self.assertEqualAndEqualSign(pow_op(-1.0, 1.0), -1.0)
314+
self.assertEqualAndEqualSign(pow_op(-1.0, 2.0), 1.0)
315+
self.assertEqualAndEqualSign(pow_op(2.0, -2.0), 0.25)
316+
self.assertEqualAndEqualSign(pow_op(2.0, -1.0), 0.5)
317+
self.assertEqualAndEqualSign(pow_op(2.0, -0.0), 1.0)
318+
self.assertEqualAndEqualSign(pow_op(2.0, 0.0), 1.0)
319+
self.assertEqualAndEqualSign(pow_op(2.0, 1.0), 2.0)
320+
self.assertEqualAndEqualSign(pow_op(2.0, 2.0), 4.0)
321+
322+
# 1 ** large and -1 ** large; some libms apparently
323+
# have problems with these
324+
self.assertEqualAndEqualSign(pow_op(1.0, -1e100), 1.0)
325+
self.assertEqualAndEqualSign(pow_op(1.0, 1e100), 1.0)
326+
self.assertEqualAndEqualSign(pow_op(-1.0, -1e100), 1.0)
327+
self.assertEqualAndEqualSign(pow_op(-1.0, 1e100), 1.0)
328+
329+
# check sign for results that underflow to 0
330+
self.assertEqualAndEqualSign(pow_op(-2.0, -2000.0), 0.0)
331+
self.assertRaises(ValueError, pow_op, -2.0, -2000.5)
332+
self.assertEqualAndEqualSign(pow_op(-2.0, -2001.0), -0.0)
333+
self.assertEqualAndEqualSign(pow_op(2.0, -2000.0), 0.0)
334+
self.assertEqualAndEqualSign(pow_op(2.0, -2000.5), 0.0)
335+
self.assertEqualAndEqualSign(pow_op(2.0, -2001.0), 0.0)
336+
self.assertEqualAndEqualSign(pow_op(-0.5, 2000.0), 0.0)
337+
self.assertRaises(ValueError, pow_op, -0.5, 2000.5)
338+
self.assertEqualAndEqualSign(pow_op(-0.5, 2001.0), -0.0)
339+
self.assertEqualAndEqualSign(pow_op(0.5, 2000.0), 0.0)
340+
self.assertEqualAndEqualSign(pow_op(0.5, 2000.5), 0.0)
341+
self.assertEqualAndEqualSign(pow_op(0.5, 2001.0), 0.0)
342+
343+
# check we don't raise an exception for subnormal results,
344+
# and validate signs. Tests currently disabled, since
345+
# they fail on systems where a subnormal result from pow
346+
# is flushed to zero (e.g. Debian/ia64.)
347+
#self.assertTrue(0.0 < pow_op(0.5, 1048) < 1e-315)
348+
#self.assertTrue(0.0 < pow_op(-0.5, 1048) < 1e-315)
349+
#self.assertTrue(0.0 < pow_op(0.5, 1047) < 1e-315)
350+
#self.assertTrue(0.0 > pow_op(-0.5, 1047) > -1e-315)
351+
#self.assertTrue(0.0 < pow_op(2.0, -1048) < 1e-315)
352+
#self.assertTrue(0.0 < pow_op(-2.0, -1048) < 1e-315)
353+
#self.assertTrue(0.0 < pow_op(2.0, -1047) < 1e-315)
354+
#self.assertTrue(0.0 > pow_op(-2.0, -1047) > -1e-315)
355+
356+
145357
class FormatFunctionsTestCase(unittest.TestCase):
146358

147359
def setUp(self):

‎Misc/NEWS‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ What's New in Python 2.7 alpha 2?
1212
Core and Builtins
1313
-----------------
1414

15+
- Issue #7534: Fix handling of IEEE specials (infinities, nans,
16+
negative zero) in ** operator. The behaviour now conforms to that
17+
described in C99 Annex F.
18+
1519
- Issue #7579: the msvcrt module now has docstrings for all its functions.
1620

1721
- Issue #7413: Passing '\0' as the separator to datetime.datetime.isoformat()

0 commit comments

Comments
 (0)