blob: 715003af0517f9578935ac7fae098597bd6842c0 [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
Eric Smithf24a0d92010-12-04 13:32:18 +00004from test.support import run_unittest, verbose, requires_IEEE_754
Victor Stinnerfce92332011-06-01 12:28:04 +02005from test import support
Thomas Wouters89f507f2006-12-13 04:49:30 +00006import unittest
7import math
Christian Heimes53876d92008-04-19 00:31:39 +00008import os
Victor Stinnercd9dd372011-05-10 23:40:17 +02009import platform
Christian Heimes53876d92008-04-19 00:31:39 +000010import sys
Mark Dickinson12c4bdb2009-09-28 19:21:11 +000011import struct
Victor Stinnerbe3da382010-11-07 14:14:27 +000012import sysconfig
Guido van Rossumfcce6301996-08-08 18:26:25 +000013
Christian Heimes53876d92008-04-19 00:31:39 +000014eps = 1E-05
15NAN = float('nan')
16INF = float('inf')
17NINF = float('-inf')
18
Mark Dickinson5c567082009-04-24 16:39:07 +000019# detect evidence of double-rounding: fsum is not always correctly
20# rounded on machines that suffer from double rounding.
21x, y = 1e16, 2.9999 # use temporary values to defeat peephole optimizer
22HAVE_DOUBLE_ROUNDING = (x + y == 1e16 + 4)
23
Christian Heimes53876d92008-04-19 00:31:39 +000024# locate file with test values
25if __name__ == '__main__':
26 file = sys.argv[0]
27else:
28 file = __file__
29test_dir = os.path.dirname(file) or os.curdir
Mark Dickinson12c4bdb2009-09-28 19:21:11 +000030math_testcases = os.path.join(test_dir, 'math_testcases.txt')
Christian Heimes53876d92008-04-19 00:31:39 +000031test_file = os.path.join(test_dir, 'cmath_testcases.txt')
32
Mark Dickinson12c4bdb2009-09-28 19:21:11 +000033def to_ulps(x):
34 """Convert a non-NaN float x to an integer, in such a way that
35 adjacent floats are converted to adjacent integers. Then
36 abs(ulps(x) - ulps(y)) gives the difference in ulps between two
37 floats.
38
39 The results from this function will only make sense on platforms
40 where C doubles are represented in IEEE 754 binary64 format.
41
42 """
Mark Dickinsond412ab52009-10-17 07:10:00 +000043 n = struct.unpack('<q', struct.pack('<d', x))[0]
Mark Dickinson12c4bdb2009-09-28 19:21:11 +000044 if n < 0:
45 n = ~(n+2**63)
46 return n
47
Mark Dickinson05d2e082009-12-11 20:17:17 +000048def ulps_check(expected, got, ulps=20):
49 """Given non-NaN floats `expected` and `got`,
50 check that they're equal to within the given number of ulps.
51
52 Returns None on success and an error message on failure."""
53
54 ulps_error = to_ulps(got) - to_ulps(expected)
55 if abs(ulps_error) <= ulps:
56 return None
57 return "error = {} ulps; permitted error = {} ulps".format(ulps_error,
58 ulps)
59
Mark Dickinson4c8a9a22010-05-15 17:02:38 +000060# Here's a pure Python version of the math.factorial algorithm, for
61# documentation and comparison purposes.
62#
63# Formula:
64#
65# factorial(n) = factorial_odd_part(n) << (n - count_set_bits(n))
66#
67# where
68#
69# factorial_odd_part(n) = product_{i >= 0} product_{0 < j <= n >> i; j odd} j
70#
71# The outer product above is an infinite product, but once i >= n.bit_length,
72# (n >> i) < 1 and the corresponding term of the product is empty. So only the
73# finitely many terms for 0 <= i < n.bit_length() contribute anything.
74#
75# We iterate downwards from i == n.bit_length() - 1 to i == 0. The inner
76# product in the formula above starts at 1 for i == n.bit_length(); for each i
77# < n.bit_length() we get the inner product for i from that for i + 1 by
78# multiplying by all j in {n >> i+1 < j <= n >> i; j odd}. In Python terms,
79# this set is range((n >> i+1) + 1 | 1, (n >> i) + 1 | 1, 2).
80
81def count_set_bits(n):
82 """Number of '1' bits in binary expansion of a nonnnegative integer."""
83 return 1 + count_set_bits(n & n - 1) if n else 0
84
85def partial_product(start, stop):
86 """Product of integers in range(start, stop, 2), computed recursively.
87 start and stop should both be odd, with start <= stop.
88
89 """
90 numfactors = (stop - start) >> 1
91 if not numfactors:
92 return 1
93 elif numfactors == 1:
94 return start
95 else:
96 mid = (start + numfactors) | 1
97 return partial_product(start, mid) * partial_product(mid, stop)
98
99def py_factorial(n):
100 """Factorial of nonnegative integer n, via "Binary Split Factorial Formula"
101 described at http://www.luschny.de/math/factorial/binarysplitfact.html
102
103 """
104 inner = outer = 1
105 for i in reversed(range(n.bit_length())):
106 inner *= partial_product((n >> i + 1) + 1 | 1, (n >> i) + 1 | 1)
107 outer *= inner
108 return outer << (n - count_set_bits(n))
109
Mark Dickinson05d2e082009-12-11 20:17:17 +0000110def acc_check(expected, got, rel_err=2e-15, abs_err = 5e-323):
111 """Determine whether non-NaN floats a and b are equal to within a
112 (small) rounding error. The default values for rel_err and
113 abs_err are chosen to be suitable for platforms where a float is
114 represented by an IEEE 754 double. They allow an error of between
115 9 and 19 ulps."""
116
117 # need to special case infinities, since inf - inf gives nan
118 if math.isinf(expected) and got == expected:
119 return None
120
121 error = got - expected
122
123 permitted_error = max(abs_err, rel_err * abs(expected))
124 if abs(error) < permitted_error:
125 return None
126 return "error = {}; permitted error = {}".format(error,
127 permitted_error)
Mark Dickinson12c4bdb2009-09-28 19:21:11 +0000128
129def parse_mtestfile(fname):
130 """Parse a file with test values
131
132 -- starts a comment
133 blank lines, or lines containing only a comment, are ignored
134 other lines are expected to have the form
135 id fn arg -> expected [flag]*
136
137 """
138 with open(fname) as fp:
139 for line in fp:
140 # strip comments, and skip blank lines
141 if '--' in line:
142 line = line[:line.index('--')]
143 if not line.strip():
144 continue
145
146 lhs, rhs = line.split('->')
147 id, fn, arg = lhs.split()
148 rhs_pieces = rhs.split()
149 exp = rhs_pieces[0]
150 flags = rhs_pieces[1:]
151
152 yield (id, fn, float(arg), float(exp), flags)
153
Christian Heimes53876d92008-04-19 00:31:39 +0000154def parse_testfile(fname):
155 """Parse a file with test values
156
157 Empty lines or lines starting with -- are ignored
158 yields id, fn, arg_real, arg_imag, exp_real, exp_imag
159 """
160 with open(fname) as fp:
161 for line in fp:
162 # skip comment lines and blank lines
163 if line.startswith('--') or not line.strip():
164 continue
165
166 lhs, rhs = line.split('->')
167 id, fn, arg_real, arg_imag = lhs.split()
168 rhs_pieces = rhs.split()
169 exp_real, exp_imag = rhs_pieces[0], rhs_pieces[1]
170 flags = rhs_pieces[2:]
171
172 yield (id, fn,
173 float(arg_real), float(arg_imag),
174 float(exp_real), float(exp_imag),
175 flags
176 )
Guido van Rossumfcce6301996-08-08 18:26:25 +0000177
Thomas Wouters89f507f2006-12-13 04:49:30 +0000178class MathTests(unittest.TestCase):
Guido van Rossumfcce6301996-08-08 18:26:25 +0000179
Thomas Wouters89f507f2006-12-13 04:49:30 +0000180 def ftest(self, name, value, expected):
181 if abs(value-expected) > eps:
Guido van Rossum806c2462007-08-06 23:33:07 +0000182 # Use %r instead of %f so the error message
183 # displays full precision. Otherwise discrepancies
184 # in the last few bits will lead to very confusing
185 # error messages
186 self.fail('%s returned %r, expected %r' %
Thomas Wouters89f507f2006-12-13 04:49:30 +0000187 (name, value, expected))
Guido van Rossumfcce6301996-08-08 18:26:25 +0000188
Thomas Wouters89f507f2006-12-13 04:49:30 +0000189 def testConstants(self):
190 self.ftest('pi', math.pi, 3.1415926)
191 self.ftest('e', math.e, 2.7182818)
Guido van Rossumfcce6301996-08-08 18:26:25 +0000192
Thomas Wouters89f507f2006-12-13 04:49:30 +0000193 def testAcos(self):
194 self.assertRaises(TypeError, math.acos)
195 self.ftest('acos(-1)', math.acos(-1), math.pi)
196 self.ftest('acos(0)', math.acos(0), math.pi/2)
197 self.ftest('acos(1)', math.acos(1), 0)
Christian Heimes53876d92008-04-19 00:31:39 +0000198 self.assertRaises(ValueError, math.acos, INF)
199 self.assertRaises(ValueError, math.acos, NINF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000200 self.assertTrue(math.isnan(math.acos(NAN)))
Christian Heimes53876d92008-04-19 00:31:39 +0000201
202 def testAcosh(self):
203 self.assertRaises(TypeError, math.acosh)
204 self.ftest('acosh(1)', math.acosh(1), 0)
205 self.ftest('acosh(2)', math.acosh(2), 1.3169578969248168)
206 self.assertRaises(ValueError, math.acosh, 0)
207 self.assertRaises(ValueError, math.acosh, -1)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000208 self.assertEqual(math.acosh(INF), INF)
Christian Heimes53876d92008-04-19 00:31:39 +0000209 self.assertRaises(ValueError, math.acosh, NINF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000210 self.assertTrue(math.isnan(math.acosh(NAN)))
Guido van Rossumfcce6301996-08-08 18:26:25 +0000211
Thomas Wouters89f507f2006-12-13 04:49:30 +0000212 def testAsin(self):
213 self.assertRaises(TypeError, math.asin)
214 self.ftest('asin(-1)', math.asin(-1), -math.pi/2)
215 self.ftest('asin(0)', math.asin(0), 0)
216 self.ftest('asin(1)', math.asin(1), math.pi/2)
Christian Heimes53876d92008-04-19 00:31:39 +0000217 self.assertRaises(ValueError, math.asin, INF)
218 self.assertRaises(ValueError, math.asin, NINF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000219 self.assertTrue(math.isnan(math.asin(NAN)))
Christian Heimes53876d92008-04-19 00:31:39 +0000220
221 def testAsinh(self):
222 self.assertRaises(TypeError, math.asinh)
223 self.ftest('asinh(0)', math.asinh(0), 0)
224 self.ftest('asinh(1)', math.asinh(1), 0.88137358701954305)
225 self.ftest('asinh(-1)', math.asinh(-1), -0.88137358701954305)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000226 self.assertEqual(math.asinh(INF), INF)
227 self.assertEqual(math.asinh(NINF), NINF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000228 self.assertTrue(math.isnan(math.asinh(NAN)))
Guido van Rossumfcce6301996-08-08 18:26:25 +0000229
Thomas Wouters89f507f2006-12-13 04:49:30 +0000230 def testAtan(self):
231 self.assertRaises(TypeError, math.atan)
232 self.ftest('atan(-1)', math.atan(-1), -math.pi/4)
233 self.ftest('atan(0)', math.atan(0), 0)
234 self.ftest('atan(1)', math.atan(1), math.pi/4)
Christian Heimes53876d92008-04-19 00:31:39 +0000235 self.ftest('atan(inf)', math.atan(INF), math.pi/2)
Christian Heimesa342c012008-04-20 21:01:16 +0000236 self.ftest('atan(-inf)', math.atan(NINF), -math.pi/2)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000237 self.assertTrue(math.isnan(math.atan(NAN)))
Christian Heimes53876d92008-04-19 00:31:39 +0000238
239 def testAtanh(self):
240 self.assertRaises(TypeError, math.atan)
241 self.ftest('atanh(0)', math.atanh(0), 0)
242 self.ftest('atanh(0.5)', math.atanh(0.5), 0.54930614433405489)
243 self.ftest('atanh(-0.5)', math.atanh(-0.5), -0.54930614433405489)
244 self.assertRaises(ValueError, math.atanh, 1)
245 self.assertRaises(ValueError, math.atanh, -1)
246 self.assertRaises(ValueError, math.atanh, INF)
247 self.assertRaises(ValueError, math.atanh, NINF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000248 self.assertTrue(math.isnan(math.atanh(NAN)))
Guido van Rossumfcce6301996-08-08 18:26:25 +0000249
Thomas Wouters89f507f2006-12-13 04:49:30 +0000250 def testAtan2(self):
251 self.assertRaises(TypeError, math.atan2)
252 self.ftest('atan2(-1, 0)', math.atan2(-1, 0), -math.pi/2)
253 self.ftest('atan2(-1, 1)', math.atan2(-1, 1), -math.pi/4)
254 self.ftest('atan2(0, 1)', math.atan2(0, 1), 0)
255 self.ftest('atan2(1, 1)', math.atan2(1, 1), math.pi/4)
256 self.ftest('atan2(1, 0)', math.atan2(1, 0), math.pi/2)
Guido van Rossumfcce6301996-08-08 18:26:25 +0000257
Christian Heimese57950f2008-04-21 13:08:03 +0000258 # math.atan2(0, x)
259 self.ftest('atan2(0., -inf)', math.atan2(0., NINF), math.pi)
260 self.ftest('atan2(0., -2.3)', math.atan2(0., -2.3), math.pi)
261 self.ftest('atan2(0., -0.)', math.atan2(0., -0.), math.pi)
262 self.assertEqual(math.atan2(0., 0.), 0.)
263 self.assertEqual(math.atan2(0., 2.3), 0.)
264 self.assertEqual(math.atan2(0., INF), 0.)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000265 self.assertTrue(math.isnan(math.atan2(0., NAN)))
Christian Heimese57950f2008-04-21 13:08:03 +0000266 # math.atan2(-0, x)
267 self.ftest('atan2(-0., -inf)', math.atan2(-0., NINF), -math.pi)
268 self.ftest('atan2(-0., -2.3)', math.atan2(-0., -2.3), -math.pi)
269 self.ftest('atan2(-0., -0.)', math.atan2(-0., -0.), -math.pi)
270 self.assertEqual(math.atan2(-0., 0.), -0.)
271 self.assertEqual(math.atan2(-0., 2.3), -0.)
272 self.assertEqual(math.atan2(-0., INF), -0.)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000273 self.assertTrue(math.isnan(math.atan2(-0., NAN)))
Christian Heimese57950f2008-04-21 13:08:03 +0000274 # math.atan2(INF, x)
275 self.ftest('atan2(inf, -inf)', math.atan2(INF, NINF), math.pi*3/4)
276 self.ftest('atan2(inf, -2.3)', math.atan2(INF, -2.3), math.pi/2)
277 self.ftest('atan2(inf, -0.)', math.atan2(INF, -0.0), math.pi/2)
278 self.ftest('atan2(inf, 0.)', math.atan2(INF, 0.0), math.pi/2)
279 self.ftest('atan2(inf, 2.3)', math.atan2(INF, 2.3), math.pi/2)
280 self.ftest('atan2(inf, inf)', math.atan2(INF, INF), math.pi/4)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000281 self.assertTrue(math.isnan(math.atan2(INF, NAN)))
Christian Heimese57950f2008-04-21 13:08:03 +0000282 # math.atan2(NINF, x)
283 self.ftest('atan2(-inf, -inf)', math.atan2(NINF, NINF), -math.pi*3/4)
284 self.ftest('atan2(-inf, -2.3)', math.atan2(NINF, -2.3), -math.pi/2)
285 self.ftest('atan2(-inf, -0.)', math.atan2(NINF, -0.0), -math.pi/2)
286 self.ftest('atan2(-inf, 0.)', math.atan2(NINF, 0.0), -math.pi/2)
287 self.ftest('atan2(-inf, 2.3)', math.atan2(NINF, 2.3), -math.pi/2)
288 self.ftest('atan2(-inf, inf)', math.atan2(NINF, INF), -math.pi/4)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000289 self.assertTrue(math.isnan(math.atan2(NINF, NAN)))
Christian Heimese57950f2008-04-21 13:08:03 +0000290 # math.atan2(+finite, x)
291 self.ftest('atan2(2.3, -inf)', math.atan2(2.3, NINF), math.pi)
292 self.ftest('atan2(2.3, -0.)', math.atan2(2.3, -0.), math.pi/2)
293 self.ftest('atan2(2.3, 0.)', math.atan2(2.3, 0.), math.pi/2)
294 self.assertEqual(math.atan2(2.3, INF), 0.)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000295 self.assertTrue(math.isnan(math.atan2(2.3, NAN)))
Christian Heimese57950f2008-04-21 13:08:03 +0000296 # math.atan2(-finite, x)
297 self.ftest('atan2(-2.3, -inf)', math.atan2(-2.3, NINF), -math.pi)
298 self.ftest('atan2(-2.3, -0.)', math.atan2(-2.3, -0.), -math.pi/2)
299 self.ftest('atan2(-2.3, 0.)', math.atan2(-2.3, 0.), -math.pi/2)
300 self.assertEqual(math.atan2(-2.3, INF), -0.)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000301 self.assertTrue(math.isnan(math.atan2(-2.3, NAN)))
Christian Heimese57950f2008-04-21 13:08:03 +0000302 # math.atan2(NAN, x)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000303 self.assertTrue(math.isnan(math.atan2(NAN, NINF)))
304 self.assertTrue(math.isnan(math.atan2(NAN, -2.3)))
305 self.assertTrue(math.isnan(math.atan2(NAN, -0.)))
306 self.assertTrue(math.isnan(math.atan2(NAN, 0.)))
307 self.assertTrue(math.isnan(math.atan2(NAN, 2.3)))
308 self.assertTrue(math.isnan(math.atan2(NAN, INF)))
309 self.assertTrue(math.isnan(math.atan2(NAN, NAN)))
Christian Heimese57950f2008-04-21 13:08:03 +0000310
Thomas Wouters89f507f2006-12-13 04:49:30 +0000311 def testCeil(self):
312 self.assertRaises(TypeError, math.ceil)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000313 self.assertEqual(int, type(math.ceil(0.5)))
Thomas Wouters89f507f2006-12-13 04:49:30 +0000314 self.ftest('ceil(0.5)', math.ceil(0.5), 1)
315 self.ftest('ceil(1.0)', math.ceil(1.0), 1)
316 self.ftest('ceil(1.5)', math.ceil(1.5), 2)
317 self.ftest('ceil(-0.5)', math.ceil(-0.5), 0)
318 self.ftest('ceil(-1.0)', math.ceil(-1.0), -1)
319 self.ftest('ceil(-1.5)', math.ceil(-1.5), -1)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000320 #self.assertEqual(math.ceil(INF), INF)
321 #self.assertEqual(math.ceil(NINF), NINF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000322 #self.assertTrue(math.isnan(math.ceil(NAN)))
Guido van Rossumfcce6301996-08-08 18:26:25 +0000323
Guido van Rossum13e05de2007-08-23 22:56:55 +0000324 class TestCeil:
325 def __ceil__(self):
326 return 42
327 class TestNoCeil:
328 pass
329 self.ftest('ceil(TestCeil())', math.ceil(TestCeil()), 42)
330 self.assertRaises(TypeError, math.ceil, TestNoCeil())
331
332 t = TestNoCeil()
333 t.__ceil__ = lambda *args: args
334 self.assertRaises(TypeError, math.ceil, t)
335 self.assertRaises(TypeError, math.ceil, t, 0)
336
Mark Dickinson63566232009-09-18 21:04:19 +0000337 @requires_IEEE_754
338 def testCopysign(self):
Mark Dickinson06b59e02010-02-06 23:16:50 +0000339 self.assertEqual(math.copysign(1, 42), 1.0)
340 self.assertEqual(math.copysign(0., 42), 0.0)
341 self.assertEqual(math.copysign(1., -42), -1.0)
342 self.assertEqual(math.copysign(3, 0.), 3.0)
343 self.assertEqual(math.copysign(4., -0.), -4.0)
344
Mark Dickinson63566232009-09-18 21:04:19 +0000345 self.assertRaises(TypeError, math.copysign)
346 # copysign should let us distinguish signs of zeros
Ezio Melottib3aedd42010-11-20 19:04:17 +0000347 self.assertEqual(math.copysign(1., 0.), 1.)
348 self.assertEqual(math.copysign(1., -0.), -1.)
349 self.assertEqual(math.copysign(INF, 0.), INF)
350 self.assertEqual(math.copysign(INF, -0.), NINF)
351 self.assertEqual(math.copysign(NINF, 0.), INF)
352 self.assertEqual(math.copysign(NINF, -0.), NINF)
Mark Dickinson63566232009-09-18 21:04:19 +0000353 # and of infinities
Ezio Melottib3aedd42010-11-20 19:04:17 +0000354 self.assertEqual(math.copysign(1., INF), 1.)
355 self.assertEqual(math.copysign(1., NINF), -1.)
356 self.assertEqual(math.copysign(INF, INF), INF)
357 self.assertEqual(math.copysign(INF, NINF), NINF)
358 self.assertEqual(math.copysign(NINF, INF), INF)
359 self.assertEqual(math.copysign(NINF, NINF), NINF)
Mark Dickinson06b59e02010-02-06 23:16:50 +0000360 self.assertTrue(math.isnan(math.copysign(NAN, 1.)))
361 self.assertTrue(math.isnan(math.copysign(NAN, INF)))
362 self.assertTrue(math.isnan(math.copysign(NAN, NINF)))
363 self.assertTrue(math.isnan(math.copysign(NAN, NAN)))
Mark Dickinson63566232009-09-18 21:04:19 +0000364 # copysign(INF, NAN) may be INF or it may be NINF, since
365 # we don't know whether the sign bit of NAN is set on any
366 # given platform.
Mark Dickinson06b59e02010-02-06 23:16:50 +0000367 self.assertTrue(math.isinf(math.copysign(INF, NAN)))
Mark Dickinson63566232009-09-18 21:04:19 +0000368 # similarly, copysign(2., NAN) could be 2. or -2.
Ezio Melottib3aedd42010-11-20 19:04:17 +0000369 self.assertEqual(abs(math.copysign(2., NAN)), 2.)
Christian Heimes53876d92008-04-19 00:31:39 +0000370
Thomas Wouters89f507f2006-12-13 04:49:30 +0000371 def testCos(self):
372 self.assertRaises(TypeError, math.cos)
373 self.ftest('cos(-pi/2)', math.cos(-math.pi/2), 0)
374 self.ftest('cos(0)', math.cos(0), 1)
375 self.ftest('cos(pi/2)', math.cos(math.pi/2), 0)
376 self.ftest('cos(pi)', math.cos(math.pi), -1)
Christian Heimes53876d92008-04-19 00:31:39 +0000377 try:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000378 self.assertTrue(math.isnan(math.cos(INF)))
379 self.assertTrue(math.isnan(math.cos(NINF)))
Christian Heimes53876d92008-04-19 00:31:39 +0000380 except ValueError:
381 self.assertRaises(ValueError, math.cos, INF)
382 self.assertRaises(ValueError, math.cos, NINF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000383 self.assertTrue(math.isnan(math.cos(NAN)))
Guido van Rossumfcce6301996-08-08 18:26:25 +0000384
Thomas Wouters89f507f2006-12-13 04:49:30 +0000385 def testCosh(self):
386 self.assertRaises(TypeError, math.cosh)
387 self.ftest('cosh(0)', math.cosh(0), 1)
388 self.ftest('cosh(2)-2*cosh(1)**2', math.cosh(2)-2*math.cosh(1)**2, -1) # Thanks to Lambert
Ezio Melottib3aedd42010-11-20 19:04:17 +0000389 self.assertEqual(math.cosh(INF), INF)
390 self.assertEqual(math.cosh(NINF), INF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000391 self.assertTrue(math.isnan(math.cosh(NAN)))
Raymond Hettinger64108af2002-05-13 03:55:01 +0000392
Thomas Wouters89f507f2006-12-13 04:49:30 +0000393 def testDegrees(self):
394 self.assertRaises(TypeError, math.degrees)
395 self.ftest('degrees(pi)', math.degrees(math.pi), 180.0)
396 self.ftest('degrees(pi/2)', math.degrees(math.pi/2), 90.0)
397 self.ftest('degrees(-pi/4)', math.degrees(-math.pi/4), -45.0)
Guido van Rossumfcce6301996-08-08 18:26:25 +0000398
Thomas Wouters89f507f2006-12-13 04:49:30 +0000399 def testExp(self):
400 self.assertRaises(TypeError, math.exp)
401 self.ftest('exp(-1)', math.exp(-1), 1/math.e)
402 self.ftest('exp(0)', math.exp(0), 1)
403 self.ftest('exp(1)', math.exp(1), math.e)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000404 self.assertEqual(math.exp(INF), INF)
405 self.assertEqual(math.exp(NINF), 0.)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000406 self.assertTrue(math.isnan(math.exp(NAN)))
Guido van Rossumfcce6301996-08-08 18:26:25 +0000407
Thomas Wouters89f507f2006-12-13 04:49:30 +0000408 def testFabs(self):
409 self.assertRaises(TypeError, math.fabs)
410 self.ftest('fabs(-1)', math.fabs(-1), 1)
411 self.ftest('fabs(0)', math.fabs(0), 0)
412 self.ftest('fabs(1)', math.fabs(1), 1)
Guido van Rossumfcce6301996-08-08 18:26:25 +0000413
Georg Brandlc28e1fa2008-06-10 19:20:26 +0000414 def testFactorial(self):
Mark Dickinson4c8a9a22010-05-15 17:02:38 +0000415 self.assertEqual(math.factorial(0), 1)
416 self.assertEqual(math.factorial(0.0), 1)
417 total = 1
418 for i in range(1, 1000):
419 total *= i
420 self.assertEqual(math.factorial(i), total)
421 self.assertEqual(math.factorial(float(i)), total)
422 self.assertEqual(math.factorial(i), py_factorial(i))
Georg Brandlc28e1fa2008-06-10 19:20:26 +0000423 self.assertRaises(ValueError, math.factorial, -1)
Mark Dickinson4c8a9a22010-05-15 17:02:38 +0000424 self.assertRaises(ValueError, math.factorial, -1.0)
Georg Brandlc28e1fa2008-06-10 19:20:26 +0000425 self.assertRaises(ValueError, math.factorial, math.pi)
Mark Dickinson4c8a9a22010-05-15 17:02:38 +0000426 self.assertRaises(OverflowError, math.factorial, sys.maxsize+1)
427 self.assertRaises(OverflowError, math.factorial, 10e100)
Georg Brandlc28e1fa2008-06-10 19:20:26 +0000428
Thomas Wouters89f507f2006-12-13 04:49:30 +0000429 def testFloor(self):
430 self.assertRaises(TypeError, math.floor)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000431 self.assertEqual(int, type(math.floor(0.5)))
Thomas Wouters89f507f2006-12-13 04:49:30 +0000432 self.ftest('floor(0.5)', math.floor(0.5), 0)
433 self.ftest('floor(1.0)', math.floor(1.0), 1)
434 self.ftest('floor(1.5)', math.floor(1.5), 1)
435 self.ftest('floor(-0.5)', math.floor(-0.5), -1)
436 self.ftest('floor(-1.0)', math.floor(-1.0), -1)
437 self.ftest('floor(-1.5)', math.floor(-1.5), -2)
Guido van Rossum806c2462007-08-06 23:33:07 +0000438 # pow() relies on floor() to check for integers
439 # This fails on some platforms - so check it here
440 self.ftest('floor(1.23e167)', math.floor(1.23e167), 1.23e167)
441 self.ftest('floor(-1.23e167)', math.floor(-1.23e167), -1.23e167)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000442 #self.assertEqual(math.ceil(INF), INF)
443 #self.assertEqual(math.ceil(NINF), NINF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000444 #self.assertTrue(math.isnan(math.floor(NAN)))
Guido van Rossumfcce6301996-08-08 18:26:25 +0000445
Guido van Rossum13e05de2007-08-23 22:56:55 +0000446 class TestFloor:
447 def __floor__(self):
448 return 42
449 class TestNoFloor:
450 pass
451 self.ftest('floor(TestFloor())', math.floor(TestFloor()), 42)
452 self.assertRaises(TypeError, math.floor, TestNoFloor())
453
454 t = TestNoFloor()
455 t.__floor__ = lambda *args: args
456 self.assertRaises(TypeError, math.floor, t)
457 self.assertRaises(TypeError, math.floor, t, 0)
458
Thomas Wouters89f507f2006-12-13 04:49:30 +0000459 def testFmod(self):
460 self.assertRaises(TypeError, math.fmod)
Mark Dickinson5bc7a442011-05-03 21:13:40 +0100461 self.ftest('fmod(10, 1)', math.fmod(10, 1), 0.0)
462 self.ftest('fmod(10, 0.5)', math.fmod(10, 0.5), 0.0)
463 self.ftest('fmod(10, 1.5)', math.fmod(10, 1.5), 1.0)
464 self.ftest('fmod(-10, 1)', math.fmod(-10, 1), -0.0)
465 self.ftest('fmod(-10, 0.5)', math.fmod(-10, 0.5), -0.0)
466 self.ftest('fmod(-10, 1.5)', math.fmod(-10, 1.5), -1.0)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000467 self.assertTrue(math.isnan(math.fmod(NAN, 1.)))
468 self.assertTrue(math.isnan(math.fmod(1., NAN)))
469 self.assertTrue(math.isnan(math.fmod(NAN, NAN)))
Christian Heimes53876d92008-04-19 00:31:39 +0000470 self.assertRaises(ValueError, math.fmod, 1., 0.)
471 self.assertRaises(ValueError, math.fmod, INF, 1.)
472 self.assertRaises(ValueError, math.fmod, NINF, 1.)
473 self.assertRaises(ValueError, math.fmod, INF, 0.)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000474 self.assertEqual(math.fmod(3.0, INF), 3.0)
475 self.assertEqual(math.fmod(-3.0, INF), -3.0)
476 self.assertEqual(math.fmod(3.0, NINF), 3.0)
477 self.assertEqual(math.fmod(-3.0, NINF), -3.0)
478 self.assertEqual(math.fmod(0.0, 3.0), 0.0)
479 self.assertEqual(math.fmod(0.0, NINF), 0.0)
Guido van Rossumfcce6301996-08-08 18:26:25 +0000480
Thomas Wouters89f507f2006-12-13 04:49:30 +0000481 def testFrexp(self):
482 self.assertRaises(TypeError, math.frexp)
Guido van Rossumfcce6301996-08-08 18:26:25 +0000483
Guido van Rossum1bc535d2007-05-15 18:46:22 +0000484 def testfrexp(name, result, expected):
485 (mant, exp), (emant, eexp) = result, expected
Thomas Wouters89f507f2006-12-13 04:49:30 +0000486 if abs(mant-emant) > eps or exp != eexp:
487 self.fail('%s returned %r, expected %r'%\
Guido van Rossum1bc535d2007-05-15 18:46:22 +0000488 (name, result, expected))
Guido van Rossumfcce6301996-08-08 18:26:25 +0000489
Thomas Wouters89f507f2006-12-13 04:49:30 +0000490 testfrexp('frexp(-1)', math.frexp(-1), (-0.5, 1))
491 testfrexp('frexp(0)', math.frexp(0), (0, 0))
492 testfrexp('frexp(1)', math.frexp(1), (0.5, 1))
493 testfrexp('frexp(2)', math.frexp(2), (0.5, 2))
Guido van Rossumfcce6301996-08-08 18:26:25 +0000494
Ezio Melottib3aedd42010-11-20 19:04:17 +0000495 self.assertEqual(math.frexp(INF)[0], INF)
496 self.assertEqual(math.frexp(NINF)[0], NINF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000497 self.assertTrue(math.isnan(math.frexp(NAN)[0]))
Christian Heimes53876d92008-04-19 00:31:39 +0000498
Mark Dickinson63566232009-09-18 21:04:19 +0000499 @requires_IEEE_754
Mark Dickinson5c567082009-04-24 16:39:07 +0000500 @unittest.skipIf(HAVE_DOUBLE_ROUNDING,
501 "fsum is not exact on machines with double rounding")
Mark Dickinsonaa7633a2008-08-01 08:16:13 +0000502 def testFsum(self):
503 # math.fsum relies on exact rounding for correct operation.
504 # There's a known problem with IA32 floating-point that causes
505 # inexact rounding in some situations, and will cause the
506 # math.fsum tests below to fail; see issue #2937. On non IEEE
507 # 754 platforms, and on IEEE 754 platforms that exhibit the
508 # problem described in issue #2937, we simply skip the whole
509 # test.
510
Mark Dickinsonaa7633a2008-08-01 08:16:13 +0000511 # Python version of math.fsum, for comparison. Uses a
512 # different algorithm based on frexp, ldexp and integer
513 # arithmetic.
514 from sys import float_info
515 mant_dig = float_info.mant_dig
516 etiny = float_info.min_exp - mant_dig
517
518 def msum(iterable):
519 """Full precision summation. Compute sum(iterable) without any
520 intermediate accumulation of error. Based on the 'lsum' function
521 at http://code.activestate.com/recipes/393090/
522
523 """
524 tmant, texp = 0, 0
525 for x in iterable:
526 mant, exp = math.frexp(x)
527 mant, exp = int(math.ldexp(mant, mant_dig)), exp - mant_dig
528 if texp > exp:
529 tmant <<= texp-exp
530 texp = exp
531 else:
532 mant <<= exp-texp
533 tmant += mant
534 # Round tmant * 2**texp to a float. The original recipe
535 # used float(str(tmant)) * 2.0**texp for this, but that's
536 # a little unsafe because str -> float conversion can't be
537 # relied upon to do correct rounding on all platforms.
538 tail = max(len(bin(abs(tmant)))-2 - mant_dig, etiny - texp)
539 if tail > 0:
540 h = 1 << (tail-1)
541 tmant = tmant // (2*h) + bool(tmant & h and tmant & 3*h-1)
542 texp += tail
543 return math.ldexp(tmant, texp)
544
545 test_values = [
546 ([], 0.0),
547 ([0.0], 0.0),
548 ([1e100, 1.0, -1e100, 1e-100, 1e50, -1.0, -1e50], 1e-100),
549 ([2.0**53, -0.5, -2.0**-54], 2.0**53-1.0),
550 ([2.0**53, 1.0, 2.0**-100], 2.0**53+2.0),
551 ([2.0**53+10.0, 1.0, 2.0**-100], 2.0**53+12.0),
552 ([2.0**53-4.0, 0.5, 2.0**-54], 2.0**53-3.0),
553 ([1./n for n in range(1, 1001)],
554 float.fromhex('0x1.df11f45f4e61ap+2')),
555 ([(-1.)**n/n for n in range(1, 1001)],
556 float.fromhex('-0x1.62a2af1bd3624p-1')),
557 ([1.7**(i+1)-1.7**i for i in range(1000)] + [-1.7**1000], -1.0),
558 ([1e16, 1., 1e-16], 10000000000000002.0),
559 ([1e16-2., 1.-2.**-53, -(1e16-2.), -(1.-2.**-53)], 0.0),
560 # exercise code for resizing partials array
561 ([2.**n - 2.**(n+50) + 2.**(n+52) for n in range(-1074, 972, 2)] +
562 [-2.**1022],
563 float.fromhex('0x1.5555555555555p+970')),
564 ]
565
566 for i, (vals, expected) in enumerate(test_values):
567 try:
568 actual = math.fsum(vals)
569 except OverflowError:
570 self.fail("test %d failed: got OverflowError, expected %r "
571 "for math.fsum(%.100r)" % (i, expected, vals))
572 except ValueError:
573 self.fail("test %d failed: got ValueError, expected %r "
574 "for math.fsum(%.100r)" % (i, expected, vals))
575 self.assertEqual(actual, expected)
576
577 from random import random, gauss, shuffle
578 for j in range(1000):
579 vals = [7, 1e100, -7, -1e100, -9e-20, 8e-20] * 10
580 s = 0
581 for i in range(200):
582 v = gauss(0, random()) ** 7 - s
583 s += v
584 vals.append(v)
585 shuffle(vals)
586
587 s = msum(vals)
588 self.assertEqual(msum(vals), math.fsum(vals))
589
Thomas Wouters89f507f2006-12-13 04:49:30 +0000590 def testHypot(self):
591 self.assertRaises(TypeError, math.hypot)
592 self.ftest('hypot(0,0)', math.hypot(0,0), 0)
593 self.ftest('hypot(3,4)', math.hypot(3,4), 5)
Christian Heimes53876d92008-04-19 00:31:39 +0000594 self.assertEqual(math.hypot(NAN, INF), INF)
595 self.assertEqual(math.hypot(INF, NAN), INF)
596 self.assertEqual(math.hypot(NAN, NINF), INF)
597 self.assertEqual(math.hypot(NINF, NAN), INF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000598 self.assertTrue(math.isnan(math.hypot(1.0, NAN)))
599 self.assertTrue(math.isnan(math.hypot(NAN, -2.0)))
Guido van Rossumfcce6301996-08-08 18:26:25 +0000600
Thomas Wouters89f507f2006-12-13 04:49:30 +0000601 def testLdexp(self):
602 self.assertRaises(TypeError, math.ldexp)
603 self.ftest('ldexp(0,1)', math.ldexp(0,1), 0)
604 self.ftest('ldexp(1,1)', math.ldexp(1,1), 2)
605 self.ftest('ldexp(1,-1)', math.ldexp(1,-1), 0.5)
606 self.ftest('ldexp(-1,1)', math.ldexp(-1,1), -2)
Christian Heimes53876d92008-04-19 00:31:39 +0000607 self.assertRaises(OverflowError, math.ldexp, 1., 1000000)
608 self.assertRaises(OverflowError, math.ldexp, -1., 1000000)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000609 self.assertEqual(math.ldexp(1., -1000000), 0.)
610 self.assertEqual(math.ldexp(-1., -1000000), -0.)
611 self.assertEqual(math.ldexp(INF, 30), INF)
612 self.assertEqual(math.ldexp(NINF, -213), NINF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000613 self.assertTrue(math.isnan(math.ldexp(NAN, 0)))
Guido van Rossumfcce6301996-08-08 18:26:25 +0000614
Alexandre Vassalotti6461e102008-05-15 22:09:29 +0000615 # large second argument
616 for n in [10**5, 10**10, 10**20, 10**40]:
Ezio Melottib3aedd42010-11-20 19:04:17 +0000617 self.assertEqual(math.ldexp(INF, -n), INF)
618 self.assertEqual(math.ldexp(NINF, -n), NINF)
619 self.assertEqual(math.ldexp(1., -n), 0.)
620 self.assertEqual(math.ldexp(-1., -n), -0.)
621 self.assertEqual(math.ldexp(0., -n), 0.)
622 self.assertEqual(math.ldexp(-0., -n), -0.)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000623 self.assertTrue(math.isnan(math.ldexp(NAN, -n)))
Alexandre Vassalotti6461e102008-05-15 22:09:29 +0000624
625 self.assertRaises(OverflowError, math.ldexp, 1., n)
626 self.assertRaises(OverflowError, math.ldexp, -1., n)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000627 self.assertEqual(math.ldexp(0., n), 0.)
628 self.assertEqual(math.ldexp(-0., n), -0.)
629 self.assertEqual(math.ldexp(INF, n), INF)
630 self.assertEqual(math.ldexp(NINF, n), NINF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000631 self.assertTrue(math.isnan(math.ldexp(NAN, n)))
Alexandre Vassalotti6461e102008-05-15 22:09:29 +0000632
Thomas Wouters89f507f2006-12-13 04:49:30 +0000633 def testLog(self):
634 self.assertRaises(TypeError, math.log)
635 self.ftest('log(1/e)', math.log(1/math.e), -1)
636 self.ftest('log(1)', math.log(1), 0)
637 self.ftest('log(e)', math.log(math.e), 1)
638 self.ftest('log(32,2)', math.log(32,2), 5)
639 self.ftest('log(10**40, 10)', math.log(10**40, 10), 40)
640 self.ftest('log(10**40, 10**20)', math.log(10**40, 10**20), 2)
Mark Dickinsonc6037172010-09-29 19:06:36 +0000641 self.ftest('log(10**1000)', math.log(10**1000),
642 2302.5850929940457)
643 self.assertRaises(ValueError, math.log, -1.5)
644 self.assertRaises(ValueError, math.log, -10**1000)
Christian Heimes53876d92008-04-19 00:31:39 +0000645 self.assertRaises(ValueError, math.log, NINF)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000646 self.assertEqual(math.log(INF), INF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000647 self.assertTrue(math.isnan(math.log(NAN)))
Christian Heimes53876d92008-04-19 00:31:39 +0000648
649 def testLog1p(self):
650 self.assertRaises(TypeError, math.log1p)
Christian Heimes53876d92008-04-19 00:31:39 +0000651 n= 2**90
Ezio Melottib3aedd42010-11-20 19:04:17 +0000652 self.assertAlmostEqual(math.log1p(n), math.log1p(float(n)))
Guido van Rossumfcce6301996-08-08 18:26:25 +0000653
Victor Stinnerfa0e3d52011-05-09 01:01:09 +0200654 @requires_IEEE_754
655 def testLog2(self):
656 self.assertRaises(TypeError, math.log2)
Victor Stinnerfa0e3d52011-05-09 01:01:09 +0200657
658 # Check some integer values
659 self.assertEqual(math.log2(1), 0.0)
660 self.assertEqual(math.log2(2), 1.0)
661 self.assertEqual(math.log2(4), 2.0)
662
663 # Large integer values
664 self.assertEqual(math.log2(2**1023), 1023.0)
665 self.assertEqual(math.log2(2**1024), 1024.0)
666 self.assertEqual(math.log2(2**2000), 2000.0)
667
668 self.assertRaises(ValueError, math.log2, -1.5)
669 self.assertRaises(ValueError, math.log2, NINF)
670 self.assertTrue(math.isnan(math.log2(NAN)))
671
Victor Stinnercd9dd372011-05-10 23:40:17 +0200672 @requires_IEEE_754
Victor Stinnerebbbdaf2011-06-01 13:19:07 +0200673 # log2() is not accurate enough on Mac OS X Tiger (10.4)
674 @support.requires_mac_ver(10, 5)
Victor Stinnercd9dd372011-05-10 23:40:17 +0200675 def testLog2Exact(self):
676 # Check that we get exact equality for log2 of powers of 2.
677 actual = [math.log2(math.ldexp(1.0, n)) for n in range(-1074, 1024)]
678 expected = [float(n) for n in range(-1074, 1024)]
679 self.assertEqual(actual, expected)
680
Thomas Wouters89f507f2006-12-13 04:49:30 +0000681 def testLog10(self):
682 self.assertRaises(TypeError, math.log10)
683 self.ftest('log10(0.1)', math.log10(0.1), -1)
684 self.ftest('log10(1)', math.log10(1), 0)
685 self.ftest('log10(10)', math.log10(10), 1)
Mark Dickinsonc6037172010-09-29 19:06:36 +0000686 self.ftest('log10(10**1000)', math.log10(10**1000), 1000.0)
687 self.assertRaises(ValueError, math.log10, -1.5)
688 self.assertRaises(ValueError, math.log10, -10**1000)
Christian Heimes53876d92008-04-19 00:31:39 +0000689 self.assertRaises(ValueError, math.log10, NINF)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000690 self.assertEqual(math.log(INF), INF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000691 self.assertTrue(math.isnan(math.log10(NAN)))
Guido van Rossumfcce6301996-08-08 18:26:25 +0000692
Thomas Wouters89f507f2006-12-13 04:49:30 +0000693 def testModf(self):
694 self.assertRaises(TypeError, math.modf)
Guido van Rossumfcce6301996-08-08 18:26:25 +0000695
Guido van Rossum1bc535d2007-05-15 18:46:22 +0000696 def testmodf(name, result, expected):
697 (v1, v2), (e1, e2) = result, expected
Thomas Wouters89f507f2006-12-13 04:49:30 +0000698 if abs(v1-e1) > eps or abs(v2-e2):
699 self.fail('%s returned %r, expected %r'%\
Guido van Rossum1bc535d2007-05-15 18:46:22 +0000700 (name, result, expected))
Raymond Hettinger64108af2002-05-13 03:55:01 +0000701
Thomas Wouters89f507f2006-12-13 04:49:30 +0000702 testmodf('modf(1.5)', math.modf(1.5), (0.5, 1.0))
703 testmodf('modf(-1.5)', math.modf(-1.5), (-0.5, -1.0))
Guido van Rossumfcce6301996-08-08 18:26:25 +0000704
Ezio Melottib3aedd42010-11-20 19:04:17 +0000705 self.assertEqual(math.modf(INF), (0.0, INF))
706 self.assertEqual(math.modf(NINF), (-0.0, NINF))
Christian Heimes53876d92008-04-19 00:31:39 +0000707
708 modf_nan = math.modf(NAN)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000709 self.assertTrue(math.isnan(modf_nan[0]))
710 self.assertTrue(math.isnan(modf_nan[1]))
Christian Heimes53876d92008-04-19 00:31:39 +0000711
Thomas Wouters89f507f2006-12-13 04:49:30 +0000712 def testPow(self):
713 self.assertRaises(TypeError, math.pow)
714 self.ftest('pow(0,1)', math.pow(0,1), 0)
715 self.ftest('pow(1,0)', math.pow(1,0), 1)
716 self.ftest('pow(2,1)', math.pow(2,1), 2)
717 self.ftest('pow(2,-1)', math.pow(2,-1), 0.5)
Christian Heimes53876d92008-04-19 00:31:39 +0000718 self.assertEqual(math.pow(INF, 1), INF)
719 self.assertEqual(math.pow(NINF, 1), NINF)
720 self.assertEqual((math.pow(1, INF)), 1.)
721 self.assertEqual((math.pow(1, NINF)), 1.)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000722 self.assertTrue(math.isnan(math.pow(NAN, 1)))
723 self.assertTrue(math.isnan(math.pow(2, NAN)))
724 self.assertTrue(math.isnan(math.pow(0, NAN)))
Christian Heimes53876d92008-04-19 00:31:39 +0000725 self.assertEqual(math.pow(1, NAN), 1)
Christian Heimesa342c012008-04-20 21:01:16 +0000726
727 # pow(0., x)
728 self.assertEqual(math.pow(0., INF), 0.)
729 self.assertEqual(math.pow(0., 3.), 0.)
730 self.assertEqual(math.pow(0., 2.3), 0.)
731 self.assertEqual(math.pow(0., 2.), 0.)
732 self.assertEqual(math.pow(0., 0.), 1.)
733 self.assertEqual(math.pow(0., -0.), 1.)
734 self.assertRaises(ValueError, math.pow, 0., -2.)
735 self.assertRaises(ValueError, math.pow, 0., -2.3)
736 self.assertRaises(ValueError, math.pow, 0., -3.)
737 self.assertRaises(ValueError, math.pow, 0., NINF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000738 self.assertTrue(math.isnan(math.pow(0., NAN)))
Christian Heimesa342c012008-04-20 21:01:16 +0000739
740 # pow(INF, x)
741 self.assertEqual(math.pow(INF, INF), INF)
742 self.assertEqual(math.pow(INF, 3.), INF)
743 self.assertEqual(math.pow(INF, 2.3), INF)
744 self.assertEqual(math.pow(INF, 2.), INF)
745 self.assertEqual(math.pow(INF, 0.), 1.)
746 self.assertEqual(math.pow(INF, -0.), 1.)
747 self.assertEqual(math.pow(INF, -2.), 0.)
748 self.assertEqual(math.pow(INF, -2.3), 0.)
749 self.assertEqual(math.pow(INF, -3.), 0.)
750 self.assertEqual(math.pow(INF, NINF), 0.)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000751 self.assertTrue(math.isnan(math.pow(INF, NAN)))
Christian Heimesa342c012008-04-20 21:01:16 +0000752
753 # pow(-0., x)
754 self.assertEqual(math.pow(-0., INF), 0.)
755 self.assertEqual(math.pow(-0., 3.), -0.)
756 self.assertEqual(math.pow(-0., 2.3), 0.)
757 self.assertEqual(math.pow(-0., 2.), 0.)
758 self.assertEqual(math.pow(-0., 0.), 1.)
759 self.assertEqual(math.pow(-0., -0.), 1.)
760 self.assertRaises(ValueError, math.pow, -0., -2.)
761 self.assertRaises(ValueError, math.pow, -0., -2.3)
762 self.assertRaises(ValueError, math.pow, -0., -3.)
763 self.assertRaises(ValueError, math.pow, -0., NINF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000764 self.assertTrue(math.isnan(math.pow(-0., NAN)))
Christian Heimesa342c012008-04-20 21:01:16 +0000765
766 # pow(NINF, x)
767 self.assertEqual(math.pow(NINF, INF), INF)
768 self.assertEqual(math.pow(NINF, 3.), NINF)
769 self.assertEqual(math.pow(NINF, 2.3), INF)
770 self.assertEqual(math.pow(NINF, 2.), INF)
771 self.assertEqual(math.pow(NINF, 0.), 1.)
772 self.assertEqual(math.pow(NINF, -0.), 1.)
773 self.assertEqual(math.pow(NINF, -2.), 0.)
774 self.assertEqual(math.pow(NINF, -2.3), 0.)
775 self.assertEqual(math.pow(NINF, -3.), -0.)
776 self.assertEqual(math.pow(NINF, NINF), 0.)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000777 self.assertTrue(math.isnan(math.pow(NINF, NAN)))
Christian Heimesa342c012008-04-20 21:01:16 +0000778
779 # pow(-1, x)
780 self.assertEqual(math.pow(-1., INF), 1.)
781 self.assertEqual(math.pow(-1., 3.), -1.)
782 self.assertRaises(ValueError, math.pow, -1., 2.3)
783 self.assertEqual(math.pow(-1., 2.), 1.)
784 self.assertEqual(math.pow(-1., 0.), 1.)
785 self.assertEqual(math.pow(-1., -0.), 1.)
786 self.assertEqual(math.pow(-1., -2.), 1.)
787 self.assertRaises(ValueError, math.pow, -1., -2.3)
788 self.assertEqual(math.pow(-1., -3.), -1.)
789 self.assertEqual(math.pow(-1., NINF), 1.)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000790 self.assertTrue(math.isnan(math.pow(-1., NAN)))
Christian Heimesa342c012008-04-20 21:01:16 +0000791
792 # pow(1, x)
793 self.assertEqual(math.pow(1., INF), 1.)
794 self.assertEqual(math.pow(1., 3.), 1.)
795 self.assertEqual(math.pow(1., 2.3), 1.)
796 self.assertEqual(math.pow(1., 2.), 1.)
797 self.assertEqual(math.pow(1., 0.), 1.)
798 self.assertEqual(math.pow(1., -0.), 1.)
799 self.assertEqual(math.pow(1., -2.), 1.)
800 self.assertEqual(math.pow(1., -2.3), 1.)
801 self.assertEqual(math.pow(1., -3.), 1.)
802 self.assertEqual(math.pow(1., NINF), 1.)
803 self.assertEqual(math.pow(1., NAN), 1.)
804
805 # pow(x, 0) should be 1 for any x
806 self.assertEqual(math.pow(2.3, 0.), 1.)
807 self.assertEqual(math.pow(-2.3, 0.), 1.)
808 self.assertEqual(math.pow(NAN, 0.), 1.)
809 self.assertEqual(math.pow(2.3, -0.), 1.)
810 self.assertEqual(math.pow(-2.3, -0.), 1.)
811 self.assertEqual(math.pow(NAN, -0.), 1.)
812
813 # pow(x, y) is invalid if x is negative and y is not integral
814 self.assertRaises(ValueError, math.pow, -1., 2.3)
815 self.assertRaises(ValueError, math.pow, -15., -3.1)
816
817 # pow(x, NINF)
818 self.assertEqual(math.pow(1.9, NINF), 0.)
819 self.assertEqual(math.pow(1.1, NINF), 0.)
820 self.assertEqual(math.pow(0.9, NINF), INF)
821 self.assertEqual(math.pow(0.1, NINF), INF)
822 self.assertEqual(math.pow(-0.1, NINF), INF)
823 self.assertEqual(math.pow(-0.9, NINF), INF)
824 self.assertEqual(math.pow(-1.1, NINF), 0.)
825 self.assertEqual(math.pow(-1.9, NINF), 0.)
826
827 # pow(x, INF)
828 self.assertEqual(math.pow(1.9, INF), INF)
829 self.assertEqual(math.pow(1.1, INF), INF)
830 self.assertEqual(math.pow(0.9, INF), 0.)
831 self.assertEqual(math.pow(0.1, INF), 0.)
832 self.assertEqual(math.pow(-0.1, INF), 0.)
833 self.assertEqual(math.pow(-0.9, INF), 0.)
834 self.assertEqual(math.pow(-1.1, INF), INF)
835 self.assertEqual(math.pow(-1.9, INF), INF)
836
837 # pow(x, y) should work for x negative, y an integer
838 self.ftest('(-2.)**3.', math.pow(-2.0, 3.0), -8.0)
839 self.ftest('(-2.)**2.', math.pow(-2.0, 2.0), 4.0)
840 self.ftest('(-2.)**1.', math.pow(-2.0, 1.0), -2.0)
841 self.ftest('(-2.)**0.', math.pow(-2.0, 0.0), 1.0)
842 self.ftest('(-2.)**-0.', math.pow(-2.0, -0.0), 1.0)
843 self.ftest('(-2.)**-1.', math.pow(-2.0, -1.0), -0.5)
844 self.ftest('(-2.)**-2.', math.pow(-2.0, -2.0), 0.25)
845 self.ftest('(-2.)**-3.', math.pow(-2.0, -3.0), -0.125)
846 self.assertRaises(ValueError, math.pow, -2.0, -0.5)
847 self.assertRaises(ValueError, math.pow, -2.0, 0.5)
848
849 # the following tests have been commented out since they don't
850 # really belong here: the implementation of ** for floats is
Ezio Melotti13925002011-03-16 11:05:33 +0200851 # independent of the implementation of math.pow
Christian Heimesa342c012008-04-20 21:01:16 +0000852 #self.assertEqual(1**NAN, 1)
853 #self.assertEqual(1**INF, 1)
854 #self.assertEqual(1**NINF, 1)
855 #self.assertEqual(1**0, 1)
856 #self.assertEqual(1.**NAN, 1)
857 #self.assertEqual(1.**INF, 1)
858 #self.assertEqual(1.**NINF, 1)
859 #self.assertEqual(1.**0, 1)
Guido van Rossumfcce6301996-08-08 18:26:25 +0000860
Thomas Wouters89f507f2006-12-13 04:49:30 +0000861 def testRadians(self):
862 self.assertRaises(TypeError, math.radians)
863 self.ftest('radians(180)', math.radians(180), math.pi)
864 self.ftest('radians(90)', math.radians(90), math.pi/2)
865 self.ftest('radians(-45)', math.radians(-45), -math.pi/4)
Guido van Rossumfcce6301996-08-08 18:26:25 +0000866
Thomas Wouters89f507f2006-12-13 04:49:30 +0000867 def testSin(self):
868 self.assertRaises(TypeError, math.sin)
869 self.ftest('sin(0)', math.sin(0), 0)
870 self.ftest('sin(pi/2)', math.sin(math.pi/2), 1)
871 self.ftest('sin(-pi/2)', math.sin(-math.pi/2), -1)
Christian Heimes53876d92008-04-19 00:31:39 +0000872 try:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000873 self.assertTrue(math.isnan(math.sin(INF)))
874 self.assertTrue(math.isnan(math.sin(NINF)))
Christian Heimes53876d92008-04-19 00:31:39 +0000875 except ValueError:
876 self.assertRaises(ValueError, math.sin, INF)
877 self.assertRaises(ValueError, math.sin, NINF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000878 self.assertTrue(math.isnan(math.sin(NAN)))
Guido van Rossumfcce6301996-08-08 18:26:25 +0000879
Thomas Wouters89f507f2006-12-13 04:49:30 +0000880 def testSinh(self):
881 self.assertRaises(TypeError, math.sinh)
882 self.ftest('sinh(0)', math.sinh(0), 0)
883 self.ftest('sinh(1)**2-cosh(1)**2', math.sinh(1)**2-math.cosh(1)**2, -1)
884 self.ftest('sinh(1)+sinh(-1)', math.sinh(1)+math.sinh(-1), 0)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000885 self.assertEqual(math.sinh(INF), INF)
886 self.assertEqual(math.sinh(NINF), NINF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000887 self.assertTrue(math.isnan(math.sinh(NAN)))
Tim Peters1d120612000-10-12 06:10:25 +0000888
Thomas Wouters89f507f2006-12-13 04:49:30 +0000889 def testSqrt(self):
890 self.assertRaises(TypeError, math.sqrt)
891 self.ftest('sqrt(0)', math.sqrt(0), 0)
892 self.ftest('sqrt(1)', math.sqrt(1), 1)
893 self.ftest('sqrt(4)', math.sqrt(4), 2)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000894 self.assertEqual(math.sqrt(INF), INF)
Christian Heimes53876d92008-04-19 00:31:39 +0000895 self.assertRaises(ValueError, math.sqrt, NINF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000896 self.assertTrue(math.isnan(math.sqrt(NAN)))
Tim Peters1d120612000-10-12 06:10:25 +0000897
Thomas Wouters89f507f2006-12-13 04:49:30 +0000898 def testTan(self):
899 self.assertRaises(TypeError, math.tan)
900 self.ftest('tan(0)', math.tan(0), 0)
901 self.ftest('tan(pi/4)', math.tan(math.pi/4), 1)
902 self.ftest('tan(-pi/4)', math.tan(-math.pi/4), -1)
Christian Heimes53876d92008-04-19 00:31:39 +0000903 try:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000904 self.assertTrue(math.isnan(math.tan(INF)))
905 self.assertTrue(math.isnan(math.tan(NINF)))
Christian Heimes53876d92008-04-19 00:31:39 +0000906 except:
907 self.assertRaises(ValueError, math.tan, INF)
908 self.assertRaises(ValueError, math.tan, NINF)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000909 self.assertTrue(math.isnan(math.tan(NAN)))
Tim Peters1d120612000-10-12 06:10:25 +0000910
Thomas Wouters89f507f2006-12-13 04:49:30 +0000911 def testTanh(self):
912 self.assertRaises(TypeError, math.tanh)
913 self.ftest('tanh(0)', math.tanh(0), 0)
914 self.ftest('tanh(1)+tanh(-1)', math.tanh(1)+math.tanh(-1), 0)
Christian Heimes53876d92008-04-19 00:31:39 +0000915 self.ftest('tanh(inf)', math.tanh(INF), 1)
916 self.ftest('tanh(-inf)', math.tanh(NINF), -1)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000917 self.assertTrue(math.isnan(math.tanh(NAN)))
Victor Stinnerbe3da382010-11-07 14:14:27 +0000918
919 @requires_IEEE_754
920 @unittest.skipIf(sysconfig.get_config_var('TANH_PRESERVES_ZERO_SIGN') == 0,
921 "system tanh() function doesn't copy the sign")
922 def testTanhSign(self):
Christian Heimese57950f2008-04-21 13:08:03 +0000923 # check that tanh(-0.) == -0. on IEEE 754 systems
Victor Stinnerbe3da382010-11-07 14:14:27 +0000924 self.assertEqual(math.tanh(-0.), -0.)
925 self.assertEqual(math.copysign(1., math.tanh(-0.)),
926 math.copysign(1., -0.))
Tim Peters1d120612000-10-12 06:10:25 +0000927
Christian Heimes400adb02008-02-01 08:12:03 +0000928 def test_trunc(self):
929 self.assertEqual(math.trunc(1), 1)
930 self.assertEqual(math.trunc(-1), -1)
931 self.assertEqual(type(math.trunc(1)), int)
932 self.assertEqual(type(math.trunc(1.5)), int)
933 self.assertEqual(math.trunc(1.5), 1)
934 self.assertEqual(math.trunc(-1.5), -1)
935 self.assertEqual(math.trunc(1.999999), 1)
936 self.assertEqual(math.trunc(-1.999999), -1)
937 self.assertEqual(math.trunc(-0.999999), -0)
938 self.assertEqual(math.trunc(-100.999), -100)
939
940 class TestTrunc(object):
941 def __trunc__(self):
942 return 23
943
944 class TestNoTrunc(object):
945 pass
946
947 self.assertEqual(math.trunc(TestTrunc()), 23)
948
949 self.assertRaises(TypeError, math.trunc)
950 self.assertRaises(TypeError, math.trunc, 1, 2)
951 self.assertRaises(TypeError, math.trunc, TestNoTrunc())
952
Mark Dickinson8e0c9962010-07-11 17:38:24 +0000953 def testIsfinite(self):
954 self.assertTrue(math.isfinite(0.0))
955 self.assertTrue(math.isfinite(-0.0))
956 self.assertTrue(math.isfinite(1.0))
957 self.assertTrue(math.isfinite(-1.0))
958 self.assertFalse(math.isfinite(float("nan")))
959 self.assertFalse(math.isfinite(float("inf")))
960 self.assertFalse(math.isfinite(float("-inf")))
961
Christian Heimes072c0f12008-01-03 23:01:04 +0000962 def testIsnan(self):
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000963 self.assertTrue(math.isnan(float("nan")))
964 self.assertTrue(math.isnan(float("inf")* 0.))
965 self.assertFalse(math.isnan(float("inf")))
966 self.assertFalse(math.isnan(0.))
967 self.assertFalse(math.isnan(1.))
Christian Heimes072c0f12008-01-03 23:01:04 +0000968
969 def testIsinf(self):
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000970 self.assertTrue(math.isinf(float("inf")))
971 self.assertTrue(math.isinf(float("-inf")))
972 self.assertTrue(math.isinf(1E400))
973 self.assertTrue(math.isinf(-1E400))
974 self.assertFalse(math.isinf(float("nan")))
975 self.assertFalse(math.isinf(0.))
976 self.assertFalse(math.isinf(1.))
Christian Heimes072c0f12008-01-03 23:01:04 +0000977
Thomas Wouters89f507f2006-12-13 04:49:30 +0000978 # RED_FLAG 16-Oct-2000 Tim
979 # While 2.0 is more consistent about exceptions than previous releases, it
980 # still fails this part of the test on some platforms. For now, we only
981 # *run* test_exceptions() in verbose mode, so that this isn't normally
982 # tested.
Tim Peters98c81842000-10-16 17:35:13 +0000983
Thomas Wouters89f507f2006-12-13 04:49:30 +0000984 if verbose:
985 def test_exceptions(self):
986 try:
987 x = math.exp(-1000000000)
988 except:
989 # mathmodule.c is failing to weed out underflows from libm, or
990 # we've got an fp format with huge dynamic range
991 self.fail("underflowing exp() should not have raised "
992 "an exception")
993 if x != 0:
994 self.fail("underflowing exp() should have returned 0")
995
996 # If this fails, probably using a strict IEEE-754 conforming libm, and x
997 # is +Inf afterwards. But Python wants overflows detected by default.
998 try:
999 x = math.exp(1000000000)
1000 except OverflowError:
1001 pass
1002 else:
1003 self.fail("overflowing exp() didn't trigger OverflowError")
1004
1005 # If this fails, it could be a puzzle. One odd possibility is that
1006 # mathmodule.c's macros are getting confused while comparing
1007 # Inf (HUGE_VAL) to a NaN, and artificially setting errno to ERANGE
1008 # as a result (and so raising OverflowError instead).
1009 try:
1010 x = math.sqrt(-1.0)
1011 except ValueError:
1012 pass
1013 else:
1014 self.fail("sqrt(-1) didn't raise ValueError")
1015
Mark Dickinson63566232009-09-18 21:04:19 +00001016 @requires_IEEE_754
Christian Heimes53876d92008-04-19 00:31:39 +00001017 def test_testfile(self):
Christian Heimes53876d92008-04-19 00:31:39 +00001018 for id, fn, ar, ai, er, ei, flags in parse_testfile(test_file):
1019 # Skip if either the input or result is complex, or if
1020 # flags is nonempty
1021 if ai != 0. or ei != 0. or flags:
1022 continue
1023 if fn in ['rect', 'polar']:
1024 # no real versions of rect, polar
1025 continue
1026 func = getattr(math, fn)
Christian Heimesa342c012008-04-20 21:01:16 +00001027 try:
1028 result = func(ar)
Mark Dickinsona0de26c2008-04-30 23:30:57 +00001029 except ValueError as exc:
1030 message = (("Unexpected ValueError: %s\n " +
1031 "in test %s:%s(%r)\n") % (exc.args[0], id, fn, ar))
Christian Heimesa342c012008-04-20 21:01:16 +00001032 self.fail(message)
Benjamin Peterson2b7411d2008-05-26 17:36:47 +00001033 except OverflowError:
1034 message = ("Unexpected OverflowError in " +
1035 "test %s:%s(%r)\n" % (id, fn, ar))
1036 self.fail(message)
Christian Heimes53876d92008-04-19 00:31:39 +00001037 self.ftest("%s:%s(%r)" % (id, fn, ar), result, er)
Thomas Wouters89f507f2006-12-13 04:49:30 +00001038
Victor Stinnerbe3da382010-11-07 14:14:27 +00001039 @requires_IEEE_754
Mark Dickinson12c4bdb2009-09-28 19:21:11 +00001040 def test_mtestfile(self):
Mark Dickinson12c4bdb2009-09-28 19:21:11 +00001041 fail_fmt = "{}:{}({!r}): expected {!r}, got {!r}"
1042
1043 failures = []
1044 for id, fn, arg, expected, flags in parse_mtestfile(math_testcases):
1045 func = getattr(math, fn)
1046
1047 if 'invalid' in flags or 'divide-by-zero' in flags:
1048 expected = 'ValueError'
1049 elif 'overflow' in flags:
1050 expected = 'OverflowError'
1051
1052 try:
1053 got = func(arg)
1054 except ValueError:
1055 got = 'ValueError'
1056 except OverflowError:
1057 got = 'OverflowError'
1058
Mark Dickinson05d2e082009-12-11 20:17:17 +00001059 accuracy_failure = None
Mark Dickinson12c4bdb2009-09-28 19:21:11 +00001060 if isinstance(got, float) and isinstance(expected, float):
1061 if math.isnan(expected) and math.isnan(got):
1062 continue
1063 if not math.isnan(expected) and not math.isnan(got):
Mark Dickinson664b5112009-12-16 20:23:42 +00001064 if fn == 'lgamma':
1065 # we use a weaker accuracy test for lgamma;
1066 # lgamma only achieves an absolute error of
1067 # a few multiples of the machine accuracy, in
1068 # general.
Mark Dickinson05d2e082009-12-11 20:17:17 +00001069 accuracy_failure = acc_check(expected, got,
1070 rel_err = 5e-15,
1071 abs_err = 5e-15)
Mark Dickinsonbcdf9da2010-06-13 10:52:38 +00001072 elif fn == 'erfc':
1073 # erfc has less-than-ideal accuracy for large
1074 # arguments (x ~ 25 or so), mainly due to the
1075 # error involved in computing exp(-x*x).
1076 #
1077 # XXX Would be better to weaken this test only
1078 # for large x, instead of for all x.
1079 accuracy_failure = ulps_check(expected, got, 2000)
1080
Mark Dickinson05d2e082009-12-11 20:17:17 +00001081 else:
Mark Dickinson664b5112009-12-16 20:23:42 +00001082 accuracy_failure = ulps_check(expected, got, 20)
Mark Dickinson05d2e082009-12-11 20:17:17 +00001083 if accuracy_failure is None:
Mark Dickinson12c4bdb2009-09-28 19:21:11 +00001084 continue
1085
1086 if isinstance(got, str) and isinstance(expected, str):
1087 if got == expected:
1088 continue
1089
1090 fail_msg = fail_fmt.format(id, fn, arg, expected, got)
Mark Dickinson05d2e082009-12-11 20:17:17 +00001091 if accuracy_failure is not None:
1092 fail_msg += ' ({})'.format(accuracy_failure)
Mark Dickinson12c4bdb2009-09-28 19:21:11 +00001093 failures.append(fail_msg)
1094
1095 if failures:
1096 self.fail('Failures in test_mtestfile:\n ' +
1097 '\n '.join(failures))
1098
1099
Thomas Wouters89f507f2006-12-13 04:49:30 +00001100def test_main():
Christian Heimes53876d92008-04-19 00:31:39 +00001101 from doctest import DocFileSuite
1102 suite = unittest.TestSuite()
1103 suite.addTest(unittest.makeSuite(MathTests))
1104 suite.addTest(DocFileSuite("ieee754.txt"))
1105 run_unittest(suite)
Thomas Wouters89f507f2006-12-13 04:49:30 +00001106
1107if __name__ == '__main__':
1108 test_main()