blob: 75e1afc8247c2d83acc51de12700778155e62a59 [file] [log] [blame]
Raymond Hettinger40f62172002-12-29 23:03:38 +00001#!/usr/bin/env python
2
3import unittest
Tim Peters46c04e12002-05-05 20:40:00 +00004import random
Raymond Hettinger40f62172002-12-29 23:03:38 +00005import time
Raymond Hettinger5f078ff2003-06-24 20:29:04 +00006import pickle
Raymond Hettinger2f726e92003-10-05 09:09:15 +00007import warnings
Georg Brandla4f46e12010-02-07 17:03:15 +00008from math import log, exp, pi, fsum, sin
Ezio Melottidde5b942010-02-03 05:37:26 +00009from functools import reduce
Raymond Hettinger40f62172002-12-29 23:03:38 +000010from test import test_support
Tim Peters46c04e12002-05-05 20:40:00 +000011
Raymond Hettinger40f62172002-12-29 23:03:38 +000012class TestBasicOps(unittest.TestCase):
13 # Superclass with tests common to all generators.
14 # Subclasses must arrange for self.gen to retrieve the Random instance
15 # to be tested.
Tim Peters46c04e12002-05-05 20:40:00 +000016
Raymond Hettinger40f62172002-12-29 23:03:38 +000017 def randomlist(self, n):
18 """Helper function to make a list of random numbers"""
19 return [self.gen.random() for i in xrange(n)]
Tim Peters46c04e12002-05-05 20:40:00 +000020
Raymond Hettinger40f62172002-12-29 23:03:38 +000021 def test_autoseed(self):
22 self.gen.seed()
23 state1 = self.gen.getstate()
Raymond Hettinger3081d592003-08-09 18:30:57 +000024 time.sleep(0.1)
Raymond Hettinger40f62172002-12-29 23:03:38 +000025 self.gen.seed() # diffent seeds at different times
26 state2 = self.gen.getstate()
27 self.assertNotEqual(state1, state2)
Tim Peters46c04e12002-05-05 20:40:00 +000028
Raymond Hettinger40f62172002-12-29 23:03:38 +000029 def test_saverestore(self):
30 N = 1000
31 self.gen.seed()
32 state = self.gen.getstate()
33 randseq = self.randomlist(N)
34 self.gen.setstate(state) # should regenerate the same sequence
35 self.assertEqual(randseq, self.randomlist(N))
36
37 def test_seedargs(self):
38 for arg in [None, 0, 0L, 1, 1L, -1, -1L, 10**20, -(10**20),
39 3.14, 1+2j, 'a', tuple('abc')]:
40 self.gen.seed(arg)
41 for arg in [range(3), dict(one=1)]:
42 self.assertRaises(TypeError, self.gen.seed, arg)
Raymond Hettinger58335872004-07-09 14:26:18 +000043 self.assertRaises(TypeError, self.gen.seed, 1, 2)
44 self.assertRaises(TypeError, type(self.gen), [])
Raymond Hettinger40f62172002-12-29 23:03:38 +000045
Andrew Svetlovb6cdae32013-04-12 23:39:33 +030046 def test_triangular(self):
47 # Check that triangular() correctly handles bad input. See issue 13355.
48 # mode > high.
49 with self.assertRaises(ValueError):
50 random.triangular(mode=2)
51 with self.assertRaises(ValueError):
52 random.triangular(low=1, high=10, mode=11)
53 with self.assertRaises(ValueError):
54 random.triangular(low=1, high=1, mode=11)
55 # mode < low.
56 with self.assertRaises(ValueError):
57 random.triangular(mode=-1)
58 with self.assertRaises(ValueError):
59 random.triangular(low=1, high=10, mode=0)
60 with self.assertRaises(ValueError):
61 random.triangular(low=1, high=1, mode=0)
62 # low > high
63 with self.assertRaises(ValueError):
64 random.triangular(low=5, high=2)
65 with self.assertRaises(ValueError):
66 random.triangular(low=5, high=2, mode=1)
67 with self.assertRaises(ValueError):
68 random.triangular(low=-2, high=-5)
69
70 self.assertEqual(random.triangular(low=10, high=10), 10)
71 self.assertEqual(random.triangular(low=10, high=10, mode=10), 10)
72
Raymond Hettinger40f62172002-12-29 23:03:38 +000073 def test_jumpahead(self):
74 self.gen.seed()
75 state1 = self.gen.getstate()
76 self.gen.jumpahead(100)
77 state2 = self.gen.getstate() # s/b distinct from state1
78 self.assertNotEqual(state1, state2)
79 self.gen.jumpahead(100)
80 state3 = self.gen.getstate() # s/b distinct from state2
81 self.assertNotEqual(state2, state3)
82
Florent Xicluna6de9e932010-03-07 12:18:33 +000083 with test_support.check_py3k_warnings(quiet=True):
Antoine Pitroub844ef72009-10-14 18:56:11 +000084 self.assertRaises(TypeError, self.gen.jumpahead) # needs an arg
Antoine Pitroub844ef72009-10-14 18:56:11 +000085 self.assertRaises(TypeError, self.gen.jumpahead, 2, 3) # too many
Raymond Hettinger40f62172002-12-29 23:03:38 +000086
Mark Dickinsone0afb722012-06-30 17:19:35 +010087 def test_jumpahead_produces_valid_state(self):
88 # From http://bugs.python.org/issue14591.
89 self.gen.seed(199210368)
90 self.gen.jumpahead(13550674232554645900)
91 for i in range(500):
92 val = self.gen.random()
93 self.assertLess(val, 1.0)
94
Raymond Hettinger40f62172002-12-29 23:03:38 +000095 def test_sample(self):
96 # For the entire allowable range of 0 <= k <= N, validate that
97 # the sample is of the correct length and contains only unique items
98 N = 100
99 population = xrange(N)
100 for k in xrange(N+1):
101 s = self.gen.sample(population, k)
102 self.assertEqual(len(s), k)
Raymond Hettingera690a992003-11-16 16:17:49 +0000103 uniq = set(s)
Raymond Hettinger40f62172002-12-29 23:03:38 +0000104 self.assertEqual(len(uniq), k)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000105 self.assertTrue(uniq <= set(population))
Raymond Hettinger8ec78812003-01-04 05:55:11 +0000106 self.assertEqual(self.gen.sample([], 0), []) # test edge case N==k==0
Raymond Hettinger40f62172002-12-29 23:03:38 +0000107
Raymond Hettinger7b0cf762003-01-17 17:23:23 +0000108 def test_sample_distribution(self):
109 # For the entire allowable range of 0 <= k <= N, validate that
110 # sample generates all possible permutations
111 n = 5
112 pop = range(n)
113 trials = 10000 # large num prevents false negatives without slowing normal case
114 def factorial(n):
Raymond Hettinger105b0842003-02-04 05:47:30 +0000115 return reduce(int.__mul__, xrange(1, n), 1)
Raymond Hettinger7b0cf762003-01-17 17:23:23 +0000116 for k in xrange(n):
Raymond Hettingerffdb8bb2004-09-27 15:29:05 +0000117 expected = factorial(n) // factorial(n-k)
Raymond Hettinger7b0cf762003-01-17 17:23:23 +0000118 perms = {}
119 for i in xrange(trials):
120 perms[tuple(self.gen.sample(pop, k))] = None
121 if len(perms) == expected:
122 break
123 else:
124 self.fail()
125
Raymond Hettinger66d09f12003-09-06 04:25:54 +0000126 def test_sample_inputs(self):
127 # SF bug #801342 -- population can be any iterable defining __len__()
Raymond Hettingera690a992003-11-16 16:17:49 +0000128 self.gen.sample(set(range(20)), 2)
Raymond Hettinger66d09f12003-09-06 04:25:54 +0000129 self.gen.sample(range(20), 2)
130 self.gen.sample(xrange(20), 2)
Raymond Hettinger66d09f12003-09-06 04:25:54 +0000131 self.gen.sample(str('abcdefghijklmnopqrst'), 2)
132 self.gen.sample(tuple('abcdefghijklmnopqrst'), 2)
Tim Petersc17976e2006-04-01 00:26:53 +0000133
134 def test_sample_on_dicts(self):
135 self.gen.sample(dict.fromkeys('abcdefghijklmnopqrst'), 2)
136
Raymond Hettinger3c3346d2006-03-29 09:13:13 +0000137 # SF bug #1460340 -- random.sample can raise KeyError
138 a = dict.fromkeys(range(10)+range(10,100,2)+range(100,110))
Tim Petersc17976e2006-04-01 00:26:53 +0000139 self.gen.sample(a, 3)
140
141 # A followup to bug #1460340: sampling from a dict could return
142 # a subset of its keys or of its values, depending on the size of
143 # the subset requested.
144 N = 30
145 d = dict((i, complex(i, i)) for i in xrange(N))
146 for k in xrange(N+1):
147 samp = self.gen.sample(d, k)
148 # Verify that we got ints back (keys); the values are complex.
149 for x in samp:
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000150 self.assertTrue(type(x) is int)
Tim Petersc17976e2006-04-01 00:26:53 +0000151 samp.sort()
152 self.assertEqual(samp, range(N))
Raymond Hettinger66d09f12003-09-06 04:25:54 +0000153
Raymond Hettinger40f62172002-12-29 23:03:38 +0000154 def test_gauss(self):
155 # Ensure that the seed() method initializes all the hidden state. In
156 # particular, through 2.2.1 it failed to reset a piece of state used
157 # by (and only by) the .gauss() method.
158
159 for seed in 1, 12, 123, 1234, 12345, 123456, 654321:
160 self.gen.seed(seed)
161 x1 = self.gen.random()
162 y1 = self.gen.gauss(0, 1)
163
164 self.gen.seed(seed)
165 x2 = self.gen.random()
166 y2 = self.gen.gauss(0, 1)
167
168 self.assertEqual(x1, x2)
169 self.assertEqual(y1, y2)
170
Raymond Hettinger5f078ff2003-06-24 20:29:04 +0000171 def test_pickling(self):
172 state = pickle.dumps(self.gen)
173 origseq = [self.gen.random() for i in xrange(10)]
174 newgen = pickle.loads(state)
175 restoredseq = [newgen.random() for i in xrange(10)]
176 self.assertEqual(origseq, restoredseq)
Raymond Hettinger40f62172002-12-29 23:03:38 +0000177
Martin v. Löwis6b449f42007-12-03 19:20:02 +0000178 def test_bug_1727780(self):
179 # verify that version-2-pickles can be loaded
180 # fine, whether they are created on 32-bit or 64-bit
181 # platforms, and that version-3-pickles load fine.
182 files = [("randv2_32.pck", 780),
183 ("randv2_64.pck", 866),
184 ("randv3.pck", 343)]
185 for file, value in files:
186 f = open(test_support.findfile(file),"rb")
187 r = pickle.load(f)
188 f.close()
189 self.assertEqual(r.randrange(1000), value)
190
Raymond Hettinger40f62172002-12-29 23:03:38 +0000191class WichmannHill_TestBasicOps(TestBasicOps):
192 gen = random.WichmannHill()
193
Raymond Hettinger58335872004-07-09 14:26:18 +0000194 def test_setstate_first_arg(self):
195 self.assertRaises(ValueError, self.gen.setstate, (2, None, None))
196
Raymond Hettinger40f62172002-12-29 23:03:38 +0000197 def test_strong_jumpahead(self):
198 # tests that jumpahead(n) semantics correspond to n calls to random()
199 N = 1000
200 s = self.gen.getstate()
201 self.gen.jumpahead(N)
202 r1 = self.gen.random()
203 # now do it the slow way
204 self.gen.setstate(s)
205 for i in xrange(N):
206 self.gen.random()
207 r2 = self.gen.random()
208 self.assertEqual(r1, r2)
209
210 def test_gauss_with_whseed(self):
211 # Ensure that the seed() method initializes all the hidden state. In
212 # particular, through 2.2.1 it failed to reset a piece of state used
213 # by (and only by) the .gauss() method.
214
215 for seed in 1, 12, 123, 1234, 12345, 123456, 654321:
216 self.gen.whseed(seed)
217 x1 = self.gen.random()
218 y1 = self.gen.gauss(0, 1)
219
220 self.gen.whseed(seed)
221 x2 = self.gen.random()
222 y2 = self.gen.gauss(0, 1)
223
224 self.assertEqual(x1, x2)
225 self.assertEqual(y1, y2)
226
Raymond Hettinger2f726e92003-10-05 09:09:15 +0000227 def test_bigrand(self):
228 # Verify warnings are raised when randrange is too large for random()
Brett Cannon672237d2008-09-09 00:49:16 +0000229 with warnings.catch_warnings():
Brett Cannon6d9520c2006-12-13 23:09:53 +0000230 warnings.filterwarnings("error", "Underlying random")
231 self.assertRaises(UserWarning, self.gen.randrange, 2**60)
Raymond Hettinger2f726e92003-10-05 09:09:15 +0000232
Raymond Hettinger23f12412004-09-13 22:23:21 +0000233class SystemRandom_TestBasicOps(TestBasicOps):
234 gen = random.SystemRandom()
Raymond Hettinger356a4592004-08-30 06:14:31 +0000235
236 def test_autoseed(self):
237 # Doesn't need to do anything except not fail
238 self.gen.seed()
239
240 def test_saverestore(self):
241 self.assertRaises(NotImplementedError, self.gen.getstate)
242 self.assertRaises(NotImplementedError, self.gen.setstate, None)
243
244 def test_seedargs(self):
245 # Doesn't need to do anything except not fail
246 self.gen.seed(100)
247
248 def test_jumpahead(self):
249 # Doesn't need to do anything except not fail
250 self.gen.jumpahead(100)
251
252 def test_gauss(self):
253 self.gen.gauss_next = None
254 self.gen.seed(100)
255 self.assertEqual(self.gen.gauss_next, None)
256
257 def test_pickling(self):
258 self.assertRaises(NotImplementedError, pickle.dumps, self.gen)
259
260 def test_53_bits_per_float(self):
261 # This should pass whenever a C double has 53 bit precision.
262 span = 2 ** 53
263 cum = 0
264 for i in xrange(100):
265 cum |= int(self.gen.random() * span)
266 self.assertEqual(cum, span-1)
267
268 def test_bigrand(self):
269 # The randrange routine should build-up the required number of bits
270 # in stages so that all bit positions are active.
271 span = 2 ** 500
272 cum = 0
273 for i in xrange(100):
274 r = self.gen.randrange(span)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000275 self.assertTrue(0 <= r < span)
Raymond Hettinger356a4592004-08-30 06:14:31 +0000276 cum |= r
277 self.assertEqual(cum, span-1)
278
279 def test_bigrand_ranges(self):
280 for i in [40,80, 160, 200, 211, 250, 375, 512, 550]:
281 start = self.gen.randrange(2 ** i)
282 stop = self.gen.randrange(2 ** (i-2))
283 if stop <= start:
284 return
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000285 self.assertTrue(start <= self.gen.randrange(start, stop) < stop)
Raymond Hettinger356a4592004-08-30 06:14:31 +0000286
287 def test_rangelimits(self):
288 for start, stop in [(-2,0), (-(2**60)-2,-(2**60)), (2**60,2**60+2)]:
289 self.assertEqual(set(range(start,stop)),
290 set([self.gen.randrange(start,stop) for i in xrange(100)]))
291
292 def test_genrandbits(self):
293 # Verify ranges
294 for k in xrange(1, 1000):
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000295 self.assertTrue(0 <= self.gen.getrandbits(k) < 2**k)
Raymond Hettinger356a4592004-08-30 06:14:31 +0000296
297 # Verify all bits active
298 getbits = self.gen.getrandbits
299 for span in [1, 2, 3, 4, 31, 32, 32, 52, 53, 54, 119, 127, 128, 129]:
300 cum = 0
301 for i in xrange(100):
302 cum |= getbits(span)
303 self.assertEqual(cum, 2**span-1)
304
305 # Verify argument checking
306 self.assertRaises(TypeError, self.gen.getrandbits)
307 self.assertRaises(TypeError, self.gen.getrandbits, 1, 2)
308 self.assertRaises(ValueError, self.gen.getrandbits, 0)
309 self.assertRaises(ValueError, self.gen.getrandbits, -1)
310 self.assertRaises(TypeError, self.gen.getrandbits, 10.1)
311
312 def test_randbelow_logic(self, _log=log, int=int):
313 # check bitcount transition points: 2**i and 2**(i+1)-1
314 # show that: k = int(1.001 + _log(n, 2))
315 # is equal to or one greater than the number of bits in n
316 for i in xrange(1, 1000):
317 n = 1L << i # check an exact power of two
318 numbits = i+1
319 k = int(1.00001 + _log(n, 2))
320 self.assertEqual(k, numbits)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000321 self.assertTrue(n == 2**(k-1))
Raymond Hettinger356a4592004-08-30 06:14:31 +0000322
323 n += n - 1 # check 1 below the next power of two
324 k = int(1.00001 + _log(n, 2))
Ezio Melottiaa980582010-01-23 23:04:36 +0000325 self.assertIn(k, [numbits, numbits+1])
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000326 self.assertTrue(2**k > n > 2**(k-2))
Raymond Hettinger356a4592004-08-30 06:14:31 +0000327
328 n -= n >> 15 # check a little farther below the next power of two
329 k = int(1.00001 + _log(n, 2))
330 self.assertEqual(k, numbits) # note the stronger assertion
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000331 self.assertTrue(2**k > n > 2**(k-1)) # note the stronger assertion
Raymond Hettinger356a4592004-08-30 06:14:31 +0000332
333
Raymond Hettinger40f62172002-12-29 23:03:38 +0000334class MersenneTwister_TestBasicOps(TestBasicOps):
335 gen = random.Random()
336
Raymond Hettinger58335872004-07-09 14:26:18 +0000337 def test_setstate_first_arg(self):
338 self.assertRaises(ValueError, self.gen.setstate, (1, None, None))
339
340 def test_setstate_middle_arg(self):
341 # Wrong type, s/b tuple
342 self.assertRaises(TypeError, self.gen.setstate, (2, None, None))
343 # Wrong length, s/b 625
344 self.assertRaises(ValueError, self.gen.setstate, (2, (1,2,3), None))
345 # Wrong type, s/b tuple of 625 ints
346 self.assertRaises(TypeError, self.gen.setstate, (2, ('a',)*625, None))
347 # Last element s/b an int also
348 self.assertRaises(TypeError, self.gen.setstate, (2, (0,)*624+('a',), None))
349
Raymond Hettinger40f62172002-12-29 23:03:38 +0000350 def test_referenceImplementation(self):
351 # Compare the python implementation with results from the original
352 # code. Create 2000 53-bit precision random floats. Compare only
353 # the last ten entries to show that the independent implementations
354 # are tracking. Here is the main() function needed to create the
355 # list of expected random numbers:
356 # void main(void){
357 # int i;
358 # unsigned long init[4]={61731, 24903, 614, 42143}, length=4;
359 # init_by_array(init, length);
360 # for (i=0; i<2000; i++) {
361 # printf("%.15f ", genrand_res53());
362 # if (i%5==4) printf("\n");
363 # }
364 # }
365 expected = [0.45839803073713259,
366 0.86057815201978782,
367 0.92848331726782152,
368 0.35932681119782461,
369 0.081823493762449573,
370 0.14332226470169329,
371 0.084297823823520024,
372 0.53814864671831453,
373 0.089215024911993401,
374 0.78486196105372907]
375
376 self.gen.seed(61731L + (24903L<<32) + (614L<<64) + (42143L<<96))
377 actual = self.randomlist(2000)[-10:]
378 for a, e in zip(actual, expected):
379 self.assertAlmostEqual(a,e,places=14)
380
381 def test_strong_reference_implementation(self):
382 # Like test_referenceImplementation, but checks for exact bit-level
383 # equality. This should pass on any box where C double contains
384 # at least 53 bits of precision (the underlying algorithm suffers
385 # no rounding errors -- all results are exact).
386 from math import ldexp
387
388 expected = [0x0eab3258d2231fL,
389 0x1b89db315277a5L,
390 0x1db622a5518016L,
391 0x0b7f9af0d575bfL,
392 0x029e4c4db82240L,
393 0x04961892f5d673L,
394 0x02b291598e4589L,
395 0x11388382c15694L,
396 0x02dad977c9e1feL,
397 0x191d96d4d334c6L]
Raymond Hettinger40f62172002-12-29 23:03:38 +0000398 self.gen.seed(61731L + (24903L<<32) + (614L<<64) + (42143L<<96))
399 actual = self.randomlist(2000)[-10:]
400 for a, e in zip(actual, expected):
401 self.assertEqual(long(ldexp(a, 53)), e)
402
403 def test_long_seed(self):
404 # This is most interesting to run in debug mode, just to make sure
405 # nothing blows up. Under the covers, a dynamically resized array
406 # is allocated, consuming space proportional to the number of bits
407 # in the seed. Unfortunately, that's a quadratic-time algorithm,
408 # so don't make this horribly big.
409 seed = (1L << (10000 * 8)) - 1 # about 10K bytes
410 self.gen.seed(seed)
411
Raymond Hettinger2f726e92003-10-05 09:09:15 +0000412 def test_53_bits_per_float(self):
413 # This should pass whenever a C double has 53 bit precision.
414 span = 2 ** 53
415 cum = 0
416 for i in xrange(100):
417 cum |= int(self.gen.random() * span)
418 self.assertEqual(cum, span-1)
419
420 def test_bigrand(self):
421 # The randrange routine should build-up the required number of bits
422 # in stages so that all bit positions are active.
423 span = 2 ** 500
424 cum = 0
425 for i in xrange(100):
426 r = self.gen.randrange(span)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000427 self.assertTrue(0 <= r < span)
Raymond Hettinger2f726e92003-10-05 09:09:15 +0000428 cum |= r
429 self.assertEqual(cum, span-1)
430
431 def test_bigrand_ranges(self):
432 for i in [40,80, 160, 200, 211, 250, 375, 512, 550]:
433 start = self.gen.randrange(2 ** i)
434 stop = self.gen.randrange(2 ** (i-2))
435 if stop <= start:
436 return
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000437 self.assertTrue(start <= self.gen.randrange(start, stop) < stop)
Raymond Hettinger2f726e92003-10-05 09:09:15 +0000438
439 def test_rangelimits(self):
440 for start, stop in [(-2,0), (-(2**60)-2,-(2**60)), (2**60,2**60+2)]:
Raymond Hettingera690a992003-11-16 16:17:49 +0000441 self.assertEqual(set(range(start,stop)),
442 set([self.gen.randrange(start,stop) for i in xrange(100)]))
Raymond Hettinger2f726e92003-10-05 09:09:15 +0000443
444 def test_genrandbits(self):
445 # Verify cross-platform repeatability
446 self.gen.seed(1234567)
447 self.assertEqual(self.gen.getrandbits(100),
448 97904845777343510404718956115L)
449 # Verify ranges
450 for k in xrange(1, 1000):
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000451 self.assertTrue(0 <= self.gen.getrandbits(k) < 2**k)
Raymond Hettinger2f726e92003-10-05 09:09:15 +0000452
453 # Verify all bits active
454 getbits = self.gen.getrandbits
455 for span in [1, 2, 3, 4, 31, 32, 32, 52, 53, 54, 119, 127, 128, 129]:
456 cum = 0
457 for i in xrange(100):
458 cum |= getbits(span)
459 self.assertEqual(cum, 2**span-1)
460
Raymond Hettinger58335872004-07-09 14:26:18 +0000461 # Verify argument checking
462 self.assertRaises(TypeError, self.gen.getrandbits)
463 self.assertRaises(TypeError, self.gen.getrandbits, 'a')
464 self.assertRaises(TypeError, self.gen.getrandbits, 1, 2)
465 self.assertRaises(ValueError, self.gen.getrandbits, 0)
466 self.assertRaises(ValueError, self.gen.getrandbits, -1)
467
Raymond Hettinger2f726e92003-10-05 09:09:15 +0000468 def test_randbelow_logic(self, _log=log, int=int):
469 # check bitcount transition points: 2**i and 2**(i+1)-1
470 # show that: k = int(1.001 + _log(n, 2))
471 # is equal to or one greater than the number of bits in n
472 for i in xrange(1, 1000):
473 n = 1L << i # check an exact power of two
474 numbits = i+1
475 k = int(1.00001 + _log(n, 2))
476 self.assertEqual(k, numbits)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000477 self.assertTrue(n == 2**(k-1))
Raymond Hettinger2f726e92003-10-05 09:09:15 +0000478
479 n += n - 1 # check 1 below the next power of two
480 k = int(1.00001 + _log(n, 2))
Ezio Melottiaa980582010-01-23 23:04:36 +0000481 self.assertIn(k, [numbits, numbits+1])
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000482 self.assertTrue(2**k > n > 2**(k-2))
Raymond Hettinger2f726e92003-10-05 09:09:15 +0000483
484 n -= n >> 15 # check a little farther below the next power of two
485 k = int(1.00001 + _log(n, 2))
486 self.assertEqual(k, numbits) # note the stronger assertion
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000487 self.assertTrue(2**k > n > 2**(k-1)) # note the stronger assertion
Raymond Hettinger2f726e92003-10-05 09:09:15 +0000488
Raymond Hettinger94547f72006-12-20 06:42:06 +0000489 def test_randrange_bug_1590891(self):
490 start = 1000000000000
491 stop = -100000000000000000000
492 step = -200
493 x = self.gen.randrange(start, stop, step)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000494 self.assertTrue(stop < x <= start)
Raymond Hettinger94547f72006-12-20 06:42:06 +0000495 self.assertEqual((x+stop)%step, 0)
496
Raymond Hettinger8f9a1ee2009-02-19 09:50:24 +0000497def gamma(z, sqrt2pi=(2.0*pi)**0.5):
498 # Reflection to right half of complex plane
499 if z < 0.5:
500 return pi / sin(pi*z) / gamma(1.0-z)
501 # Lanczos approximation with g=7
502 az = z + (7.0 - 0.5)
503 return az ** (z-0.5) / exp(az) * sqrt2pi * fsum([
504 0.9999999999995183,
505 676.5203681218835 / z,
506 -1259.139216722289 / (z+1.0),
507 771.3234287757674 / (z+2.0),
508 -176.6150291498386 / (z+3.0),
509 12.50734324009056 / (z+4.0),
510 -0.1385710331296526 / (z+5.0),
511 0.9934937113930748e-05 / (z+6.0),
512 0.1659470187408462e-06 / (z+7.0),
513 ])
Raymond Hettinger3dd990c2003-01-05 09:20:06 +0000514
Raymond Hettinger15ec3732003-01-05 01:08:34 +0000515class TestDistributions(unittest.TestCase):
516 def test_zeroinputs(self):
517 # Verify that distributions can handle a series of zero inputs'
518 g = random.Random()
519 x = [g.random() for i in xrange(50)] + [0.0]*5
520 g.random = x[:].pop; g.uniform(1,10)
521 g.random = x[:].pop; g.paretovariate(1.0)
522 g.random = x[:].pop; g.expovariate(1.0)
523 g.random = x[:].pop; g.weibullvariate(1.0, 1.0)
Serhiy Storchaka65d56392013-02-10 19:27:37 +0200524 g.random = x[:].pop; g.vonmisesvariate(1.0, 1.0)
Raymond Hettinger15ec3732003-01-05 01:08:34 +0000525 g.random = x[:].pop; g.normalvariate(0.0, 1.0)
526 g.random = x[:].pop; g.gauss(0.0, 1.0)
527 g.random = x[:].pop; g.lognormvariate(0.0, 1.0)
528 g.random = x[:].pop; g.vonmisesvariate(0.0, 1.0)
529 g.random = x[:].pop; g.gammavariate(0.01, 1.0)
530 g.random = x[:].pop; g.gammavariate(1.0, 1.0)
531 g.random = x[:].pop; g.gammavariate(200.0, 1.0)
532 g.random = x[:].pop; g.betavariate(3.0, 3.0)
Raymond Hettingerbbc50ea2008-03-23 13:32:32 +0000533 g.random = x[:].pop; g.triangular(0.0, 1.0, 1.0/3.0)
Raymond Hettinger15ec3732003-01-05 01:08:34 +0000534
Raymond Hettinger3dd990c2003-01-05 09:20:06 +0000535 def test_avg_std(self):
536 # Use integration to test distribution average and standard deviation.
537 # Only works for distributions which do not consume variates in pairs
538 g = random.Random()
539 N = 5000
540 x = [i/float(N) for i in xrange(1,N)]
541 for variate, args, mu, sigmasqrd in [
542 (g.uniform, (1.0,10.0), (10.0+1.0)/2, (10.0-1.0)**2/12),
Raymond Hettingerbbc50ea2008-03-23 13:32:32 +0000543 (g.triangular, (0.0, 1.0, 1.0/3.0), 4.0/9.0, 7.0/9.0/18.0),
Raymond Hettinger3dd990c2003-01-05 09:20:06 +0000544 (g.expovariate, (1.5,), 1/1.5, 1/1.5**2),
Serhiy Storchaka65d56392013-02-10 19:27:37 +0200545 (g.vonmisesvariate, (1.23, 0), pi, pi**2/3),
Raymond Hettinger3dd990c2003-01-05 09:20:06 +0000546 (g.paretovariate, (5.0,), 5.0/(5.0-1),
547 5.0/((5.0-1)**2*(5.0-2))),
548 (g.weibullvariate, (1.0, 3.0), gamma(1+1/3.0),
549 gamma(1+2/3.0)-gamma(1+1/3.0)**2) ]:
550 g.random = x[:].pop
551 y = []
552 for i in xrange(len(x)):
553 try:
554 y.append(variate(*args))
555 except IndexError:
556 pass
557 s1 = s2 = 0
558 for e in y:
559 s1 += e
560 s2 += (e - mu) ** 2
561 N = len(y)
Serhiy Storchaka65d56392013-02-10 19:27:37 +0200562 self.assertAlmostEqual(s1/N, mu, places=2,
563 msg='%s%r' % (variate.__name__, args))
564 self.assertAlmostEqual(s2/(N-1), sigmasqrd, places=2,
565 msg='%s%r' % (variate.__name__, args))
566
567 def test_constant(self):
568 g = random.Random()
569 N = 100
570 for variate, args, expected in [
571 (g.uniform, (10.0, 10.0), 10.0),
572 (g.triangular, (10.0, 10.0), 10.0),
Andrew Svetlovb6cdae32013-04-12 23:39:33 +0300573 (g.triangular, (10.0, 10.0, 10.0), 10.0),
Serhiy Storchaka65d56392013-02-10 19:27:37 +0200574 (g.expovariate, (float('inf'),), 0.0),
575 (g.vonmisesvariate, (3.0, float('inf')), 3.0),
576 (g.gauss, (10.0, 0.0), 10.0),
577 (g.lognormvariate, (0.0, 0.0), 1.0),
578 (g.lognormvariate, (-float('inf'), 0.0), 0.0),
579 (g.normalvariate, (10.0, 0.0), 10.0),
580 (g.paretovariate, (float('inf'),), 1.0),
581 (g.weibullvariate, (10.0, float('inf')), 10.0),
582 (g.weibullvariate, (0.0, 10.0), 0.0),
583 ]:
584 for i in range(N):
585 self.assertEqual(variate(*args), expected)
Raymond Hettinger3dd990c2003-01-05 09:20:06 +0000586
Mark Dickinson9aaeb5e2013-02-10 14:13:40 +0000587 def test_von_mises_range(self):
588 # Issue 17149: von mises variates were not consistently in the
589 # range [0, 2*PI].
590 g = random.Random()
591 N = 100
592 for mu in 0.0, 0.1, 3.1, 6.2:
593 for kappa in 0.0, 2.3, 500.0:
594 for _ in range(N):
595 sample = g.vonmisesvariate(mu, kappa)
596 self.assertTrue(
597 0 <= sample <= random.TWOPI,
598 msg=("vonmisesvariate({}, {}) produced a result {} out"
599 " of range [0, 2*pi]").format(mu, kappa, sample))
600
Serhiy Storchaka65d56392013-02-10 19:27:37 +0200601 def test_von_mises_large_kappa(self):
602 # Issue #17141: vonmisesvariate() was hang for large kappas
603 random.vonmisesvariate(0, 1e15)
604 random.vonmisesvariate(0, 1e100)
605
606
Raymond Hettinger40f62172002-12-29 23:03:38 +0000607class TestModule(unittest.TestCase):
608 def testMagicConstants(self):
609 self.assertAlmostEqual(random.NV_MAGICCONST, 1.71552776992141)
610 self.assertAlmostEqual(random.TWOPI, 6.28318530718)
611 self.assertAlmostEqual(random.LOG4, 1.38629436111989)
612 self.assertAlmostEqual(random.SG_MAGICCONST, 2.50407739677627)
613
614 def test__all__(self):
615 # tests validity but not completeness of the __all__ list
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000616 self.assertTrue(set(random.__all__) <= set(dir(random)))
Raymond Hettinger40f62172002-12-29 23:03:38 +0000617
Georg Brandlb84c1372007-01-21 10:28:43 +0000618 def test_random_subclass_with_kwargs(self):
619 # SF bug #1486663 -- this used to erroneously raise a TypeError
620 class Subclass(random.Random):
621 def __init__(self, newarg=None):
622 random.Random.__init__(self)
623 Subclass(newarg=1)
624
625
Raymond Hettinger105b0842003-02-04 05:47:30 +0000626def test_main(verbose=None):
Raymond Hettingerb8717632004-09-04 20:13:29 +0000627 testclasses = [WichmannHill_TestBasicOps,
Raymond Hettinger40f62172002-12-29 23:03:38 +0000628 MersenneTwister_TestBasicOps,
Raymond Hettinger15ec3732003-01-05 01:08:34 +0000629 TestDistributions,
Raymond Hettingerb8717632004-09-04 20:13:29 +0000630 TestModule]
631
Raymond Hettingerc1c43ca2004-09-05 00:00:42 +0000632 try:
Raymond Hettinger23f12412004-09-13 22:23:21 +0000633 random.SystemRandom().random()
Raymond Hettingerc1c43ca2004-09-05 00:00:42 +0000634 except NotImplementedError:
635 pass
636 else:
Raymond Hettinger23f12412004-09-13 22:23:21 +0000637 testclasses.append(SystemRandom_TestBasicOps)
Raymond Hettingerb8717632004-09-04 20:13:29 +0000638
Raymond Hettinger27922ee2003-05-03 03:38:01 +0000639 test_support.run_unittest(*testclasses)
Raymond Hettinger40f62172002-12-29 23:03:38 +0000640
Raymond Hettinger105b0842003-02-04 05:47:30 +0000641 # verify reference counting
642 import sys
643 if verbose and hasattr(sys, "gettotalrefcount"):
Raymond Hettinger320a1b02003-05-02 22:44:59 +0000644 counts = [None] * 5
645 for i in xrange(len(counts)):
Raymond Hettinger27922ee2003-05-03 03:38:01 +0000646 test_support.run_unittest(*testclasses)
Raymond Hettinger320a1b02003-05-02 22:44:59 +0000647 counts[i] = sys.gettotalrefcount()
Raymond Hettinger105b0842003-02-04 05:47:30 +0000648 print counts
649
Raymond Hettinger40f62172002-12-29 23:03:38 +0000650if __name__ == "__main__":
Raymond Hettinger105b0842003-02-04 05:47:30 +0000651 test_main(verbose=True)