random
index
/usr/lib/python2.2/random.py

Random variable generators.
 
    integers
    --------
           uniform within range
 
    sequences
    ---------
           pick random element
           generate random permutation
 
    distributions on the real line:
    ------------------------------
           uniform
           normal (Gaussian)
           lognormal
           negative exponential
           gamma
           beta
 
    distributions on the circle (angles 0 to 2pi)
    ---------------------------------------------
           circular uniform
           von Mises
 
Translated from anonymously contributed C/C++ source.
 
Multi-threading note:  the random number generator used here is not thread-
safe; it is possible that two calls return the same random value.  However,
you can instantiate a different instance of Random() in each thread to get
generators that don't share state, then use .setstate() and .jumpahead() to
move the generators to disjoint segments of the full period.  For example,
 
def create_generators(num, delta, firstseed=None):
    """Return list of num distinct generators.
    Each generator has its own unique segment of delta elements from
    Random.random()'s full period.
    Seed the first generator with optional arg firstseed (default is
    None, to seed from current time).
    """
 
    from random import Random
    g = Random(firstseed)
    result = [g]
    for i in range(num - 1):
        laststate = g.getstate()
        g = Random()
        g.setstate(laststate)
        g.jumpahead(delta)
        result.append(g)
    return result
 
gens = create_generators(10, 1000000)
 
That creates 10 distinct generators, which can be passed out to 10 distinct
threads.  The generators don't share state so can be called safely in
parallel.  So long as no thread calls its g.random() more than a million
times (the second argument to create_generators), the sequences seen by
each thread will not overlap.
 
The period of the underlying Wichmann-Hill generator is 6,953,607,871,644,
and that limits how far this technique can be pushed.
 
Just for fun, note that since we know the period, .jumpahead() can also be
used to "move backward in time":
 
>>> g = Random(42)  # arbitrary
>>> g.random()
0.25420336316883324
>>> g.jumpahead(6953607871644L - 1) # move *back* one
>>> g.random()
0.25420336316883324

 
Classes
            
Random
 
class Random
       
   Methods defined here:
_Random__whseed = __whseed(self, x=0, y=0, z=0)
Set the Wichmann-Hill seed from (x, y, z).
 
These must be integers in the range [0, 256).
__getstate__(self)
__init__(self, x=None)
Initialize an instance.
 
Optional argument x controls seeding, as for Random.seed().
__setstate__(self, state)
betavariate(self, alpha, beta)
choice(self, seq)
Choose a random element from a non-empty sequence.
cunifvariate(self, mean, arc)
expovariate(self, lambd)
gammavariate(self, alpha, beta)
gauss(self, mu, sigma)
getstate(self)
Return internal state; can be passed to setstate() later.
jumpahead(self, n)
Act as if n calls to random() were made, but quickly.
 
n is an int, greater than or equal to 0.
 
Example use:  If you have 2 threads and know that each will
consume no more than a million random numbers, create two Random
objects r1 and r2, then do
    r2.setstate(r1.getstate())
    r2.jumpahead(1000000)
Then r1 and r2 will use guaranteed-disjoint segments of the full
period.
lognormvariate(self, mu, sigma)
normalvariate(self, mu, sigma)
paretovariate(self, alpha)
randint(self, a, b)
Return random integer in range [a, b], including both end points.
 
(Deprecated; use randrange(a, b+1).)
random(self)
Get the next random number in the range [0.0, 1.0).
randrange(self, start, stop=None, step=1, int=<type 'int'>, default=None)
Choose a random item from range(start, stop[, step]).
 
This fixes the problem with randint() which includes the
endpoint; in Python this is usually not what you want.
Do not supply the 'int' and 'default' arguments.
seed(self, a=None)
Initialize internal state from hashable object.
 
None or no argument seeds from current time.
 
If a is not None or an int or long, hash(a) is used instead.
 
If a is an int or long, a is used directly.  Distinct values between
0 and 27814431486575L inclusive are guaranteed to yield distinct
internal states (this guarantee is specific to the default
Wichmann-Hill generator).
setstate(self, state)
Restore internal state from object returned by getstate().
shuffle(self, x, random=None, int=<type 'int'>)
x, random=random.random -> shuffle list x in place; return None.
 
Optional arg random is a 0-argument function returning a random
float in [0.0, 1.0); by default, the standard random.random.
 
Note that for even rather small len(x), the total number of
permutations of x is larger than the period of most random number
generators; this implies that "most" permutations of a long
sequence can never be generated.
stdgamma(self, alpha, ainv, bbb, ccc)
uniform(self, a, b)
Get a random number in the range [a, b).
vonmisesvariate(self, mu, kappa)
weibullvariate(self, alpha, beta)
whseed(self, a=None)
Seed from hashable object's hash code.
 
