Copyright	Copyright (c) 2014-2015 Christopher Chalmers <c.chalmers@me.com>
License	BSD3
Maintainer	Christopher Chalmers <c.chalmers@me.com>
Stability	experimental
Portability	CPP
Safe Haskell	None
Language	Haskell2010

System.Random.PCG.Class

Contents

Classes
Type restricted versions
Utilities

Description

Classes for working with random numbers along with utility functions. In a future release this module may disappear and use another module for this functionality.

Synopsis

class Monad m => Generator g m where
class Variate a where
uniformW8 :: Generator g m => g -> m Word8
uniformW16 :: Generator g m => g -> m Word16
uniformW32 :: Generator g m => g -> m Word32
uniformW64 :: Generator g m => g -> m Word64
uniformI8 :: Generator g m => g -> m Int8
uniformI16 :: Generator g m => g -> m Int16
uniformI32 :: Generator g m => g -> m Int32
uniformI64 :: Generator g m => g -> m Int64
uniformF :: Generator g m => g -> m Float
uniformD :: Generator g m => g -> m Double
uniformBool :: Generator g m => g -> m Bool
uniformRW8 :: Generator g m => (Word8, Word8) -> g -> m Word8
uniformRW16 :: Generator g m => (Word16, Word16) -> g -> m Word16
uniformRW32 :: Generator g m => (Word32, Word32) -> g -> m Word32
uniformRW64 :: Generator g m => (Word64, Word64) -> g -> m Word64
uniformRI8 :: Generator g m => (Int8, Int8) -> g -> m Int8
uniformRI16 :: Generator g m => (Int16, Int16) -> g -> m Int16
uniformRI32 :: Generator g m => (Int32, Int32) -> g -> m Int32
uniformRI64 :: Generator g m => (Int64, Int64) -> g -> m Int64
uniformRF :: Generator g m => (Float, Float) -> g -> m Float
uniformRD :: Generator g m => (Double, Double) -> g -> m Double
uniformRBool :: Generator g m => (Bool, Bool) -> g -> m Bool
uniformBW8 :: Generator g m => Word8 -> g -> m Word8
uniformBW16 :: Generator g m => Word16 -> g -> m Word16
uniformBW32 :: Generator g m => Word32 -> g -> m Word32
uniformBW64 :: Generator g m => Word64 -> g -> m Word64
uniformBI8 :: Generator g m => Int8 -> g -> m Int8
uniformBI16 :: Generator g m => Int16 -> g -> m Int16
uniformBI32 :: Generator g m => Int32 -> g -> m Int32
uniformBI64 :: Generator g m => Int64 -> g -> m Int64
uniformBF :: Generator g m => Float -> g -> m Float
uniformBD :: Generator g m => Double -> g -> m Double
uniformBBool :: Generator g m => Bool -> g -> m Bool
type family Unsigned a :: *
wordsTo64Bit :: Integral a => Word32 -> Word32 -> a
wordToBool :: Word32 -> Bool
wordToFloat :: Word32 -> Float
wordsToDouble :: Word32 -> Word32 -> Double
sysRandom :: IO Word64

Classes

class Monad m => Generator g m where Source #

Minimal complete definition

uniform1, uniform2, uniform1B

Methods

uniform1 :: (Word32 -> a) -> g -> m a Source #

uniform2 :: (Word32 -> Word32 -> a) -> g -> m a Source #

uniform1B :: Integral a => (Word32 -> a) -> Word32 -> g -> m a Source #

Instances

Generator Gen IO Source #
Instance details Methods uniform1 :: (Word32 -> a) -> Gen -> IO a Source # uniform2 :: (Word32 -> Word32 -> a) -> Gen -> IO a Source # uniform1B :: Integral a => (Word32 -> a) -> Word32 -> Gen -> IO a Source #
(PrimMonad m, s ~ PrimState m) => Generator (Gen s) m Source #
Instance details Methods uniform1 :: (Word32 -> a) -> Gen s -> m a Source # uniform2 :: (Word32 -> Word32 -> a) -> Gen s -> m a Source # uniform1B :: Integral a => (Word32 -> a) -> Word32 -> Gen s -> m a Source #
(PrimMonad m, s ~ PrimState m) => Generator (Gen s) m Source #
Instance details Methods uniform1 :: (Word32 -> a) -> Gen s -> m a Source # uniform2 :: (Word32 -> Word32 -> a) -> Gen s -> m a Source # uniform1B :: Integral a => (Word32 -> a) -> Word32 -> Gen s -> m a Source #
(PrimMonad m, s ~ PrimState m) => Generator (Gen s) m Source #
Instance details Methods uniform1 :: (Word32 -> a) -> Gen s -> m a Source # uniform2 :: (Word32 -> Word32 -> a) -> Gen s -> m a Source # uniform1B :: Integral a => (Word32 -> a) -> Word32 -> Gen s -> m a Source #
(PrimMonad m, s ~ PrimState m) => Generator (Gen s) m Source #
Instance details Methods uniform1 :: (Word32 -> a) -> Gen s -> m a Source # uniform2 :: (Word32 -> Word32 -> a) -> Gen s -> m a Source # uniform1B :: Integral a => (Word32 -> a) -> Word32 -> Gen s -> m a Source #
(PrimMonad m, s ~ PrimState m) => Generator (Gen s) m Source #
Instance details Methods uniform1 :: (Word32 -> a) -> Gen s -> m a Source # uniform2 :: (Word32 -> Word32 -> a) -> Gen s -> m a Source # uniform1B :: Integral a => (Word32 -> a) -> Word32 -> Gen s -> m a Source #

