blob: 0ef9a7a1098e70d07a185b3866590dc22bee6f24 [file] [log] [blame]
Florent Xicluna41fe6152010-04-02 18:52:12 +00001import unittest
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002from test import support
Walter Dörwald5edd7852003-06-18 14:26:18 +00003
Tim Peters0f336042001-03-18 08:21:57 +00004from random import random
Mark Dickinsonad476da2009-04-23 19:14:16 +00005from math import atan2, isnan, copysign
Mark Dickinsonf673f0c2010-03-13 09:48:39 +00006import operator
Tim Peters0f336042001-03-18 08:21:57 +00007
Christian Heimesa156e092008-02-16 07:38:31 +00008INF = float("inf")
9NAN = float("nan")
Walter Dörwald5edd7852003-06-18 14:26:18 +000010# These tests ensure that complex math does the right thing
Fred Drake68773e72001-12-13 19:57:53 +000011
Walter Dörwald5edd7852003-06-18 14:26:18 +000012class ComplexTest(unittest.TestCase):
Tim Peters0f336042001-03-18 08:21:57 +000013
Walter Dörwald5edd7852003-06-18 14:26:18 +000014 def assertAlmostEqual(self, a, b):
15 if isinstance(a, complex):
16 if isinstance(b, complex):
17 unittest.TestCase.assertAlmostEqual(self, a.real, b.real)
18 unittest.TestCase.assertAlmostEqual(self, a.imag, b.imag)
19 else:
20 unittest.TestCase.assertAlmostEqual(self, a.real, b)
21 unittest.TestCase.assertAlmostEqual(self, a.imag, 0.)
22 else:
23 if isinstance(b, complex):
24 unittest.TestCase.assertAlmostEqual(self, a, b.real)
25 unittest.TestCase.assertAlmostEqual(self, 0., b.imag)
26 else:
27 unittest.TestCase.assertAlmostEqual(self, a, b)
Tim Peters0f336042001-03-18 08:21:57 +000028
Walter Dörwald5edd7852003-06-18 14:26:18 +000029 def assertCloseAbs(self, x, y, eps=1e-9):
Antoine Pitrou9086f922014-10-10 23:49:32 +020030 """Return true iff floats x and y "are close"."""
Walter Dörwald5edd7852003-06-18 14:26:18 +000031 # put the one with larger magnitude second
32 if abs(x) > abs(y):
33 x, y = y, x
34 if y == 0:
35 return abs(x) < eps
36 if x == 0:
37 return abs(y) < eps
38 # check that relative difference < eps
Benjamin Petersonc9c0f202009-06-30 23:06:06 +000039 self.assertTrue(abs((x-y)/y) < eps)
Tim Petersc5b235c2001-09-06 23:00:21 +000040
Mark Dickinsonad476da2009-04-23 19:14:16 +000041 def assertFloatsAreIdentical(self, x, y):
42 """assert that floats x and y are identical, in the sense that:
43 (1) both x and y are nans, or
44 (2) both x and y are infinities, with the same sign, or
45 (3) both x and y are zeros, with the same sign, or
46 (4) x and y are both finite and nonzero, and x == y
47
48 """
49 msg = 'floats {!r} and {!r} are not identical'
50
51 if isnan(x) or isnan(y):
52 if isnan(x) and isnan(y):
53 return
54 elif x == y:
55 if x != 0.0:
56 return
57 # both zero; check that signs match
58 elif copysign(1.0, x) == copysign(1.0, y):
59 return
60 else:
61 msg += ': zeros have different signs'
62 self.fail(msg.format(x, y))
63
Walter Dörwald5edd7852003-06-18 14:26:18 +000064 def assertClose(self, x, y, eps=1e-9):
Antoine Pitrou9086f922014-10-10 23:49:32 +020065 """Return true iff complexes x and y "are close"."""
Walter Dörwald5edd7852003-06-18 14:26:18 +000066 self.assertCloseAbs(x.real, y.real, eps)
67 self.assertCloseAbs(x.imag, y.imag, eps)
Tim Peters0f336042001-03-18 08:21:57 +000068
Walter Dörwald5edd7852003-06-18 14:26:18 +000069 def check_div(self, x, y):
70 """Compute complex z=x*y, and check that z/x==y and z/y==x."""
71 z = x * y
72 if x != 0:
73 q = z / x
74 self.assertClose(q, y)
Walter Dörwaldb27cca62003-08-05 15:34:34 +000075 q = z.__truediv__(x)
76 self.assertClose(q, y)
Walter Dörwald5edd7852003-06-18 14:26:18 +000077 if y != 0:
78 q = z / y
79 self.assertClose(q, x)
Walter Dörwaldb27cca62003-08-05 15:34:34 +000080 q = z.__truediv__(y)
81 self.assertClose(q, x)
Tim Peters0f336042001-03-18 08:21:57 +000082
Neal Norwitzbcc0db82006-03-24 08:14:36 +000083 def test_truediv(self):
Guido van Rossum805365e2007-05-07 22:24:25 +000084 simple_real = [float(i) for i in range(-5, 6)]
Walter Dörwald5edd7852003-06-18 14:26:18 +000085 simple_complex = [complex(x, y) for x in simple_real for y in simple_real]
86 for x in simple_complex:
87 for y in simple_complex:
88 self.check_div(x, y)
Tim Peters0f336042001-03-18 08:21:57 +000089
Walter Dörwald5edd7852003-06-18 14:26:18 +000090 # A naive complex division algorithm (such as in 2.0) is very prone to
91 # nonsense errors for these (overflows and underflows).
92 self.check_div(complex(1e200, 1e200), 1+0j)
93 self.check_div(complex(1e-200, 1e-200), 1+0j)
Tim Peters0f336042001-03-18 08:21:57 +000094
Walter Dörwald5edd7852003-06-18 14:26:18 +000095 # Just for fun.
Guido van Rossum805365e2007-05-07 22:24:25 +000096 for i in range(100):
Walter Dörwald5edd7852003-06-18 14:26:18 +000097 self.check_div(complex(random(), random()),
98 complex(random(), random()))
Neal Norwitzfc37af82001-12-29 01:02:21 +000099
Neal Norwitzbcc0db82006-03-24 08:14:36 +0000100 self.assertRaises(ZeroDivisionError, complex.__truediv__, 1+1j, 0+0j)
Walter Dörwald5edd7852003-06-18 14:26:18 +0000101 # FIXME: The following currently crashes on Alpha
102 # self.assertRaises(OverflowError, pow, 1e200+1j, 1e200+1j)
Neal Norwitzfc37af82001-12-29 01:02:21 +0000103
Walter Dörwald5edd7852003-06-18 14:26:18 +0000104 self.assertAlmostEqual(complex.__truediv__(2+0j, 1+1j), 1-1j)
105 self.assertRaises(ZeroDivisionError, complex.__truediv__, 1+1j, 0+0j)
Neal Norwitz5a0f0102001-12-29 14:31:46 +0000106
Antoine Pitrou9086f922014-10-10 23:49:32 +0200107 for denom_real, denom_imag in [(0, NAN), (NAN, 0), (NAN, NAN)]:
108 z = complex(0, 0) / complex(denom_real, denom_imag)
109 self.assertTrue(isnan(z.real))
110 self.assertTrue(isnan(z.imag))
111
Walter Dörwald5edd7852003-06-18 14:26:18 +0000112 def test_floordiv(self):
Guido van Rossum9648d622007-08-03 20:40:44 +0000113 self.assertRaises(TypeError, complex.__floordiv__, 3+0j, 1.5+0j)
114 self.assertRaises(TypeError, complex.__floordiv__, 3+0j, 0+0j)
Neal Norwitzfc37af82001-12-29 01:02:21 +0000115
Walter Dörwald5edd7852003-06-18 14:26:18 +0000116 def test_richcompare(self):
Mark Dickinsoncc6a9822010-05-21 14:55:26 +0000117 self.assertIs(complex.__eq__(1+1j, 1<<10000), False)
Mark Dickinsonf673f0c2010-03-13 09:48:39 +0000118 self.assertIs(complex.__lt__(1+1j, None), NotImplemented)
Walter Dörwald5edd7852003-06-18 14:26:18 +0000119 self.assertIs(complex.__eq__(1+1j, 1+1j), True)
120 self.assertIs(complex.__eq__(1+1j, 2+2j), False)
121 self.assertIs(complex.__ne__(1+1j, 1+1j), False)
122 self.assertIs(complex.__ne__(1+1j, 2+2j), True)
Mark Dickinsoncc6a9822010-05-21 14:55:26 +0000123 for i in range(1, 100):
124 f = i / 100.0
125 self.assertIs(complex.__eq__(f+0j, f), True)
126 self.assertIs(complex.__ne__(f+0j, f), False)
127 self.assertIs(complex.__eq__(complex(f, f), f), False)
128 self.assertIs(complex.__ne__(complex(f, f), f), True)
Mark Dickinsonf673f0c2010-03-13 09:48:39 +0000129 self.assertIs(complex.__lt__(1+1j, 2+2j), NotImplemented)
130 self.assertIs(complex.__le__(1+1j, 2+2j), NotImplemented)
131 self.assertIs(complex.__gt__(1+1j, 2+2j), NotImplemented)
132 self.assertIs(complex.__ge__(1+1j, 2+2j), NotImplemented)
133 self.assertRaises(TypeError, operator.lt, 1+1j, 2+2j)
134 self.assertRaises(TypeError, operator.le, 1+1j, 2+2j)
135 self.assertRaises(TypeError, operator.gt, 1+1j, 2+2j)
136 self.assertRaises(TypeError, operator.ge, 1+1j, 2+2j)
137 self.assertIs(operator.eq(1+1j, 1+1j), True)
138 self.assertIs(operator.eq(1+1j, 2+2j), False)
139 self.assertIs(operator.ne(1+1j, 1+1j), False)
140 self.assertIs(operator.ne(1+1j, 2+2j), True)
Tim Peters0f336042001-03-18 08:21:57 +0000141
Mark Dickinsoncc6a9822010-05-21 14:55:26 +0000142 def test_richcompare_boundaries(self):
143 def check(n, deltas, is_equal, imag = 0.0):
144 for delta in deltas:
145 i = n + delta
146 z = complex(i, imag)
147 self.assertIs(complex.__eq__(z, i), is_equal(delta))
148 self.assertIs(complex.__ne__(z, i), not is_equal(delta))
149 # For IEEE-754 doubles the following should hold:
150 # x in [2 ** (52 + i), 2 ** (53 + i + 1)] -> x mod 2 ** i == 0
151 # where the interval is representable, of course.
152 for i in range(1, 10):
153 pow = 52 + i
154 mult = 2 ** i
155 check(2 ** pow, range(1, 101), lambda delta: delta % mult == 0)
156 check(2 ** pow, range(1, 101), lambda delta: False, float(i))
157 check(2 ** 53, range(-100, 0), lambda delta: True)
158
Walter Dörwald5edd7852003-06-18 14:26:18 +0000159 def test_mod(self):
Guido van Rossum9648d622007-08-03 20:40:44 +0000160 # % is no longer supported on complex numbers
161 self.assertRaises(TypeError, (1+1j).__mod__, 0+0j)
162 self.assertRaises(TypeError, lambda: (3.33+4.43j) % 0)
Jeffrey Yasskin3404b3c2007-09-07 15:15:49 +0000163 self.assertRaises(TypeError, (1+1j).__mod__, 4.3j)
Walter Dörwaldf393fc62003-07-15 18:47:27 +0000164
Walter Dörwald5edd7852003-06-18 14:26:18 +0000165 def test_divmod(self):
Guido van Rossum9648d622007-08-03 20:40:44 +0000166 self.assertRaises(TypeError, divmod, 1+1j, 1+0j)
167 self.assertRaises(TypeError, divmod, 1+1j, 0+0j)
Walter Dörwald5edd7852003-06-18 14:26:18 +0000168
169 def test_pow(self):
170 self.assertAlmostEqual(pow(1+1j, 0+0j), 1.0)
171 self.assertAlmostEqual(pow(0+0j, 2+0j), 0.0)
172 self.assertRaises(ZeroDivisionError, pow, 0+0j, 1j)
173 self.assertAlmostEqual(pow(1j, -1), 1/1j)
174 self.assertAlmostEqual(pow(1j, 200), 1)
175 self.assertRaises(ValueError, pow, 1+1j, 1+1j, 1+1j)
176
Walter Dörwaldf393fc62003-07-15 18:47:27 +0000177 a = 3.33+4.43j
178 self.assertEqual(a ** 0j, 1)
179 self.assertEqual(a ** 0.+0.j, 1)
180
181 self.assertEqual(3j ** 0j, 1)
182 self.assertEqual(3j ** 0, 1)
183
184 try:
185 0j ** a
186 except ZeroDivisionError:
187 pass
188 else:
189 self.fail("should fail 0.0 to negative or complex power")
190
191 try:
192 0j ** (3-2j)
193 except ZeroDivisionError:
194 pass
195 else:
196 self.fail("should fail 0.0 to negative or complex power")
197
198 # The following is used to exercise certain code paths
199 self.assertEqual(a ** 105, a ** 105)
200 self.assertEqual(a ** -105, a ** -105)
201 self.assertEqual(a ** -30, a ** -30)
202
203 self.assertEqual(0.0j ** 0, 1)
204
205 b = 5.1+2.3j
206 self.assertRaises(ValueError, pow, a, b, 0)
207
Walter Dörwald5edd7852003-06-18 14:26:18 +0000208 def test_boolcontext(self):
Guido van Rossum805365e2007-05-07 22:24:25 +0000209 for i in range(100):
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000210 self.assertTrue(complex(random() + 1e-6, random() + 1e-6))
211 self.assertTrue(not complex(0.0, 0.0))
Walter Dörwald5edd7852003-06-18 14:26:18 +0000212
213 def test_conjugate(self):
214 self.assertClose(complex(5.3, 9.8).conjugate(), 5.3-9.8j)
215
216 def test_constructor(self):
217 class OS:
218 def __init__(self, value): self.value = value
219 def __complex__(self): return self.value
220 class NS(object):
221 def __init__(self, value): self.value = value
222 def __complex__(self): return self.value
223 self.assertEqual(complex(OS(1+10j)), 1+10j)
224 self.assertEqual(complex(NS(1+10j)), 1+10j)
225 self.assertRaises(TypeError, complex, OS(None))
226 self.assertRaises(TypeError, complex, NS(None))
Alexander Belopolsky942af5a2010-12-04 03:38:46 +0000227 self.assertRaises(TypeError, complex, {})
Mark Dickinsond20fb822012-11-14 17:08:31 +0000228 self.assertRaises(TypeError, complex, NS(1.5))
229 self.assertRaises(TypeError, complex, NS(1))
Walter Dörwald5edd7852003-06-18 14:26:18 +0000230
231 self.assertAlmostEqual(complex("1+10j"), 1+10j)
232 self.assertAlmostEqual(complex(10), 10+0j)
233 self.assertAlmostEqual(complex(10.0), 10+0j)
Guido van Rossume2a383d2007-01-15 16:59:06 +0000234 self.assertAlmostEqual(complex(10), 10+0j)
Walter Dörwald5edd7852003-06-18 14:26:18 +0000235 self.assertAlmostEqual(complex(10+0j), 10+0j)
236 self.assertAlmostEqual(complex(1,10), 1+10j)
Guido van Rossume2a383d2007-01-15 16:59:06 +0000237 self.assertAlmostEqual(complex(1,10), 1+10j)
Walter Dörwald5edd7852003-06-18 14:26:18 +0000238 self.assertAlmostEqual(complex(1,10.0), 1+10j)
Guido van Rossume2a383d2007-01-15 16:59:06 +0000239 self.assertAlmostEqual(complex(1,10), 1+10j)
240 self.assertAlmostEqual(complex(1,10), 1+10j)
241 self.assertAlmostEqual(complex(1,10.0), 1+10j)
Walter Dörwald5edd7852003-06-18 14:26:18 +0000242 self.assertAlmostEqual(complex(1.0,10), 1+10j)
Guido van Rossume2a383d2007-01-15 16:59:06 +0000243 self.assertAlmostEqual(complex(1.0,10), 1+10j)
Walter Dörwald5edd7852003-06-18 14:26:18 +0000244 self.assertAlmostEqual(complex(1.0,10.0), 1+10j)
245 self.assertAlmostEqual(complex(3.14+0j), 3.14+0j)
246 self.assertAlmostEqual(complex(3.14), 3.14+0j)
247 self.assertAlmostEqual(complex(314), 314.0+0j)
Guido van Rossume2a383d2007-01-15 16:59:06 +0000248 self.assertAlmostEqual(complex(314), 314.0+0j)
Walter Dörwald5edd7852003-06-18 14:26:18 +0000249 self.assertAlmostEqual(complex(3.14+0j, 0j), 3.14+0j)
250 self.assertAlmostEqual(complex(3.14, 0.0), 3.14+0j)
251 self.assertAlmostEqual(complex(314, 0), 314.0+0j)
Guido van Rossume2a383d2007-01-15 16:59:06 +0000252 self.assertAlmostEqual(complex(314, 0), 314.0+0j)
Walter Dörwald5edd7852003-06-18 14:26:18 +0000253 self.assertAlmostEqual(complex(0j, 3.14j), -3.14+0j)
254 self.assertAlmostEqual(complex(0.0, 3.14j), -3.14+0j)
255 self.assertAlmostEqual(complex(0j, 3.14), 3.14j)
256 self.assertAlmostEqual(complex(0.0, 3.14), 3.14j)
257 self.assertAlmostEqual(complex("1"), 1+0j)
258 self.assertAlmostEqual(complex("1j"), 1j)
259 self.assertAlmostEqual(complex(), 0)
260 self.assertAlmostEqual(complex("-1"), -1)
261 self.assertAlmostEqual(complex("+1"), +1)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000262 self.assertAlmostEqual(complex("(1+2j)"), 1+2j)
263 self.assertAlmostEqual(complex("(1.3+2.2j)"), 1.3+2.2j)
Mark Dickinsonad476da2009-04-23 19:14:16 +0000264 self.assertAlmostEqual(complex("3.14+1J"), 3.14+1j)
265 self.assertAlmostEqual(complex(" ( +3.14-6J )"), 3.14-6j)
Mark Dickinson6649fa42009-04-24 13:25:20 +0000266 self.assertAlmostEqual(complex(" ( +3.14-J )"), 3.14-1j)
267 self.assertAlmostEqual(complex(" ( +3.14+j )"), 3.14+1j)
268 self.assertAlmostEqual(complex("J"), 1j)
269 self.assertAlmostEqual(complex("( j )"), 1j)
270 self.assertAlmostEqual(complex("+J"), 1j)
271 self.assertAlmostEqual(complex("( -j)"), -1j)
272 self.assertAlmostEqual(complex('1e-500'), 0.0 + 0.0j)
273 self.assertAlmostEqual(complex('-1e-500j'), 0.0 - 0.0j)
274 self.assertAlmostEqual(complex('-1e-500+1e-500j'), -0.0 + 0.0j)
Walter Dörwald5edd7852003-06-18 14:26:18 +0000275
276 class complex2(complex): pass
277 self.assertAlmostEqual(complex(complex2(1+1j)), 1+1j)
278 self.assertAlmostEqual(complex(real=17, imag=23), 17+23j)
279 self.assertAlmostEqual(complex(real=17+23j), 17+23j)
280 self.assertAlmostEqual(complex(real=17+23j, imag=23), 17+46j)
281 self.assertAlmostEqual(complex(real=1+2j, imag=3+4j), -3+5j)
282
Christian Heimes69a79632007-11-28 10:04:30 +0000283 # check that the sign of a zero in the real or imaginary part
284 # is preserved when constructing from two floats. (These checks
285 # are harmless on systems without support for signed zeros.)
286 def split_zeros(x):
287 """Function that produces different results for 0. and -0."""
288 return atan2(x, -1.)
289
290 self.assertEqual(split_zeros(complex(1., 0.).imag), split_zeros(0.))
291 self.assertEqual(split_zeros(complex(1., -0.).imag), split_zeros(-0.))
292 self.assertEqual(split_zeros(complex(0., 1.).real), split_zeros(0.))
293 self.assertEqual(split_zeros(complex(-0., 1.).real), split_zeros(-0.))
294
Walter Dörwald5edd7852003-06-18 14:26:18 +0000295 c = 3.14 + 1j
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000296 self.assertTrue(complex(c) is c)
Walter Dörwald5edd7852003-06-18 14:26:18 +0000297 del c
298
299 self.assertRaises(TypeError, complex, "1", "1")
300 self.assertRaises(TypeError, complex, 1, "1")
301
Walter Dörwald5edd7852003-06-18 14:26:18 +0000302 # SF bug 543840: complex(string) accepts strings with \0
303 # Fixed in 2.3.
304 self.assertRaises(ValueError, complex, '1+1j\0j')
305
306 self.assertRaises(TypeError, int, 5+3j)
Guido van Rossume2a383d2007-01-15 16:59:06 +0000307 self.assertRaises(TypeError, int, 5+3j)
Walter Dörwald5edd7852003-06-18 14:26:18 +0000308 self.assertRaises(TypeError, float, 5+3j)
309 self.assertRaises(ValueError, complex, "")
310 self.assertRaises(TypeError, complex, None)
Ezio Melottia5b95992013-11-07 19:18:34 +0200311 self.assertRaisesRegex(TypeError, "not 'NoneType'", complex, None)
Walter Dörwald5edd7852003-06-18 14:26:18 +0000312 self.assertRaises(ValueError, complex, "\0")
Guido van Rossumd8faa362007-04-27 19:54:29 +0000313 self.assertRaises(ValueError, complex, "3\09")
Walter Dörwald5edd7852003-06-18 14:26:18 +0000314 self.assertRaises(TypeError, complex, "1", "2")
315 self.assertRaises(TypeError, complex, "1", 42)
316 self.assertRaises(TypeError, complex, 1, "2")
317 self.assertRaises(ValueError, complex, "1+")
318 self.assertRaises(ValueError, complex, "1+1j+1j")
319 self.assertRaises(ValueError, complex, "--")
Guido van Rossumd8faa362007-04-27 19:54:29 +0000320 self.assertRaises(ValueError, complex, "(1+2j")
321 self.assertRaises(ValueError, complex, "1+2j)")
322 self.assertRaises(ValueError, complex, "1+(2j)")
323 self.assertRaises(ValueError, complex, "(1+2j)123")
Walter Dörwald1f5947b2007-05-22 16:52:54 +0000324 self.assertRaises(ValueError, complex, "x")
Mark Dickinsonad476da2009-04-23 19:14:16 +0000325 self.assertRaises(ValueError, complex, "1j+2")
326 self.assertRaises(ValueError, complex, "1e1ej")
327 self.assertRaises(ValueError, complex, "1e++1ej")
328 self.assertRaises(ValueError, complex, ")1+2j(")
Mark Dickinson6649fa42009-04-24 13:25:20 +0000329 # the following three are accepted by Python 2.6
330 self.assertRaises(ValueError, complex, "1..1j")
331 self.assertRaises(ValueError, complex, "1.11.1j")
332 self.assertRaises(ValueError, complex, "1e1.1j")
Walter Dörwald5edd7852003-06-18 14:26:18 +0000333
Mark Dickinsonf9724882009-10-26 21:51:18 +0000334 # check that complex accepts long unicode strings
335 self.assertEqual(type(complex("1"*500)), complex)
Alexander Belopolsky942af5a2010-12-04 03:38:46 +0000336 # check whitespace processing
337 self.assertEqual(complex('\N{EM SPACE}(\N{EN SPACE}1+1j ) '), 1+1j)
Mark Dickinsonf9724882009-10-26 21:51:18 +0000338
Walter Dörwald5edd7852003-06-18 14:26:18 +0000339 class EvilExc(Exception):
Tim Peters478c1052003-06-29 05:46:54 +0000340 pass
Walter Dörwald5edd7852003-06-18 14:26:18 +0000341
342 class evilcomplex:
343 def __complex__(self):
344 raise EvilExc
345
346 self.assertRaises(EvilExc, complex, evilcomplex())
347
348 class float2:
349 def __init__(self, value):
350 self.value = value
351 def __float__(self):
352 return self.value
353
354 self.assertAlmostEqual(complex(float2(42.)), 42)
355 self.assertAlmostEqual(complex(real=float2(17.), imag=float2(23.)), 17+23j)
356 self.assertRaises(TypeError, complex, float2(None))
357
Brett Cannonc3647ac2005-04-26 03:45:26 +0000358 class complex0(complex):
359 """Test usage of __complex__() when inheriting from 'complex'"""
360 def __complex__(self):
361 return 42j
362
363 class complex1(complex):
364 """Test usage of __complex__() with a __new__() method"""
365 def __new__(self, value=0j):
366 return complex.__new__(self, 2*value)
367 def __complex__(self):
368 return self
369
370 class complex2(complex):
371 """Make sure that __complex__() calls fail if anything other than a
372 complex is returned"""
373 def __complex__(self):
374 return None
375
376 self.assertAlmostEqual(complex(complex0(1j)), 42j)
377 self.assertAlmostEqual(complex(complex1(1j)), 2j)
378 self.assertRaises(TypeError, complex, complex2(1j))
379
Walter Dörwald5edd7852003-06-18 14:26:18 +0000380 def test_hash(self):
Guido van Rossum805365e2007-05-07 22:24:25 +0000381 for x in range(-30, 30):
Walter Dörwald5edd7852003-06-18 14:26:18 +0000382 self.assertEqual(hash(x), hash(complex(x, 0)))
383 x /= 3.0 # now check against floating point
384 self.assertEqual(hash(x), hash(complex(x, 0.)))
385
386 def test_abs(self):
Guido van Rossum805365e2007-05-07 22:24:25 +0000387 nums = [complex(x/3., y/7.) for x in range(-9,9) for y in range(-9,9)]
Walter Dörwald5edd7852003-06-18 14:26:18 +0000388 for num in nums:
389 self.assertAlmostEqual((num.real**2 + num.imag**2) ** 0.5, abs(num))
390
Eric Smith70099a12010-12-04 13:27:34 +0000391 def test_repr_str(self):
392 def test(v, expected, test_fn=self.assertEqual):
393 test_fn(repr(v), expected)
394 test_fn(str(v), expected)
Walter Dörwald5edd7852003-06-18 14:26:18 +0000395
Eric Smith70099a12010-12-04 13:27:34 +0000396 test(1+6j, '(1+6j)')
397 test(1-6j, '(1-6j)')
398
399 test(-(1+0j), '(-1+-0j)', test_fn=self.assertNotEqual)
400
401 test(complex(1., INF), "(1+infj)")
402 test(complex(1., -INF), "(1-infj)")
403 test(complex(INF, 1), "(inf+1j)")
404 test(complex(-INF, INF), "(-inf+infj)")
405 test(complex(NAN, 1), "(nan+1j)")
406 test(complex(1, NAN), "(1+nanj)")
407 test(complex(NAN, NAN), "(nan+nanj)")
408
409 test(complex(0, INF), "infj")
410 test(complex(0, -INF), "-infj")
411 test(complex(0, NAN), "nanj")
Georg Brandl9e281072005-09-17 07:51:15 +0000412
Guido van Rossumd8faa362007-04-27 19:54:29 +0000413 self.assertEqual(1-6j,complex(repr(1-6j)))
414 self.assertEqual(1+6j,complex(repr(1+6j)))
415 self.assertEqual(-6j,complex(repr(-6j)))
416 self.assertEqual(6j,complex(repr(6j)))
417
Eric Smith1ed77f32010-12-04 15:26:13 +0000418 @support.requires_IEEE_754
419 def test_negative_zero_repr_str(self):
420 def test(v, expected, test_fn=self.assertEqual):
421 test_fn(repr(v), expected)
422 test_fn(str(v), expected)
423
424 test(complex(0., 1.), "1j")
425 test(complex(-0., 1.), "(-0+1j)")
426 test(complex(0., -1.), "-1j")
427 test(complex(-0., -1.), "(-0-1j)")
428
429 test(complex(0., 0.), "0j")
430 test(complex(0., -0.), "-0j")
431 test(complex(-0., 0.), "(-0+0j)")
432 test(complex(-0., -0.), "(-0-0j)")
433
Walter Dörwald5edd7852003-06-18 14:26:18 +0000434 def test_neg(self):
435 self.assertEqual(-(1+6j), -1-6j)
436
Walter Dörwaldf393fc62003-07-15 18:47:27 +0000437 def test_file(self):
438 a = 3.33+4.43j
439 b = 5.1+2.3j
440
441 fo = None
442 try:
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000443 fo = open(support.TESTFN, "w")
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000444 print(a, b, file=fo)
Walter Dörwaldf393fc62003-07-15 18:47:27 +0000445 fo.close()
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000446 fo = open(support.TESTFN, "r")
Guido van Rossum09549f42007-08-27 20:40:10 +0000447 self.assertEqual(fo.read(), ("%s %s\n" % (a, b)))
Walter Dörwaldf393fc62003-07-15 18:47:27 +0000448 finally:
449 if (fo is not None) and (not fo.closed):
450 fo.close()
Florent Xicluna41fe6152010-04-02 18:52:12 +0000451 support.unlink(support.TESTFN)
Walter Dörwald5edd7852003-06-18 14:26:18 +0000452
Georg Brandl0c77a822008-06-10 16:37:50 +0000453 def test_getnewargs(self):
454 self.assertEqual((1+2j).__getnewargs__(), (1.0, 2.0))
455 self.assertEqual((1-2j).__getnewargs__(), (1.0, -2.0))
456 self.assertEqual((2j).__getnewargs__(), (0.0, 2.0))
457 self.assertEqual((-0j).__getnewargs__(), (0.0, -0.0))
458 self.assertEqual(complex(0, INF).__getnewargs__(), (0.0, INF))
459 self.assertEqual(complex(INF, 0).__getnewargs__(), (INF, 0.0))
460
Eric Smith3ab08ca2010-12-04 15:17:38 +0000461 @support.requires_IEEE_754
462 def test_plus_minus_0j(self):
463 # test that -0j and 0j literals are not identified
464 z1, z2 = 0j, -0j
465 self.assertEqual(atan2(z1.imag, -1.), atan2(0., -1.))
466 self.assertEqual(atan2(z2.imag, -1.), atan2(-0., -1.))
Christian Heimes400adb02008-02-01 08:12:03 +0000467
Eric Smith3ab08ca2010-12-04 15:17:38 +0000468 @support.requires_IEEE_754
Mark Dickinson50b79a82010-06-30 11:13:36 +0000469 def test_negated_imaginary_literal(self):
470 z0 = -0j
471 z1 = -7j
472 z2 = -1e1000j
473 # Note: In versions of Python < 3.2, a negated imaginary literal
474 # accidentally ended up with real part 0.0 instead of -0.0, thanks to a
475 # modification during CST -> AST translation (see issue #9011). That's
476 # fixed in Python 3.2.
477 self.assertFloatsAreIdentical(z0.real, -0.0)
478 self.assertFloatsAreIdentical(z0.imag, -0.0)
479 self.assertFloatsAreIdentical(z1.real, -0.0)
480 self.assertFloatsAreIdentical(z1.imag, -7.0)
481 self.assertFloatsAreIdentical(z2.real, -0.0)
482 self.assertFloatsAreIdentical(z2.imag, -INF)
483
Eric Smith3ab08ca2010-12-04 15:17:38 +0000484 @support.requires_IEEE_754
Mark Dickinson6b1e43b2009-05-20 18:41:04 +0000485 def test_overflow(self):
486 self.assertEqual(complex("1e500"), complex(INF, 0.0))
487 self.assertEqual(complex("-1e500j"), complex(0.0, -INF))
488 self.assertEqual(complex("-1e500+1.8e308j"), complex(-INF, INF))
489
Eric Smith3ab08ca2010-12-04 15:17:38 +0000490 @support.requires_IEEE_754
Mark Dickinsonad476da2009-04-23 19:14:16 +0000491 def test_repr_roundtrip(self):
Mark Dickinsonde8a7102009-04-25 10:11:40 +0000492 vals = [0.0, 1e-500, 1e-315, 1e-200, 0.0123, 3.1415, 1e50, INF, NAN]
Mark Dickinsonad476da2009-04-23 19:14:16 +0000493 vals += [-v for v in vals]
Mark Dickinsonde8a7102009-04-25 10:11:40 +0000494
495 # complex(repr(z)) should recover z exactly, even for complex
496 # numbers involving an infinity, nan, or negative zero
Mark Dickinsonad476da2009-04-23 19:14:16 +0000497 for x in vals:
498 for y in vals:
499 z = complex(x, y)
500 roundtrip = complex(repr(z))
501 self.assertFloatsAreIdentical(z.real, roundtrip.real)
502 self.assertFloatsAreIdentical(z.imag, roundtrip.imag)
503
Mark Dickinsonde8a7102009-04-25 10:11:40 +0000504 # if we predefine some constants, then eval(repr(z)) should
505 # also work, except that it might change the sign of zeros
506 inf, nan = float('inf'), float('nan')
507 infj, nanj = complex(0.0, inf), complex(0.0, nan)
508 for x in vals:
509 for y in vals:
510 z = complex(x, y)
511 roundtrip = eval(repr(z))
512 # adding 0.0 has no effect beside changing -0.0 to 0.0
513 self.assertFloatsAreIdentical(0.0 + z.real,
514 0.0 + roundtrip.real)
515 self.assertFloatsAreIdentical(0.0 + z.imag,
516 0.0 + roundtrip.imag)
517
Eric Smith58a42242009-04-30 01:00:33 +0000518 def test_format(self):
519 # empty format string is same as str()
520 self.assertEqual(format(1+3j, ''), str(1+3j))
521 self.assertEqual(format(1.5+3.5j, ''), str(1.5+3.5j))
522 self.assertEqual(format(3j, ''), str(3j))
523 self.assertEqual(format(3.2j, ''), str(3.2j))
524 self.assertEqual(format(3+0j, ''), str(3+0j))
525 self.assertEqual(format(3.2+0j, ''), str(3.2+0j))
Mark Dickinsonde8a7102009-04-25 10:11:40 +0000526
Eric Smith63376222009-05-05 14:04:18 +0000527 # empty presentation type should still be analogous to str,
528 # even when format string is nonempty (issue #5920).
529 self.assertEqual(format(3.2+0j, '-'), str(3.2+0j))
530 self.assertEqual(format(3.2+0j, '<'), str(3.2+0j))
531 z = 4/7. - 100j/7.
532 self.assertEqual(format(z, ''), str(z))
533 self.assertEqual(format(z, '-'), str(z))
534 self.assertEqual(format(z, '<'), str(z))
535 self.assertEqual(format(z, '10'), str(z))
Mark Dickinson5b65df72010-08-01 10:41:49 +0000536 z = complex(0.0, 3.0)
537 self.assertEqual(format(z, ''), str(z))
538 self.assertEqual(format(z, '-'), str(z))
539 self.assertEqual(format(z, '<'), str(z))
540 self.assertEqual(format(z, '2'), str(z))
541 z = complex(-0.0, 2.0)
542 self.assertEqual(format(z, ''), str(z))
543 self.assertEqual(format(z, '-'), str(z))
544 self.assertEqual(format(z, '<'), str(z))
545 self.assertEqual(format(z, '3'), str(z))
Eric Smith63376222009-05-05 14:04:18 +0000546
Eric Smith58a42242009-04-30 01:00:33 +0000547 self.assertEqual(format(1+3j, 'g'), '1+3j')
548 self.assertEqual(format(3j, 'g'), '0+3j')
549 self.assertEqual(format(1.5+3.5j, 'g'), '1.5+3.5j')
550
551 self.assertEqual(format(1.5+3.5j, '+g'), '+1.5+3.5j')
552 self.assertEqual(format(1.5-3.5j, '+g'), '+1.5-3.5j')
553 self.assertEqual(format(1.5-3.5j, '-g'), '1.5-3.5j')
554 self.assertEqual(format(1.5+3.5j, ' g'), ' 1.5+3.5j')
555 self.assertEqual(format(1.5-3.5j, ' g'), ' 1.5-3.5j')
556 self.assertEqual(format(-1.5+3.5j, ' g'), '-1.5+3.5j')
557 self.assertEqual(format(-1.5-3.5j, ' g'), '-1.5-3.5j')
558
559 self.assertEqual(format(-1.5-3.5e-20j, 'g'), '-1.5-3.5e-20j')
560 self.assertEqual(format(-1.5-3.5j, 'f'), '-1.500000-3.500000j')
561 self.assertEqual(format(-1.5-3.5j, 'F'), '-1.500000-3.500000j')
562 self.assertEqual(format(-1.5-3.5j, 'e'), '-1.500000e+00-3.500000e+00j')
563 self.assertEqual(format(-1.5-3.5j, '.2e'), '-1.50e+00-3.50e+00j')
564 self.assertEqual(format(-1.5-3.5j, '.2E'), '-1.50E+00-3.50E+00j')
565 self.assertEqual(format(-1.5e10-3.5e5j, '.2G'), '-1.5E+10-3.5E+05j')
566
567 self.assertEqual(format(1.5+3j, '<20g'), '1.5+3j ')
568 self.assertEqual(format(1.5+3j, '*<20g'), '1.5+3j**************')
569 self.assertEqual(format(1.5+3j, '>20g'), ' 1.5+3j')
570 self.assertEqual(format(1.5+3j, '^20g'), ' 1.5+3j ')
571 self.assertEqual(format(1.5+3j, '<20'), '(1.5+3j) ')
572 self.assertEqual(format(1.5+3j, '>20'), ' (1.5+3j)')
573 self.assertEqual(format(1.5+3j, '^20'), ' (1.5+3j) ')
574 self.assertEqual(format(1.123-3.123j, '^20.2'), ' (1.1-3.1j) ')
575
Eric Smith4e260c52010-02-22 18:54:44 +0000576 self.assertEqual(format(1.5+3j, '20.2f'), ' 1.50+3.00j')
577 self.assertEqual(format(1.5+3j, '>20.2f'), ' 1.50+3.00j')
Eric Smith58a42242009-04-30 01:00:33 +0000578 self.assertEqual(format(1.5+3j, '<20.2f'), '1.50+3.00j ')
579 self.assertEqual(format(1.5e20+3j, '<20.2f'), '150000000000000000000.00+3.00j')
580 self.assertEqual(format(1.5e20+3j, '>40.2f'), ' 150000000000000000000.00+3.00j')
581 self.assertEqual(format(1.5e20+3j, '^40,.2f'), ' 150,000,000,000,000,000,000.00+3.00j ')
582 self.assertEqual(format(1.5e21+3j, '^40,.2f'), ' 1,500,000,000,000,000,000,000.00+3.00j ')
583 self.assertEqual(format(1.5e21+3000j, ',.2f'), '1,500,000,000,000,000,000,000.00+3,000.00j')
584
Eric Smith984bb582010-11-25 16:08:06 +0000585 # Issue 7094: Alternate formatting (specified by #)
586 self.assertEqual(format(1+1j, '.0e'), '1e+00+1e+00j')
587 self.assertEqual(format(1+1j, '#.0e'), '1.e+00+1.e+00j')
588 self.assertEqual(format(1+1j, '.0f'), '1+1j')
589 self.assertEqual(format(1+1j, '#.0f'), '1.+1.j')
590 self.assertEqual(format(1.1+1.1j, 'g'), '1.1+1.1j')
591 self.assertEqual(format(1.1+1.1j, '#g'), '1.10000+1.10000j')
592
593 # Alternate doesn't make a difference for these, they format the same with or without it
594 self.assertEqual(format(1+1j, '.1e'), '1.0e+00+1.0e+00j')
595 self.assertEqual(format(1+1j, '#.1e'), '1.0e+00+1.0e+00j')
596 self.assertEqual(format(1+1j, '.1f'), '1.0+1.0j')
597 self.assertEqual(format(1+1j, '#.1f'), '1.0+1.0j')
598
599 # Misc. other alternate tests
600 self.assertEqual(format((-1.5+0.5j), '#f'), '-1.500000+0.500000j')
601 self.assertEqual(format((-1.5+0.5j), '#.0f'), '-2.+0.j')
602 self.assertEqual(format((-1.5+0.5j), '#e'), '-1.500000e+00+5.000000e-01j')
603 self.assertEqual(format((-1.5+0.5j), '#.0e'), '-2.e+00+5.e-01j')
604 self.assertEqual(format((-1.5+0.5j), '#g'), '-1.50000+0.500000j')
605 self.assertEqual(format((-1.5+0.5j), '.0g'), '-2+0.5j')
606 self.assertEqual(format((-1.5+0.5j), '#.0g'), '-2.+0.5j')
Eric Smith58a42242009-04-30 01:00:33 +0000607
608 # zero padding is invalid
609 self.assertRaises(ValueError, (1.5+0.5j).__format__, '010f')
610
611 # '=' alignment is invalid
612 self.assertRaises(ValueError, (1.5+3j).__format__, '=20')
613
614 # integer presentation types are an error
615 for t in 'bcdoxX':
616 self.assertRaises(ValueError, (1.5+0.5j).__format__, t)
617
618 # make sure everything works in ''.format()
619 self.assertEqual('*{0:.3f}*'.format(3.14159+2.71828j), '*3.142+2.718j*')
Mark Dickinsonad476da2009-04-23 19:14:16 +0000620
Eric Smith741191f2009-05-06 13:08:15 +0000621 # issue 3382
622 self.assertEqual(format(complex(NAN, NAN), 'f'), 'nan+nanj')
623 self.assertEqual(format(complex(1, NAN), 'f'), '1.000000+nanj')
624 self.assertEqual(format(complex(NAN, 1), 'f'), 'nan+1.000000j')
625 self.assertEqual(format(complex(NAN, -1), 'f'), 'nan-1.000000j')
626 self.assertEqual(format(complex(NAN, NAN), 'F'), 'NAN+NANj')
627 self.assertEqual(format(complex(1, NAN), 'F'), '1.000000+NANj')
628 self.assertEqual(format(complex(NAN, 1), 'F'), 'NAN+1.000000j')
629 self.assertEqual(format(complex(NAN, -1), 'F'), 'NAN-1.000000j')
630 self.assertEqual(format(complex(INF, INF), 'f'), 'inf+infj')
631 self.assertEqual(format(complex(1, INF), 'f'), '1.000000+infj')
632 self.assertEqual(format(complex(INF, 1), 'f'), 'inf+1.000000j')
633 self.assertEqual(format(complex(INF, -1), 'f'), 'inf-1.000000j')
634 self.assertEqual(format(complex(INF, INF), 'F'), 'INF+INFj')
635 self.assertEqual(format(complex(1, INF), 'F'), '1.000000+INFj')
636 self.assertEqual(format(complex(INF, 1), 'F'), 'INF+1.000000j')
637 self.assertEqual(format(complex(INF, -1), 'F'), 'INF-1.000000j')
638
Walter Dörwald5edd7852003-06-18 14:26:18 +0000639def test_main():
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000640 support.run_unittest(ComplexTest)
Walter Dörwald5edd7852003-06-18 14:26:18 +0000641
642if __name__ == "__main__":
643 test_main()