Copyright | (c) Brent Yorgey 2016 |
---|---|
License | BSD3 (see LICENSE) |
Maintainer | byorgey@gmail.com |
Stability | experimental |
Portability | non-portable (multi-param classes, functional dependencies, undecidable instances) |
Safe Haskell | Safe |
Language | Haskell2010 |
Control.Monad.Random.Strict
Description
Random monads that are strict in the generator state. For a lazy version, see Control.Monad.Random.Lazy, which has the same interface.
Synopsis
- type Rand g = RandT g Identity
- liftRand :: (g -> (a, g)) -> Rand g a
- runRand :: Rand g a -> g -> (a, g)
- evalRand :: Rand g a -> g -> a
- execRand :: Rand g a -> g -> g
- mapRand :: ((a, g) -> (b, g)) -> Rand g a -> Rand g b
- withRand :: (g -> g) -> Rand g a -> Rand g a
- evalRandIO :: Rand StdGen a -> IO a
- data RandT g m a
- liftRandT :: (g -> m (a, g)) -> RandT g m a
- runRandT :: RandT g m a -> g -> m (a, g)
- evalRandT :: Monad m => RandT g m a -> g -> m a
- execRandT :: Monad m => RandT g m a -> g -> m g
- mapRandT :: (m (a, g) -> n (b, g)) -> RandT g m a -> RandT g n b
- withRandT :: (g -> g) -> RandT g m a -> RandT g m a
- evalRandTIO :: MonadIO m => RandT StdGen m a -> m a
- class Uniform a
- class Finite a
- class UniformRange a
- data StdGen
- class RandomGen g where
- next :: g -> (Int, g)
- genWord8 :: g -> (Word8, g)
- genWord16 :: g -> (Word16, g)
- genWord32 :: g -> (Word32, g)
- genWord64 :: g -> (Word64, g)
- genWord32R :: Word32 -> g -> (Word32, g)
- genWord64R :: Word64 -> g -> (Word64, g)
- genShortByteString :: Int -> g -> (ShortByteString, g)
- genRange :: g -> (Int, Int)
- split :: g -> (g, g)
- class Random a where
- mkStdGen :: Int -> StdGen
- genByteString :: RandomGen g => Int -> g -> (ByteString, g)
- initStdGen :: MonadIO m => m StdGen
- setStdGen :: MonadIO m => StdGen -> m ()
- getStdGen :: MonadIO m => m StdGen
- newStdGen :: MonadIO m => m StdGen
- getStdRandom :: MonadIO m => (StdGen -> (a, StdGen)) -> m a
- randomRIO :: (Random a, MonadIO m) => (a, a) -> m a
- randomIO :: (Random a, MonadIO m) => m a
- module Control.Monad.Random.Class
The Rand monad transformer
type Rand g = RandT g Identity #
A random monad parameterized by the type g
of the generator to carry.
The return
function leaves the generator unchanged, while >>=
uses the
final generator of the first computation as the initial generator of the
second.
Arguments
:: (g -> (a, g)) | pure random transformer |
-> Rand g a | equivalent generator-passing computation |
Construct a random monad computation from a function.
(The inverse of runRand
.)
Arguments
:: Rand g a | generator-passing computation to execute |
-> g | initial generator |
-> (a, g) | return value and final generator |
Unwrap a random monad computation as a function.
(The inverse of liftRand
.)
Arguments
:: Rand g a | generator-passing computation to execute |
-> g | initial generator |
-> a | return value of the random computation |
Arguments
:: Rand g a | generator-passing computation to execute |
-> g | initial generator |
-> g | final generator |
evalRandIO :: Rand StdGen a -> IO a #
Evaluate a random computation in the IO
monad, splitting the global
standard generator to get a new one for the computation.
The RandT monad transformer
A random transformer monad parameterized by:
g
- The generator.m
- The inner monad.
The return
function leaves the generator unchanged, while >>=
uses the
final generator of the first computation as the initial generator of the
second.
Instances
(MonadReader r m, MonadWriter w m, MonadState s m) => MonadRWS r w s (RandT g m) # | |
Defined in Control.Monad.Trans.Random.Strict | |
(RandomGen g, Monad m) => MonadSplit g (RandT g m) # | |
Defined in Control.Monad.Trans.Random.Strict | |
MonadError e m => MonadError e (RandT g m) # | |
Defined in Control.Monad.Trans.Random.Strict | |
MonadReader r m => MonadReader r (RandT g m) # | |
MonadState s m => MonadState s (RandT g m) # | |
MonadWriter w m => MonadWriter w (RandT g m) # | |
MonadTrans (RandT g) # | |
Defined in Control.Monad.Trans.Random.Strict | |
(Monad m, RandomGen g) => RandomGenM (RandGen g) g (RandT g m) # | Since: 0.5.3 |
Defined in Control.Monad.Trans.Random.Strict Methods applyRandomGenM :: (g -> (a, g)) -> RandGen g -> RandT g m a # | |
(Monad m, RandomGen g) => StatefulGen (RandGen g) (RandT g m) # | Since: 0.5.3 |
Defined in Control.Monad.Trans.Random.Strict Methods uniformWord32R :: Word32 -> RandGen g -> RandT g m Word32 # uniformWord64R :: Word64 -> RandGen g -> RandT g m Word64 # uniformWord8 :: RandGen g -> RandT g m Word8 # uniformWord16 :: RandGen g -> RandT g m Word16 # uniformWord32 :: RandGen g -> RandT g m Word32 # uniformWord64 :: RandGen g -> RandT g m Word64 # uniformShortByteString :: Int -> RandGen g -> RandT g m ShortByteString # | |
(Monad m, RandomGen g) => MonadInterleave (RandT g m) # | |
Defined in Control.Monad.Trans.Random.Strict Methods interleave :: RandT g m a -> RandT g m a # | |
(RandomGen g, Monad m) => MonadRandom (RandT g m) # | |
Defined in Control.Monad.Trans.Random.Strict | |
MonadFail m => MonadFail (RandT g m) # | |
Defined in Control.Monad.Trans.Random.Strict | |
MonadFix m => MonadFix (RandT g m) # | |
Defined in Control.Monad.Trans.Random.Strict | |
MonadIO m => MonadIO (RandT g m) # | |
Defined in Control.Monad.Trans.Random.Strict | |
MonadPlus m => Alternative (RandT g m) # | |
Monad m => Applicative (RandT g m) # | |
Functor m => Functor (RandT g m) # | |
Monad m => Monad (RandT g m) # | |
MonadPlus m => MonadPlus (RandT g m) # | |
MonadCont m => MonadCont (RandT g m) # | |
Defined in Control.Monad.Trans.Random.Strict | |
PrimMonad m => PrimMonad (RandT s m) # | |
type PrimState (RandT s m) # | |
Defined in Control.Monad.Trans.Random.Strict |
Arguments
:: (g -> m (a, g)) | impure random transformer |
-> RandT g m a | equivalent generator-passing computation |
Construct a random monad computation from an impure function.
(The inverse of runRandT
.)
Arguments
:: RandT g m a | generator-passing computation to execute |
-> g | initial generator |
-> m (a, g) | return value and final generator |
Unwrap a random monad computation as an impure function.
(The inverse of liftRandT
.)
evalRandTIO :: MonadIO m => RandT StdGen m a -> m a #
Evaluate a random computation that is embedded in the IO
monad,
splitting the global standard generator to get a new one for the
computation.
Some convenience re-exports
The class of types for which a uniformly distributed value can be drawn from all possible values of the type.
Since: random-1.2.0
Instances
Uniform CBool | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g m => g -> m CBool # | |
Uniform CChar | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g m => g -> m CChar # | |
Uniform CInt | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g m => g -> m CInt # | |
Uniform CIntMax | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g m => g -> m CIntMax # | |
Uniform CIntPtr | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g m => g -> m CIntPtr # | |
Uniform CLLong | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g m => g -> m CLLong # | |
Uniform CLong | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g m => g -> m CLong # | |
Uniform CPtrdiff | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g m => g -> m CPtrdiff # | |
Uniform CSChar | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g m => g -> m CSChar # | |
Uniform CShort | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g m => g -> m CShort # | |
Uniform CSigAtomic | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g m => g -> m CSigAtomic # | |
Uniform CSize | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g m => g -> m CSize # | |
Uniform CUChar | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g m => g -> m CUChar # | |
Uniform CUInt | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g m => g -> m CUInt # | |
Uniform CUIntMax | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g m => g -> m CUIntMax # | |
Uniform CUIntPtr | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g m => g -> m CUIntPtr # | |
Uniform CULLong | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g m => g -> m CULLong # | |
Uniform CULong | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g m => g -> m CULong # | |
Uniform CUShort | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g m => g -> m CUShort # | |
Uniform CWchar | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g m => g -> m CWchar # | |
Uniform Int16 | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g m => g -> m Int16 # | |
Uniform Int32 | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g m => g -> m Int32 # | |
Uniform Int64 | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g m => g -> m Int64 # | |
Uniform Int8 | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g m => g -> m Int8 # | |
Uniform Word16 | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g m => g -> m Word16 # | |
Uniform Word32 | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g m => g -> m Word32 # | |
Uniform Word64 | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g m => g -> m Word64 # | |
Uniform Word8 | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g m => g -> m Word8 # | |
Uniform () | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g m => g -> m () # | |
Uniform Bool | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g m => g -> m Bool # | |
Uniform Char | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g m => g -> m Char # | |
Uniform Int | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g m => g -> m Int # | |
Uniform Word | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g m => g -> m Word # | |
(Uniform a, Uniform b) => Uniform (a, b) | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g m => g -> m (a, b) # | |
(Uniform a, Uniform b, Uniform c) => Uniform (a, b, c) | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g m => g -> m (a, b, c) # | |
(Uniform a, Uniform b, Uniform c, Uniform d) => Uniform (a, b, c, d) | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g m => g -> m (a, b, c, d) # | |
(Uniform a, Uniform b, Uniform c, Uniform d, Uniform e) => Uniform (a, b, c, d, e) | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g m => g -> m (a, b, c, d, e) # | |
(Uniform a, Uniform b, Uniform c, Uniform d, Uniform e, Uniform f) => Uniform (a, b, c, d, e, f) | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g m => g -> m (a, b, c, d, e, f) # | |
(Uniform a, Uniform b, Uniform c, Uniform d, Uniform e, Uniform f, Uniform g) => Uniform (a, b, c, d, e, f, g) | |
Defined in System.Random.Internal Methods uniformM :: StatefulGen g0 m => g0 -> m (a, b, c, d, e, f, g) # |
A type class for data with a finite number of inhabitants.
This type class is used
in default implementations of Uniform
.
Users are not supposed to write instances of Finite
manually.
There is a default implementation in terms of Generic
instead.
>>>
:set -XDeriveGeneric -XDeriveAnyClass
>>>
import GHC.Generics (Generic)
>>>
data MyBool = MyTrue | MyFalse deriving (Generic, Finite)
>>>
data Action = Code MyBool | Eat (Maybe Bool) | Sleep deriving (Generic, Finite)
Instances
Finite Void | |
Defined in System.Random.GFinite Methods cardinality :: Proxy# Void -> Cardinality toFinite :: Integer -> Void fromFinite :: Void -> Integer | |
Finite Int16 | |
Defined in System.Random.GFinite Methods cardinality :: Proxy# Int16 -> Cardinality toFinite :: Integer -> Int16 fromFinite :: Int16 -> Integer | |
Finite Int32 | |
Defined in System.Random.GFinite Methods cardinality :: Proxy# Int32 -> Cardinality toFinite :: Integer -> Int32 fromFinite :: Int32 -> Integer | |
Finite Int64 | |
Defined in System.Random.GFinite Methods cardinality :: Proxy# Int64 -> Cardinality toFinite :: Integer -> Int64 fromFinite :: Int64 -> Integer | |
Finite Int8 | |
Defined in System.Random.GFinite Methods cardinality :: Proxy# Int8 -> Cardinality toFinite :: Integer -> Int8 fromFinite :: Int8 -> Integer | |
Finite Word16 | |
Defined in System.Random.GFinite Methods cardinality :: Proxy# Word16 -> Cardinality toFinite :: Integer -> Word16 fromFinite :: Word16 -> Integer | |
Finite Word32 | |
Defined in System.Random.GFinite Methods cardinality :: Proxy# Word32 -> Cardinality toFinite :: Integer -> Word32 fromFinite :: Word32 -> Integer | |
Finite Word64 | |
Defined in System.Random.GFinite Methods cardinality :: Proxy# Word64 -> Cardinality toFinite :: Integer -> Word64 fromFinite :: Word64 -> Integer | |
Finite Word8 | |
Defined in System.Random.GFinite Methods cardinality :: Proxy# Word8 -> Cardinality toFinite :: Integer -> Word8 fromFinite :: Word8 -> Integer | |
Finite Ordering | |
Defined in System.Random.GFinite Methods cardinality :: Proxy# Ordering -> Cardinality toFinite :: Integer -> Ordering fromFinite :: Ordering -> Integer | |
Finite () | |
Defined in System.Random.GFinite | |
Finite Bool | |
Defined in System.Random.GFinite Methods cardinality :: Proxy# Bool -> Cardinality toFinite :: Integer -> Bool fromFinite :: Bool -> Integer | |
Finite Char | |
Defined in System.Random.GFinite Methods cardinality :: Proxy# Char -> Cardinality toFinite :: Integer -> Char fromFinite :: Char -> Integer | |
Finite Int | |
Defined in System.Random.GFinite Methods cardinality :: Proxy# Int -> Cardinality toFinite :: Integer -> Int fromFinite :: Int -> Integer | |
Finite Word | |
Defined in System.Random.GFinite Methods cardinality :: Proxy# Word -> Cardinality toFinite :: Integer -> Word fromFinite :: Word -> Integer | |
Finite a => Finite (Maybe a) | |
Defined in System.Random.GFinite Methods cardinality :: Proxy# (Maybe a) -> Cardinality toFinite :: Integer -> Maybe a fromFinite :: Maybe a -> Integer | |
(Finite a, Finite b) => Finite (Either a b) | |
Defined in System.Random.GFinite Methods cardinality :: Proxy# (Either a b) -> Cardinality toFinite :: Integer -> Either a b fromFinite :: Either a b -> Integer | |
(Finite a, Finite b) => Finite (a, b) | |
Defined in System.Random.GFinite Methods cardinality :: Proxy# (a, b) -> Cardinality toFinite :: Integer -> (a, b) fromFinite :: (a, b) -> Integer | |
(Finite a, Finite b, Finite c) => Finite (a, b, c) | |
Defined in System.Random.GFinite Methods cardinality :: Proxy# (a, b, c) -> Cardinality toFinite :: Integer -> (a, b, c) fromFinite :: (a, b, c) -> Integer | |
(Finite a, Finite b, Finite c, Finite d) => Finite (a, b, c, d) | |
Defined in System.Random.GFinite Methods cardinality :: Proxy# (a, b, c, d) -> Cardinality toFinite :: Integer -> (a, b, c, d) fromFinite :: (a, b, c, d) -> Integer | |
(Finite a, Finite b, Finite c, Finite d, Finite e) => Finite (a, b, c, d, e) | |
Defined in System.Random.GFinite Methods cardinality :: Proxy# (a, b, c, d, e) -> Cardinality toFinite :: Integer -> (a, b, c, d, e) fromFinite :: (a, b, c, d, e) -> Integer | |
(Finite a, Finite b, Finite c, Finite d, Finite e, Finite f) => Finite (a, b, c, d, e, f) | |
Defined in System.Random.GFinite Methods cardinality :: Proxy# (a, b, c, d, e, f) -> Cardinality toFinite :: Integer -> (a, b, c, d, e, f) fromFinite :: (a, b, c, d, e, f) -> Integer |
class UniformRange a #
The class of types for which a uniformly distributed value can be drawn from a range.
Since: random-1.2.0
Minimal complete definition
Instances
UniformRange CBool | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => (CBool, CBool) -> g -> m CBool # | |
UniformRange CChar | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => (CChar, CChar) -> g -> m CChar # | |
UniformRange CDouble | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => (CDouble, CDouble) -> g -> m CDouble # | |
UniformRange CFloat | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => (CFloat, CFloat) -> g -> m CFloat # | |
UniformRange CInt | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => (CInt, CInt) -> g -> m CInt # | |
UniformRange CIntMax | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => (CIntMax, CIntMax) -> g -> m CIntMax # | |
UniformRange CIntPtr | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => (CIntPtr, CIntPtr) -> g -> m CIntPtr # | |
UniformRange CLLong | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => (CLLong, CLLong) -> g -> m CLLong # | |
UniformRange CLong | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => (CLong, CLong) -> g -> m CLong # | |
UniformRange CPtrdiff | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => (CPtrdiff, CPtrdiff) -> g -> m CPtrdiff # | |
UniformRange CSChar | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => (CSChar, CSChar) -> g -> m CSChar # | |
UniformRange CShort | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => (CShort, CShort) -> g -> m CShort # | |
UniformRange CSigAtomic | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => (CSigAtomic, CSigAtomic) -> g -> m CSigAtomic # | |
UniformRange CSize | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => (CSize, CSize) -> g -> m CSize # | |
UniformRange CUChar | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => (CUChar, CUChar) -> g -> m CUChar # | |
UniformRange CUInt | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => (CUInt, CUInt) -> g -> m CUInt # | |
UniformRange CUIntMax | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => (CUIntMax, CUIntMax) -> g -> m CUIntMax # | |
UniformRange CUIntPtr | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => (CUIntPtr, CUIntPtr) -> g -> m CUIntPtr # | |
UniformRange CULLong | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => (CULLong, CULLong) -> g -> m CULLong # | |
UniformRange CULong | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => (CULong, CULong) -> g -> m CULong # | |
UniformRange CUShort | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => (CUShort, CUShort) -> g -> m CUShort # | |
UniformRange CWchar | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => (CWchar, CWchar) -> g -> m CWchar # | |
UniformRange Int16 | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => (Int16, Int16) -> g -> m Int16 # | |
UniformRange Int32 | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => (Int32, Int32) -> g -> m Int32 # | |
UniformRange Int64 | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => (Int64, Int64) -> g -> m Int64 # | |
UniformRange Int8 | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => (Int8, Int8) -> g -> m Int8 # | |
UniformRange Word16 | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => (Word16, Word16) -> g -> m Word16 # | |
UniformRange Word32 | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => (Word32, Word32) -> g -> m Word32 # | |
UniformRange Word64 | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => (Word64, Word64) -> g -> m Word64 # | |
UniformRange Word8 | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => (Word8, Word8) -> g -> m Word8 # | |
UniformRange Integer | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => (Integer, Integer) -> g -> m Integer # | |
UniformRange Natural | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => (Natural, Natural) -> g -> m Natural # | |
UniformRange () | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => ((), ()) -> g -> m () # | |
UniformRange Bool | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => (Bool, Bool) -> g -> m Bool # | |
UniformRange Char | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => (Char, Char) -> g -> m Char # | |
UniformRange Double | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => (Double, Double) -> g -> m Double # | |
UniformRange Float | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => (Float, Float) -> g -> m Float # | |
UniformRange Int | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => (Int, Int) -> g -> m Int # | |
UniformRange Word | |
Defined in System.Random.Internal Methods uniformRM :: StatefulGen g m => (Word, Word) -> g -> m Word # |
The standard pseudo-random number generator.
Instances
Show StdGen | |
NFData StdGen | |
Defined in System.Random.Internal | |
Eq StdGen | |
RandomGen StdGen | |
Defined in System.Random.Internal Methods next :: StdGen -> (Int, StdGen) # genWord8 :: StdGen -> (Word8, StdGen) # genWord16 :: StdGen -> (Word16, StdGen) # genWord32 :: StdGen -> (Word32, StdGen) # genWord64 :: StdGen -> (Word64, StdGen) # genWord32R :: Word32 -> StdGen -> (Word32, StdGen) # genWord64R :: Word64 -> StdGen -> (Word64, StdGen) # genShortByteString :: Int -> StdGen -> (ShortByteString, StdGen) # | |
MonadSplit StdGen IO # | |
Defined in Control.Monad.Random.Class |
RandomGen
is an interface to pure pseudo-random number generators.
StdGen
is the standard RandomGen
instance provided by this library.
Since: random-1.0.0
Methods
Returns an Int
that is uniformly distributed over the range returned by
genRange
(including both end points), and a new generator. Using next
is inefficient as all operations go via Integer
. See
here for
more details. It is thus deprecated.
Since: random-1.0.0
Returns a Word8
that is uniformly distributed over the entire Word8
range.
Since: random-1.2.0
genWord16 :: g -> (Word16, g) #
Returns a Word16
that is uniformly distributed over the entire Word16
range.
Since: random-1.2.0
genWord32 :: g -> (Word32, g) #
Returns a Word32
that is uniformly distributed over the entire Word32
range.
Since: random-1.2.0
genWord64 :: g -> (Word64, g) #
Returns a Word64
that is uniformly distributed over the entire Word64
range.
Since: random-1.2.0
genWord32R :: Word32 -> g -> (Word32, g) #
genWord32R upperBound g
returns a Word32
that is uniformly
distributed over the range [0, upperBound]
.
Since: random-1.2.0
genWord64R :: Word64 -> g -> (Word64, g) #
genWord64R upperBound g
returns a Word64
that is uniformly
distributed over the range [0, upperBound]
.
Since: random-1.2.0
genShortByteString :: Int -> g -> (ShortByteString, g) #
genShortByteString n g
returns a ShortByteString
of length n
filled with pseudo-random bytes.
Since: random-1.2.0
Yields the range of values returned by next
.
It is required that:
- If
(a, b) =
, thengenRange
ga < b
. genRange
must not examine its argument so the value it returns is determined only by the instance ofRandomGen
.
The default definition spans the full range of Int
.
Since: random-1.0.0
Returns two distinct pseudo-random number generators.
Implementations should take care to ensure that the resulting generators
are not correlated. Some pseudo-random number generators are not
splittable. In that case, the split
implementation should fail with a
descriptive error
message.
Since: random-1.0.0
Instances
RandomGen StdGen | |
Defined in System.Random.Internal Methods next :: StdGen -> (Int, StdGen) # genWord8 :: StdGen -> (Word8, StdGen) # genWord16 :: StdGen -> (Word16, StdGen) # genWord32 :: StdGen -> (Word32, StdGen) # genWord64 :: StdGen -> (Word64, StdGen) # genWord32R :: Word32 -> StdGen -> (Word32, StdGen) # genWord64R :: Word64 -> StdGen -> (Word64, StdGen) # genShortByteString :: Int -> StdGen -> (ShortByteString, StdGen) # | |
RandomGen SMGen | |
Defined in System.Random.Internal Methods next :: SMGen -> (Int, SMGen) # genWord8 :: SMGen -> (Word8, SMGen) # genWord16 :: SMGen -> (Word16, SMGen) # genWord32 :: SMGen -> (Word32, SMGen) # genWord64 :: SMGen -> (Word64, SMGen) # genWord32R :: Word32 -> SMGen -> (Word32, SMGen) # genWord64R :: Word64 -> SMGen -> (Word64, SMGen) # genShortByteString :: Int -> SMGen -> (ShortByteString, SMGen) # | |
RandomGen SMGen | |
Defined in System.Random.Internal Methods next :: SMGen -> (Int, SMGen) # genWord8 :: SMGen -> (Word8, SMGen) # genWord16 :: SMGen -> (Word16, SMGen) # genWord32 :: SMGen -> (Word32, SMGen) # genWord64 :: SMGen -> (Word64, SMGen) # genWord32R :: Word32 -> SMGen -> (Word32, SMGen) # genWord64R :: Word64 -> SMGen -> (Word64, SMGen) # genShortByteString :: Int -> SMGen -> (ShortByteString, SMGen) # | |
RandomGen g => RandomGen (StateGen g) | |
Defined in System.Random.Internal Methods next :: StateGen g -> (Int, StateGen g) # genWord8 :: StateGen g -> (Word8, StateGen g) # genWord16 :: StateGen g -> (Word16, StateGen g) # genWord32 :: StateGen g -> (Word32, StateGen g) # genWord64 :: StateGen g -> (Word64, StateGen g) # genWord32R :: Word32 -> StateGen g -> (Word32, StateGen g) # genWord64R :: Word64 -> StateGen g -> (Word64, StateGen g) # genShortByteString :: Int -> StateGen g -> (ShortByteString, StateGen g) # | |
RandomGen g => RandomGen (AtomicGen g) | |
Defined in System.Random.Stateful Methods next :: AtomicGen g -> (Int, AtomicGen g) # genWord8 :: AtomicGen g -> (Word8, AtomicGen g) # genWord16 :: AtomicGen g -> (Word16, AtomicGen g) # genWord32 :: AtomicGen g -> (Word32, AtomicGen g) # genWord64 :: AtomicGen g -> (Word64, AtomicGen g) # genWord32R :: Word32 -> AtomicGen g -> (Word32, AtomicGen g) # genWord64R :: Word64 -> AtomicGen g -> (Word64, AtomicGen g) # genShortByteString :: Int -> AtomicGen g -> (ShortByteString, AtomicGen g) # | |
RandomGen g => RandomGen (IOGen g) | |
Defined in System.Random.Stateful Methods next :: IOGen g -> (Int, IOGen g) # genWord8 :: IOGen g -> (Word8, IOGen g) # genWord16 :: IOGen g -> (Word16, IOGen g) # genWord32 :: IOGen g -> (Word32, IOGen g) # genWord64 :: IOGen g -> (Word64, IOGen g) # genWord32R :: Word32 -> IOGen g -> (Word32, IOGen g) # genWord64R :: Word64 -> IOGen g -> (Word64, IOGen g) # genShortByteString :: Int -> IOGen g -> (ShortByteString, IOGen g) # | |
RandomGen g => RandomGen (STGen g) | |
Defined in System.Random.Stateful Methods next :: STGen g -> (Int, STGen g) # genWord8 :: STGen g -> (Word8, STGen g) # genWord16 :: STGen g -> (Word16, STGen g) # genWord32 :: STGen g -> (Word32, STGen g) # genWord64 :: STGen g -> (Word64, STGen g) # genWord32R :: Word32 -> STGen g -> (Word32, STGen g) # genWord64R :: Word64 -> STGen g -> (Word64, STGen g) # genShortByteString :: Int -> STGen g -> (ShortByteString, STGen g) # | |
RandomGen g => RandomGen (TGen g) | |
Defined in System.Random.Stateful Methods next :: TGen g -> (Int, TGen g) # genWord8 :: TGen g -> (Word8, TGen g) # genWord16 :: TGen g -> (Word16, TGen g) # genWord32 :: TGen g -> (Word32, TGen g) # genWord64 :: TGen g -> (Word64, TGen g) # genWord32R :: Word32 -> TGen g -> (Word32, TGen g) # genWord64R :: Word64 -> TGen g -> (Word64, TGen g) # genShortByteString :: Int -> TGen g -> (ShortByteString, TGen g) # |
The class of types for which random values can be generated. Most
instances of Random
will produce values that are uniformly distributed on the full
range, but for those types without a well-defined "full range" some sensible default
subrange will be selected.
Random
exists primarily for backwards compatibility with version 1.1 of
this library. In new code, use the better specified Uniform
and
UniformRange
instead.
Since: random-1.0.0
Minimal complete definition
Nothing
Methods
randomR :: RandomGen g => (a, a) -> g -> (a, g) #
Takes a range (lo,hi) and a pseudo-random number generator g, and returns a pseudo-random value uniformly distributed over the closed interval [lo,hi], together with a new generator. It is unspecified what happens if lo>hi, but usually the values will simply get swapped.
>>>
let gen = mkStdGen 2021
>>>
fst $ randomR ('a', 'z') gen
't'>>>
fst $ randomR ('z', 'a') gen
't'
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.
There is no requirement to follow the Ord
instance and the concept of range can be
defined on per type basis. For example product types will treat their values
independently:
>>>
fst $ randomR (('a', 5.0), ('z', 10.0)) $ mkStdGen 2021
('t',6.240232662366563)
In case when a lawful range is desired uniformR
should be used
instead.
Since: random-1.0.0
random :: RandomGen g => g -> (a, g) #
The same as randomR
, but using a default range determined by the type:
- For bounded types (instances of
Bounded
, such asChar
), the range is normally the whole type. - For floating point types, the range is normally the closed interval
[0,1]
. - For
Integer
, the range is (arbitrarily) the range ofInt
.
Since: random-1.0.0
randomRs :: RandomGen g => (a, a) -> g -> [a] #
Plural variant of randomR
, producing an infinite list of
pseudo-random values instead of returning a new generator.
Since: random-1.0.0
randoms :: RandomGen g => g -> [a] #
Plural variant of random
, producing an infinite list of
pseudo-random values instead of returning a new generator.
Since: random-1.0.0
Instances
Random CBool | |
Random CChar | |
Random CDouble | Note - |
Random CFloat | Note - |
Random CInt | |
Random CIntMax | |
Random CIntPtr | |
Random CLLong | |
Random CLong | |
Random CPtrdiff | |
Random CSChar | |
Random CShort | |
Random CSigAtomic | |
Random CSize | |
Random CUChar | |
Random CUInt | |
Random CUIntMax | |
Random CUIntPtr | |
Random CULLong | |
Random CULong | |
Random CUShort | |
Random CWchar | |
Random Int16 | |
Random Int32 | |
Random Int64 | |
Random Int8 | |
Random Word16 | |
Random Word32 | |
Random Word64 | |
Random Word8 | |
Random Integer | Note - |
Random Bool | |
Random Char | |
Random Double | Note - |
Random Float | Note - |
Random Int | |
Random Word | |
(Random a, Random b) => Random (a, b) | Note - |
(Random a, Random b, Random c) => Random (a, b, c) | Note - |
(Random a, Random b, Random c, Random d) => Random (a, b, c, d) | Note - |
(Random a, Random b, Random c, Random d, Random e) => Random (a, b, c, d, e) | Note - |
Defined in System.Random | |
(Random a, Random b, Random c, Random d, Random e, Random f) => Random (a, b, c, d, e, f) | Note - |
(Random a, Random b, Random c, Random d, Random e, Random f, Random g) => Random (a, b, c, d, e, f, g) | Note - |
Defined in System.Random |
genByteString :: RandomGen g => Int -> g -> (ByteString, g) #
Generates a ByteString
of the specified size using a pure pseudo-random
number generator. See uniformByteStringM
for the monadic version.
Examples
>>>
import System.Random
>>>
import Data.ByteString
>>>
let pureGen = mkStdGen 137
>>>
unpack . fst . genByteString 10 $ pureGen
[51,123,251,37,49,167,90,109,1,4]
Since: random-1.2.0
initStdGen :: MonadIO m => m StdGen #
Initialize StdGen
using system entropy (i.e. /dev/urandom
) when it is
available, while falling back on using system time as the seed.
Since: random-1.2.1
setStdGen :: MonadIO m => StdGen -> m () #
Sets the global pseudo-random number generator. Overwrites the contents of
globalStdGen
Since: random-1.0.0
getStdGen :: MonadIO m => m StdGen #
Gets the global pseudo-random number generator. Extracts the contents of
globalStdGen
Since: random-1.0.0
newStdGen :: MonadIO m => m StdGen #
Applies split
to the current global pseudo-random generator
globalStdGen
, updates it with one of the results,
and returns the other.
Since: random-1.0.0
getStdRandom :: MonadIO m => (StdGen -> (a, StdGen)) -> m a #
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
produces a pseudo-random integer
between 1 and 6:
>>>
rollDice = getStdRandom (randomR (1, 6))
>>>
replicateM 10 (rollDice :: IO Int)
[5,6,6,1,1,6,4,2,4,1]
This is an outdated function and it is recommended to switch to its
equivalent applyAtomicGen
instead, possibly with the
globalStdGen
if relying on the global state is
acceptable.
>>>
import System.Random.Stateful
>>>
rollDice = applyAtomicGen (uniformR (1, 6)) globalStdGen
>>>
replicateM 10 (rollDice :: IO Int)
[4,6,1,1,4,4,3,2,1,2]
Since: random-1.0.0
randomRIO :: (Random a, MonadIO m) => (a, a) -> m a #
A variant of randomRM
that uses the global
pseudo-random number generator globalStdGen
>>>
randomRIO (2020, 2100) :: IO Int
2040
Similar to randomIO
, this function is equivalent to
and is included in this interface for historical reasons and
backwards compatibility. It is recommended to use
getStdRandom
randomR
uniformRM
instead, possibly with the
globalStdGen
if relying on the global state is
acceptable.
>>>
import System.Random.Stateful
>>>
uniformRM (2020, 2100) globalStdGen :: IO Int
2079
Since: random-1.0.0
randomIO :: (Random a, MonadIO m) => m a #
A variant of randomM
that uses the global
pseudo-random number generator globalStdGen
.
>>>
import Data.Int
>>>
randomIO :: IO Int32
-1580093805
This function is equivalent to
and is included in
this interface for historical reasons and backwards compatibility. It is
recommended to use getStdRandom
random
uniformM
instead, possibly with
the globalStdGen
if relying on the global state is
acceptable.
>>>
import System.Random.Stateful
>>>
uniformM globalStdGen :: IO Int32
-1649127057
Since: random-1.0.0
module Control.Monad.Random.Class