random-1.1: random number library

Copyright(c) The University of Glasgow 2001
LicenseBSD-style (see the file LICENSE in the 'random' repository)
Maintainerlibraries@haskell.org
Stabilitystable
Portabilityportable
Safe HaskellTrustworthy
LanguageHaskell98

System.Random

Contents

Description

This library deals with the common task of pseudo-random number generation. The library makes it possible to generate repeatable results, by starting with a specified initial random number generator, or to get different results on each run by using the system-initialised generator or by supplying a seed from some other source.

The library is split into two layers:

  • A core random number generator provides a supply of bits. The class RandomGen provides a common interface to such generators. The library provides one instance of RandomGen, the abstract data type StdGen. Programmers may, of course, supply their own instances of RandomGen.
  • The class Random provides a way to extract values of a particular type from a random number generator. For example, the Float instance of Random allows one to generate random values of type Float.

This implementation uses the Portable Combined Generator of L'Ecuyer [System.Random] for 32-bit computers, transliterated by Lennart Augustsson. It has a period of roughly 2.30584e18.

Synopsis

Random number generators

class RandomGen g where Source #

The class RandomGen provides a common interface to random number generators.

Minimal complete definition

next, split

Methods

next :: g -> (Int, g) Source #

The next operation returns an Int that is uniformly distributed in the range returned by genRange (including both end points), and a new generator.

genRange :: g -> (Int, Int) Source #

The genRange operation yields the range of values returned by the generator.

It is required that:

The second condition ensures that genRange cannot examine its argument, and hence the value it returns can be determined only by the instance of RandomGen. That in turn allows an implementation to make a single call to genRange to establish a generator's range, without being concerned that the generator returned by (say) next might have a different range to the generator passed to next.

The default definition spans the full range of Int.

split :: g -> (g, g) Source #

The split operation allows one to obtain two distinct random number generators. This is very useful in functional programs (for example, when passing a random number generator down to recursive calls), but very little work has been done on statistically robust implementations of split ([System.Random, System.Random] are the only examples we know of).

Instances
RandomGen StdGen Source # 
Instance details

Defined in System.Random

Standard random number generators

data StdGen Source #

The StdGen instance of RandomGen has a genRange of at least 30 bits.

The result of repeatedly using next should be at least as statistically robust as the Minimal Standard Random Number Generator described by [System.Random, System.Random]. Until more is known about implementations of split, all we require is that split deliver generators that are (a) not identical and (b) independently robust in the sense just given.

The Show and Read instances of StdGen provide a primitive way to save the state of a random number generator. It is required that read (show g) == g.

In addition, reads may be used to map an arbitrary string (not necessarily one produced by show) onto a value of type StdGen. In general, the Read instance of StdGen has the following properties:

  • It guarantees to succeed on any string.
  • It guarantees to consume only a finite portion of the string.
  • Different argument strings are likely to result in different results.
Instances
Read StdGen Source # 
Instance details

Defined in System.Random

Show StdGen Source # 
Instance details

Defined in System.Random

RandomGen StdGen Source # 
Instance details

Defined in System.Random

mkStdGen :: Int -> StdGen Source #

The function mkStdGen provides an alternative way of producing an initial generator, by mapping an Int into a generator. Again, distinct arguments should be likely to produce distinct generators.

The global random number generator

There is a single, implicit, global random number generator of type StdGen, held in some global variable maintained by the IO monad. It is initialised automatically in some system-dependent fashion, for example, by using the time of day, or Linux's kernel random number generator. To get deterministic behaviour, use setStdGen.

getStdRandom :: (StdGen -> (a, StdGen)) -> IO a Source #

Uses the supplied function to get a value from the current global random generator, and updates the global generator with the new generator returned by the function. For example, rollDice gets a random integer between 1 and 6:

 rollDice :: IO Int
 rollDice = getStdRandom (randomR (1,6))

getStdGen :: IO StdGen Source #

Gets the global random number generator.

setStdGen :: StdGen -> IO () Source #

Sets the global random number generator.

newStdGen :: IO StdGen Source #

Applies split to the current global random generator, updates it with one of the results, and returns the other.

Random values of various types

class Random a where Source #

With a source of random number supply in hand, the Random class allows the programmer to extract random values of a variety of types.

Minimal complete definition: randomR and random.

Minimal complete definition

randomR, random

Methods

randomR :: RandomGen g => (a, a) -> g -> (a, g) Source #

Takes a range (lo,hi) and a random number generator g, and returns a random value uniformly distributed in the closed interval [lo,hi], together with a new generator. It is unspecified what happens if lo>hi. For continuous types there is no requirement that the values lo and hi are ever produced, but they may be, depending on the implementation and the interval.

random :: RandomGen g => g -> (a, g) Source #

The same as randomR, but using a default range determined by the type:

  • For bounded types (instances of Bounded, such as Char), the range is normally the whole type.
  • For fractional types, the range is normally the semi-closed interval [0,1).
  • For Integer, the range is (arbitrarily) the range of Int.