class Variate a where Source #

Minimal complete definition

uniform, uniformR, uniformB

Methods

uniform :: Generator g m => g -> m a Source #

Generate a uniformly distributed random vairate.

Use entire range for integral types.
Use (0,1] range for floating types.

uniformR :: Generator g m => (a, a) -> g -> m a Source #

Generate a uniformly distributed random vairate in the given range.

Use inclusive range for integral types.
Use (a,b] range for floating types.

uniformB :: Generator g m => a -> g -> m a Source #

Generate a uniformly distributed random vairate in the range [0,b). For integral types the bound must be less than the max bound of Word32 (4294967295). Behaviour is undefined for negative bounds.

Instances

Variate Bool Source #
Instance details Methods uniform :: Generator g m => g -> m Bool Source # uniformR :: Generator g m => (Bool, Bool) -> g -> m Bool Source # uniformB :: Generator g m => Bool -> g -> m Bool Source #
Variate Double Source #
Instance details Methods uniform :: Generator g m => g -> m Double Source # uniformR :: Generator g m => (Double, Double) -> g -> m Double Source # uniformB :: Generator g m => Double -> g -> m Double Source #
Variate Float Source #
Instance details Methods uniform :: Generator g m => g -> m Float Source # uniformR :: Generator g m => (Float, Float) -> g -> m Float Source # uniformB :: Generator g m => Float -> g -> m Float Source #
Variate Int Source #
Instance details Methods uniform :: Generator g m => g -> m Int Source # uniformR :: Generator g m => (Int, Int) -> g -> m Int Source # uniformB :: Generator g m => Int -> g -> m Int Source #
Variate Int8 Source #
Instance details Methods uniform :: Generator g m => g -> m Int8 Source # uniformR :: Generator g m => (Int8, Int8) -> g -> m Int8 Source # uniformB :: Generator g m => Int8 -> g -> m Int8 Source #
Variate Int16 Source #
Instance details Methods uniform :: Generator g m => g -> m Int16 Source # uniformR :: Generator g m => (Int16, Int16) -> g -> m Int16 Source # uniformB :: Generator g m => Int16 -> g -> m Int16 Source #
Variate Int32 Source #
Instance details Methods uniform :: Generator g m => g -> m Int32 Source # uniformR :: Generator g m => (Int32, Int32) -> g -> m Int32 Source # uniformB :: Generator g m => Int32 -> g -> m Int32 Source #
Variate Int64 Source #
Instance details Methods uniform :: Generator g m => g -> m Int64 Source # uniformR :: Generator g m => (Int64, Int64) -> g -> m Int64 Source # uniformB :: Generator g m => Int64 -> g -> m Int64 Source #
Variate Word Source #
Instance details Methods uniform :: Generator g m => g -> m Word Source # uniformR :: Generator g m => (Word, Word) -> g -> m Word Source # uniformB :: Generator g m => Word -> g -> m Word Source #
Variate Word8 Source #
Instance details Methods uniform :: Generator g m => g -> m Word8 Source # uniformR :: Generator g m => (Word8, Word8) -> g -> m Word8 Source # uniformB :: Generator g m => Word8 -> g -> m Word8 Source #
Variate Word16 Source #
Instance details Methods uniform :: Generator g m => g -> m Word16 Source # uniformR :: Generator g m => (Word16, Word16) -> g -> m Word16 Source # uniformB :: Generator g m => Word16 -> g -> m Word16 Source #
Variate Word32 Source #
Instance details Methods uniform :: Generator g m => g -> m Word32 Source # uniformR :: Generator g m => (Word32, Word32) -> g -> m Word32 Source # uniformB :: Generator g m => Word32 -> g -> m Word32 Source #
Variate Word64 Source #
Instance details Methods uniform :: Generator g m => g -> m Word64 Source # uniformR :: Generator g m => (Word64, Word64) -> g -> m Word64 Source # uniformB :: Generator g m => Word64 -> g -> m Word64 Source #
(Variate a, Variate b) => Variate (a, b) Source #
Instance details Methods uniform :: Generator g m => g -> m (a, b) Source # uniformR :: Generator g m => ((a, b), (a, b)) -> g -> m (a, b) Source # uniformB :: Generator g m => (a, b) -> g -> m (a, b) Source #
(Variate a, Variate b, Variate c) => Variate (a, b, c) Source #
Instance details Methods uniform :: Generator g m => g -> m (a, b, c) Source # uniformR :: Generator g m => ((a, b, c), (a, b, c)) -> g -> m (a, b, c) Source # uniformB :: Generator g m => (a, b, c) -> g -> m (a, b, c) Source #
(Variate a, Variate b, Variate c, Variate d) => Variate (a, b, c, d) Source #
Instance details Methods uniform :: Generator g m => g -> m (a, b, c, d) Source # uniformR :: Generator g m => ((a, b, c, d), (a, b, c, d)) -> g -> m (a, b, c, d) Source # uniformB :: Generator g m => (a, b, c, d) -> g -> m (a, b, c, d) Source #

