GSL.Random.Gen

Random number generators.

Data types

newtype RNG

Constructors

MkRNG (ForeignPtr ())

data RNGType

Initializing

newRNG :: RNGType -> IO RNG

Allocate a new random number generator of the given type and initialize it with the default seed.

setSeed :: RNG -> Word64 -> IO ()

Seed the generator with the given value.

Sampling

getSample :: RNG -> IO Word64

Returns a value uniform in [rngMin, rngMax]

getUniform :: RNG -> IO Double

Returns a value uniform on [0,1)

getUniformPos :: RNG -> IO Double

Returns a value uniform on (0,1)

getUniformInt :: RNG -> Int -> IO Int

Returns an integer uniform on [0,n-1]. n must be greater than 0.

Auxiliary functions

getName :: RNG -> IO String

Get the name of the generator.

getMax :: RNG -> IO Word64

Get the largest value that the generator can return.

getMin :: RNG -> IO Word64

Get the smallest value that the generator can return.

getSize :: RNG -> IO Word64

Get the size of the generator state, in bytes.

getState :: RNG -> IO [Word8]

Get the generator state.

setState :: RNG -> [Word8] -> IO ()

Set the generator state. The input array should have size equal to getSize of the generator; otherwise, strange things will happen.

Copying state

copyRNG :: RNG -> RNG -> IO ()

copyRNG dst src copies the state from one generator to another. The two generators must have the same type.

cloneRNG :: RNG -> IO RNG

Allocate a new random number generator that is an exact copy of another generator

Algorithms

mt19937 :: RNGType

rngType :: String -> Maybe RNGType