blob: 1499ff9729d0d7ddf063d639e3da4ec053266b21 [file] [log] [blame]
Guido van Rossumfcce6301996-08-08 18:26:25 +00001# Python test set -- math module
2# XXXX Should not do tests around zero only
3
Benjamin Petersonee8712c2008-05-20 21:35:26 +00004from test.support import run_unittest, verbose
Thomas Wouters89f507f2006-12-13 04:49:30 +00005import unittest
6import math
Christian Heimes53876d92008-04-19 00:31:39 +00007import os
8import sys
Georg Brandlc28e1fa2008-06-10 19:20:26 +00009import random
Mark Dickinson12c4bdb2009-09-28 19:21:11 +000010import struct
Guido van Rossumfcce6301996-08-08 18:26:25 +000011
Christian Heimes53876d92008-04-19 00:31:39 +000012eps = 1E-05
13NAN = float('nan')
14INF = float('inf')
15NINF = float('-inf')
16
Mark Dickinson63566232009-09-18 21:04:19 +000017# decorator for skipping tests on non-IEEE 754 platforms
18requires_IEEE_754 = unittest.skipUnless(
19 float.__getformat__("double").startswith("IEEE"),
20 "test requires IEEE 754 doubles")
21
Mark Dickinson5c567082009-04-24 16:39:07 +000022# detect evidence of double-rounding: fsum is not always correctly
23# rounded on machines that suffer from double rounding.
24x, y = 1e16, 2.9999 # use temporary values to defeat peephole optimizer
25HAVE_DOUBLE_ROUNDING = (x + y == 1e16 + 4)
26
Christian Heimes53876d92008-04-19 00:31:39 +000027# locate file with test values
28if __name__ == '__main__':
29 file = sys.argv[0]
30else:
31 file = __file__
32test_dir = os.path.dirname(file) or os.curdir
Mark Dickinson12c4bdb2009-09-28 19:21:11 +000033math_testcases = os.path.join(test_dir, 'math_testcases.txt')
Christian Heimes53876d92008-04-19 00:31:39 +000034test_file = os.path.join(test_dir, 'cmath_testcases.txt')
35
Mark Dickinson12c4bdb2009-09-28 19:21:11 +000036def to_ulps(x):
37 """Convert a non-NaN float x to an integer, in such a way that
38 adjacent floats are converted to adjacent integers. Then
39 abs(ulps(x) - ulps(y)) gives the difference in ulps between two
40 floats.
41
42 The results from this function will only make sense on platforms
43 where C doubles are represented in IEEE 754 binary64 format.
44
45 """
Mark Dickinsond412ab52009-10-17 07:10:00 +000046 n = struct.unpack('<q', struct.pack('<d', x))[0]
Mark Dickinson12c4bdb2009-09-28 19:21:11 +000047 if n < 0:
48 n = ~(n+2**63)
49 return n
50
Mark Dickinson05d2e082009-12-11 20:17:17 +000051def ulps_check(expected, got, ulps=20):
52 """Given non-NaN floats `expected` and `got`,
53 check that they're equal to within the given number of ulps.
54
55 Returns None on success and an error message on failure."""
56
57 ulps_error = to_ulps(got) - to_ulps(expected)
58 if abs(ulps_error) <= ulps:
59 return None
60 return "error = {} ulps; permitted error = {} ulps".format(ulps_error,
61 ulps)
62
Mark Dickinson4c8a9a22010-05-15 17:02:38 +000063# Here's a pure Python version of the math.factorial algorithm, for
64# documentation and comparison purposes.
65#
66# Formula:
67#
68# factorial(n) = factorial_odd_part(n) << (n - count_set_bits(n))
69#
70# where
71#
72# factorial_odd_part(n) = product_{i >= 0} product_{0 < j <= n >> i; j odd} j
73#
74# The outer product above is an infinite product, but once i >= n.bit_length,
75# (n >> i) < 1 and the corresponding term of the product is empty. So only the
76# finitely many terms for 0 <= i < n.bit_length() contribute anything.
77#
78# We iterate downwards from i == n.bit_length() - 1 to i == 0. The inner
79# product in the formula above starts at 1 for i == n.bit_length(); for each i
80# < n.bit_length() we get the inner product for i from that for i + 1 by
81# multiplying by all j in {n >> i+1 < j <= n >> i; j odd}. In Python terms,
82# this set is range((n >> i+1) + 1 | 1, (n >> i) + 1 | 1, 2).
83
84def count_set_bits(n):
85 """Number of '1' bits in binary expansion of a nonnnegative integer."""
86 return 1 + count_set_bits(n & n - 1) if n else 0
87
88def partial_product(start, stop):
89 """Product of integers in range(start, stop, 2), computed recursively.
90 start and stop should both be odd, with start <= stop.
91
92 """
93 numfactors = (stop - start) >> 1
94 if not numfactors:
95 return 1
96 elif numfactors == 1:
97 return start
98 else:
99 mid = (start + numfactors) | 1
100 return partial_product(start, mid) * partial_product(mid, stop)
101
102def py_factorial(n):
103 """Factorial of nonnegative integer n, via "Binary Split Factorial Formula"
104 described at http://www.luschny.de/math/factorial/binarysplitfact.html
105
106 """
107 inner = outer = 1
108 for i in reversed(range(n.bit_length())):
109 inner *= partial_product((n >> i + 1) + 1 | 1, (n >> i) + 1 | 1)
110 outer *= inner
111 return outer << (n - count_set_bits(n))
112
Mark Dickinson05d2e082009-12-11 20:17:17 +0000113def acc_check(expected, got, rel_err=2e-15, abs_err = 5e-323):
114 """Determine whether non-NaN floats a and b are equal to within a
115 (small) rounding error. The default values for rel_err and
116 abs_err are chosen to be suitable for platforms where a float is
117 represented by an IEEE 754 double. They allow an error of between
118 9 and 19 ulps."""
119
120 # need to special case infinities, since inf - inf gives nan
121 if math.isinf(expected) and got == expected:
122 return None
123
124 error = got - expected
125
126 permitted_error = max(abs_err, rel_err * abs(expected))
127 if abs(error) < permitted_error:
128 return None
129 return "error = {}; permitted error = {}".format(error,
130 permitted_error)
Mark Dickinson12c4bdb2009-09-28 19:21:11 +0000131
132def parse_mtestfile(fname):
133 """Parse a file with test values
134
135 -- starts a comment
136 blank lines, or lines containing only a comment, are ignored
137 other lines are expected to have the form
138 id fn arg -> expected [flag]*
139
140 """
141 with open(fname) as fp:
142 for line in fp:
143 # strip comments, and skip blank lines
144 if '--' in line:
145 line = line[:line.index('--')]
146 if not line.strip():
147 continue
148
149 lhs, rhs = line.split('->')
150 id, fn, arg = lhs.split()
151 rhs_pieces = rhs.split()
152 exp = rhs_pieces[0]
153 flags = rhs_pieces[1:]
154
155 yield (id, fn, float(arg), float(exp), flags)
156
Christian Heimes53876d92008-04-19 00:31:39 +0000157def parse_testfile(fname):
158 """Parse a file with test values
159
160 Empty lines or lines starting with -- are ignored
161 yields id, fn, arg_real, arg_imag, exp_real, exp_imag
162 """
163 with open(fname) as fp:
164 for line in fp:
165 # skip comment lines and blank lines
166 if line.startswith('--') or not line.strip():
167 continue
168
169 lhs, rhs = line.split('->')
170 id, fn, arg_real, arg_imag = lhs.split()
171 rhs_pieces = rhs.split()
172 exp_real, exp_imag = rhs_pieces[0], rhs_pieces[1]
173 flags = rhs_pieces[2:]
174
175 yield (id, fn,
176 float(arg_real), float(arg_imag),
177 float(exp_real), float(exp_imag),
178 flags
179 )
Guido van Rossumfcce6301996-08-08 18:26:25 +0000180
Thomas Wouters89f507f2006-12-13 04:49:30 +0000181class MathTests(unittest.TestCase):
Guido van Rossumfcce6301996-08-08 18:26:25 +0000182
Thomas Wouters89f507f2006-12-13 04:49:30 +0000183 def ftest(self, name, value, expected):
184 if abs(value-expected) > eps:
Guido van Rossum806c2462007-08-06 23:33:07 +0000185 # Use %r instead of %f so the error message
186 # displays full precision. Otherwise discrepancies
187 # in the last few bits will lead to very confusing
188 # error messages
189 self.fail('%s returned %r, expected %r' %
Thomas Wouters89f507f2006-12-13 04:49:30 +0000190 (name, value, expected))
Guido van Rossumfcce6301996-08-08 18:26:25 +0000191
Thomas Wouters89f507f2006-12-13 04:49:30 +0000192 def testConstants(self):
193 self.ftest('pi', math.pi, 3.1415926)
194 self.ftest('e', math.e, 2.7182818)
Guido van Rossumfcce6301996-08-08 18:26:25 +0000195
Thomas Wouters89f507f2006-12-13 04:49:30 +0000196 def testAcos(self):
197 self.assertRaises(TypeError, math.acos)
198 self.ftest('acos(-1)', math.acos(-1), math.pi)
199 self.ftest('acos(0)', math.acos(0), math.pi/2)
200 self.ftest('acos(1)', math.acos(1), 0)
Christian Heimes53876d92008-04-19 00:31:39 +0000201 self.assertRaises(ValueError, math.acos, INF)
202 self.assertRaises(ValueError, math.acos, NINF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000203 self.assertTrue(math.isnan(math.acos(NAN)))
Christian Heimes53876d92008-04-19 00:31:39 +0000204
205 def testAcosh(self):
206 self.assertRaises(TypeError, math.acosh)
207 self.ftest('acosh(1)', math.acosh(1), 0)
208 self.ftest('acosh(2)', math.acosh(2), 1.3169578969248168)
209 self.assertRaises(ValueError, math.acosh, 0)
210 self.assertRaises(ValueError, math.acosh, -1)
211 self.assertEquals(math.acosh(INF), INF)
212 self.assertRaises(ValueError, math.acosh, NINF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000213 self.assertTrue(math.isnan(math.acosh(NAN)))
Guido van Rossumfcce6301996-08-08 18:26:25 +0000214
Thomas Wouters89f507f2006-12-13 04:49:30 +0000215 def testAsin(self):
216 self.assertRaises(TypeError, math.asin)
217 self.ftest('asin(-1)', math.asin(-1), -math.pi/2)
218 self.ftest('asin(0)', math.asin(0), 0)
219 self.ftest('asin(1)', math.asin(1), math.pi/2)
Christian Heimes53876d92008-04-19 00:31:39 +0000220 self.assertRaises(ValueError, math.asin, INF)
221 self.assertRaises(ValueError, math.asin, NINF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000222 self.assertTrue(math.isnan(math.asin(NAN)))
Christian Heimes53876d92008-04-19 00:31:39 +0000223
224 def testAsinh(self):
225 self.assertRaises(TypeError, math.asinh)
226 self.ftest('asinh(0)', math.asinh(0), 0)
227 self.ftest('asinh(1)', math.asinh(1), 0.88137358701954305)
228 self.ftest('asinh(-1)', math.asinh(-1), -0.88137358701954305)
229 self.assertEquals(math.asinh(INF), INF)
230 self.assertEquals(math.asinh(NINF), NINF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000231 self.assertTrue(math.isnan(math.asinh(NAN)))
Guido van Rossumfcce6301996-08-08 18:26:25 +0000232
Thomas Wouters89f507f2006-12-13 04:49:30 +0000233 def testAtan(self):
234 self.assertRaises(TypeError, math.atan)
235 self.ftest('atan(-1)', math.atan(-1), -math.pi/4)
236 self.ftest('atan(0)', math.atan(0), 0)
237 self.ftest('atan(1)', math.atan(1), math.pi/4)
Christian Heimes53876d92008-04-19 00:31:39 +0000238 self.ftest('atan(inf)', math.atan(INF), math.pi/2)
Christian Heimesa342c012008-04-20 21:01:16 +0000239 self.ftest('atan(-inf)', math.atan(NINF), -math.pi/2)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000240 self.assertTrue(math.isnan(math.atan(NAN)))
Christian Heimes53876d92008-04-19 00:31:39 +0000241
242 def testAtanh(self):
243 self.assertRaises(TypeError, math.atan)
244 self.ftest('atanh(0)', math.atanh(0), 0)
245 self.ftest('atanh(0.5)', math.atanh(0.5), 0.54930614433405489)
246 self.ftest('atanh(-0.5)', math.atanh(-0.5), -0.54930614433405489)
247 self.assertRaises(ValueError, math.atanh, 1)
248 self.assertRaises(ValueError, math.atanh, -1)
249 self.assertRaises(ValueError, math.atanh, INF)
250 self.assertRaises(ValueError, math.atanh, NINF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000251 self.assertTrue(math.isnan(math.atanh(NAN)))
Guido van Rossumfcce6301996-08-08 18:26:25 +0000252
Thomas Wouters89f507f2006-12-13 04:49:30 +0000253 def testAtan2(self):
254 self.assertRaises(TypeError, math.atan2)
255 self.ftest('atan2(-1, 0)', math.atan2(-1, 0), -math.pi/2)
256 self.ftest('atan2(-1, 1)', math.atan2(-1, 1), -math.pi/4)
257 self.ftest('atan2(0, 1)', math.atan2(0, 1), 0)
258 self.ftest('atan2(1, 1)', math.atan2(1, 1), math.pi/4)
259 self.ftest('atan2(1, 0)', math.atan2(1, 0), math.pi/2)
Guido van Rossumfcce6301996-08-08 18:26:25 +0000260
Christian Heimese57950f2008-04-21 13:08:03 +0000261 # math.atan2(0, x)
262 self.ftest('atan2(0., -inf)', math.atan2(0., NINF), math.pi)
263 self.ftest('atan2(0., -2.3)', math.atan2(0., -2.3), math.pi)
264 self.ftest('atan2(0., -0.)', math.atan2(0., -0.), math.pi)
265 self.assertEqual(math.atan2(0., 0.), 0.)
266 self.assertEqual(math.atan2(0., 2.3), 0.)
267 self.assertEqual(math.atan2(0., INF), 0.)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000268 self.assertTrue(math.isnan(math.atan2(0., NAN)))
Christian Heimese57950f2008-04-21 13:08:03 +0000269 # math.atan2(-0, x)
270 self.ftest('atan2(-0., -inf)', math.atan2(-0., NINF), -math.pi)
271 self.ftest('atan2(-0., -2.3)', math.atan2(-0., -2.3), -math.pi)
272 self.ftest('atan2(-0., -0.)', math.atan2(-0., -0.), -math.pi)
273 self.assertEqual(math.atan2(-0., 0.), -0.)
274 self.assertEqual(math.atan2(-0., 2.3), -0.)
275 self.assertEqual(math.atan2(-0., INF), -0.)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000276 self.assertTrue(math.isnan(math.atan2(-0., NAN)))
Christian Heimese57950f2008-04-21 13:08:03 +0000277 # math.atan2(INF, x)
278 self.ftest('atan2(inf, -inf)', math.atan2(INF, NINF), math.pi*3/4)
279 self.ftest('atan2(inf, -2.3)', math.atan2(INF, -2.3), math.pi/2)
280 self.ftest('atan2(inf, -0.)', math.atan2(INF, -0.0), math.pi/2)
281 self.ftest('atan2(inf, 0.)', math.atan2(INF, 0.0), math.pi/2)
282 self.ftest('atan2(inf, 2.3)', math.atan2(INF, 2.3), math.pi/2)
283 self.ftest('atan2(inf, inf)', math.atan2(INF, INF), math.pi/4)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000284 self.assertTrue(math.isnan(math.atan2(INF, NAN)))
Christian Heimese57950f2008-04-21 13:08:03 +0000285 # math.atan2(NINF, x)
286 self.ftest('atan2(-inf, -inf)', math.atan2(NINF, NINF), -math.pi*3/4)
287 self.ftest('atan2(-inf, -2.3)', math.atan2(NINF, -2.3), -math.pi/2)
288 self.ftest('atan2(-inf, -0.)', math.atan2(NINF, -0.0), -math.pi/2)
289 self.ftest('atan2(-inf, 0.)', math.atan2(NINF, 0.0), -math.pi/2)
290 self.ftest('atan2(-inf, 2.3)', math.atan2(NINF, 2.3), -math.pi/2)
291 self.ftest('atan2(-inf, inf)', math.atan2(NINF, INF), -math.pi/4)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000292 self.assertTrue(math.isnan(math.atan2(NINF, NAN)))
Christian Heimese57950f2008-04-21 13:08:03 +0000293 # math.atan2(+finite, x)
294 self.ftest('atan2(2.3, -inf)', math.atan2(2.3, NINF), math.pi)
295 self.ftest('atan2(2.3, -0.)', math.atan2(2.3, -0.), math.pi/2)
296 self.ftest('atan2(2.3, 0.)', math.atan2(2.3, 0.), math.pi/2)
297 self.assertEqual(math.atan2(2.3, INF), 0.)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000298 self.assertTrue(math.isnan(math.atan2(2.3, NAN)))
Christian Heimese57950f2008-04-21 13:08:03 +0000299 # math.atan2(-finite, x)
300 self.ftest('atan2(-2.3, -inf)', math.atan2(-2.3, NINF), -math.pi)
301 self.ftest('atan2(-2.3, -0.)', math.atan2(-2.3, -0.), -math.pi/2)
302 self.ftest('atan2(-2.3, 0.)', math.atan2(-2.3, 0.), -math.pi/2)
303 self.assertEqual(math.atan2(-2.3, INF), -0.)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000304 self.assertTrue(math.isnan(math.atan2(-2.3, NAN)))
Christian Heimese57950f2008-04-21 13:08:03 +0000305 # math.atan2(NAN, x)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000306 self.assertTrue(math.isnan(math.atan2(NAN, NINF)))
307 self.assertTrue(math.isnan(math.atan2(NAN, -2.3)))
308 self.assertTrue(math.isnan(math.atan2(NAN, -0.)))
309 self.assertTrue(math.isnan(math.atan2(NAN, 0.)))
310 self.assertTrue(math.isnan(math.atan2(NAN, 2.3)))
311 self.assertTrue(math.isnan(math.atan2(NAN, INF)))
312 self.assertTrue(math.isnan(math.atan2(NAN, NAN)))
Christian Heimese57950f2008-04-21 13:08:03 +0000313
Thomas Wouters89f507f2006-12-13 04:49:30 +0000314 def testCeil(self):
315 self.assertRaises(TypeError, math.ceil)
Jeffrey Yasskinc2155832008-01-05 20:03:11 +0000316 self.assertEquals(int, type(math.ceil(0.5)))
Thomas Wouters89f507f2006-12-13 04:49:30 +0000317 self.ftest('ceil(0.5)', math.ceil(0.5), 1)
318 self.ftest('ceil(1.0)', math.ceil(1.0), 1)
319 self.ftest('ceil(1.5)', math.ceil(1.5), 2)
320 self.ftest('ceil(-0.5)', math.ceil(-0.5), 0)
321 self.ftest('ceil(-1.0)', math.ceil(-1.0), -1)
322 self.ftest('ceil(-1.5)', math.ceil(-1.5), -1)
Christian Heimes53876d92008-04-19 00:31:39 +0000323 #self.assertEquals(math.ceil(INF), INF)
324 #self.assertEquals(math.ceil(NINF), NINF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000325 #self.assertTrue(math.isnan(math.ceil(NAN)))
Guido van Rossumfcce6301996-08-08 18:26:25 +0000326
Guido van Rossum13e05de2007-08-23 22:56:55 +0000327 class TestCeil:
328 def __ceil__(self):
329 return 42
330 class TestNoCeil:
331 pass
332 self.ftest('ceil(TestCeil())', math.ceil(TestCeil()), 42)
333 self.assertRaises(TypeError, math.ceil, TestNoCeil())
334
335 t = TestNoCeil()
336 t.__ceil__ = lambda *args: args
337 self.assertRaises(TypeError, math.ceil, t)
338 self.assertRaises(TypeError, math.ceil, t, 0)
339
Mark Dickinson63566232009-09-18 21:04:19 +0000340 @requires_IEEE_754
341 def testCopysign(self):
Mark Dickinson06b59e02010-02-06 23:16:50 +0000342 self.assertEqual(math.copysign(1, 42), 1.0)
343 self.assertEqual(math.copysign(0., 42), 0.0)
344 self.assertEqual(math.copysign(1., -42), -1.0)
345 self.assertEqual(math.copysign(3, 0.), 3.0)
346 self.assertEqual(math.copysign(4., -0.), -4.0)
347
Mark Dickinson63566232009-09-18 21:04:19 +0000348 self.assertRaises(TypeError, math.copysign)
349 # copysign should let us distinguish signs of zeros
Mark Dickinson06b59e02010-02-06 23:16:50 +0000350 self.assertEquals(math.copysign(1., 0.), 1.)
351 self.assertEquals(math.copysign(1., -0.), -1.)
352 self.assertEquals(math.copysign(INF, 0.), INF)
353 self.assertEquals(math.copysign(INF, -0.), NINF)
354 self.assertEquals(math.copysign(NINF, 0.), INF)
355 self.assertEquals(math.copysign(NINF, -0.), NINF)
Mark Dickinson63566232009-09-18 21:04:19 +0000356 # and of infinities
Mark Dickinson06b59e02010-02-06 23:16:50 +0000357 self.assertEquals(math.copysign(1., INF), 1.)
358 self.assertEquals(math.copysign(1., NINF), -1.)
359 self.assertEquals(math.copysign(INF, INF), INF)
360 self.assertEquals(math.copysign(INF, NINF), NINF)
361 self.assertEquals(math.copysign(NINF, INF), INF)
362 self.assertEquals(math.copysign(NINF, NINF), NINF)
363 self.assertTrue(math.isnan(math.copysign(NAN, 1.)))
364 self.assertTrue(math.isnan(math.copysign(NAN, INF)))
365 self.assertTrue(math.isnan(math.copysign(NAN, NINF)))
366 self.assertTrue(math.isnan(math.copysign(NAN, NAN)))
Mark Dickinson63566232009-09-18 21:04:19 +0000367 # copysign(INF, NAN) may be INF or it may be NINF, since
368 # we don't know whether the sign bit of NAN is set on any
369 # given platform.
Mark Dickinson06b59e02010-02-06 23:16:50 +0000370 self.assertTrue(math.isinf(math.copysign(INF, NAN)))
Mark Dickinson63566232009-09-18 21:04:19 +0000371 # similarly, copysign(2., NAN) could be 2. or -2.
Mark Dickinson06b59e02010-02-06 23:16:50 +0000372 self.assertEquals(abs(math.copysign(2., NAN)), 2.)
Christian Heimes53876d92008-04-19 00:31:39 +0000373
Thomas Wouters89f507f2006-12-13 04:49:30 +0000374 def testCos(self):
375 self.assertRaises(TypeError, math.cos)
376 self.ftest('cos(-pi/2)', math.cos(-math.pi/2), 0)
377 self.ftest('cos(0)', math.cos(0), 1)
378 self.ftest('cos(pi/2)', math.cos(math.pi/2), 0)
379 self.ftest('cos(pi)', math.cos(math.pi), -1)
Christian Heimes53876d92008-04-19 00:31:39 +0000380 try:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000381 self.assertTrue(math.isnan(math.cos(INF)))
382 self.assertTrue(math.isnan(math.cos(NINF)))
Christian Heimes53876d92008-04-19 00:31:39 +0000383 except ValueError:
384 self.assertRaises(ValueError, math.cos, INF)
385 self.assertRaises(ValueError, math.cos, NINF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000386 self.assertTrue(math.isnan(math.cos(NAN)))
Guido van Rossumfcce6301996-08-08 18:26:25 +0000387
Thomas Wouters89f507f2006-12-13 04:49:30 +0000388 def testCosh(self):
389 self.assertRaises(TypeError, math.cosh)
390 self.ftest('cosh(0)', math.cosh(0), 1)
391 self.ftest('cosh(2)-2*cosh(1)**2', math.cosh(2)-2*math.cosh(1)**2, -1) # Thanks to Lambert
Christian Heimes53876d92008-04-19 00:31:39 +0000392 self.assertEquals(math.cosh(INF), INF)
393 self.assertEquals(math.cosh(NINF), INF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000394 self.assertTrue(math.isnan(math.cosh(NAN)))
Raymond Hettinger64108af2002-05-13 03:55:01 +0000395
Thomas Wouters89f507f2006-12-13 04:49:30 +0000396 def testDegrees(self):
397 self.assertRaises(TypeError, math.degrees)
398 self.ftest('degrees(pi)', math.degrees(math.pi), 180.0)
399 self.ftest('degrees(pi/2)', math.degrees(math.pi/2), 90.0)
400 self.ftest('degrees(-pi/4)', math.degrees(-math.pi/4), -45.0)
Guido van Rossumfcce6301996-08-08 18:26:25 +0000401
Thomas Wouters89f507f2006-12-13 04:49:30 +0000402 def testExp(self):
403 self.assertRaises(TypeError, math.exp)
404 self.ftest('exp(-1)', math.exp(-1), 1/math.e)
405 self.ftest('exp(0)', math.exp(0), 1)
406 self.ftest('exp(1)', math.exp(1), math.e)
Christian Heimes53876d92008-04-19 00:31:39 +0000407 self.assertEquals(math.exp(INF), INF)
408 self.assertEquals(math.exp(NINF), 0.)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000409 self.assertTrue(math.isnan(math.exp(NAN)))
Guido van Rossumfcce6301996-08-08 18:26:25 +0000410
Thomas Wouters89f507f2006-12-13 04:49:30 +0000411 def testFabs(self):
412 self.assertRaises(TypeError, math.fabs)
413 self.ftest('fabs(-1)', math.fabs(-1), 1)
414 self.ftest('fabs(0)', math.fabs(0), 0)
415 self.ftest('fabs(1)', math.fabs(1), 1)
Guido van Rossumfcce6301996-08-08 18:26:25 +0000416
Georg Brandlc28e1fa2008-06-10 19:20:26 +0000417 def testFactorial(self):
Mark Dickinson4c8a9a22010-05-15 17:02:38 +0000418 self.assertEqual(math.factorial(0), 1)
419 self.assertEqual(math.factorial(0.0), 1)
420 total = 1
421 for i in range(1, 1000):
422 total *= i
423 self.assertEqual(math.factorial(i), total)
424 self.assertEqual(math.factorial(float(i)), total)
425 self.assertEqual(math.factorial(i), py_factorial(i))
Georg Brandlc28e1fa2008-06-10 19:20:26 +0000426 self.assertRaises(ValueError, math.factorial, -1)
Mark Dickinson4c8a9a22010-05-15 17:02:38 +0000427 self.assertRaises(ValueError, math.factorial, -1.0)
Georg Brandlc28e1fa2008-06-10 19:20:26 +0000428 self.assertRaises(ValueError, math.factorial, math.pi)
Mark Dickinson4c8a9a22010-05-15 17:02:38 +0000429 self.assertRaises(OverflowError, math.factorial, sys.maxsize+1)
430 self.assertRaises(OverflowError, math.factorial, 10e100)
Georg Brandlc28e1fa2008-06-10 19:20:26 +0000431
Thomas Wouters89f507f2006-12-13 04:49:30 +0000432 def testFloor(self):
433 self.assertRaises(TypeError, math.floor)
Jeffrey Yasskinc2155832008-01-05 20:03:11 +0000434 self.assertEquals(int, type(math.floor(0.5)))
Thomas Wouters89f507f2006-12-13 04:49:30 +0000435 self.ftest('floor(0.5)', math.floor(0.5), 0)
436 self.ftest('floor(1.0)', math.floor(1.0), 1)
437 self.ftest('floor(1.5)', math.floor(1.5), 1)
438 self.ftest('floor(-0.5)', math.floor(-0.5), -1)
439 self.ftest('floor(-1.0)', math.floor(-1.0), -1)
440 self.ftest('floor(-1.5)', math.floor(-1.5), -2)
Guido van Rossum806c2462007-08-06 23:33:07 +0000441 # pow() relies on floor() to check for integers
442 # This fails on some platforms - so check it here
443 self.ftest('floor(1.23e167)', math.floor(1.23e167), 1.23e167)
444 self.ftest('floor(-1.23e167)', math.floor(-1.23e167), -1.23e167)
Christian Heimes53876d92008-04-19 00:31:39 +0000445 #self.assertEquals(math.ceil(INF), INF)
446 #self.assertEquals(math.ceil(NINF), NINF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000447 #self.assertTrue(math.isnan(math.floor(NAN)))
Guido van Rossumfcce6301996-08-08 18:26:25 +0000448
Guido van Rossum13e05de2007-08-23 22:56:55 +0000449 class TestFloor:
450 def __floor__(self):
451 return 42
452 class TestNoFloor:
453 pass
454 self.ftest('floor(TestFloor())', math.floor(TestFloor()), 42)
455 self.assertRaises(TypeError, math.floor, TestNoFloor())
456
457 t = TestNoFloor()
458 t.__floor__ = lambda *args: args
459 self.assertRaises(TypeError, math.floor, t)
460 self.assertRaises(TypeError, math.floor, t, 0)
461
Thomas Wouters89f507f2006-12-13 04:49:30 +0000462 def testFmod(self):
463 self.assertRaises(TypeError, math.fmod)
464 self.ftest('fmod(10,1)', math.fmod(10,1), 0)
465 self.ftest('fmod(10,0.5)', math.fmod(10,0.5), 0)
466 self.ftest('fmod(10,1.5)', math.fmod(10,1.5), 1)
467 self.ftest('fmod(-10,1)', math.fmod(-10,1), 0)
468 self.ftest('fmod(-10,0.5)', math.fmod(-10,0.5), 0)
469 self.ftest('fmod(-10,1.5)', math.fmod(-10,1.5), -1)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000470 self.assertTrue(math.isnan(math.fmod(NAN, 1.)))
471 self.assertTrue(math.isnan(math.fmod(1., NAN)))
472 self.assertTrue(math.isnan(math.fmod(NAN, NAN)))
Christian Heimes53876d92008-04-19 00:31:39 +0000473 self.assertRaises(ValueError, math.fmod, 1., 0.)
474 self.assertRaises(ValueError, math.fmod, INF, 1.)
475 self.assertRaises(ValueError, math.fmod, NINF, 1.)
476 self.assertRaises(ValueError, math.fmod, INF, 0.)
477 self.assertEquals(math.fmod(3.0, INF), 3.0)
478 self.assertEquals(math.fmod(-3.0, INF), -3.0)
479 self.assertEquals(math.fmod(3.0, NINF), 3.0)
480 self.assertEquals(math.fmod(-3.0, NINF), -3.0)
481 self.assertEquals(math.fmod(0.0, 3.0), 0.0)
482 self.assertEquals(math.fmod(0.0, NINF), 0.0)
Guido van Rossumfcce6301996-08-08 18:26:25 +0000483
Thomas Wouters89f507f2006-12-13 04:49:30 +0000484 def testFrexp(self):
485 self.assertRaises(TypeError, math.frexp)
Guido van Rossumfcce6301996-08-08 18:26:25 +0000486
Guido van Rossum1bc535d2007-05-15 18:46:22 +0000487 def testfrexp(name, result, expected):
488 (mant, exp), (emant, eexp) = result, expected
Thomas Wouters89f507f2006-12-13 04:49:30 +0000489 if abs(mant-emant) > eps or exp != eexp:
490 self.fail('%s returned %r, expected %r'%\
Guido van Rossum1bc535d2007-05-15 18:46:22 +0000491 (name, result, expected))
Guido van Rossumfcce6301996-08-08 18:26:25 +0000492
Thomas Wouters89f507f2006-12-13 04:49:30 +0000493 testfrexp('frexp(-1)', math.frexp(-1), (-0.5, 1))
494 testfrexp('frexp(0)', math.frexp(0), (0, 0))
495 testfrexp('frexp(1)', math.frexp(1), (0.5, 1))
496 testfrexp('frexp(2)', math.frexp(2), (0.5, 2))
Guido van Rossumfcce6301996-08-08 18:26:25 +0000497
Christian Heimes53876d92008-04-19 00:31:39 +0000498 self.assertEquals(math.frexp(INF)[0], INF)
499 self.assertEquals(math.frexp(NINF)[0], NINF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000500 self.assertTrue(math.isnan(math.frexp(NAN)[0]))
Christian Heimes53876d92008-04-19 00:31:39 +0000501
Mark Dickinson63566232009-09-18 21:04:19 +0000502 @requires_IEEE_754
Mark Dickinson5c567082009-04-24 16:39:07 +0000503 @unittest.skipIf(HAVE_DOUBLE_ROUNDING,
504 "fsum is not exact on machines with double rounding")
Mark Dickinsonaa7633a2008-08-01 08:16:13 +0000505 def testFsum(self):
506 # math.fsum relies on exact rounding for correct operation.
507 # There's a known problem with IA32 floating-point that causes
508 # inexact rounding in some situations, and will cause the
509 # math.fsum tests below to fail; see issue #2937. On non IEEE
510 # 754 platforms, and on IEEE 754 platforms that exhibit the
511 # problem described in issue #2937, we simply skip the whole
512 # test.
513
Mark Dickinsonaa7633a2008-08-01 08:16:13 +0000514 # Python version of math.fsum, for comparison. Uses a
515 # different algorithm based on frexp, ldexp and integer
516 # arithmetic.
517 from sys import float_info
518 mant_dig = float_info.mant_dig
519 etiny = float_info.min_exp - mant_dig
520
521 def msum(iterable):
522 """Full precision summation. Compute sum(iterable) without any
523 intermediate accumulation of error. Based on the 'lsum' function
524 at http://code.activestate.com/recipes/393090/
525
526 """
527 tmant, texp = 0, 0
528 for x in iterable:
529 mant, exp = math.frexp(x)
530 mant, exp = int(math.ldexp(mant, mant_dig)), exp - mant_dig
531 if texp > exp:
532 tmant <<= texp-exp
533 texp = exp
534 else:
535 mant <<= exp-texp
536 tmant += mant
537 # Round tmant * 2**texp to a float. The original recipe
538 # used float(str(tmant)) * 2.0**texp for this, but that's
539 # a little unsafe because str -> float conversion can't be
540 # relied upon to do correct rounding on all platforms.
541 tail = max(len(bin(abs(tmant)))-2 - mant_dig, etiny - texp)
542 if tail > 0:
543 h = 1 << (tail-1)
544 tmant = tmant // (2*h) + bool(tmant & h and tmant & 3*h-1)
545 texp += tail
546 return math.ldexp(tmant, texp)
547
548 test_values = [
549 ([], 0.0),
550 ([0.0], 0.0),
551 ([1e100, 1.0, -1e100, 1e-100, 1e50, -1.0, -1e50], 1e-100),
552 ([2.0**53, -0.5, -2.0**-54], 2.0**53-1.0),
553 ([2.0**53, 1.0, 2.0**-100], 2.0**53+2.0),
554 ([2.0**53+10.0, 1.0, 2.0**-100], 2.0**53+12.0),
555 ([2.0**53-4.0, 0.5, 2.0**-54], 2.0**53-3.0),
556 ([1./n for n in range(1, 1001)],
557 float.fromhex('0x1.df11f45f4e61ap+2')),
558 ([(-1.)**n/n for n in range(1, 1001)],
559 float.fromhex('-0x1.62a2af1bd3624p-1')),
560 ([1.7**(i+1)-1.7**i for i in range(1000)] + [-1.7**1000], -1.0),
561 ([1e16, 1., 1e-16], 10000000000000002.0),
562 ([1e16-2., 1.-2.**-53, -(1e16-2.), -(1.-2.**-53)], 0.0),
563 # exercise code for resizing partials array
564 ([2.**n - 2.**(n+50) + 2.**(n+52) for n in range(-1074, 972, 2)] +
565 [-2.**1022],
566 float.fromhex('0x1.5555555555555p+970')),
567 ]
568
569 for i, (vals, expected) in enumerate(test_values):
570 try:
571 actual = math.fsum(vals)
572 except OverflowError:
573 self.fail("test %d failed: got OverflowError, expected %r "
574 "for math.fsum(%.100r)" % (i, expected, vals))
575 except ValueError:
576 self.fail("test %d failed: got ValueError, expected %r "
577 "for math.fsum(%.100r)" % (i, expected, vals))
578 self.assertEqual(actual, expected)
579
580 from random import random, gauss, shuffle
581 for j in range(1000):
582 vals = [7, 1e100, -7, -1e100, -9e-20, 8e-20] * 10
583 s = 0
584 for i in range(200):
585 v = gauss(0, random()) ** 7 - s
586 s += v
587 vals.append(v)
588 shuffle(vals)
589
590 s = msum(vals)
591 self.assertEqual(msum(vals), math.fsum(vals))
592
Thomas Wouters89f507f2006-12-13 04:49:30 +0000593 def testHypot(self):
594 self.assertRaises(TypeError, math.hypot)
595 self.ftest('hypot(0,0)', math.hypot(0,0), 0)
596 self.ftest('hypot(3,4)', math.hypot(3,4), 5)
Christian Heimes53876d92008-04-19 00:31:39 +0000597 self.assertEqual(math.hypot(NAN, INF), INF)
598 self.assertEqual(math.hypot(INF, NAN), INF)
599 self.assertEqual(math.hypot(NAN, NINF), INF)
600 self.assertEqual(math.hypot(NINF, NAN), INF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000601 self.assertTrue(math.isnan(math.hypot(1.0, NAN)))
602 self.assertTrue(math.isnan(math.hypot(NAN, -2.0)))
Guido van Rossumfcce6301996-08-08 18:26:25 +0000603
Thomas Wouters89f507f2006-12-13 04:49:30 +0000604 def testLdexp(self):
605 self.assertRaises(TypeError, math.ldexp)
606 self.ftest('ldexp(0,1)', math.ldexp(0,1), 0)
607 self.ftest('ldexp(1,1)', math.ldexp(1,1), 2)
608 self.ftest('ldexp(1,-1)', math.ldexp(1,-1), 0.5)
609 self.ftest('ldexp(-1,1)', math.ldexp(-1,1), -2)
Christian Heimes53876d92008-04-19 00:31:39 +0000610 self.assertRaises(OverflowError, math.ldexp, 1., 1000000)
611 self.assertRaises(OverflowError, math.ldexp, -1., 1000000)
612 self.assertEquals(math.ldexp(1., -1000000), 0.)
613 self.assertEquals(math.ldexp(-1., -1000000), -0.)
614 self.assertEquals(math.ldexp(INF, 30), INF)
615 self.assertEquals(math.ldexp(NINF, -213), NINF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000616 self.assertTrue(math.isnan(math.ldexp(NAN, 0)))
Guido van Rossumfcce6301996-08-08 18:26:25 +0000617
Alexandre Vassalotti6461e102008-05-15 22:09:29 +0000618 # large second argument
619 for n in [10**5, 10**10, 10**20, 10**40]:
620 self.assertEquals(math.ldexp(INF, -n), INF)
621 self.assertEquals(math.ldexp(NINF, -n), NINF)
622 self.assertEquals(math.ldexp(1., -n), 0.)
623 self.assertEquals(math.ldexp(-1., -n), -0.)
624 self.assertEquals(math.ldexp(0., -n), 0.)
625 self.assertEquals(math.ldexp(-0., -n), -0.)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000626 self.assertTrue(math.isnan(math.ldexp(NAN, -n)))
Alexandre Vassalotti6461e102008-05-15 22:09:29 +0000627
628 self.assertRaises(OverflowError, math.ldexp, 1., n)
629 self.assertRaises(OverflowError, math.ldexp, -1., n)
630 self.assertEquals(math.ldexp(0., n), 0.)
631 self.assertEquals(math.ldexp(-0., n), -0.)
632 self.assertEquals(math.ldexp(INF, n), INF)
633 self.assertEquals(math.ldexp(NINF, n), NINF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000634 self.assertTrue(math.isnan(math.ldexp(NAN, n)))
Alexandre Vassalotti6461e102008-05-15 22:09:29 +0000635
Thomas Wouters89f507f2006-12-13 04:49:30 +0000636 def testLog(self):
637 self.assertRaises(TypeError, math.log)
638 self.ftest('log(1/e)', math.log(1/math.e), -1)
639 self.ftest('log(1)', math.log(1), 0)
640 self.ftest('log(e)', math.log(math.e), 1)
641 self.ftest('log(32,2)', math.log(32,2), 5)
642 self.ftest('log(10**40, 10)', math.log(10**40, 10), 40)
643 self.ftest('log(10**40, 10**20)', math.log(10**40, 10**20), 2)
Mark Dickinsonc6037172010-09-29 19:06:36 +0000644 self.ftest('log(10**1000)', math.log(10**1000),
645 2302.5850929940457)
646 self.assertRaises(ValueError, math.log, -1.5)
647 self.assertRaises(ValueError, math.log, -10**1000)
Christian Heimes53876d92008-04-19 00:31:39 +0000648 self.assertRaises(ValueError, math.log, NINF)
Mark Dickinsonc6037172010-09-29 19:06:36 +0000649 self.assertEquals(math.log(INF), INF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000650 self.assertTrue(math.isnan(math.log(NAN)))
Christian Heimes53876d92008-04-19 00:31:39 +0000651
652 def testLog1p(self):
653 self.assertRaises(TypeError, math.log1p)
Christian Heimes53876d92008-04-19 00:31:39 +0000654 n= 2**90
Christian Heimes53876d92008-04-19 00:31:39 +0000655 self.assertAlmostEquals(math.log1p(n), math.log1p(float(n)))
Guido van Rossumfcce6301996-08-08 18:26:25 +0000656
Thomas Wouters89f507f2006-12-13 04:49:30 +0000657 def testLog10(self):
658 self.assertRaises(TypeError, math.log10)
659 self.ftest('log10(0.1)', math.log10(0.1), -1)
660 self.ftest('log10(1)', math.log10(1), 0)
661 self.ftest('log10(10)', math.log10(10), 1)
Mark Dickinsonc6037172010-09-29 19:06:36 +0000662 self.ftest('log10(10**1000)', math.log10(10**1000), 1000.0)
663 self.assertRaises(ValueError, math.log10, -1.5)
664 self.assertRaises(ValueError, math.log10, -10**1000)
Christian Heimes53876d92008-04-19 00:31:39 +0000665 self.assertRaises(ValueError, math.log10, NINF)
Mark Dickinsonc6037172010-09-29 19:06:36 +0000666 self.assertEquals(math.log(INF), INF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000667 self.assertTrue(math.isnan(math.log10(NAN)))
Guido van Rossumfcce6301996-08-08 18:26:25 +0000668
Thomas Wouters89f507f2006-12-13 04:49:30 +0000669 def testModf(self):
670 self.assertRaises(TypeError, math.modf)
Guido van Rossumfcce6301996-08-08 18:26:25 +0000671
Guido van Rossum1bc535d2007-05-15 18:46:22 +0000672 def testmodf(name, result, expected):
673 (v1, v2), (e1, e2) = result, expected
Thomas Wouters89f507f2006-12-13 04:49:30 +0000674 if abs(v1-e1) > eps or abs(v2-e2):
675 self.fail('%s returned %r, expected %r'%\
Guido van Rossum1bc535d2007-05-15 18:46:22 +0000676 (name, result, expected))
Raymond Hettinger64108af2002-05-13 03:55:01 +0000677
Thomas Wouters89f507f2006-12-13 04:49:30 +0000678 testmodf('modf(1.5)', math.modf(1.5), (0.5, 1.0))
679 testmodf('modf(-1.5)', math.modf(-1.5), (-0.5, -1.0))
Guido van Rossumfcce6301996-08-08 18:26:25 +0000680
Christian Heimes53876d92008-04-19 00:31:39 +0000681 self.assertEquals(math.modf(INF), (0.0, INF))
682 self.assertEquals(math.modf(NINF), (-0.0, NINF))
683
684 modf_nan = math.modf(NAN)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000685 self.assertTrue(math.isnan(modf_nan[0]))
686 self.assertTrue(math.isnan(modf_nan[1]))
Christian Heimes53876d92008-04-19 00:31:39 +0000687
Thomas Wouters89f507f2006-12-13 04:49:30 +0000688 def testPow(self):
689 self.assertRaises(TypeError, math.pow)
690 self.ftest('pow(0,1)', math.pow(0,1), 0)
691 self.ftest('pow(1,0)', math.pow(1,0), 1)
692 self.ftest('pow(2,1)', math.pow(2,1), 2)
693 self.ftest('pow(2,-1)', math.pow(2,-1), 0.5)
Christian Heimes53876d92008-04-19 00:31:39 +0000694 self.assertEqual(math.pow(INF, 1), INF)
695 self.assertEqual(math.pow(NINF, 1), NINF)
696 self.assertEqual((math.pow(1, INF)), 1.)
697 self.assertEqual((math.pow(1, NINF)), 1.)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000698 self.assertTrue(math.isnan(math.pow(NAN, 1)))
699 self.assertTrue(math.isnan(math.pow(2, NAN)))
700 self.assertTrue(math.isnan(math.pow(0, NAN)))
Christian Heimes53876d92008-04-19 00:31:39 +0000701 self.assertEqual(math.pow(1, NAN), 1)
Christian Heimesa342c012008-04-20 21:01:16 +0000702
703 # pow(0., x)
704 self.assertEqual(math.pow(0., INF), 0.)
705 self.assertEqual(math.pow(0., 3.), 0.)
706 self.assertEqual(math.pow(0., 2.3), 0.)
707 self.assertEqual(math.pow(0., 2.), 0.)
708 self.assertEqual(math.pow(0., 0.), 1.)
709 self.assertEqual(math.pow(0., -0.), 1.)
710 self.assertRaises(ValueError, math.pow, 0., -2.)
711 self.assertRaises(ValueError, math.pow, 0., -2.3)
712 self.assertRaises(ValueError, math.pow, 0., -3.)
713 self.assertRaises(ValueError, math.pow, 0., NINF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000714 self.assertTrue(math.isnan(math.pow(0., NAN)))
Christian Heimesa342c012008-04-20 21:01:16 +0000715
716 # pow(INF, x)
717 self.assertEqual(math.pow(INF, INF), INF)
718 self.assertEqual(math.pow(INF, 3.), INF)
719 self.assertEqual(math.pow(INF, 2.3), INF)
720 self.assertEqual(math.pow(INF, 2.), INF)
721 self.assertEqual(math.pow(INF, 0.), 1.)
722 self.assertEqual(math.pow(INF, -0.), 1.)
723 self.assertEqual(math.pow(INF, -2.), 0.)
724 self.assertEqual(math.pow(INF, -2.3), 0.)
725 self.assertEqual(math.pow(INF, -3.), 0.)
726 self.assertEqual(math.pow(INF, NINF), 0.)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000727 self.assertTrue(math.isnan(math.pow(INF, NAN)))
Christian Heimesa342c012008-04-20 21:01:16 +0000728
729 # pow(-0., x)
730 self.assertEqual(math.pow(-0., INF), 0.)
731 self.assertEqual(math.pow(-0., 3.), -0.)
732 self.assertEqual(math.pow(-0., 2.3), 0.)
733 self.assertEqual(math.pow(-0., 2.), 0.)
734 self.assertEqual(math.pow(-0., 0.), 1.)
735 self.assertEqual(math.pow(-0., -0.), 1.)
736 self.assertRaises(ValueError, math.pow, -0., -2.)
737 self.assertRaises(ValueError, math.pow, -0., -2.3)
738 self.assertRaises(ValueError, math.pow, -0., -3.)
739 self.assertRaises(ValueError, math.pow, -0., NINF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000740 self.assertTrue(math.isnan(math.pow(-0., NAN)))
Christian Heimesa342c012008-04-20 21:01:16 +0000741
742 # pow(NINF, x)
743 self.assertEqual(math.pow(NINF, INF), INF)
744 self.assertEqual(math.pow(NINF, 3.), NINF)
745 self.assertEqual(math.pow(NINF, 2.3), INF)
746 self.assertEqual(math.pow(NINF, 2.), INF)
747 self.assertEqual(math.pow(NINF, 0.), 1.)
748 self.assertEqual(math.pow(NINF, -0.), 1.)
749 self.assertEqual(math.pow(NINF, -2.), 0.)
750 self.assertEqual(math.pow(NINF, -2.3), 0.)
751 self.assertEqual(math.pow(NINF, -3.), -0.)
752 self.assertEqual(math.pow(NINF, NINF), 0.)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000753 self.assertTrue(math.isnan(math.pow(NINF, NAN)))
Christian Heimesa342c012008-04-20 21:01:16 +0000754
755 # pow(-1, x)
756 self.assertEqual(math.pow(-1., INF), 1.)
757 self.assertEqual(math.pow(-1., 3.), -1.)
758 self.assertRaises(ValueError, math.pow, -1., 2.3)
759 self.assertEqual(math.pow(-1., 2.), 1.)
760 self.assertEqual(math.pow(-1., 0.), 1.)
761 self.assertEqual(math.pow(-1., -0.), 1.)
762 self.assertEqual(math.pow(-1., -2.), 1.)
763 self.assertRaises(ValueError, math.pow, -1., -2.3)
764 self.assertEqual(math.pow(-1., -3.), -1.)
765 self.assertEqual(math.pow(-1., NINF), 1.)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000766 self.assertTrue(math.isnan(math.pow(-1., NAN)))
Christian Heimesa342c012008-04-20 21:01:16 +0000767
768 # pow(1, x)
769 self.assertEqual(math.pow(1., INF), 1.)
770 self.assertEqual(math.pow(1., 3.), 1.)
771 self.assertEqual(math.pow(1., 2.3), 1.)
772 self.assertEqual(math.pow(1., 2.), 1.)
773 self.assertEqual(math.pow(1., 0.), 1.)
774 self.assertEqual(math.pow(1., -0.), 1.)
775 self.assertEqual(math.pow(1., -2.), 1.)
776 self.assertEqual(math.pow(1., -2.3), 1.)
777 self.assertEqual(math.pow(1., -3.), 1.)
778 self.assertEqual(math.pow(1., NINF), 1.)
779 self.assertEqual(math.pow(1., NAN), 1.)
780
781 # pow(x, 0) should be 1 for any x
782 self.assertEqual(math.pow(2.3, 0.), 1.)
783 self.assertEqual(math.pow(-2.3, 0.), 1.)
784 self.assertEqual(math.pow(NAN, 0.), 1.)
785 self.assertEqual(math.pow(2.3, -0.), 1.)
786 self.assertEqual(math.pow(-2.3, -0.), 1.)
787 self.assertEqual(math.pow(NAN, -0.), 1.)
788
789 # pow(x, y) is invalid if x is negative and y is not integral
790 self.assertRaises(ValueError, math.pow, -1., 2.3)
791 self.assertRaises(ValueError, math.pow, -15., -3.1)
792
793 # pow(x, NINF)
794 self.assertEqual(math.pow(1.9, NINF), 0.)
795 self.assertEqual(math.pow(1.1, NINF), 0.)
796 self.assertEqual(math.pow(0.9, NINF), INF)
797 self.assertEqual(math.pow(0.1, NINF), INF)
798 self.assertEqual(math.pow(-0.1, NINF), INF)
799 self.assertEqual(math.pow(-0.9, NINF), INF)
800 self.assertEqual(math.pow(-1.1, NINF), 0.)
801 self.assertEqual(math.pow(-1.9, NINF), 0.)
802
803 # pow(x, INF)
804 self.assertEqual(math.pow(1.9, INF), INF)
805 self.assertEqual(math.pow(1.1, INF), INF)
806 self.assertEqual(math.pow(0.9, INF), 0.)
807 self.assertEqual(math.pow(0.1, INF), 0.)
808 self.assertEqual(math.pow(-0.1, INF), 0.)
809 self.assertEqual(math.pow(-0.9, INF), 0.)
810 self.assertEqual(math.pow(-1.1, INF), INF)
811 self.assertEqual(math.pow(-1.9, INF), INF)
812
813 # pow(x, y) should work for x negative, y an integer
814 self.ftest('(-2.)**3.', math.pow(-2.0, 3.0), -8.0)
815 self.ftest('(-2.)**2.', math.pow(-2.0, 2.0), 4.0)
816 self.ftest('(-2.)**1.', math.pow(-2.0, 1.0), -2.0)
817 self.ftest('(-2.)**0.', math.pow(-2.0, 0.0), 1.0)
818 self.ftest('(-2.)**-0.', math.pow(-2.0, -0.0), 1.0)
819 self.ftest('(-2.)**-1.', math.pow(-2.0, -1.0), -0.5)
820 self.ftest('(-2.)**-2.', math.pow(-2.0, -2.0), 0.25)
821 self.ftest('(-2.)**-3.', math.pow(-2.0, -3.0), -0.125)
822 self.assertRaises(ValueError, math.pow, -2.0, -0.5)
823 self.assertRaises(ValueError, math.pow, -2.0, 0.5)
824
825 # the following tests have been commented out since they don't
826 # really belong here: the implementation of ** for floats is
827 # independent of the implemention of math.pow
828 #self.assertEqual(1**NAN, 1)
829 #self.assertEqual(1**INF, 1)
830 #self.assertEqual(1**NINF, 1)
831 #self.assertEqual(1**0, 1)
832 #self.assertEqual(1.**NAN, 1)
833 #self.assertEqual(1.**INF, 1)
834 #self.assertEqual(1.**NINF, 1)
835 #self.assertEqual(1.**0, 1)
Guido van Rossumfcce6301996-08-08 18:26:25 +0000836
Thomas Wouters89f507f2006-12-13 04:49:30 +0000837 def testRadians(self):
838 self.assertRaises(TypeError, math.radians)
839 self.ftest('radians(180)', math.radians(180), math.pi)
840 self.ftest('radians(90)', math.radians(90), math.pi/2)
841 self.ftest('radians(-45)', math.radians(-45), -math.pi/4)
Guido van Rossumfcce6301996-08-08 18:26:25 +0000842
Thomas Wouters89f507f2006-12-13 04:49:30 +0000843 def testSin(self):
844 self.assertRaises(TypeError, math.sin)
845 self.ftest('sin(0)', math.sin(0), 0)
846 self.ftest('sin(pi/2)', math.sin(math.pi/2), 1)
847 self.ftest('sin(-pi/2)', math.sin(-math.pi/2), -1)
Christian Heimes53876d92008-04-19 00:31:39 +0000848 try:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000849 self.assertTrue(math.isnan(math.sin(INF)))
850 self.assertTrue(math.isnan(math.sin(NINF)))
Christian Heimes53876d92008-04-19 00:31:39 +0000851 except ValueError:
852 self.assertRaises(ValueError, math.sin, INF)
853 self.assertRaises(ValueError, math.sin, NINF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000854 self.assertTrue(math.isnan(math.sin(NAN)))
Guido van Rossumfcce6301996-08-08 18:26:25 +0000855
Thomas Wouters89f507f2006-12-13 04:49:30 +0000856 def testSinh(self):
857 self.assertRaises(TypeError, math.sinh)
858 self.ftest('sinh(0)', math.sinh(0), 0)
859 self.ftest('sinh(1)**2-cosh(1)**2', math.sinh(1)**2-math.cosh(1)**2, -1)
860 self.ftest('sinh(1)+sinh(-1)', math.sinh(1)+math.sinh(-1), 0)
Christian Heimes53876d92008-04-19 00:31:39 +0000861 self.assertEquals(math.sinh(INF), INF)
Christian Heimesa342c012008-04-20 21:01:16 +0000862 self.assertEquals(math.sinh(NINF), NINF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000863 self.assertTrue(math.isnan(math.sinh(NAN)))
Tim Peters1d120612000-10-12 06:10:25 +0000864
Thomas Wouters89f507f2006-12-13 04:49:30 +0000865 def testSqrt(self):
866 self.assertRaises(TypeError, math.sqrt)
867 self.ftest('sqrt(0)', math.sqrt(0), 0)
868 self.ftest('sqrt(1)', math.sqrt(1), 1)
869 self.ftest('sqrt(4)', math.sqrt(4), 2)
Christian Heimes53876d92008-04-19 00:31:39 +0000870 self.assertEquals(math.sqrt(INF), INF)
871 self.assertRaises(ValueError, math.sqrt, NINF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000872 self.assertTrue(math.isnan(math.sqrt(NAN)))
Tim Peters1d120612000-10-12 06:10:25 +0000873
Thomas Wouters89f507f2006-12-13 04:49:30 +0000874 def testTan(self):
875 self.assertRaises(TypeError, math.tan)
876 self.ftest('tan(0)', math.tan(0), 0)
877 self.ftest('tan(pi/4)', math.tan(math.pi/4), 1)
878 self.ftest('tan(-pi/4)', math.tan(-math.pi/4), -1)
Christian Heimes53876d92008-04-19 00:31:39 +0000879 try:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000880 self.assertTrue(math.isnan(math.tan(INF)))
881 self.assertTrue(math.isnan(math.tan(NINF)))
Christian Heimes53876d92008-04-19 00:31:39 +0000882 except:
883 self.assertRaises(ValueError, math.tan, INF)
884 self.assertRaises(ValueError, math.tan, NINF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000885 self.assertTrue(math.isnan(math.tan(NAN)))
Tim Peters1d120612000-10-12 06:10:25 +0000886
Thomas Wouters89f507f2006-12-13 04:49:30 +0000887 def testTanh(self):
888 self.assertRaises(TypeError, math.tanh)
889 self.ftest('tanh(0)', math.tanh(0), 0)
890 self.ftest('tanh(1)+tanh(-1)', math.tanh(1)+math.tanh(-1), 0)
Christian Heimes53876d92008-04-19 00:31:39 +0000891 self.ftest('tanh(inf)', math.tanh(INF), 1)
892 self.ftest('tanh(-inf)', math.tanh(NINF), -1)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000893 self.assertTrue(math.isnan(math.tanh(NAN)))
Christian Heimese57950f2008-04-21 13:08:03 +0000894 # check that tanh(-0.) == -0. on IEEE 754 systems
895 if float.__getformat__("double").startswith("IEEE"):
896 self.assertEqual(math.tanh(-0.), -0.)
897 self.assertEqual(math.copysign(1., math.tanh(-0.)),
898 math.copysign(1., -0.))
Tim Peters1d120612000-10-12 06:10:25 +0000899
Christian Heimes400adb02008-02-01 08:12:03 +0000900 def test_trunc(self):
901 self.assertEqual(math.trunc(1), 1)
902 self.assertEqual(math.trunc(-1), -1)
903 self.assertEqual(type(math.trunc(1)), int)
904 self.assertEqual(type(math.trunc(1.5)), int)
905 self.assertEqual(math.trunc(1.5), 1)
906 self.assertEqual(math.trunc(-1.5), -1)
907 self.assertEqual(math.trunc(1.999999), 1)
908 self.assertEqual(math.trunc(-1.999999), -1)
909 self.assertEqual(math.trunc(-0.999999), -0)
910 self.assertEqual(math.trunc(-100.999), -100)
911
912 class TestTrunc(object):
913 def __trunc__(self):
914 return 23
915
916 class TestNoTrunc(object):
917 pass
918
919 self.assertEqual(math.trunc(TestTrunc()), 23)
920
921 self.assertRaises(TypeError, math.trunc)
922 self.assertRaises(TypeError, math.trunc, 1, 2)
923 self.assertRaises(TypeError, math.trunc, TestNoTrunc())
924
Mark Dickinson8e0c9962010-07-11 17:38:24 +0000925 def testIsfinite(self):
926 self.assertTrue(math.isfinite(0.0))
927 self.assertTrue(math.isfinite(-0.0))
928 self.assertTrue(math.isfinite(1.0))
929 self.assertTrue(math.isfinite(-1.0))
930 self.assertFalse(math.isfinite(float("nan")))
931 self.assertFalse(math.isfinite(float("inf")))
932 self.assertFalse(math.isfinite(float("-inf")))
933
Christian Heimes072c0f12008-01-03 23:01:04 +0000934 def testIsnan(self):
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000935 self.assertTrue(math.isnan(float("nan")))
936 self.assertTrue(math.isnan(float("inf")* 0.))
937 self.assertFalse(math.isnan(float("inf")))
938 self.assertFalse(math.isnan(0.))
939 self.assertFalse(math.isnan(1.))
Christian Heimes072c0f12008-01-03 23:01:04 +0000940
941 def testIsinf(self):
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000942 self.assertTrue(math.isinf(float("inf")))
943 self.assertTrue(math.isinf(float("-inf")))
944 self.assertTrue(math.isinf(1E400))
945 self.assertTrue(math.isinf(-1E400))
946 self.assertFalse(math.isinf(float("nan")))
947 self.assertFalse(math.isinf(0.))
948 self.assertFalse(math.isinf(1.))
Christian Heimes072c0f12008-01-03 23:01:04 +0000949
Thomas Wouters89f507f2006-12-13 04:49:30 +0000950 # RED_FLAG 16-Oct-2000 Tim
951 # While 2.0 is more consistent about exceptions than previous releases, it
952 # still fails this part of the test on some platforms. For now, we only
953 # *run* test_exceptions() in verbose mode, so that this isn't normally
954 # tested.
Tim Peters98c81842000-10-16 17:35:13 +0000955
Thomas Wouters89f507f2006-12-13 04:49:30 +0000956 if verbose:
957 def test_exceptions(self):
958 try:
959 x = math.exp(-1000000000)
960 except:
961 # mathmodule.c is failing to weed out underflows from libm, or
962 # we've got an fp format with huge dynamic range
963 self.fail("underflowing exp() should not have raised "
964 "an exception")
965 if x != 0:
966 self.fail("underflowing exp() should have returned 0")
967
968 # If this fails, probably using a strict IEEE-754 conforming libm, and x
969 # is +Inf afterwards. But Python wants overflows detected by default.
970 try:
971 x = math.exp(1000000000)
972 except OverflowError:
973 pass
974 else:
975 self.fail("overflowing exp() didn't trigger OverflowError")
976
977 # If this fails, it could be a puzzle. One odd possibility is that
978 # mathmodule.c's macros are getting confused while comparing
979 # Inf (HUGE_VAL) to a NaN, and artificially setting errno to ERANGE
980 # as a result (and so raising OverflowError instead).
981 try:
982 x = math.sqrt(-1.0)
983 except ValueError:
984 pass
985 else:
986 self.fail("sqrt(-1) didn't raise ValueError")
987
Mark Dickinson63566232009-09-18 21:04:19 +0000988 @requires_IEEE_754
Christian Heimes53876d92008-04-19 00:31:39 +0000989 def test_testfile(self):
Christian Heimes53876d92008-04-19 00:31:39 +0000990 for id, fn, ar, ai, er, ei, flags in parse_testfile(test_file):
991 # Skip if either the input or result is complex, or if
992 # flags is nonempty
993 if ai != 0. or ei != 0. or flags:
994 continue
995 if fn in ['rect', 'polar']:
996 # no real versions of rect, polar
997 continue
998 func = getattr(math, fn)
Christian Heimesa342c012008-04-20 21:01:16 +0000999 try:
1000 result = func(ar)
Mark Dickinsona0de26c2008-04-30 23:30:57 +00001001 except ValueError as exc:
1002 message = (("Unexpected ValueError: %s\n " +
1003 "in test %s:%s(%r)\n") % (exc.args[0], id, fn, ar))
Christian Heimesa342c012008-04-20 21:01:16 +00001004 self.fail(message)
Benjamin Peterson2b7411d2008-05-26 17:36:47 +00001005 except OverflowError:
1006 message = ("Unexpected OverflowError in " +
1007 "test %s:%s(%r)\n" % (id, fn, ar))
1008 self.fail(message)
Christian Heimes53876d92008-04-19 00:31:39 +00001009 self.ftest("%s:%s(%r)" % (id, fn, ar), result, er)
Thomas Wouters89f507f2006-12-13 04:49:30 +00001010
Mark Dickinson12c4bdb2009-09-28 19:21:11 +00001011 @unittest.skipUnless(float.__getformat__("double").startswith("IEEE"),
1012 "test requires IEEE 754 doubles")
1013 def test_mtestfile(self):
1014 ALLOWED_ERROR = 20 # permitted error, in ulps
1015 fail_fmt = "{}:{}({!r}): expected {!r}, got {!r}"
1016
1017 failures = []
1018 for id, fn, arg, expected, flags in parse_mtestfile(math_testcases):
1019 func = getattr(math, fn)
1020
1021 if 'invalid' in flags or 'divide-by-zero' in flags:
1022 expected = 'ValueError'
1023 elif 'overflow' in flags:
1024 expected = 'OverflowError'
1025
1026 try:
1027 got = func(arg)
1028 except ValueError:
1029 got = 'ValueError'
1030 except OverflowError:
1031 got = 'OverflowError'
1032
Mark Dickinson05d2e082009-12-11 20:17:17 +00001033 accuracy_failure = None
Mark Dickinson12c4bdb2009-09-28 19:21:11 +00001034 if isinstance(got, float) and isinstance(expected, float):
1035 if math.isnan(expected) and math.isnan(got):
1036 continue
1037 if not math.isnan(expected) and not math.isnan(got):
Mark Dickinson664b5112009-12-16 20:23:42 +00001038 if fn == 'lgamma':
1039 # we use a weaker accuracy test for lgamma;
1040 # lgamma only achieves an absolute error of
1041 # a few multiples of the machine accuracy, in
1042 # general.
Mark Dickinson05d2e082009-12-11 20:17:17 +00001043 accuracy_failure = acc_check(expected, got,
1044 rel_err = 5e-15,
1045 abs_err = 5e-15)
Mark Dickinsonbcdf9da2010-06-13 10:52:38 +00001046 elif fn == 'erfc':
1047 # erfc has less-than-ideal accuracy for large
1048 # arguments (x ~ 25 or so), mainly due to the
1049 # error involved in computing exp(-x*x).
1050 #
1051 # XXX Would be better to weaken this test only
1052 # for large x, instead of for all x.
1053 accuracy_failure = ulps_check(expected, got, 2000)
1054
Mark Dickinson05d2e082009-12-11 20:17:17 +00001055 else:
Mark Dickinson664b5112009-12-16 20:23:42 +00001056 accuracy_failure = ulps_check(expected, got, 20)
Mark Dickinson05d2e082009-12-11 20:17:17 +00001057 if accuracy_failure is None:
Mark Dickinson12c4bdb2009-09-28 19:21:11 +00001058 continue
1059
1060 if isinstance(got, str) and isinstance(expected, str):
1061 if got == expected:
1062 continue
1063
1064 fail_msg = fail_fmt.format(id, fn, arg, expected, got)
Mark Dickinson05d2e082009-12-11 20:17:17 +00001065 if accuracy_failure is not None:
1066 fail_msg += ' ({})'.format(accuracy_failure)
Mark Dickinson12c4bdb2009-09-28 19:21:11 +00001067 failures.append(fail_msg)
1068
1069 if failures:
1070 self.fail('Failures in test_mtestfile:\n ' +
1071 '\n '.join(failures))
1072
1073
Thomas Wouters89f507f2006-12-13 04:49:30 +00001074def test_main():
Christian Heimes53876d92008-04-19 00:31:39 +00001075 from doctest import DocFileSuite
1076 suite = unittest.TestSuite()
1077 suite.addTest(unittest.makeSuite(MathTests))
1078 suite.addTest(DocFileSuite("ieee754.txt"))
1079 run_unittest(suite)
Thomas Wouters89f507f2006-12-13 04:49:30 +00001080
1081if __name__ == '__main__':
1082 test_main()