randomRs :: RandomGen g => (a, a) -> g -> [a] Source #

Plural variant of randomR, producing an infinite list of random values instead of returning a new generator.

randoms :: RandomGen g => g -> [a] Source #

Plural variant of random, producing an infinite list of random values instead of returning a new generator.

randomRIO :: (a, a) -> IO a Source #

A variant of randomR that uses the global random number generator (see System.Random).

randomIO :: IO a Source #

A variant of random that uses the global random number generator (see System.Random).

Instances
Random Bool Source # 
Instance details

Defined in System.Random

Methods

randomR :: RandomGen g => (Bool, Bool) -> g -> (Bool, g) Source #

random :: RandomGen g => g -> (Bool, g) Source #

randomRs :: RandomGen g => (Bool, Bool) -> g -> [Bool] Source #

randoms :: RandomGen g => g -> [Bool] Source #

randomRIO :: (Bool, Bool) -> IO Bool Source #

randomIO :: IO Bool Source #

Random Char Source # 
Instance details

Defined in System.Random

Methods

randomR :: RandomGen g => (Char, Char) -> g -> (Char, g) Source #

random :: RandomGen g => g -> (Char, g) Source #

randomRs :: RandomGen g => (Char, Char) -> g -> [Char] Source #

randoms :: RandomGen g => g -> [Char] Source #

randomRIO :: (Char, Char) -> IO Char Source #

randomIO :: IO Char Source #

Random Double Source # 
Instance details

Defined in System.Random

Random Float Source # 
Instance details

Defined in System.Random

Methods

randomR :: RandomGen g => (Float, Float) -> g -> (Float, g) Source #

random :: RandomGen g => g -> (Float, g) Source #

randomRs :: RandomGen g => (Float, Float) -> g -> [Float] Source #

randoms :: RandomGen g => g -> [Float] Source #

randomRIO :: (Float, Float) -> IO Float Source #

randomIO :: IO Float Source #

Random Int Source # 
Instance details

Defined in System.Random

Methods

randomR :: RandomGen g => (Int, Int) -> g -> (Int, g) Source #

random :: RandomGen g => g -> (Int, g) Source #

randomRs :: RandomGen g => (Int, Int) -> g -> [Int] Source #

randoms :: RandomGen g => g -> [Int] Source #

randomRIO :: (Int, Int) -> IO Int Source #

randomIO :: IO Int Source #

Random Int8 Source # 
Instance details

Defined in System.Random

Methods

randomR :: RandomGen g => (Int8, Int8) -> g -> (Int8, g) Source #

random :: RandomGen g => g -> (Int8, g) Source #

randomRs :: RandomGen g => (Int8, Int8) -> g -> [Int8] Source #

randoms :: RandomGen g => g -> [Int8] Source #

randomRIO :: (Int8, Int8) -> IO Int8 Source #

randomIO :: IO Int8 Source #

Random Int16 Source # 
Instance details

Defined in System.Random

Methods

randomR :: RandomGen g => (Int16, Int16) -> g -> (Int16, g) Source #

random :: RandomGen g => g -> (Int16, g) Source #

randomRs :: RandomGen g => (Int16, Int16) -> g -> [Int16] Source #

randoms :: RandomGen g => g -> [Int16] Source #

randomRIO :: (Int16, Int16) -> IO Int16 Source #

randomIO :: IO Int16 Source #

Random Int32 Source # 
Instance details

Defined in System.Random

Methods

randomR :: RandomGen g => (Int32, Int32) -> g -> (Int32, g) Source #

random :: RandomGen g => g -> (Int32, g) Source #

randomRs :: RandomGen g => (Int32, Int32) -> g -> [Int32] Source #

randoms :: RandomGen g => g -> [Int32] Source #

randomRIO :: (Int32, Int32) -> IO Int32 Source #

randomIO :: IO Int32 Source #

Random Int64 Source # 
Instance details

Defined in System.Random

Methods

randomR :: RandomGen g => (Int64, Int64) -> g -> (Int64, g) Source #

random :: RandomGen g => g -> (Int64, g) Source #

randomRs :: RandomGen g => (Int64, Int64) -> g -> [Int64] Source #

randoms :: RandomGen g => g -> [Int64] Source #

randomRIO :: (Int64, Int64) -> IO Int64 Source #

randomIO :: IO Int64 Source #

Random Integer Source # 
Instance details

Defined in System.Random

Random Word Source # 
Instance details

Defined in System.Random

Methods

randomR :: RandomGen g => (Word, Word) -> g -> (Word, g) Source #

random :: RandomGen g => g -> (Word, g) Source #

randomRs :: RandomGen g => (Word, Word) -> g -> [Word] Source #

randoms :: RandomGen g => g -> [Word] Source #

randomRIO :: (Word, Word) -> IO Word Source #

randomIO :: IO Word Source #

Random Word8 Source # 
Instance details