None or no argument seeds from current time.  It is not guaranteed
that objects with distinct hash codes lead to distinct internal
states.
 
This is obsolete, provided for compatibility with the seed routine
used prior to Python 2.1.  Use the .seed() method instead.

Data and non-method functions defined here:
VERSION = 1
__doc__ = None
__module__ = 'random'
 
Functions
            
_acos = acos(...)
acos(x)
 
Return the arc cosine (measured in radians) of x.
_cos = cos(...)
cos(x)
 
Return the cosine of x (measured in radians).
_exp = exp(...)
exp(x)
 
Return e raised to the power of x.
_log = log(...)
log(x) -> the natural logarithm (base e) of x.
_sin = sin(...)
sin(x)
 
Return the sine of x (measured in radians).
_sqrt = sqrt(...)
sqrt(x)
 
Return the square root of x.
_test(N=200)
_test_generator(n, funccall)
betavariate(self, alpha, beta) method of Random instance
choice(self, seq) method of Random instance
Choose a random element from a non-empty sequence.
cunifvariate(self, mean, arc) method of Random instance
expovariate(self, lambd) method of Random instance
gammavariate(self, alpha, beta) method of Random instance
gauss(self, mu, sigma) method of Random instance
getstate(self) method of Random instance
Return internal state; can be passed to setstate() later.
jumpahead(self, n) method of Random instance
Act as if n calls to random() were made, but quickly.
 
n is an int, greater than or equal to 0.
 
Example use:  If you have 2 threads and know that each will
consume no more than a million random numbers, create two Random
objects r1 and r2, then do
    r2.setstate(r1.getstate())
    r2.jumpahead(1000000)
Then r1 and r2 will use guaranteed-disjoint segments of the full
period.
lognormvariate(self, mu, sigma) method of Random instance
normalvariate(self, mu, sigma) method of Random instance
paretovariate(self, alpha) method of Random instance
randint(self, a, b) method of Random instance
Return random integer in range [a, b], including both end points.
 
(Deprecated; use randrange(a, b+1).)
random(self) method of Random instance
Get the next random number in the range [0.0, 1.0).
randrange(self, start, stop=None, step=1, int=<type 'int'>, default=None) method of Random instance
Choose a random item from range(start, stop[, step]).
 
This fixes the problem with randint() which includes the
endpoint; in Python this is usually not what you want.
Do not supply the 'int' and 'default' arguments.
seed(self, a=None) method of Random instance
Initialize internal state from hashable object.
 
None or no argument seeds from current time.
 
If a is not None or an int or long, hash(a) is used instead.
 
If a is an int or long, a is used directly.  Distinct values between
0 and 27814431486575L inclusive are guaranteed to yield distinct
internal states (this guarantee is specific to the default
Wichmann-Hill generator).
setstate(self, state) method of Random instance
Restore internal state from object returned by getstate().
shuffle(self, x, random=None, int=<type 'int'>) method of Random instance
x, random=random.random -> shuffle list x in place; return None.
 
Optional arg random is a 0-argument function returning a random
float in [0.0, 1.0); by default, the standard random.random.
 
Note that for even rather small len(x), the total number of
permutations of x is larger than the period of most random number
generators; this implies that "most" permutations of a long
sequence can never be generated.
stdgamma(self, alpha, ainv, bbb, ccc) method of Random instance
uniform(self, a, b) method of Random instance
Get a random number in the range [a, b).
vonmisesvariate(self, mu, kappa) method of Random instance
weibullvariate(self, alpha, beta) method of Random instance
whseed(self, a=None) method of Random instance
Seed from hashable object's hash code.
 
None or no argument seeds from current time.  It is not guaranteed
that objects with distinct hash codes lead to distinct internal
states.
 
This is obsolete, provided for compatibility with the seed routine
used prior to Python 2.1.  Use the .seed() method instead.
 
Data
             LOG4 = 1.3862943611198906
NV_MAGICCONST = 1.7155277699214135
SG_MAGICCONST = 2.5040773967762742
TWOPI = 6.2831853071795862
__all__ = ['Random', 'seed', 'random', 'uniform', 'randint', 'choice', 'randrange', 'shuffle', 'normalvariate', 'lognormvariate', 'cunifvariate', 'expovariate', 'vonmisesvariate', 'gammavariate', 'stdgamma', 'gauss', 'betavariate', 'paretovariate', 'weibullvariate', 'getstate', ...]
__file__ = '/usr/lib/python2.2/random.pyc'
__name__ = 'random'
_e = 2.7182818284590451
_inst = <random.Random instance>
_pi = 3.1415926535897931