| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Data.Random.Internal.Source
Synopsis
- data Prim a where
- PrimWord8 :: Prim Word8
- PrimWord16 :: Prim Word16
- PrimWord32 :: Prim Word32
- PrimWord64 :: Prim Word64
- PrimDouble :: Prim Double
- PrimNByteInteger :: !Int -> Prim Integer
- class Monad m => MonadRandom m where
- getRandomPrim :: Prim t -> m t
- getRandomWord8 :: m Word8
- getRandomWord16 :: m Word16
- getRandomWord32 :: m Word32
- getRandomWord64 :: m Word64
- getRandomDouble :: m Double
- getRandomNByteInteger :: MonadRandom m => Int -> m Integer
- class Monad m => RandomSource m s where
- getRandomPrimFrom :: s -> Prim t -> m t
- getRandomWord8From :: s -> m Word8
- getRandomWord16From :: s -> m Word16
- getRandomWord32From :: s -> m Word32
- getRandomWord64From :: s -> m Word64
- getRandomDoubleFrom :: s -> m Double
- getRandomNByteIntegerFrom :: s -> Int -> m Integer
- newtype GetPrim m = GetPrim (forall t. Prim t -> m t)
Documentation
A Prompt GADT describing a request for a primitive random variate.
Random variable definitions will request their entropy via these prompts,
and entropy sources will satisfy those requests. The functions in
Data.Random.Source.Internal.TH extend incomplete entropy-source definitions
to complete ones, essentially defining a very flexible
implementation-defaulting system.
Some possible future additions: PrimFloat :: Prim Float PrimInt :: Prim Int PrimPair :: Prim a -> Prim b -> Prim (a :*: b) PrimNormal :: Prim Double PrimChoice :: [(Double :*: a)] -> Prim a PrimBytes :: !Int -> Prim ByteString
Unfortunately, I cannot get Haddock to accept my comments about the data constructors, but hopefully they should be reasonably self-explanatory.
Constructors
| PrimWord8 :: Prim Word8 | |
| PrimWord16 :: Prim Word16 | |
| PrimWord32 :: Prim Word32 | |
| PrimWord64 :: Prim Word64 | |
| PrimDouble :: Prim Double | |
| PrimNByteInteger :: !Int -> Prim Integer |
class Monad m => MonadRandom m where Source #
A typeclass for monads with a chosen source of entropy. For example,
RVar is such a monad - the source from which it is (eventually) sampled
is the only source from which a random variable is permitted to draw, so
when directly requesting entropy for a random variable these functions
are used.
Minimum implementation is either the internal getRandomPrim or all
other functions. Additionally, this class's interface is subject to
extension at any time, so it is very, very strongly recommended that
the monadRandom Template Haskell function be used to implement this
function rather than directly implementing it. That function takes care
of choosing default implementations for any missing functions; as long as
at least one function is implemented, it will derive sensible
implementations of all others.
To use monadRandom, just wrap your instance declaration as follows (and
enable the TemplateHaskell and GADTs language extensions):
$(monadRandom [d|
instance MonadRandom FooM where
getRandomDouble = return pi
getRandomWord16 = return 4
{- etc... -}
|])Minimal complete definition
Nothing
Methods
getRandomPrim :: Prim t -> m t Source #
Generate a random value corresponding to the specified primitive.
This is an internal interface; use at your own risk. It may change or disappear at any time.
getRandomWord8 :: m Word8 Source #
Generate a uniformly distributed random Word8
getRandomWord16 :: m Word16 Source #
Generate a uniformly distributed random Word16
getRandomWord32 :: m Word32 Source #
Generate a uniformly distributed random Word32
getRandomWord64 :: m Word64 Source #
Generate a uniformly distributed random Word64
getRandomDouble :: m Double Source #
Generate a uniformly distributed random Double in the range 0 <= U < 1
getRandomNByteInteger :: MonadRandom m => Int -> m Integer Source #
Generate a uniformly distributed random Integer in the range 0 <= U < 256^n
Instances
class Monad m => RandomSource m s where Source #
A source of entropy which can be used in the given monad.
See also MonadRandom.
Minimum implementation is either the internal getRandomPrimFrom or all
other functions. Additionally, this class's interface is subject to
extension at any time, so it is very, very strongly recommended that
the randomSource Template Haskell function be used to implement this
function rather than directly implementing it. That function takes care
of choosing default implementations for any missing functions; as long as
at least one function is implemented, it will derive sensible
implementations of all others.
To use randomSource, just wrap your instance declaration as follows (and
enable the TemplateHaskell, MultiParamTypeClasses and GADTs language
extensions, as well as any others required by your instances, such as
FlexibleInstances):
$(randomSource [d|
instance RandomSource FooM Bar where
{- at least one RandomSource function... -}
|])Minimal complete definition
Nothing
Methods
getRandomPrimFrom :: s -> Prim t -> m t Source #
Generate a random value corresponding to the specified primitive.
This is an internal interface; use at your own risk. It may change or disappear at any time.
getRandomWord8From :: s -> m Word8 Source #
Generate a uniformly distributed random Word8
getRandomWord16From :: s -> m Word16 Source #
Generate a uniformly distributed random Word16
getRandomWord32From :: s -> m Word32 Source #
Generate a uniformly distributed random Word32
getRandomWord64From :: s -> m Word64 Source #
Generate a uniformly distributed random Word64
getRandomDoubleFrom :: s -> m Double Source #
Generate a uniformly distributed random Double in the range 0 <= U < 1
getRandomNByteIntegerFrom :: s -> Int -> m Integer Source #
Generate a uniformly distributed random Integer in the range 0 <= U < 256^n
Instances
This type provides a way to define a RandomSource for a monad without actually
having to declare an instance.
Instances
| Monad m => RandomSource m (GetPrim m) Source # | |
Defined in Data.Random.Internal.Source Methods getRandomPrimFrom :: GetPrim m -> Prim t -> m t Source # getRandomWord8From :: GetPrim m -> m Word8 Source # getRandomWord16From :: GetPrim m -> m Word16 Source # getRandomWord32From :: GetPrim m -> m Word32 Source # getRandomWord64From :: GetPrim m -> m Word64 Source # getRandomDoubleFrom :: GetPrim m -> m Double Source # getRandomNByteIntegerFrom :: GetPrim m -> Int -> m Integer Source # | |