Defined in System.Random

Methods

randomR :: RandomGen g => (Word8, Word8) -> g -> (Word8, g) Source #

random :: RandomGen g => g -> (Word8, g) Source #

randomRs :: RandomGen g => (Word8, Word8) -> g -> [Word8] Source #

randoms :: RandomGen g => g -> [Word8] Source #

randomRIO :: (Word8, Word8) -> IO Word8 Source #

randomIO :: IO Word8 Source #

Random Word16 Source # 
Instance details

Defined in System.Random

Random Word32 Source # 
Instance details

Defined in System.Random

Random Word64 Source # 
Instance details

Defined in System.Random

Random CChar Source # 
Instance details

Defined in System.Random

Methods

randomR :: RandomGen g => (CChar, CChar) -> g -> (CChar, g) Source #

random :: RandomGen g => g -> (CChar, g) Source #

randomRs :: RandomGen g => (CChar, CChar) -> g -> [CChar] Source #

randoms :: RandomGen g => g -> [CChar] Source #

randomRIO :: (CChar, CChar) -> IO CChar Source #

randomIO :: IO CChar Source #

Random CSChar Source # 
Instance details

Defined in System.Random

Random CUChar Source # 
Instance details

Defined in System.Random

Random CShort Source # 
Instance details

Defined in System.Random

Random CUShort Source # 
Instance details

Defined in System.Random

Random CInt Source # 
Instance details

Defined in System.Random

Methods

randomR :: RandomGen g => (CInt, CInt) -> g -> (CInt, g) Source #

random :: RandomGen g => g -> (CInt, g) Source #

randomRs :: RandomGen g => (CInt, CInt) -> g -> [CInt] Source #

randoms :: RandomGen g => g -> [CInt] Source #

randomRIO :: (CInt, CInt) -> IO CInt Source #

randomIO :: IO CInt Source #

Random CUInt Source # 
Instance details

Defined in System.Random

Methods

randomR :: RandomGen g => (CUInt, CUInt) -> g -> (CUInt, g) Source #

random :: RandomGen g => g -> (CUInt, g) Source #

randomRs :: RandomGen g => (CUInt, CUInt) -> g -> [CUInt] Source #

randoms :: RandomGen g => g -> [CUInt] Source #

randomRIO :: (CUInt, CUInt) -> IO CUInt Source #

randomIO :: IO CUInt Source #

Random CLong Source # 
Instance details

Defined in System.Random

Methods

randomR :: RandomGen g => (CLong, CLong) -> g -> (CLong, g) Source #

random :: RandomGen g => g -> (CLong, g) Source #

randomRs :: RandomGen g => (CLong, CLong) -> g -> [CLong] Source #

randoms :: RandomGen g => g -> [CLong] Source #

randomRIO :: (CLong, CLong) -> IO CLong Source #

randomIO :: IO CLong Source #

Random CULong Source # 
Instance details

Defined in System.Random

Random CLLong Source # 
Instance details

Defined in System.Random

Random CULLong Source # 
Instance details

Defined in System.Random

Random CFloat Source # 
Instance details

Defined in System.Random

Random CDouble Source # 
Instance details

Defined in System.Random

Random CPtrdiff Source # 
Instance details

Defined in System.Random

Random CSize Source # 
Instance details

Defined in System.Random

Methods

randomR :: RandomGen g => (CSize, CSize) -> g -> (CSize, g) Source #

random :: RandomGen g => g -> (CSize, g) Source #

randomRs :: RandomGen g => (CSize, CSize) -> g -> [CSize] Source #

randoms :: RandomGen g => g -> [CSize] Source #

randomRIO :: (CSize, CSize) -> IO CSize Source #

randomIO :: IO CSize Source #

Random CWchar Source # 
Instance details

Defined in System.Random

Random CSigAtomic Source # 
Instance details

Defined in System.Random

Random CIntPtr Source # 
Instance details

Defined in System.Random

Random CUIntPtr Source # 
Instance details

Defined in System.Random

Random CIntMax Source # 
Instance details

Defined in System.Random

Random CUIntMax Source # 
Instance details

Defined in System.Random

References

  1. FW Burton and RL Page, Distributed random number generation, Journal of Functional Programming, 2(2):203-212, April 1992.
  2. SK Park, and KW Miller, /Random number generators - good ones are hard to find/, Comm ACM 31(10), Oct 1988, pp1192-1201.
  3. DG Carta, /Two fast implementations of the minimal standard random number generator/, Comm ACM, 33(1), Jan 1990, pp87-88.
  4. P Hellekalek, Don't trust parallel Monte Carlo, Department of Mathematics, University of Salzburg, http://random.mat.sbg.ac.at/~peter/pads98.ps, 1998.
  5. Pierre L'Ecuyer, /Efficient and portable combined random number generators/, Comm ACM, 31(6), Jun 1988, pp742-749.

The Web site http://random.mat.sbg.ac.at/ is a great source of information.