Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 1 | """Random variable generators. |
Guido van Rossum | ff03b1a | 1994-03-09 12:55:02 +0000 | [diff] [blame] | 2 | |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 3 | integers |
| 4 | -------- |
| 5 | uniform within range |
| 6 | |
| 7 | sequences |
| 8 | --------- |
| 9 | pick random element |
Raymond Hettinger | f24eb35 | 2002-11-12 17:41:57 +0000 | [diff] [blame] | 10 | pick random sample |
Raymond Hettinger | e8f1e00 | 2016-09-06 17:15:29 -0700 | [diff] [blame] | 11 | pick weighted random sample |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 12 | generate random permutation |
| 13 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 14 | distributions on the real line: |
| 15 | ------------------------------ |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 16 | uniform |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 17 | triangular |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 18 | normal (Gaussian) |
| 19 | lognormal |
| 20 | negative exponential |
| 21 | gamma |
| 22 | beta |
Raymond Hettinger | 40f6217 | 2002-12-29 23:03:38 +0000 | [diff] [blame] | 23 | pareto |
| 24 | Weibull |
Guido van Rossum | ff03b1a | 1994-03-09 12:55:02 +0000 | [diff] [blame] | 25 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 26 | distributions on the circle (angles 0 to 2pi) |
| 27 | --------------------------------------------- |
| 28 | circular uniform |
| 29 | von Mises |
| 30 | |
Raymond Hettinger | 40f6217 | 2002-12-29 23:03:38 +0000 | [diff] [blame] | 31 | General notes on the underlying Mersenne Twister core generator: |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 32 | |
Raymond Hettinger | 40f6217 | 2002-12-29 23:03:38 +0000 | [diff] [blame] | 33 | * The period is 2**19937-1. |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 34 | * It is one of the most extensively tested generators in existence. |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 35 | * The random() method is implemented in C, executes in a single Python step, |
| 36 | and is, therefore, threadsafe. |
Tim Peters | e360d95 | 2001-01-26 10:00:39 +0000 | [diff] [blame] | 37 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 38 | """ |
Guido van Rossum | d03e119 | 1998-05-29 17:51:31 +0000 | [diff] [blame] | 39 | |
Raymond Hettinger | 2f726e9 | 2003-10-05 09:09:15 +0000 | [diff] [blame] | 40 | from warnings import warn as _warn |
Raymond Hettinger | 91e27c2 | 2005-08-19 01:36:35 +0000 | [diff] [blame] | 41 | from math import log as _log, exp as _exp, pi as _pi, e as _e, ceil as _ceil |
Miss Islington (bot) | cd69620 | 2020-06-22 21:22:40 -0700 | [diff] [blame] | 42 | from math import sqrt as _sqrt, acos as _acos, cos as _cos, sin as _sin |
| 43 | from math import tau as TWOPI, floor as _floor |
Raymond Hettinger | c1c43ca | 2004-09-05 00:00:42 +0000 | [diff] [blame] | 44 | from os import urandom as _urandom |
Christian Heimes | f1dc3ee | 2013-10-13 02:04:20 +0200 | [diff] [blame] | 45 | from _collections_abc import Set as _Set, Sequence as _Sequence |
Raymond Hettinger | 5382203 | 2019-02-16 13:30:51 -0800 | [diff] [blame] | 46 | from itertools import accumulate as _accumulate, repeat as _repeat |
Raymond Hettinger | cfd31f0 | 2019-02-13 02:04:17 -0800 | [diff] [blame] | 47 | from bisect import bisect as _bisect |
Antoine Pitrou | 346cbd3 | 2017-05-27 17:50:54 +0200 | [diff] [blame] | 48 | import os as _os |
Guido van Rossum | ff03b1a | 1994-03-09 12:55:02 +0000 | [diff] [blame] | 49 | |
Christian Heimes | d914596 | 2019-04-10 22:18:02 +0200 | [diff] [blame] | 50 | try: |
| 51 | # hashlib is pretty heavy to load, try lean internal module first |
| 52 | from _sha512 import sha512 as _sha512 |
| 53 | except ImportError: |
| 54 | # fallback to official implementation |
| 55 | from hashlib import sha512 as _sha512 |
| 56 | |
| 57 | |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 58 | __all__ = [ |
| 59 | "Random", |
| 60 | "SystemRandom", |
| 61 | "betavariate", |
| 62 | "choice", |
| 63 | "choices", |
| 64 | "expovariate", |
| 65 | "gammavariate", |
| 66 | "gauss", |
| 67 | "getrandbits", |
| 68 | "getstate", |
| 69 | "lognormvariate", |
| 70 | "normalvariate", |
| 71 | "paretovariate", |
| 72 | "randint", |
| 73 | "random", |
| 74 | "randrange", |
| 75 | "sample", |
| 76 | "seed", |
| 77 | "setstate", |
| 78 | "shuffle", |
| 79 | "triangular", |
| 80 | "uniform", |
| 81 | "vonmisesvariate", |
| 82 | "weibullvariate", |
| 83 | ] |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 84 | |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 85 | NV_MAGICCONST = 4 * _exp(-0.5) / _sqrt(2.0) |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 86 | LOG4 = _log(4.0) |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 87 | SG_MAGICCONST = 1.0 + _log(4.5) |
Raymond Hettinger | 2f726e9 | 2003-10-05 09:09:15 +0000 | [diff] [blame] | 88 | BPF = 53 # Number of bits in a float |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 89 | RECIP_BPF = 2 ** -BPF |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 90 | |
Raymond Hettinger | 356a459 | 2004-08-30 06:14:31 +0000 | [diff] [blame] | 91 | |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 92 | # Translated by Guido van Rossum from C source provided by |
Raymond Hettinger | 40f6217 | 2002-12-29 23:03:38 +0000 | [diff] [blame] | 93 | # Adrian Baddeley. Adapted by Raymond Hettinger for use with |
Raymond Hettinger | 3fa19d7 | 2004-08-31 01:05:15 +0000 | [diff] [blame] | 94 | # the Mersenne Twister and os.urandom() core generators. |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 95 | |
Raymond Hettinger | 145a4a0 | 2003-01-07 10:25:55 +0000 | [diff] [blame] | 96 | import _random |
Raymond Hettinger | 40f6217 | 2002-12-29 23:03:38 +0000 | [diff] [blame] | 97 | |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 98 | |
Raymond Hettinger | 145a4a0 | 2003-01-07 10:25:55 +0000 | [diff] [blame] | 99 | class Random(_random.Random): |
Raymond Hettinger | c32f033 | 2002-05-23 19:44:49 +0000 | [diff] [blame] | 100 | """Random number generator base class used by bound module functions. |
| 101 | |
| 102 | Used to instantiate instances of Random to get generators that don't |
Raymond Hettinger | 28de64f | 2008-01-13 23:40:30 +0000 | [diff] [blame] | 103 | share state. |
Raymond Hettinger | c32f033 | 2002-05-23 19:44:49 +0000 | [diff] [blame] | 104 | |
| 105 | Class Random can also be subclassed if you want to use a different basic |
| 106 | generator of your own devising: in that case, override the following |
Raymond Hettinger | 28de64f | 2008-01-13 23:40:30 +0000 | [diff] [blame] | 107 | methods: random(), seed(), getstate(), and setstate(). |
Benjamin Peterson | d18de0e | 2008-07-31 20:21:46 +0000 | [diff] [blame] | 108 | Optionally, implement a getrandbits() method so that randrange() |
Raymond Hettinger | 2f726e9 | 2003-10-05 09:09:15 +0000 | [diff] [blame] | 109 | can cover arbitrarily large ranges. |
Raymond Hettinger | ef4d4bd | 2002-05-23 23:58:17 +0000 | [diff] [blame] | 110 | |
Raymond Hettinger | c32f033 | 2002-05-23 19:44:49 +0000 | [diff] [blame] | 111 | """ |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 112 | |
Christian Heimes | cbf3b5c | 2007-12-03 21:02:03 +0000 | [diff] [blame] | 113 | VERSION = 3 # used by getstate/setstate |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 114 | |
| 115 | def __init__(self, x=None): |
| 116 | """Initialize an instance. |
| 117 | |
| 118 | Optional argument x controls seeding, as for Random.seed(). |
| 119 | """ |
| 120 | |
| 121 | self.seed(x) |
Raymond Hettinger | 40f6217 | 2002-12-29 23:03:38 +0000 | [diff] [blame] | 122 | self.gauss_next = None |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 123 | |
Serhiy Storchaka | 2085bd0 | 2019-06-01 11:00:15 +0300 | [diff] [blame] | 124 | def __init_subclass__(cls, /, **kwargs): |
Wolfgang Maier | ba3a87a | 2018-04-17 17:16:17 +0200 | [diff] [blame] | 125 | """Control how subclasses generate random integers. |
| 126 | |
| 127 | The algorithm a subclass can use depends on the random() and/or |
| 128 | getrandbits() implementation available to it and determines |
| 129 | whether it can generate random integers from arbitrarily large |
| 130 | ranges. |
| 131 | """ |
| 132 | |
Serhiy Storchaka | ec1622d | 2018-05-08 15:45:15 +0300 | [diff] [blame] | 133 | for c in cls.__mro__: |
| 134 | if '_randbelow' in c.__dict__: |
| 135 | # just inherit it |
| 136 | break |
| 137 | if 'getrandbits' in c.__dict__: |
| 138 | cls._randbelow = cls._randbelow_with_getrandbits |
| 139 | break |
| 140 | if 'random' in c.__dict__: |
| 141 | cls._randbelow = cls._randbelow_without_getrandbits |
| 142 | break |
Wolfgang Maier | ba3a87a | 2018-04-17 17:16:17 +0200 | [diff] [blame] | 143 | |
Raymond Hettinger | f763a72 | 2010-09-07 00:38:15 +0000 | [diff] [blame] | 144 | def seed(self, a=None, version=2): |
Raymond Hettinger | d0cdeaa | 2019-08-22 09:19:36 -0700 | [diff] [blame] | 145 | """Initialize internal state from a seed. |
| 146 | |
| 147 | The only supported seed types are None, int, float, |
| 148 | str, bytes, and bytearray. |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 149 | |
Raymond Hettinger | 23f1241 | 2004-09-13 22:23:21 +0000 | [diff] [blame] | 150 | None or no argument seeds from current time or from an operating |
| 151 | system specific randomness source if available. |
Tim Peters | 0de88fc | 2001-02-01 04:59:18 +0000 | [diff] [blame] | 152 | |
Raymond Hettinger | 183cd1f | 2010-09-08 18:48:21 +0000 | [diff] [blame] | 153 | If *a* is an int, all bits are used. |
Raymond Hettinger | f763a72 | 2010-09-07 00:38:15 +0000 | [diff] [blame] | 154 | |
Raymond Hettinger | 16eb827 | 2016-09-04 11:17:28 -0700 | [diff] [blame] | 155 | For version 2 (the default), all of the bits are used if *a* is a str, |
| 156 | bytes, or bytearray. For version 1 (provided for reproducing random |
| 157 | sequences from older versions of Python), the algorithm for str and |
| 158 | bytes generates a narrower range of seeds. |
| 159 | |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 160 | """ |
| 161 | |
Raymond Hettinger | c7bab7c | 2016-08-31 15:01:08 -0700 | [diff] [blame] | 162 | if version == 1 and isinstance(a, (str, bytes)): |
Raymond Hettinger | 132a7d7 | 2017-09-17 09:04:30 -0700 | [diff] [blame] | 163 | a = a.decode('latin-1') if isinstance(a, bytes) else a |
Raymond Hettinger | c7bab7c | 2016-08-31 15:01:08 -0700 | [diff] [blame] | 164 | x = ord(a[0]) << 7 if a else 0 |
Raymond Hettinger | 132a7d7 | 2017-09-17 09:04:30 -0700 | [diff] [blame] | 165 | for c in map(ord, a): |
| 166 | x = ((1000003 * x) ^ c) & 0xFFFFFFFFFFFFFFFF |
Raymond Hettinger | c7bab7c | 2016-08-31 15:01:08 -0700 | [diff] [blame] | 167 | x ^= len(a) |
| 168 | a = -2 if x == -1 else x |
| 169 | |
Raymond Hettinger | d0cdeaa | 2019-08-22 09:19:36 -0700 | [diff] [blame] | 170 | elif version == 2 and isinstance(a, (str, bytes, bytearray)): |
Raymond Hettinger | 2f9cc7a | 2016-08-31 23:00:32 -0700 | [diff] [blame] | 171 | if isinstance(a, str): |
| 172 | a = a.encode() |
| 173 | a += _sha512(a).digest() |
| 174 | a = int.from_bytes(a, 'big') |
Raymond Hettinger | f763a72 | 2010-09-07 00:38:15 +0000 | [diff] [blame] | 175 | |
Raymond Hettinger | d0cdeaa | 2019-08-22 09:19:36 -0700 | [diff] [blame] | 176 | elif not isinstance(a, (type(None), int, float, str, bytes, bytearray)): |
| 177 | _warn('Seeding based on hashing is deprecated\n' |
| 178 | 'since Python 3.9 and will be removed in a subsequent ' |
| 179 | 'version. The only \n' |
| 180 | 'supported seed types are: None, ' |
| 181 | 'int, float, str, bytes, and bytearray.', |
| 182 | DeprecationWarning, 2) |
| 183 | |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 184 | super().seed(a) |
Tim Peters | 46c04e1 | 2002-05-05 20:40:00 +0000 | [diff] [blame] | 185 | self.gauss_next = None |
| 186 | |
Tim Peters | cd80410 | 2001-01-25 20:25:57 +0000 | [diff] [blame] | 187 | def getstate(self): |
| 188 | """Return internal state; can be passed to setstate() later.""" |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 189 | return self.VERSION, super().getstate(), self.gauss_next |
Tim Peters | cd80410 | 2001-01-25 20:25:57 +0000 | [diff] [blame] | 190 | |
| 191 | def setstate(self, state): |
| 192 | """Restore internal state from object returned by getstate().""" |
| 193 | version = state[0] |
Christian Heimes | cbf3b5c | 2007-12-03 21:02:03 +0000 | [diff] [blame] | 194 | if version == 3: |
Raymond Hettinger | 40f6217 | 2002-12-29 23:03:38 +0000 | [diff] [blame] | 195 | version, internalstate, self.gauss_next = state |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 196 | super().setstate(internalstate) |
Christian Heimes | cbf3b5c | 2007-12-03 21:02:03 +0000 | [diff] [blame] | 197 | elif version == 2: |
| 198 | version, internalstate, self.gauss_next = state |
| 199 | # In version 2, the state was saved as signed ints, which causes |
| 200 | # inconsistencies between 32/64-bit systems. The state is |
| 201 | # really unsigned 32-bit ints, so we convert negative ints from |
| 202 | # version 2 to positive longs for version 3. |
| 203 | try: |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 204 | internalstate = tuple(x % (2 ** 32) for x in internalstate) |
Christian Heimes | cbf3b5c | 2007-12-03 21:02:03 +0000 | [diff] [blame] | 205 | except ValueError as e: |
| 206 | raise TypeError from e |
Raymond Hettinger | 183cd1f | 2010-09-08 18:48:21 +0000 | [diff] [blame] | 207 | super().setstate(internalstate) |
Tim Peters | cd80410 | 2001-01-25 20:25:57 +0000 | [diff] [blame] | 208 | else: |
| 209 | raise ValueError("state with version %s passed to " |
| 210 | "Random.setstate() of version %s" % |
| 211 | (version, self.VERSION)) |
| 212 | |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 213 | ## ---- Methods below this point do not need to be overridden when |
| 214 | ## ---- subclassing for the purpose of using a different core generator. |
Tim Peters | cd80410 | 2001-01-25 20:25:57 +0000 | [diff] [blame] | 215 | |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 216 | ## -------------------- bytes methods --------------------- |
Victor Stinner | 2d87577 | 2020-04-29 18:49:00 +0200 | [diff] [blame] | 217 | |
| 218 | def randbytes(self, n): |
| 219 | """Generate n random bytes.""" |
| 220 | return self.getrandbits(n * 8).to_bytes(n, 'little') |
| 221 | |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 222 | ## -------------------- pickle support ------------------- |
Tim Peters | cd80410 | 2001-01-25 20:25:57 +0000 | [diff] [blame] | 223 | |
R David Murray | d9ebf4d | 2013-04-02 13:10:52 -0400 | [diff] [blame] | 224 | # Issue 17489: Since __reduce__ was defined to fix #759889 this is no |
| 225 | # longer called; we leave it here because it has been here since random was |
| 226 | # rewritten back in 2001 and why risk breaking something. |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 227 | def __getstate__(self): # for pickle |
Tim Peters | cd80410 | 2001-01-25 20:25:57 +0000 | [diff] [blame] | 228 | return self.getstate() |
| 229 | |
| 230 | def __setstate__(self, state): # for pickle |
| 231 | self.setstate(state) |
| 232 | |
Raymond Hettinger | 5f078ff | 2003-06-24 20:29:04 +0000 | [diff] [blame] | 233 | def __reduce__(self): |
| 234 | return self.__class__, (), self.getstate() |
| 235 | |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 236 | ## -------------------- integer methods ------------------- |
Tim Peters | cd80410 | 2001-01-25 20:25:57 +0000 | [diff] [blame] | 237 | |
Miss Islington (bot) | cd69620 | 2020-06-22 21:22:40 -0700 | [diff] [blame] | 238 | def randrange(self, start, stop=None, step=1): |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 239 | """Choose a random item from range(start, stop[, step]). |
| 240 | |
| 241 | This fixes the problem with randint() which includes the |
| 242 | endpoint; in Python this is usually not what you want. |
Raymond Hettinger | 3051cc3 | 2010-09-07 00:48:40 +0000 | [diff] [blame] | 243 | |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 244 | """ |
| 245 | |
| 246 | # This code is a bit messy to make it fast for the |
Tim Peters | 9146f27 | 2002-08-16 03:41:39 +0000 | [diff] [blame] | 247 | # common case while still doing adequate error checking. |
Miss Islington (bot) | cd69620 | 2020-06-22 21:22:40 -0700 | [diff] [blame] | 248 | istart = int(start) |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 249 | if istart != start: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 250 | raise ValueError("non-integer arg 1 for randrange()") |
Raymond Hettinger | 3051cc3 | 2010-09-07 00:48:40 +0000 | [diff] [blame] | 251 | if stop is None: |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 252 | if istart > 0: |
Raymond Hettinger | 0515661 | 2010-09-07 04:44:52 +0000 | [diff] [blame] | 253 | return self._randbelow(istart) |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 254 | raise ValueError("empty range for randrange()") |
Tim Peters | 9146f27 | 2002-08-16 03:41:39 +0000 | [diff] [blame] | 255 | |
| 256 | # stop argument supplied. |
Miss Islington (bot) | cd69620 | 2020-06-22 21:22:40 -0700 | [diff] [blame] | 257 | istop = int(stop) |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 258 | if istop != stop: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 259 | raise ValueError("non-integer stop for randrange()") |
Raymond Hettinger | 2f726e9 | 2003-10-05 09:09:15 +0000 | [diff] [blame] | 260 | width = istop - istart |
| 261 | if step == 1 and width > 0: |
Raymond Hettinger | c324697 | 2010-09-07 09:32:57 +0000 | [diff] [blame] | 262 | return istart + self._randbelow(width) |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 263 | if step == 1: |
Kumar Akshay | 2433a2a | 2019-01-22 00:49:59 +0530 | [diff] [blame] | 264 | raise ValueError("empty range for randrange() (%d, %d, %d)" % (istart, istop, width)) |
Tim Peters | 9146f27 | 2002-08-16 03:41:39 +0000 | [diff] [blame] | 265 | |
| 266 | # Non-unit step argument supplied. |
Miss Islington (bot) | cd69620 | 2020-06-22 21:22:40 -0700 | [diff] [blame] | 267 | istep = int(step) |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 268 | if istep != step: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 269 | raise ValueError("non-integer step for randrange()") |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 270 | if istep > 0: |
Raymond Hettinger | ffdb8bb | 2004-09-27 15:29:05 +0000 | [diff] [blame] | 271 | n = (width + istep - 1) // istep |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 272 | elif istep < 0: |
Raymond Hettinger | ffdb8bb | 2004-09-27 15:29:05 +0000 | [diff] [blame] | 273 | n = (width + istep + 1) // istep |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 274 | else: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 275 | raise ValueError("zero step for randrange()") |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 276 | |
| 277 | if n <= 0: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 278 | raise ValueError("empty range for randrange()") |
Raymond Hettinger | 2f726e9 | 2003-10-05 09:09:15 +0000 | [diff] [blame] | 279 | |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 280 | return istart + istep * self._randbelow(n) |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 281 | |
| 282 | def randint(self, a, b): |
Tim Peters | cd80410 | 2001-01-25 20:25:57 +0000 | [diff] [blame] | 283 | """Return random integer in range [a, b], including both end points. |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 284 | """ |
| 285 | |
| 286 | return self.randrange(a, b+1) |
| 287 | |
Wolfgang Maier | ba3a87a | 2018-04-17 17:16:17 +0200 | [diff] [blame] | 288 | def _randbelow_with_getrandbits(self, n): |
Raymond Hettinger | 4168f1e | 2020-05-01 10:34:19 -0700 | [diff] [blame] | 289 | "Return a random int in the range [0,n). Returns 0 if n==0." |
Raymond Hettinger | 2f726e9 | 2003-10-05 09:09:15 +0000 | [diff] [blame] | 290 | |
Antoine Pitrou | 75a3378 | 2020-04-17 19:32:14 +0200 | [diff] [blame] | 291 | if not n: |
Raymond Hettinger | 4168f1e | 2020-05-01 10:34:19 -0700 | [diff] [blame] | 292 | return 0 |
Raymond Hettinger | c324697 | 2010-09-07 09:32:57 +0000 | [diff] [blame] | 293 | getrandbits = self.getrandbits |
Wolfgang Maier | ba3a87a | 2018-04-17 17:16:17 +0200 | [diff] [blame] | 294 | k = n.bit_length() # don't use (n-1) here because n can be 1 |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 295 | r = getrandbits(k) # 0 <= r < 2**k |
Wolfgang Maier | ba3a87a | 2018-04-17 17:16:17 +0200 | [diff] [blame] | 296 | while r >= n: |
| 297 | r = getrandbits(k) |
| 298 | return r |
| 299 | |
Miss Islington (bot) | cd69620 | 2020-06-22 21:22:40 -0700 | [diff] [blame] | 300 | def _randbelow_without_getrandbits(self, n, maxsize=1<<BPF): |
Raymond Hettinger | 4168f1e | 2020-05-01 10:34:19 -0700 | [diff] [blame] | 301 | """Return a random int in the range [0,n). Returns 0 if n==0. |
Wolfgang Maier | ba3a87a | 2018-04-17 17:16:17 +0200 | [diff] [blame] | 302 | |
| 303 | The implementation does not use getrandbits, but only random. |
| 304 | """ |
| 305 | |
| 306 | random = self.random |
Raymond Hettinger | e4a3e99 | 2010-09-08 00:30:28 +0000 | [diff] [blame] | 307 | if n >= maxsize: |
Raymond Hettinger | 2f726e9 | 2003-10-05 09:09:15 +0000 | [diff] [blame] | 308 | _warn("Underlying random() generator does not supply \n" |
Raymond Hettinger | f015b3f | 2010-09-07 20:04:42 +0000 | [diff] [blame] | 309 | "enough bits to choose from a population range this large.\n" |
| 310 | "To remove the range limitation, add a getrandbits() method.") |
Miss Islington (bot) | cd69620 | 2020-06-22 21:22:40 -0700 | [diff] [blame] | 311 | return _floor(random() * n) |
Wolfgang Maier | 091e95e | 2018-04-05 17:19:44 +0200 | [diff] [blame] | 312 | if n == 0: |
Raymond Hettinger | 4168f1e | 2020-05-01 10:34:19 -0700 | [diff] [blame] | 313 | return 0 |
Raymond Hettinger | e4a3e99 | 2010-09-08 00:30:28 +0000 | [diff] [blame] | 314 | rem = maxsize % n |
| 315 | limit = (maxsize - rem) / maxsize # int(limit * maxsize) % n == 0 |
| 316 | r = random() |
| 317 | while r >= limit: |
| 318 | r = random() |
Miss Islington (bot) | cd69620 | 2020-06-22 21:22:40 -0700 | [diff] [blame] | 319 | return _floor(r * maxsize) % n |
Raymond Hettinger | 2f726e9 | 2003-10-05 09:09:15 +0000 | [diff] [blame] | 320 | |
Wolfgang Maier | ba3a87a | 2018-04-17 17:16:17 +0200 | [diff] [blame] | 321 | _randbelow = _randbelow_with_getrandbits |
| 322 | |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 323 | ## -------------------- sequence methods ------------------- |
Tim Peters | cd80410 | 2001-01-25 20:25:57 +0000 | [diff] [blame] | 324 | |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 325 | def choice(self, seq): |
| 326 | """Choose a random element from a non-empty sequence.""" |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 327 | # raises IndexError if seq is empty |
| 328 | return seq[self._randbelow(len(seq))] |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 329 | |
Raymond Hettinger | 8fe47c3 | 2013-10-05 21:48:21 -0700 | [diff] [blame] | 330 | def shuffle(self, x, random=None): |
Antoine Pitrou | 5e39433 | 2012-11-04 02:10:33 +0100 | [diff] [blame] | 331 | """Shuffle list x in place, and return None. |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 332 | |
Antoine Pitrou | 5e39433 | 2012-11-04 02:10:33 +0100 | [diff] [blame] | 333 | Optional argument random is a 0-argument function returning a |
| 334 | random float in [0.0, 1.0); if it is the default None, the |
| 335 | standard random.random will be used. |
Senthil Kumaran | f8ce51a | 2013-09-11 22:54:31 -0700 | [diff] [blame] | 336 | |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 337 | """ |
| 338 | |
Raymond Hettinger | 8fe47c3 | 2013-10-05 21:48:21 -0700 | [diff] [blame] | 339 | if random is None: |
| 340 | randbelow = self._randbelow |
| 341 | for i in reversed(range(1, len(x))): |
| 342 | # pick an element in x[:i+1] with which to exchange x[i] |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 343 | j = randbelow(i + 1) |
Raymond Hettinger | 8fe47c3 | 2013-10-05 21:48:21 -0700 | [diff] [blame] | 344 | x[i], x[j] = x[j], x[i] |
| 345 | else: |
Raymond Hettinger | 190fac9 | 2020-05-02 16:45:32 -0700 | [diff] [blame] | 346 | _warn('The *random* parameter to shuffle() has been deprecated\n' |
| 347 | 'since Python 3.9 and will be removed in a subsequent ' |
| 348 | 'version.', |
| 349 | DeprecationWarning, 2) |
Miss Islington (bot) | cd69620 | 2020-06-22 21:22:40 -0700 | [diff] [blame] | 350 | floor = _floor |
Raymond Hettinger | 8fe47c3 | 2013-10-05 21:48:21 -0700 | [diff] [blame] | 351 | for i in reversed(range(1, len(x))): |
| 352 | # pick an element in x[:i+1] with which to exchange x[i] |
Miss Islington (bot) | cd69620 | 2020-06-22 21:22:40 -0700 | [diff] [blame] | 353 | j = floor(random() * (i + 1)) |
Raymond Hettinger | 8fe47c3 | 2013-10-05 21:48:21 -0700 | [diff] [blame] | 354 | x[i], x[j] = x[j], x[i] |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 355 | |
Raymond Hettinger | 81a5fc3 | 2020-05-08 07:53:15 -0700 | [diff] [blame] | 356 | def sample(self, population, k, *, counts=None): |
Raymond Hettinger | 1acde19 | 2008-01-14 01:00:53 +0000 | [diff] [blame] | 357 | """Chooses k unique random elements from a population sequence or set. |
Raymond Hettinger | f24eb35 | 2002-11-12 17:41:57 +0000 | [diff] [blame] | 358 | |
Raymond Hettinger | c0b4034 | 2002-11-13 15:26:37 +0000 | [diff] [blame] | 359 | Returns a new list containing elements from the population while |
| 360 | leaving the original population unchanged. The resulting list is |
| 361 | in selection order so that all sub-slices will also be valid random |
| 362 | samples. This allows raffle winners (the sample) to be partitioned |
| 363 | into grand prize and second place winners (the subslices). |
Raymond Hettinger | f24eb35 | 2002-11-12 17:41:57 +0000 | [diff] [blame] | 364 | |
Raymond Hettinger | c0b4034 | 2002-11-13 15:26:37 +0000 | [diff] [blame] | 365 | Members of the population need not be hashable or unique. If the |
| 366 | population contains repeats, then each occurrence is a possible |
| 367 | selection in the sample. |
Raymond Hettinger | f24eb35 | 2002-11-12 17:41:57 +0000 | [diff] [blame] | 368 | |
Raymond Hettinger | 81a5fc3 | 2020-05-08 07:53:15 -0700 | [diff] [blame] | 369 | Repeated elements can be specified one at a time or with the optional |
| 370 | counts parameter. For example: |
| 371 | |
| 372 | sample(['red', 'blue'], counts=[4, 2], k=5) |
| 373 | |
| 374 | is equivalent to: |
| 375 | |
| 376 | sample(['red', 'red', 'red', 'red', 'blue', 'blue'], k=5) |
| 377 | |
| 378 | To choose a sample from a range of integers, use range() for the |
| 379 | population argument. This is especially fast and space efficient |
| 380 | for sampling from a large population: |
| 381 | |
| 382 | sample(range(10000000), 60) |
| 383 | |
Raymond Hettinger | f24eb35 | 2002-11-12 17:41:57 +0000 | [diff] [blame] | 384 | """ |
| 385 | |
Raymond Hettinger | c0b4034 | 2002-11-13 15:26:37 +0000 | [diff] [blame] | 386 | # Sampling without replacement entails tracking either potential |
Raymond Hettinger | 91e27c2 | 2005-08-19 01:36:35 +0000 | [diff] [blame] | 387 | # selections (the pool) in a list or previous selections in a set. |
Raymond Hettinger | c0b4034 | 2002-11-13 15:26:37 +0000 | [diff] [blame] | 388 | |
Jeremy Hylton | 2b55d35 | 2004-02-23 17:27:57 +0000 | [diff] [blame] | 389 | # When the number of selections is small compared to the |
| 390 | # population, then tracking selections is efficient, requiring |
Raymond Hettinger | 91e27c2 | 2005-08-19 01:36:35 +0000 | [diff] [blame] | 391 | # only a small set and an occasional reselection. For |
Jeremy Hylton | 2b55d35 | 2004-02-23 17:27:57 +0000 | [diff] [blame] | 392 | # a larger number of selections, the pool tracking method is |
| 393 | # preferred since the list takes less space than the |
Raymond Hettinger | 91e27c2 | 2005-08-19 01:36:35 +0000 | [diff] [blame] | 394 | # set and it doesn't suffer from frequent reselections. |
Raymond Hettinger | c0b4034 | 2002-11-13 15:26:37 +0000 | [diff] [blame] | 395 | |
Raymond Hettinger | 7fc633f | 2018-12-04 00:13:38 -0800 | [diff] [blame] | 396 | # The number of calls to _randbelow() is kept at or near k, the |
| 397 | # theoretical minimum. This is important because running time |
| 398 | # is dominated by _randbelow() and because it extracts the |
| 399 | # least entropy from the underlying random number generators. |
| 400 | |
| 401 | # Memory requirements are kept to the smaller of a k-length |
| 402 | # set or an n-length list. |
| 403 | |
| 404 | # There are other sampling algorithms that do not require |
| 405 | # auxiliary memory, but they were rejected because they made |
| 406 | # too many calls to _randbelow(), making them slower and |
| 407 | # causing them to eat more entropy than necessary. |
| 408 | |
Raymond Hettinger | 57d1a88 | 2011-02-23 00:46:28 +0000 | [diff] [blame] | 409 | if isinstance(population, _Set): |
Raymond Hettinger | 4fe0020 | 2020-04-19 00:36:42 -0700 | [diff] [blame] | 410 | _warn('Sampling from a set deprecated\n' |
| 411 | 'since Python 3.9 and will be removed in a subsequent version.', |
| 412 | DeprecationWarning, 2) |
Raymond Hettinger | 1acde19 | 2008-01-14 01:00:53 +0000 | [diff] [blame] | 413 | population = tuple(population) |
Raymond Hettinger | 57d1a88 | 2011-02-23 00:46:28 +0000 | [diff] [blame] | 414 | if not isinstance(population, _Sequence): |
Raymond Hettinger | 4fe0020 | 2020-04-19 00:36:42 -0700 | [diff] [blame] | 415 | raise TypeError("Population must be a sequence. For dicts or sets, use sorted(d).") |
Raymond Hettinger | f24eb35 | 2002-11-12 17:41:57 +0000 | [diff] [blame] | 416 | n = len(population) |
Raymond Hettinger | 81a5fc3 | 2020-05-08 07:53:15 -0700 | [diff] [blame] | 417 | if counts is not None: |
| 418 | cum_counts = list(_accumulate(counts)) |
| 419 | if len(cum_counts) != n: |
| 420 | raise ValueError('The number of counts does not match the population') |
| 421 | total = cum_counts.pop() |
| 422 | if not isinstance(total, int): |
| 423 | raise TypeError('Counts must be integers') |
| 424 | if total <= 0: |
| 425 | raise ValueError('Total of counts must be greater than zero') |
| 426 | selections = sample(range(total), k=k) |
| 427 | bisect = _bisect |
| 428 | return [population[bisect(cum_counts, s)] for s in selections] |
| 429 | randbelow = self._randbelow |
Raymond Hettinger | f24eb35 | 2002-11-12 17:41:57 +0000 | [diff] [blame] | 430 | if not 0 <= k <= n: |
Raymond Hettinger | bf87126 | 2016-11-21 14:34:33 -0800 | [diff] [blame] | 431 | raise ValueError("Sample larger than population or is negative") |
Raymond Hettinger | c0b4034 | 2002-11-13 15:26:37 +0000 | [diff] [blame] | 432 | result = [None] * k |
Raymond Hettinger | 91e27c2 | 2005-08-19 01:36:35 +0000 | [diff] [blame] | 433 | setsize = 21 # size of a small set minus size of an empty list |
| 434 | if k > 5: |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 435 | setsize += 4 ** _ceil(_log(k * 3, 4)) # table size for big sets |
Raymond Hettinger | 1acde19 | 2008-01-14 01:00:53 +0000 | [diff] [blame] | 436 | if n <= setsize: |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 437 | # An n-length list is smaller than a k-length set. |
| 438 | # Invariant: non-selected at pool[0 : n-i] |
Raymond Hettinger | 311f419 | 2002-11-18 09:01:24 +0000 | [diff] [blame] | 439 | pool = list(population) |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 440 | for i in range(k): |
| 441 | j = randbelow(n - i) |
Raymond Hettinger | 311f419 | 2002-11-18 09:01:24 +0000 | [diff] [blame] | 442 | result[i] = pool[j] |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 443 | pool[j] = pool[n - i - 1] # move non-selected item into vacancy |
Raymond Hettinger | c0b4034 | 2002-11-13 15:26:37 +0000 | [diff] [blame] | 444 | else: |
Raymond Hettinger | 1acde19 | 2008-01-14 01:00:53 +0000 | [diff] [blame] | 445 | selected = set() |
| 446 | selected_add = selected.add |
| 447 | for i in range(k): |
Raymond Hettinger | 05a505f | 2010-09-07 19:19:33 +0000 | [diff] [blame] | 448 | j = randbelow(n) |
Raymond Hettinger | 1acde19 | 2008-01-14 01:00:53 +0000 | [diff] [blame] | 449 | while j in selected: |
Raymond Hettinger | 05a505f | 2010-09-07 19:19:33 +0000 | [diff] [blame] | 450 | j = randbelow(n) |
Raymond Hettinger | 1acde19 | 2008-01-14 01:00:53 +0000 | [diff] [blame] | 451 | selected_add(j) |
| 452 | result[i] = population[j] |
Raymond Hettinger | 311f419 | 2002-11-18 09:01:24 +0000 | [diff] [blame] | 453 | return result |
Raymond Hettinger | f24eb35 | 2002-11-12 17:41:57 +0000 | [diff] [blame] | 454 | |
Raymond Hettinger | 9016f28 | 2016-09-26 21:45:57 -0700 | [diff] [blame] | 455 | def choices(self, population, weights=None, *, cum_weights=None, k=1): |
Raymond Hettinger | e8f1e00 | 2016-09-06 17:15:29 -0700 | [diff] [blame] | 456 | """Return a k sized list of population elements chosen with replacement. |
| 457 | |
| 458 | If the relative weights or cumulative weights are not specified, |
| 459 | the selections are made with equal probability. |
| 460 | |
| 461 | """ |
Raymond Hettinger | 30d00e5 | 2016-10-29 16:55:36 -0700 | [diff] [blame] | 462 | random = self.random |
Raymond Hettinger | e69cd16 | 2018-07-04 15:28:20 -0700 | [diff] [blame] | 463 | n = len(population) |
Raymond Hettinger | e8f1e00 | 2016-09-06 17:15:29 -0700 | [diff] [blame] | 464 | if cum_weights is None: |
| 465 | if weights is None: |
Miss Islington (bot) | cd69620 | 2020-06-22 21:22:40 -0700 | [diff] [blame] | 466 | floor = _floor |
Raymond Hettinger | 0a18e05 | 2018-11-09 02:39:50 -0800 | [diff] [blame] | 467 | n += 0.0 # convert to float for a small speed improvement |
Miss Islington (bot) | cd69620 | 2020-06-22 21:22:40 -0700 | [diff] [blame] | 468 | return [population[floor(random() * n)] for i in _repeat(None, k)] |
Raymond Hettinger | cfd31f0 | 2019-02-13 02:04:17 -0800 | [diff] [blame] | 469 | cum_weights = list(_accumulate(weights)) |
Raymond Hettinger | e8f1e00 | 2016-09-06 17:15:29 -0700 | [diff] [blame] | 470 | elif weights is not None: |
Raymond Hettinger | 24e4239 | 2016-11-13 00:42:56 -0500 | [diff] [blame] | 471 | raise TypeError('Cannot specify both weights and cumulative weights') |
Raymond Hettinger | e69cd16 | 2018-07-04 15:28:20 -0700 | [diff] [blame] | 472 | if len(cum_weights) != n: |
Raymond Hettinger | e8f1e00 | 2016-09-06 17:15:29 -0700 | [diff] [blame] | 473 | raise ValueError('The number of weights does not match the population') |
Raymond Hettinger | 0a18e05 | 2018-11-09 02:39:50 -0800 | [diff] [blame] | 474 | total = cum_weights[-1] + 0.0 # convert to float |
Raymond Hettinger | 041d8b4 | 2019-11-23 02:22:13 -0800 | [diff] [blame] | 475 | if total <= 0.0: |
| 476 | raise ValueError('Total of weights must be greater than zero') |
| 477 | bisect = _bisect |
Raymond Hettinger | e69cd16 | 2018-07-04 15:28:20 -0700 | [diff] [blame] | 478 | hi = n - 1 |
Raymond Hettinger | ddf7171 | 2018-06-27 01:08:31 -0700 | [diff] [blame] | 479 | return [population[bisect(cum_weights, random() * total, 0, hi)] |
Raymond Hettinger | 5382203 | 2019-02-16 13:30:51 -0800 | [diff] [blame] | 480 | for i in _repeat(None, k)] |
Raymond Hettinger | e8f1e00 | 2016-09-06 17:15:29 -0700 | [diff] [blame] | 481 | |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 482 | ## -------------------- real-valued distributions ------------------- |
Tim Peters | cd80410 | 2001-01-25 20:25:57 +0000 | [diff] [blame] | 483 | |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 484 | ## -------------------- uniform distribution ------------------- |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 485 | |
| 486 | def uniform(self, a, b): |
Raymond Hettinger | be40db0 | 2009-06-11 23:12:14 +0000 | [diff] [blame] | 487 | "Get a random number in the range [a, b) or [a, b] depending on rounding." |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 488 | return a + (b - a) * self.random() |
Guido van Rossum | ff03b1a | 1994-03-09 12:55:02 +0000 | [diff] [blame] | 489 | |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 490 | ## -------------------- triangular -------------------- |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 491 | |
| 492 | def triangular(self, low=0.0, high=1.0, mode=None): |
| 493 | """Triangular distribution. |
| 494 | |
| 495 | Continuous distribution bounded by given lower and upper limits, |
| 496 | and having a given mode value in-between. |
| 497 | |
| 498 | http://en.wikipedia.org/wiki/Triangular_distribution |
| 499 | |
| 500 | """ |
| 501 | u = self.random() |
Raymond Hettinger | 978c6ab | 2014-05-25 17:25:27 -0700 | [diff] [blame] | 502 | try: |
| 503 | c = 0.5 if mode is None else (mode - low) / (high - low) |
| 504 | except ZeroDivisionError: |
| 505 | return low |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 506 | if u > c: |
| 507 | u = 1.0 - u |
| 508 | c = 1.0 - c |
| 509 | low, high = high, low |
Raymond Hettinger | f5ea83f | 2017-09-04 16:51:06 -0700 | [diff] [blame] | 510 | return low + (high - low) * _sqrt(u * c) |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 511 | |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 512 | ## -------------------- normal distribution -------------------- |
Guido van Rossum | ff03b1a | 1994-03-09 12:55:02 +0000 | [diff] [blame] | 513 | |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 514 | def normalvariate(self, mu, sigma): |
Raymond Hettinger | c32f033 | 2002-05-23 19:44:49 +0000 | [diff] [blame] | 515 | """Normal distribution. |
| 516 | |
| 517 | mu is the mean, and sigma is the standard deviation. |
Raymond Hettinger | ef4d4bd | 2002-05-23 23:58:17 +0000 | [diff] [blame] | 518 | |
Raymond Hettinger | c32f033 | 2002-05-23 19:44:49 +0000 | [diff] [blame] | 519 | """ |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 520 | # mu = mean, sigma = standard deviation |
Guido van Rossum | ff03b1a | 1994-03-09 12:55:02 +0000 | [diff] [blame] | 521 | |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 522 | # Uses Kinderman and Monahan method. Reference: Kinderman, |
| 523 | # A.J. and Monahan, J.F., "Computer generation of random |
| 524 | # variables using the ratio of uniform deviates", ACM Trans |
| 525 | # Math Software, 3, (1977), pp257-260. |
Guido van Rossum | ff03b1a | 1994-03-09 12:55:02 +0000 | [diff] [blame] | 526 | |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 527 | random = self.random |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 528 | while True: |
Tim Peters | 0c9886d | 2001-01-15 01:18:21 +0000 | [diff] [blame] | 529 | u1 = random() |
Raymond Hettinger | 73ced7e | 2003-01-04 09:26:32 +0000 | [diff] [blame] | 530 | u2 = 1.0 - random() |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 531 | z = NV_MAGICCONST * (u1 - 0.5) / u2 |
| 532 | zz = z * z / 4.0 |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 533 | if zz <= -_log(u2): |
| 534 | break |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 535 | return mu + z * sigma |
Guido van Rossum | ff03b1a | 1994-03-09 12:55:02 +0000 | [diff] [blame] | 536 | |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 537 | ## -------------------- lognormal distribution -------------------- |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 538 | |
| 539 | def lognormvariate(self, mu, sigma): |
Raymond Hettinger | c32f033 | 2002-05-23 19:44:49 +0000 | [diff] [blame] | 540 | """Log normal distribution. |
| 541 | |
| 542 | If you take the natural logarithm of this distribution, you'll get a |
| 543 | normal distribution with mean mu and standard deviation sigma. |
| 544 | mu can have any value, and sigma must be greater than zero. |
Raymond Hettinger | ef4d4bd | 2002-05-23 23:58:17 +0000 | [diff] [blame] | 545 | |
Raymond Hettinger | c32f033 | 2002-05-23 19:44:49 +0000 | [diff] [blame] | 546 | """ |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 547 | return _exp(self.normalvariate(mu, sigma)) |
| 548 | |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 549 | ## -------------------- exponential distribution -------------------- |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 550 | |
| 551 | def expovariate(self, lambd): |
Raymond Hettinger | c32f033 | 2002-05-23 19:44:49 +0000 | [diff] [blame] | 552 | """Exponential distribution. |
| 553 | |
Mark Dickinson | 2f94736 | 2009-01-07 17:54:07 +0000 | [diff] [blame] | 554 | lambd is 1.0 divided by the desired mean. It should be |
| 555 | nonzero. (The parameter would be called "lambda", but that is |
| 556 | a reserved word in Python.) Returned values range from 0 to |
| 557 | positive infinity if lambd is positive, and from negative |
| 558 | infinity to 0 if lambd is negative. |
Raymond Hettinger | ef4d4bd | 2002-05-23 23:58:17 +0000 | [diff] [blame] | 559 | |
Raymond Hettinger | c32f033 | 2002-05-23 19:44:49 +0000 | [diff] [blame] | 560 | """ |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 561 | # lambd: rate lambd = 1/mean |
| 562 | # ('lambda' is a Python reserved word) |
| 563 | |
Raymond Hettinger | 5279fb9 | 2011-06-25 11:30:53 +0200 | [diff] [blame] | 564 | # we use 1-random() instead of random() to preclude the |
| 565 | # possibility of taking the log of zero. |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 566 | return -_log(1.0 - self.random()) / lambd |
Guido van Rossum | ff03b1a | 1994-03-09 12:55:02 +0000 | [diff] [blame] | 567 | |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 568 | ## -------------------- von Mises distribution -------------------- |
Guido van Rossum | ff03b1a | 1994-03-09 12:55:02 +0000 | [diff] [blame] | 569 | |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 570 | def vonmisesvariate(self, mu, kappa): |
Raymond Hettinger | c32f033 | 2002-05-23 19:44:49 +0000 | [diff] [blame] | 571 | """Circular data distribution. |
Raymond Hettinger | ef4d4bd | 2002-05-23 23:58:17 +0000 | [diff] [blame] | 572 | |
Raymond Hettinger | c32f033 | 2002-05-23 19:44:49 +0000 | [diff] [blame] | 573 | mu is the mean angle, expressed in radians between 0 and 2*pi, and |
| 574 | kappa is the concentration parameter, which must be greater than or |
| 575 | equal to zero. If kappa is equal to zero, this distribution reduces |
| 576 | to a uniform random angle over the range 0 to 2*pi. |
Raymond Hettinger | ef4d4bd | 2002-05-23 23:58:17 +0000 | [diff] [blame] | 577 | |
Raymond Hettinger | c32f033 | 2002-05-23 19:44:49 +0000 | [diff] [blame] | 578 | """ |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 579 | # mu: mean angle (in radians between 0 and 2*pi) |
| 580 | # kappa: concentration parameter kappa (>= 0) |
| 581 | # if kappa = 0 generate uniform random angle |
| 582 | |
| 583 | # Based upon an algorithm published in: Fisher, N.I., |
| 584 | # "Statistical Analysis of Circular Data", Cambridge |
| 585 | # University Press, 1993. |
| 586 | |
| 587 | # Thanks to Magnus Kessler for a correction to the |
| 588 | # implementation of step 4. |
| 589 | |
| 590 | random = self.random |
| 591 | if kappa <= 1e-6: |
| 592 | return TWOPI * random() |
| 593 | |
Serhiy Storchaka | 6c22b1d | 2013-02-10 19:28:56 +0200 | [diff] [blame] | 594 | s = 0.5 / kappa |
| 595 | r = s + _sqrt(1.0 + s * s) |
Guido van Rossum | ff03b1a | 1994-03-09 12:55:02 +0000 | [diff] [blame] | 596 | |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 597 | while True: |
Tim Peters | 0c9886d | 2001-01-15 01:18:21 +0000 | [diff] [blame] | 598 | u1 = random() |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 599 | z = _cos(_pi * u1) |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 600 | |
Serhiy Storchaka | 6c22b1d | 2013-02-10 19:28:56 +0200 | [diff] [blame] | 601 | d = z / (r + z) |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 602 | u2 = random() |
Serhiy Storchaka | 6c22b1d | 2013-02-10 19:28:56 +0200 | [diff] [blame] | 603 | if u2 < 1.0 - d * d or u2 <= (1.0 - d) * _exp(d): |
Tim Peters | 0c9886d | 2001-01-15 01:18:21 +0000 | [diff] [blame] | 604 | break |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 605 | |
Serhiy Storchaka | 6c22b1d | 2013-02-10 19:28:56 +0200 | [diff] [blame] | 606 | q = 1.0 / r |
| 607 | f = (q + z) / (1.0 + q * z) |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 608 | u3 = random() |
| 609 | if u3 > 0.5: |
Mark Dickinson | be5f919 | 2013-02-10 14:16:10 +0000 | [diff] [blame] | 610 | theta = (mu + _acos(f)) % TWOPI |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 611 | else: |
Mark Dickinson | be5f919 | 2013-02-10 14:16:10 +0000 | [diff] [blame] | 612 | theta = (mu - _acos(f)) % TWOPI |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 613 | |
| 614 | return theta |
| 615 | |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 616 | ## -------------------- gamma distribution -------------------- |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 617 | |
| 618 | def gammavariate(self, alpha, beta): |
Raymond Hettinger | c32f033 | 2002-05-23 19:44:49 +0000 | [diff] [blame] | 619 | """Gamma distribution. Not the gamma function! |
| 620 | |
| 621 | Conditions on the parameters are alpha > 0 and beta > 0. |
| 622 | |
Raymond Hettinger | a8e4d6e | 2011-03-22 15:55:51 -0700 | [diff] [blame] | 623 | The probability distribution function is: |
| 624 | |
| 625 | x ** (alpha - 1) * math.exp(-x / beta) |
| 626 | pdf(x) = -------------------------------------- |
| 627 | math.gamma(alpha) * beta ** alpha |
| 628 | |
Raymond Hettinger | c32f033 | 2002-05-23 19:44:49 +0000 | [diff] [blame] | 629 | """ |
Tim Peters | 8ac1495 | 2002-05-23 15:15:30 +0000 | [diff] [blame] | 630 | |
Raymond Hettinger | b760efb | 2002-05-14 06:40:34 +0000 | [diff] [blame] | 631 | # alpha > 0, beta > 0, mean is alpha*beta, variance is alpha*beta**2 |
Tim Peters | 8ac1495 | 2002-05-23 15:15:30 +0000 | [diff] [blame] | 632 | |
Guido van Rossum | 570764d | 2002-05-14 14:08:12 +0000 | [diff] [blame] | 633 | # Warning: a few older sources define the gamma distribution in terms |
| 634 | # of alpha > -1.0 |
| 635 | if alpha <= 0.0 or beta <= 0.0: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 636 | raise ValueError('gammavariate: alpha and beta must be > 0.0') |
Tim Peters | 8ac1495 | 2002-05-23 15:15:30 +0000 | [diff] [blame] | 637 | |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 638 | random = self.random |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 639 | if alpha > 1.0: |
| 640 | |
| 641 | # Uses R.C.H. Cheng, "The generation of Gamma |
| 642 | # variables with non-integral shape parameters", |
| 643 | # Applied Statistics, (1977), 26, No. 1, p71-74 |
| 644 | |
Raymond Hettinger | ca6cdc2 | 2002-05-13 23:40:14 +0000 | [diff] [blame] | 645 | ainv = _sqrt(2.0 * alpha - 1.0) |
| 646 | bbb = alpha - LOG4 |
| 647 | ccc = alpha + ainv |
Tim Peters | 8ac1495 | 2002-05-23 15:15:30 +0000 | [diff] [blame] | 648 | |
Raymond Hettinger | 42406e6 | 2005-04-30 09:02:51 +0000 | [diff] [blame] | 649 | while 1: |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 650 | u1 = random() |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 651 | if not 1e-7 < u1 < 0.9999999: |
Raymond Hettinger | 73ced7e | 2003-01-04 09:26:32 +0000 | [diff] [blame] | 652 | continue |
| 653 | u2 = 1.0 - random() |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 654 | v = _log(u1 / (1.0 - u1)) / ainv |
| 655 | x = alpha * _exp(v) |
| 656 | z = u1 * u1 * u2 |
| 657 | r = bbb + ccc * v - x |
| 658 | if r + SG_MAGICCONST - 4.5 * z >= 0.0 or r >= _log(z): |
Raymond Hettinger | b760efb | 2002-05-14 06:40:34 +0000 | [diff] [blame] | 659 | return x * beta |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 660 | |
| 661 | elif alpha == 1.0: |
leodema | 9f396b6 | 2017-06-04 07:41:41 +0100 | [diff] [blame] | 662 | # expovariate(1/beta) |
leodema | 63d1522 | 2018-12-24 07:54:25 +0100 | [diff] [blame] | 663 | return -_log(1.0 - random()) * beta |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 664 | |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 665 | else: |
| 666 | # alpha is between 0 and 1 (exclusive) |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 667 | # Uses ALGORITHM GS of Statistical Computing - Kennedy & Gentle |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 668 | while True: |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 669 | u = random() |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 670 | b = (_e + alpha) / _e |
| 671 | p = b * u |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 672 | if p <= 1.0: |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 673 | x = p ** (1.0 / alpha) |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 674 | else: |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 675 | x = -_log((b - p) / alpha) |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 676 | u1 = random() |
Raymond Hettinger | 42406e6 | 2005-04-30 09:02:51 +0000 | [diff] [blame] | 677 | if p > 1.0: |
| 678 | if u1 <= x ** (alpha - 1.0): |
| 679 | break |
| 680 | elif u1 <= _exp(-x): |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 681 | break |
Raymond Hettinger | b760efb | 2002-05-14 06:40:34 +0000 | [diff] [blame] | 682 | return x * beta |
| 683 | |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 684 | ## -------------------- Gauss (faster alternative) -------------------- |
Guido van Rossum | 95bfcda | 1994-03-09 14:21:05 +0000 | [diff] [blame] | 685 | |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 686 | def gauss(self, mu, sigma): |
Raymond Hettinger | c32f033 | 2002-05-23 19:44:49 +0000 | [diff] [blame] | 687 | """Gaussian distribution. |
| 688 | |
| 689 | mu is the mean, and sigma is the standard deviation. This is |
| 690 | slightly faster than the normalvariate() function. |
| 691 | |
| 692 | Not thread-safe without a lock around calls. |
Raymond Hettinger | ef4d4bd | 2002-05-23 23:58:17 +0000 | [diff] [blame] | 693 | |
Raymond Hettinger | c32f033 | 2002-05-23 19:44:49 +0000 | [diff] [blame] | 694 | """ |
Guido van Rossum | cc32ac9 | 1994-03-15 16:10:24 +0000 | [diff] [blame] | 695 | |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 696 | # When x and y are two variables from [0, 1), uniformly |
| 697 | # distributed, then |
| 698 | # |
| 699 | # cos(2*pi*x)*sqrt(-2*log(1-y)) |
| 700 | # sin(2*pi*x)*sqrt(-2*log(1-y)) |
| 701 | # |
| 702 | # are two *independent* variables with normal distribution |
| 703 | # (mu = 0, sigma = 1). |
| 704 | # (Lambert Meertens) |
| 705 | # (corrected version; bug discovered by Mike Miller, fixed by LM) |
Guido van Rossum | cc32ac9 | 1994-03-15 16:10:24 +0000 | [diff] [blame] | 706 | |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 707 | # Multithreading note: When two threads call this function |
| 708 | # simultaneously, it is possible that they will receive the |
| 709 | # same return value. The window is very small though. To |
| 710 | # avoid this, you have to use a lock around all calls. (I |
| 711 | # didn't want to slow this down in the serial case by using a |
| 712 | # lock here.) |
Guido van Rossum | d03e119 | 1998-05-29 17:51:31 +0000 | [diff] [blame] | 713 | |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 714 | random = self.random |
| 715 | z = self.gauss_next |
| 716 | self.gauss_next = None |
| 717 | if z is None: |
| 718 | x2pi = random() * TWOPI |
| 719 | g2rad = _sqrt(-2.0 * _log(1.0 - random())) |
| 720 | z = _cos(x2pi) * g2rad |
| 721 | self.gauss_next = _sin(x2pi) * g2rad |
Guido van Rossum | cc32ac9 | 1994-03-15 16:10:24 +0000 | [diff] [blame] | 722 | |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 723 | return mu + z * sigma |
Guido van Rossum | 95bfcda | 1994-03-09 14:21:05 +0000 | [diff] [blame] | 724 | |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 725 | ## -------------------- beta -------------------- |
| 726 | ## See |
| 727 | ## http://mail.python.org/pipermail/python-bugs-list/2001-January/003752.html |
| 728 | ## for Ivan Frohne's insightful analysis of why the original implementation: |
| 729 | ## |
| 730 | ## def betavariate(self, alpha, beta): |
| 731 | ## # Discrete Event Simulation in C, pp 87-88. |
| 732 | ## |
| 733 | ## y = self.expovariate(alpha) |
| 734 | ## z = self.expovariate(1.0/beta) |
| 735 | ## return z/(y+z) |
| 736 | ## |
| 737 | ## was dead wrong, and how it probably got that way. |
Guido van Rossum | 95bfcda | 1994-03-09 14:21:05 +0000 | [diff] [blame] | 738 | |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 739 | def betavariate(self, alpha, beta): |
Raymond Hettinger | c32f033 | 2002-05-23 19:44:49 +0000 | [diff] [blame] | 740 | """Beta distribution. |
| 741 | |
Thomas Wouters | b213704 | 2007-02-01 18:02:27 +0000 | [diff] [blame] | 742 | Conditions on the parameters are alpha > 0 and beta > 0. |
Raymond Hettinger | c32f033 | 2002-05-23 19:44:49 +0000 | [diff] [blame] | 743 | Returned values range between 0 and 1. |
Raymond Hettinger | ef4d4bd | 2002-05-23 23:58:17 +0000 | [diff] [blame] | 744 | |
Raymond Hettinger | c32f033 | 2002-05-23 19:44:49 +0000 | [diff] [blame] | 745 | """ |
Raymond Hettinger | ef4d4bd | 2002-05-23 23:58:17 +0000 | [diff] [blame] | 746 | |
Tim Peters | 85e2e47 | 2001-01-26 06:49:56 +0000 | [diff] [blame] | 747 | # This version due to Janne Sinkkonen, and matches all the std |
| 748 | # texts (e.g., Knuth Vol 2 Ed 3 pg 134 "the beta distribution"). |
Raymond Hettinger | 650c1c9 | 2016-06-25 05:36:42 +0300 | [diff] [blame] | 749 | y = self.gammavariate(alpha, 1.0) |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 750 | if y: |
Raymond Hettinger | 650c1c9 | 2016-06-25 05:36:42 +0300 | [diff] [blame] | 751 | return y / (y + self.gammavariate(beta, 1.0)) |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 752 | return 0.0 |
Guido van Rossum | 95bfcda | 1994-03-09 14:21:05 +0000 | [diff] [blame] | 753 | |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 754 | ## -------------------- Pareto -------------------- |
Guido van Rossum | cf4559a | 1997-12-02 02:47:39 +0000 | [diff] [blame] | 755 | |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 756 | def paretovariate(self, alpha): |
Raymond Hettinger | c32f033 | 2002-05-23 19:44:49 +0000 | [diff] [blame] | 757 | """Pareto distribution. alpha is the shape parameter.""" |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 758 | # Jain, pg. 495 |
Guido van Rossum | cf4559a | 1997-12-02 02:47:39 +0000 | [diff] [blame] | 759 | |
Raymond Hettinger | 73ced7e | 2003-01-04 09:26:32 +0000 | [diff] [blame] | 760 | u = 1.0 - self.random() |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 761 | return 1.0 / u ** (1.0 / alpha) |
Guido van Rossum | cf4559a | 1997-12-02 02:47:39 +0000 | [diff] [blame] | 762 | |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 763 | ## -------------------- Weibull -------------------- |
Guido van Rossum | cf4559a | 1997-12-02 02:47:39 +0000 | [diff] [blame] | 764 | |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 765 | def weibullvariate(self, alpha, beta): |
Raymond Hettinger | c32f033 | 2002-05-23 19:44:49 +0000 | [diff] [blame] | 766 | """Weibull distribution. |
| 767 | |
| 768 | alpha is the scale parameter and beta is the shape parameter. |
Raymond Hettinger | ef4d4bd | 2002-05-23 23:58:17 +0000 | [diff] [blame] | 769 | |
Raymond Hettinger | c32f033 | 2002-05-23 19:44:49 +0000 | [diff] [blame] | 770 | """ |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 771 | # Jain, pg. 499; bug fix courtesy Bill Arms |
Guido van Rossum | cf4559a | 1997-12-02 02:47:39 +0000 | [diff] [blame] | 772 | |
Raymond Hettinger | 73ced7e | 2003-01-04 09:26:32 +0000 | [diff] [blame] | 773 | u = 1.0 - self.random() |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 774 | return alpha * (-_log(u)) ** (1.0 / beta) |
| 775 | |
Guido van Rossum | 6c395ba | 1999-08-18 13:53:28 +0000 | [diff] [blame] | 776 | |
Raymond Hettinger | 23f1241 | 2004-09-13 22:23:21 +0000 | [diff] [blame] | 777 | ## --------------- Operating System Random Source ------------------ |
Raymond Hettinger | 356a459 | 2004-08-30 06:14:31 +0000 | [diff] [blame] | 778 | |
Raymond Hettinger | 23f1241 | 2004-09-13 22:23:21 +0000 | [diff] [blame] | 779 | class SystemRandom(Random): |
| 780 | """Alternate random number generator using sources provided |
| 781 | by the operating system (such as /dev/urandom on Unix or |
| 782 | CryptGenRandom on Windows). |
Raymond Hettinger | 356a459 | 2004-08-30 06:14:31 +0000 | [diff] [blame] | 783 | |
| 784 | Not available on all systems (see os.urandom() for details). |
| 785 | """ |
| 786 | |
| 787 | def random(self): |
| 788 | """Get the next random number in the range [0.0, 1.0).""" |
Raymond Hettinger | 183cd1f | 2010-09-08 18:48:21 +0000 | [diff] [blame] | 789 | return (int.from_bytes(_urandom(7), 'big') >> 3) * RECIP_BPF |
Raymond Hettinger | 356a459 | 2004-08-30 06:14:31 +0000 | [diff] [blame] | 790 | |
| 791 | def getrandbits(self, k): |
Serhiy Storchaka | 9594942 | 2013-08-27 19:40:23 +0300 | [diff] [blame] | 792 | """getrandbits(k) -> x. Generates an int with k random bits.""" |
Antoine Pitrou | 75a3378 | 2020-04-17 19:32:14 +0200 | [diff] [blame] | 793 | if k < 0: |
| 794 | raise ValueError('number of bits must be non-negative') |
Raymond Hettinger | 63b1767 | 2010-09-08 19:27:59 +0000 | [diff] [blame] | 795 | numbytes = (k + 7) // 8 # bits / 8 and rounded up |
| 796 | x = int.from_bytes(_urandom(numbytes), 'big') |
| 797 | return x >> (numbytes * 8 - k) # trim excess bits |
Raymond Hettinger | 356a459 | 2004-08-30 06:14:31 +0000 | [diff] [blame] | 798 | |
Victor Stinner | 9f5fe79 | 2020-04-17 19:05:35 +0200 | [diff] [blame] | 799 | def randbytes(self, n): |
| 800 | """Generate n random bytes.""" |
| 801 | # os.urandom(n) fails with ValueError for n < 0 |
| 802 | # and returns an empty bytes string for n == 0. |
| 803 | return _urandom(n) |
| 804 | |
Raymond Hettinger | 28de64f | 2008-01-13 23:40:30 +0000 | [diff] [blame] | 805 | def seed(self, *args, **kwds): |
Raymond Hettinger | 23f1241 | 2004-09-13 22:23:21 +0000 | [diff] [blame] | 806 | "Stub method. Not used for a system random number generator." |
Raymond Hettinger | 356a459 | 2004-08-30 06:14:31 +0000 | [diff] [blame] | 807 | return None |
Raymond Hettinger | 356a459 | 2004-08-30 06:14:31 +0000 | [diff] [blame] | 808 | |
| 809 | def _notimplemented(self, *args, **kwds): |
Raymond Hettinger | 23f1241 | 2004-09-13 22:23:21 +0000 | [diff] [blame] | 810 | "Method should not be called for a system random number generator." |
| 811 | raise NotImplementedError('System entropy source does not have state.') |
Raymond Hettinger | 356a459 | 2004-08-30 06:14:31 +0000 | [diff] [blame] | 812 | getstate = setstate = _notimplemented |
| 813 | |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 814 | |
Tim Peters | cd80410 | 2001-01-25 20:25:57 +0000 | [diff] [blame] | 815 | ## -------------------- test program -------------------- |
Guido van Rossum | ff03b1a | 1994-03-09 12:55:02 +0000 | [diff] [blame] | 816 | |
Raymond Hettinger | 6229713 | 2003-08-30 01:24:19 +0000 | [diff] [blame] | 817 | def _test_generator(n, func, args): |
Miss Islington (bot) | cd69620 | 2020-06-22 21:22:40 -0700 | [diff] [blame] | 818 | from statistics import stdev, fmean as mean |
| 819 | from time import perf_counter |
| 820 | |
| 821 | t0 = perf_counter() |
| 822 | data = [func(*args) for i in range(n)] |
| 823 | t1 = perf_counter() |
| 824 | |
| 825 | xbar = mean(data) |
| 826 | sigma = stdev(data, xbar) |
| 827 | low = min(data) |
| 828 | high = max(data) |
| 829 | |
| 830 | print(f'{t1 - t0:.3f} sec, {n} times {func.__name__}') |
| 831 | print('avg %g, stddev %g, min %g, max %g\n' % (xbar, sigma, low, high)) |
Guido van Rossum | ff03b1a | 1994-03-09 12:55:02 +0000 | [diff] [blame] | 832 | |
Raymond Hettinger | f24eb35 | 2002-11-12 17:41:57 +0000 | [diff] [blame] | 833 | |
| 834 | def _test(N=2000): |
Raymond Hettinger | 6229713 | 2003-08-30 01:24:19 +0000 | [diff] [blame] | 835 | _test_generator(N, random, ()) |
| 836 | _test_generator(N, normalvariate, (0.0, 1.0)) |
| 837 | _test_generator(N, lognormvariate, (0.0, 1.0)) |
| 838 | _test_generator(N, vonmisesvariate, (0.0, 1.0)) |
| 839 | _test_generator(N, gammavariate, (0.01, 1.0)) |
| 840 | _test_generator(N, gammavariate, (0.1, 1.0)) |
| 841 | _test_generator(N, gammavariate, (0.1, 2.0)) |
| 842 | _test_generator(N, gammavariate, (0.5, 1.0)) |
| 843 | _test_generator(N, gammavariate, (0.9, 1.0)) |
| 844 | _test_generator(N, gammavariate, (1.0, 1.0)) |
| 845 | _test_generator(N, gammavariate, (2.0, 1.0)) |
| 846 | _test_generator(N, gammavariate, (20.0, 1.0)) |
| 847 | _test_generator(N, gammavariate, (200.0, 1.0)) |
| 848 | _test_generator(N, gauss, (0.0, 1.0)) |
| 849 | _test_generator(N, betavariate, (3.0, 3.0)) |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 850 | _test_generator(N, triangular, (0.0, 1.0, 1.0 / 3.0)) |
Tim Peters | cd80410 | 2001-01-25 20:25:57 +0000 | [diff] [blame] | 851 | |
Tim Peters | 715c4c4 | 2001-01-26 22:56:56 +0000 | [diff] [blame] | 852 | # Create one instance, seeded from current time, and export its methods |
Raymond Hettinger | 40f6217 | 2002-12-29 23:03:38 +0000 | [diff] [blame] | 853 | # as module-level functions. The functions share state across all uses |
Miss Islington (bot) | f1534d0 | 2020-06-13 10:23:48 -0700 | [diff] [blame] | 854 | # (both in the user's code and in the Python libraries), but that's fine |
Raymond Hettinger | 40f6217 | 2002-12-29 23:03:38 +0000 | [diff] [blame] | 855 | # for most programs and is easier for the casual user than making them |
| 856 | # instantiate their own Random() instance. |
| 857 | |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 858 | _inst = Random() |
| 859 | seed = _inst.seed |
| 860 | random = _inst.random |
| 861 | uniform = _inst.uniform |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 862 | triangular = _inst.triangular |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 863 | randint = _inst.randint |
| 864 | choice = _inst.choice |
| 865 | randrange = _inst.randrange |
Raymond Hettinger | f24eb35 | 2002-11-12 17:41:57 +0000 | [diff] [blame] | 866 | sample = _inst.sample |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 867 | shuffle = _inst.shuffle |
Raymond Hettinger | 28aa4a0 | 2016-09-07 00:08:44 -0700 | [diff] [blame] | 868 | choices = _inst.choices |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 869 | normalvariate = _inst.normalvariate |
| 870 | lognormvariate = _inst.lognormvariate |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 871 | expovariate = _inst.expovariate |
| 872 | vonmisesvariate = _inst.vonmisesvariate |
| 873 | gammavariate = _inst.gammavariate |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 874 | gauss = _inst.gauss |
| 875 | betavariate = _inst.betavariate |
| 876 | paretovariate = _inst.paretovariate |
| 877 | weibullvariate = _inst.weibullvariate |
| 878 | getstate = _inst.getstate |
| 879 | setstate = _inst.setstate |
Raymond Hettinger | 2f726e9 | 2003-10-05 09:09:15 +0000 | [diff] [blame] | 880 | getrandbits = _inst.getrandbits |
Victor Stinner | 9f5fe79 | 2020-04-17 19:05:35 +0200 | [diff] [blame] | 881 | randbytes = _inst.randbytes |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 882 | |
Antoine Pitrou | 346cbd3 | 2017-05-27 17:50:54 +0200 | [diff] [blame] | 883 | if hasattr(_os, "fork"): |
Gregory P. Smith | 163468a | 2017-05-29 10:03:41 -0700 | [diff] [blame] | 884 | _os.register_at_fork(after_in_child=_inst.seed) |
Antoine Pitrou | 346cbd3 | 2017-05-27 17:50:54 +0200 | [diff] [blame] | 885 | |
| 886 | |
Guido van Rossum | ff03b1a | 1994-03-09 12:55:02 +0000 | [diff] [blame] | 887 | if __name__ == '__main__': |
Tim Peters | d7b5e88 | 2001-01-25 03:36:26 +0000 | [diff] [blame] | 888 | _test() |