Type restricted versions

uniform

uniformW8 :: Generator g m => g -> m Word8 Source #

uniformW16 :: Generator g m => g -> m Word16 Source #

uniformW32 :: Generator g m => g -> m Word32 Source #

uniformW64 :: Generator g m => g -> m Word64 Source #

uniformI8 :: Generator g m => g -> m Int8 Source #

uniformI16 :: Generator g m => g -> m Int16 Source #

uniformI32 :: Generator g m => g -> m Int32 Source #

uniformI64 :: Generator g m => g -> m Int64 Source #

uniformF :: Generator g m => g -> m Float Source #

uniformD :: Generator g m => g -> m Double Source #

uniformBool :: Generator g m => g -> m Bool Source #

uniformR

uniformRW8 :: Generator g m => (Word8, Word8) -> g -> m Word8 Source #

uniformRW16 :: Generator g m => (Word16, Word16) -> g -> m Word16 Source #

uniformRW32 :: Generator g m => (Word32, Word32) -> g -> m Word32 Source #

uniformRW64 :: Generator g m => (Word64, Word64) -> g -> m Word64 Source #

uniformRI8 :: Generator g m => (Int8, Int8) -> g -> m Int8 Source #

uniformRI16 :: Generator g m => (Int16, Int16) -> g -> m Int16 Source #

uniformRI32 :: Generator g m => (Int32, Int32) -> g -> m Int32 Source #

uniformRI64 :: Generator g m => (Int64, Int64) -> g -> m Int64 Source #

uniformRF :: Generator g m => (Float, Float) -> g -> m Float Source #

uniformRD :: Generator g m => (Double, Double) -> g -> m Double Source #

uniformRBool :: Generator g m => (Bool, Bool) -> g -> m Bool Source #

uniformB

uniformBW8 :: Generator g m => Word8 -> g -> m Word8 Source #

uniformBW16 :: Generator g m => Word16 -> g -> m Word16 Source #

uniformBW32 :: Generator g m => Word32 -> g -> m Word32 Source #

uniformBW64 :: Generator g m => Word64 -> g -> m Word64 Source #

uniformBI8 :: Generator g m => Int8 -> g -> m Int8 Source #

uniformBI16 :: Generator g m => Int16 -> g -> m Int16 Source #

uniformBI32 :: Generator g m => Int32 -> g -> m Int32 Source #

uniformBI64 :: Generator g m => Int64 -> g -> m Int64 Source #

uniformBF :: Generator g m => Float -> g -> m Float Source #

uniformBD :: Generator g m => Double -> g -> m Double Source #

uniformBBool :: Generator g m => Bool -> g -> m Bool Source #

Utilities

type family Unsigned a :: * Source #

Instances

type Unsigned Int Source #
Instance details type Unsigned Int = Word
type Unsigned Int8 Source #
Instance details type Unsigned Int8 = Word8
type Unsigned Int16 Source #
Instance details type Unsigned Int16 = Word16
type Unsigned Int32 Source #
Instance details type Unsigned Int32 = Word32
type Unsigned Int64 Source #
Instance details type Unsigned Int64 = Word64
type Unsigned Word Source #
Instance details type Unsigned Word = Word
type Unsigned Word8 Source #
Instance details type Unsigned Word8 = Word8
type Unsigned Word16 Source #
Instance details type Unsigned Word16 = Word16
type Unsigned Word32 Source #
Instance details type Unsigned Word32 = Word32
type Unsigned Word64 Source #
Instance details type Unsigned Word64 = Word64

wordsTo64Bit :: Integral a => Word32 -> Word32 -> a Source #

wordToBool :: Word32 -> Bool Source #

wordToFloat :: Word32 -> Float Source #

wordsToDouble :: Word32 -> Word32 -> Double Source #

sysRandom :: IO Word64 Source #

Generate a random number using System.Entropy.

Use RDRAND if available and XOR with /dev/urandom on Unix and CryptAPI on Windows. This entropy is considered cryptographically secure but not true entropy.