-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/
-- | Random number generation
--
-- Random number generation based on modeling random variables in two
-- complementary ways: first, by the parameters of standard mathematical
-- distributions and, second, by an abstract type (RVar) which can
-- be composed and manipulated monadically and sampled in either monadic
-- or "pure" styles. The primary purpose of this library is to support
-- defining and sampling a wide variety of high quality random variables.
-- Quality is prioritized over speed, but performance is an important
-- goal too. In my testing, I have found it capable of speed comparable
-- to other Haskell libraries, but still a fair bit slower than straight
-- C implementations of the same algorithms. Warning to anyone upgrading
-- from "< 0.1": Discrete has been renamed Categorical,
-- the entropy source classes have been redesigned, and many things are
-- no longer exported from the root module Data.Random (In
-- particular, DevRandom - this is not available on windows, so it will
-- likely move to its own package eventually so that client code
-- dependencies on it will be made explicit). Support for base
-- packages earlier than version 4 (and thus GHC releases earlier than
-- 6.10) has been dropped, as too many of this package's dependencies do
-- not support older versions. The Data.Random module itself
-- should now have a relatively stable interface, but the other modules
-- are still subject to change. Specifically, I am considering hiding
-- data constructors for most or all of the distributions.
@package random-fu
@version 0.1.3
module Data.Random.Internal.Find
findMax :: (Fractional a, Ord a) => (a -> Bool) -> a
-- | Given an upward-closed predicate on an ordered Fractional type, find
-- the smallest value satisfying the predicate.
findMin :: (Fractional a, Ord a) => (a -> Bool) -> a
-- | Given an upward-closed predicate on an ordered Fractional type, find
-- the smallest value satisfying the predicate. Starts at the specified
-- point with the specified stepsize, performs an exponential search out
-- from there until it finds an interval bracketing the change-point of
-- the predicate, and then performs a bisection search to isolate the
-- change point. Note that infinitely-divisible domains such as
-- Rational cannot be searched by this function because it does
-- not terminate until it reaches a point where further subdivision of
-- the interval has no effect.
findMinFrom :: (Fractional a, Ord a) => a -> a -> (a -> Bool) -> a
module Data.Random.Internal.Fixed
resolutionOf :: (HasResolution r) => f r -> Integer
resolutionOf2 :: (HasResolution r) => f (g r) -> Integer
-- | The Fixed type doesn't expose its constructors, but I need a
-- way to convert them to and from their raw representation in order to
-- sample them. As long as Fixed is a newtype wrapping
-- Integer, mkFixed and unMkFixed as defined here
-- will work. Both are implemented using unsafeCoerce.
mkFixed :: Integer -> Fixed r
unMkFixed :: Fixed r -> Integer
-- | A few little functions I found myself writing inline over and over
-- again.
module Data.Random.Internal.Words
-- | Build a word out of 2 bytes. No promises are made regarding the order
-- in which the bytes are stuffed. Note that this means that a
-- RandomSource or MonadRandom making use of the
-- default definition of getRandomWord, etc., may return
-- different random values on different platforms when started with the
-- same seed, depending on the platform's endianness.
buildWord16 :: Word8 -> Word8 -> Word16
-- | Build a word out of 4 bytes. No promises are made regarding the order
-- in which the bytes are stuffed. Note that this means that a
-- RandomSource or MonadRandom making use of the
-- default definition of getRandomWord, etc., may return
-- different random values on different platforms when started with the
-- same seed, depending on the platform's endianness.
buildWord32 :: Word8 -> Word8 -> Word8 -> Word8 -> Word32
buildWord32' :: Word16 -> Word16 -> Word32
-- | Build a word out of 8 bytes. No promises are made regarding the order
-- in which the bytes are stuffed. Note that this means that a
-- RandomSource or MonadRandom making use of the
-- default definition of getRandomWord, etc., may return
-- different random values on different platforms when started with the
-- same seed, depending on the platform's endianness.
buildWord64 :: Word8 -> Word8 -> Word8 -> Word8 -> Word8 -> Word8 -> Word8 -> Word8 -> Word64
buildWord64' :: Word16 -> Word16 -> Word16 -> Word16 -> Word64
buildWord64'' :: Word32 -> Word32 -> Word64
-- | Pack the low 23 bits from a Word32 into a Float in the
-- range [0,1). Used to convert a stdUniform Word32 to a
-- stdUniform Double.
word32ToFloat :: Word32 -> Float
-- | Same as word32ToFloat, but also return the unused bits (as the 9 least
-- significant bits of a Word32)
word32ToFloatWithExcess :: Word32 -> (Float, Word32)
-- | Pack the low 23 bits from a Word64 into a Float in the
-- range [0,1). Used to convert a stdUniform Word64 to a
-- stdUniform Double.
wordToFloat :: Word64 -> Float
-- | Same as wordToFloat, but also return the unused bits (as the 41 least
-- significant bits of a Word64)
wordToFloatWithExcess :: Word64 -> (Float, Word64)
-- | Pack the low 52 bits from a Word64 into a Double in the
-- range [0,1). Used to convert a stdUniform Word64 to a
-- stdUniform Double.
wordToDouble :: Word64 -> Double
-- | Pack a Word32 into a Double in the range [0,1). Note
-- that a Double's mantissa is 52 bits, so this does not fill all of
-- them.
word32ToDouble :: Word32 -> Double
-- | Same as wordToDouble, but also return the unused bits (as the 12 least
-- significant bits of a Word64)
wordToDoubleWithExcess :: Word64 -> (Double, Word64)
-- | Template Haskell utility code to replicate instance declarations to
-- cover large numbers of types. I'm doing that rather than using class
-- contexts because most Distribution instances need to cover multiple
-- classes (such as Enum, Integral and Fractional) and that can't be done
-- easily because of overlap.
--
-- I experimented a bit with a convoluted type-level classification
-- scheme, but I think this is simpler and easier to understand. It makes
-- the haddock docs more cluttered because of the combinatorial explosion
-- of instances, but overall I think it's just more sane than anything
-- else I've come up with yet.
module Data.Random.Internal.TH
-- | replicateInstances standin types decls will take the
-- template-haskell Decs in decls and substitute every
-- instance of the Name standin with each Name in
-- types, producing one copy of the Decs in
-- decls for every Name in types.
--
-- For example, Data.Random.Distribution.Uniform has the
-- following bit of TH code:
--
--
-- $( replicateInstances ''Int integralTypes [d|
--
--
--
-- instance Distribution Uniform Int where rvar (Uniform a b) = integralUniform a b
--
--
--
-- instance CDF Uniform Int where cdf (Uniform a b) = integralUniformCDF a b
--
--
--
-- |])
--
--
-- This code takes those 2 instance declarations and creates identical
-- ones for every type named in integralTypes.
replicateInstances :: (Monad m, Data t) => Name -> [Name] -> m [t] -> m [t]
-- | Names of standard Integral types
integralTypes :: [Name]
-- | Names of standard RealFloat types
realFloatTypes :: [Name]
module Data.Random.Lift
-- | A class for "liftable" data structures. Conceptually an extension of
-- MonadTrans to allow deep lifting, but lifting need not be done
-- between monads only. Eg lifting between Applicatives is
-- allowed.
--
-- For instances where m and n have 'return'/'pure'
-- defined, these instances must satisfy lift (return x) == return
-- x.
--
-- This form of lift has an extremely general type and is used
-- primarily to support sample. Its excessive generality is the
-- main reason it's not exported from Data.Random. RVarT
-- is, however, an instance of MonadTrans, which in most cases is
-- the preferred way to do the lifting.
class Lift m n
lift :: (Lift m n) => m a -> n a
instance [incoherent] (Monad m) => Lift Identity m
instance [incoherent] Lift m m
instance [incoherent] (Monad m, MonadTrans t) => Lift m (t m)
-- | This is an experimental interface to support an extensible set of
-- primitives, where a RandomSource will be able to support whatever
-- subset of them they want and have well-founded defaults generated
-- automatically for any unsupported primitives.
--
-- The purpose, in case it's not clear, is to decouple the
-- implementations of entropy sources from any particular set of
-- primitives, so that implementors of random variates can make use of a
-- large number of primitives, supported on all entropy sources, while
-- the burden on entropy-source implementors is only to provide one or
-- two basic primitives of their choice.
--
-- One challenge I foresee with this interface is optimization -
-- different compilers or even different versions of GHC may treat this
-- interface radically differently, making it very hard to achieve
-- reliable performance on all platforms. It may even be that no compiler
-- optimizes sufficiently to make the flexibility this system provides
-- worth the overhead. I hope this is not the case, but if it turns out
-- to be a major problem, this system may disappear or be modified in
-- significant ways.
module Data.Random.Internal.Primitives
-- | 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 some or all of them.
-- The decomposePrimWhere function extends an entropy source's
-- incomplete definition to a complete definition, 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
--
-- Unfortunately, I cannot get Haddock to accept my comments about the
-- data constructors, but hopefully they should be reasonably
-- self-explanatory.
data Prim a
PrimWord8 :: Prim Word8
PrimWord16 :: Prim Word16
PrimWord32 :: Prim Word32
PrimWord64 :: Prim Word64
PrimDouble :: Prim Double
PrimNByteInteger :: !Int -> Prim Integer
-- | This function wraps up the most common calling convention for
-- decomposePrimWhere. Given a predicate identifying "supported"
-- Prims, and a (possibly partial) function that maps those
-- Prims to implementations, derives a total function mapping all
-- Prims to implementations.
getPrimWhere :: (Monad m) => (forall t. Prim t -> Bool) -> (forall t. Prim t -> m t) -> Prim a -> m a
-- | This is essentially a suite of interrelated default implementations,
-- each definition making use of only "supported" primitives. It _really_
-- ought to be inlined to the point where the supported
-- predicate is able to be inlined into it and eliminated.
--
-- When inlined sufficiently, it should in theory be optimized down to
-- the static set of best definitions for each required primitive
-- in terms of only supported primitives.
--
-- Hopefully it does not impose too much overhead when not inlined.
decomposePrimWhere :: (forall t. Prim t -> Bool) -> Prim a -> Prompt Prim a
instance Typeable1 Prim
instance Show (Prim a)
module Data.Random.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.
--
-- Occasionally one might want a RandomSource specifying the
-- MonadRandom instance (for example, when using
-- runRVar). For those cases,
-- Data.Random.Source.Std.StdRandom provides a
-- RandomSource that maps to the MonadRandom instance.
--
-- For example, State StdGen has a MonadRandom instance,
-- so to run an RVar (called x in this example) in this
-- monad one could write runRVar x StdRandom (or more concisely
-- with the sample function: sample x).
class (Monad m) => MonadRandom m
getRandomPrim :: (MonadRandom m) => Prim t -> m t
-- | A source of entropy which can be used in the given monad.
--
-- See also MonadRandom.
class (Monad m) => RandomSource m s
getRandomPrimFrom :: (RandomSource m s) => s -> Prim t -> m t
-- | 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 some or all of them.
-- The decomposePrimWhere function extends an entropy source's
-- incomplete definition to a complete definition, 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
--
-- Unfortunately, I cannot get Haddock to accept my comments about the
-- data constructors, but hopefully they should be reasonably
-- self-explanatory.
data Prim a
PrimWord8 :: Prim Word8
PrimWord16 :: Prim Word16
PrimWord32 :: Prim Word32
PrimWord64 :: Prim Word64
PrimDouble :: Prim Double
PrimNByteInteger :: !Int -> Prim Integer
instance (Monad m) => RandomSource m (m Double)
instance (Monad m) => RandomSource m (m Word64)
instance (Monad m) => RandomSource m (m Word32)
instance (Monad m) => RandomSource m (m Word16)
instance (Monad m) => RandomSource m (m Word8)
module Data.Random.Source.DevRandom
-- | On systems that have it, /dev/random is a handy-dandy ready-to-use
-- source of nonsense. Keep in mind that on some systems, Linux included,
-- /dev/random collects "real" entropy, and if you don't have a good
-- source of it, such as special hardware for the purpose or a *lot* of
-- network traffic, it's pretty easy to suck the entropy pool dry with
-- entropy-intensive applications. For many purposes other than
-- cryptography, /dev/urandom is preferable because when it runs out of
-- real entropy it'll still churn out pseudorandom data.
data DevRandom
DevRandom :: DevRandom
DevURandom :: DevRandom
instance Eq DevRandom
instance Show DevRandom
instance RandomSource IO DevRandom
-- | This module defines the following instances:
--
--
-- instance RandomSource (ST s) (Gen s)
-- instance RandomSource IO (Gen RealWorld)
--
module Data.Random.Source.MWC
instance RandomSource IO (Gen RealWorld)
instance RandomSource (ST s) (Gen s)
-- | This module provides functions useful for implementing new
-- MonadRandom and RandomSource instances for
-- state-abstractions containing StdGen values (the pure
-- pseudorandom generator provided by the System.Random module in the
-- "random" package), as well as instances for some common cases.
module Data.Random.Source.StdGen
getRandomPrimFromStdGenIO :: Prim a -> IO a
-- | Given a mutable reference to a RandomGen generator, we can make
-- a RandomSource usable in any monad in which the reference can
-- be modified.
--
-- See Data.Random.Source.PureMT.getRandomPrimFromMTRef
-- for more detailed usage hints - this function serves exactly the same
-- purpose except for a StdGen generator instead of a
-- PureMT generator.
getRandomPrimFromRandomGenRef :: (Monad m, ModifyRef sr m g, RandomGen g) => sr -> Prim a -> m a
-- | Similarly, getRandomWordFromRandomGenState x can be used in
-- any "state" monad in the mtl sense whose state is a RandomGen
-- generator. Additionally, the standard mtl state monads have
-- MonadRandom instances which do precisely that, allowing an easy
-- conversion of RVars and other Distribution instances
-- to "pure" random variables.
--
-- Again, see
-- Data.Random.Source.PureMT.getRandomPrimFromMTState for
-- more detailed usage hints - this function serves exactly the same
-- purpose except for a StdGen generator instead of a
-- PureMT generator.
getRandomPrimFromRandomGenState :: (RandomGen g, MonadState g m) => Prim a -> m a
instance (Monad m) => MonadRandom (StateT StdGen m)
instance (Monad m) => MonadRandom (StateT StdGen m)
instance (Monad m, ModifyRef (STRef s StdGen) m StdGen) => RandomSource m (STRef s StdGen)
instance (Monad m, ModifyRef (IORef StdGen) m StdGen) => RandomSource m (IORef StdGen)
instance (Monad m1, ModifyRef (Ref m2 StdGen) m1 StdGen) => RandomSource m1 (Ref m2 StdGen)
-- | This module provides functions useful for implementing new
-- MonadRandom and RandomSource instances for
-- state-abstractions containing PureMT values (the pure
-- pseudorandom generator provided by the mersenne-random-pure64
-- package), as well as instances for some common cases.
--
-- A PureMT generator is immutable, so PureMT by itself
-- cannot be a RandomSource (if it were, it would always give the
-- same "random" values). Some form of mutable state must be used, such
-- as an IORef, State monad, etc.. A few default instances
-- are provided by this module along with more-general functions
-- (getRandomPrimFromMTRef and getRandomPrimFromMTState)
-- usable as implementations for new cases users might need.
module Data.Random.Source.PureMT
-- | PureMT, a pure mersenne twister pseudo-random number generator
data PureMT :: *
-- | Create a new PureMT generator, using the clocktime as the base for the
-- seed.
newPureMT :: IO PureMT
-- | Create a PureMT generator from a Word64 seed.
pureMT :: Word64 -> PureMT
-- | Given a function for applying a PureMT transformation to some
-- hidden state, this function derives a function able to generate all
-- Prims in the given monad. This is then suitable for either a
-- MonadRandom or RandomSource instance, where the
-- supportedPrims or supportedPrimsFrom function
-- (respectively) is const True.
getRandomPrimBy :: (Monad m) => (forall t. (PureMT -> (t, PureMT)) -> m t) -> Prim a -> m a
-- | Given a mutable reference to a PureMT generator, we can
-- implement RandomSource for in any monad in which the reference
-- can be modified.
--
-- Typically this would be used to define a new RandomSource
-- instance for some new reference type or new monad in which an existing
-- reference type can be modified atomically. As an example, the
-- following instance could be used to describe how IORef
-- PureMT can be a RandomSource in the IO monad:
--
--
-- instance RandomSource IO (IORef PureMT) where
-- supportedPrimsFrom _ _ = True
-- getSupportedRandomPrimFrom = getRandomPrimFromMTRef
--
--
-- (note that there is actually a more general instance declared already
-- covering this as a a special case, so there's no need to repeat this
-- declaration anywhere)
--
-- Example usage:
--
--
-- main = do
-- src <- newIORef (pureMT 1234) -- OR: newPureMT >>= newIORef
-- x <- sampleFrom src (uniform 0 100) -- OR: runRVar (uniform 0 100) src
-- print x
--
getRandomPrimFromMTRef :: (Monad m, ModifyRef sr m PureMT) => sr -> Prim a -> m a
-- | Similarly, getRandomPrimFromMTState x can be used in any
-- "state" monad in the mtl sense whose state is a PureMT
-- generator. Additionally, the standard mtl state monads have
-- MonadRandom instances which do precisely that, allowing an easy
-- conversion of RVars and other Distribution instances
-- to "pure" random variables (e.g., by runState . sample ::
-- Distribution d t => d t -> PureMT -> (t, PureMT).
-- PureMT in the type there can be replaced by StdGen or
-- anything else satisfying MonadRandom (State s) => s).
--
-- For example, this module includes the following declaration:
--
--
-- instance MonadRandom (State PureMT) where
-- supportedPrims _ _ = True
-- getSupportedRandomPrim = getRandomPrimFromMTState
--
--
-- This describes a "standard" way of getting random values in
-- State PureMT, which can then be used in various ways,
-- for example (assuming some RVar foo and some
-- Word64 seed):
--
--
-- runState (runRVar foo StdRandom) (pureMT seed)
-- runState (sampleFrom StdRandom foo) (pureMT seed)
-- runState (sample foo) (pureMT seed)
--
--
-- Of course, the initial PureMT state could also be obtained by
-- any other convenient means, such as newPureMT if you don't care
-- what seed is used.
getRandomPrimFromMTState :: (MonadState PureMT m) => Prim a -> m a
instance (Monad m, ModifyRef (STRef s PureMT) m PureMT) => RandomSource m (STRef s PureMT)
instance (Monad m, ModifyRef (IORef PureMT) m PureMT) => RandomSource m (IORef PureMT)
instance (Monad m) => MonadRandom (StateT PureMT m)
instance (Monad m) => MonadRandom (StateT PureMT m)
instance (Monad m1, ModifyRef (Ref m2 PureMT) m1 PureMT) => RandomSource m1 (Ref m2 PureMT)
module Data.Random.Source.Std
-- | A token representing the "standard" entropy source in a
-- MonadRandom monad. Its sole purpose is to make the following
-- true (when the types check):
--
--
-- sampleFrom StdRandom === sample
--
data StdRandom
StdRandom :: StdRandom
instance (MonadRandom m) => RandomSource m StdRandom
-- | Random variables. An RVar is a sampleable random variable.
-- Because probability distributions form a monad, they are quite easy to
-- work with in the standard Haskell monadic styles. For examples, see
-- the source for any of the Distribution instances - they all
-- are defined in terms of RVars.
module Data.Random.RVar
-- | An opaque type modeling a "random variable" - a value which depends on
-- the outcome of some random event. RVars can be conveniently
-- defined by an imperative-looking style:
--
--
-- normalPair = do
-- u <- stdUniform
-- t <- stdUniform
-- let r = sqrt (-2 * log u)
-- theta = (2 * pi) * t
--
-- x = r * cos theta
-- y = r * sin theta
-- return (x,y)
--
--
-- OR by a more applicative style:
--
--
-- logNormal = exp <$> stdNormal
--
--
-- Once defined (in any style), there are several ways to sample
-- RVars:
--
--
--
--
-- sampleFrom DevRandom (uniform 1 100) :: IO Int
--
--
--
--
--
-- sample (uniform 1 100) :: State PureMT Int
--
--
--
-- - As a pure function transforming a functional RNG:
--
--
--
-- sampleState (uniform 1 100) :: StdGen -> (Int, StdGen)
--
type RVar = RVarT Identity
-- | "Run" an RVar - samples the random variable from the provided
-- source of entropy. Typically sample, sampleFrom or
-- sampleState will be more convenient to use.
runRVar :: (RandomSource m s) => RVar a -> s -> m a
-- | A random variable with access to operations in an underlying monad.
-- Useful examples include any form of state for implementing random
-- processes with hysteresis, or writer monads for implementing tracing
-- of complicated algorithms.
--
-- For example, a simple random walk can be implemented as an
-- RVarT IO value:
--
--
-- rwalkIO :: IO (RVarT IO Double)
-- rwalkIO d = do
-- lastVal <- newIORef 0
--
-- let x = do
-- prev <- lift (readIORef lastVal)
-- change <- rvarT StdNormal
--
-- let new = prev + change
-- lift (writeIORef lastVal new)
-- return new
--
-- return x
--
--
-- To run the random walk, it must first be initialized, and then it can
-- be sampled as usual:
--
--
-- do
-- rw <- rwalkIO
-- x <- sampleFrom DevURandom rw
-- y <- sampleFrom DevURandom rw
-- ...
--
--
-- The same random-walk process as above can be implemented using MTL
-- types as follows (using import Control.Monad.Trans as MTL):
--
--
-- rwalkState :: RVarT (State Double) Double
-- rwalkState = do
-- prev <- MTL.lift get
-- change <- rvarT StdNormal
--
-- let new = prev + change
-- MTL.lift (put new)
-- return new
--
--
-- Invocation is straightforward (although a bit noisy) if you're used to
-- MTL, but there is a gotcha lurking here: sample and
-- runRVarT inherit the extreme generality of lift, so
-- there will almost always need to be an explicit type signature lurking
-- somewhere in any client code making use of RVarT with MTL
-- types. In this example, the inferred type of start would be
-- too general to be practical, so the signature for rwalk
-- explicitly fixes it to Double. Alternatively, in this case
-- sample could be replaced with \x -> runRVarTWith
-- MTL.lift x StdRandom.
--
--
-- rwalk :: Int -> Double -> StdGen -> ([Double], StdGen)
-- rwalk count start gen = evalState (runStateT (sample (replicateM count rwalkState)) gen) start
--
data RVarT m a
-- | "Runs" an RVarT, sampling the random variable it defines.
--
-- The Lift context allows random variables to be defined using a
-- minimal underlying functor (Identity is sufficient for
-- "conventional" random variables) and then sampled in any monad into
-- which the underlying functor can be embedded (which, for
-- Identity, is all monads).
--
-- The lifting is very important - without it, every RVar would
-- have to either be given access to the full capability of the monad in
-- which it will eventually be sampled (which, incidentally, would also
-- have to be monomorphic so you couldn't sample one RVar in more
-- than one monad) or functions manipulating RVars would have to
-- use higher-ranked types to enforce the same kind of isolation and
-- polymorphism.
--
-- For non-standard liftings or those where you would rather not
-- introduce a Lift instance, see runRVarTWith.
runRVarT :: (Lift n m, RandomSource m s) => RVarT n a -> s -> m a
-- | Like runRVarT but allowing a user-specified lift operation.
-- This operation must obey the "monad transformer" laws:
--
--
-- lift . return = return
-- lift (x >>= f) = (lift x) >>= (lift . f)
--
--
-- One example of a useful non-standard lifting would be one that takes
-- State s to another monad with a different state
-- representation (such as IO with the state mapped to an
-- IORef):
--
--
-- embedState :: (Monad m) => m s -> (s -> m ()) -> State s a -> m a
-- embedState get put = \m -> do
-- s <- get
-- (res,s) <- return (runState m s)
-- put s
-- return res
--
runRVarTWith :: (RandomSource m s) => (forall t. n t -> m t) -> RVarT n a -> s -> m a
instance MonadRandom (RVarT n)
instance (MonadIO m) => MonadIO (RVarT m)
instance Lift (RVarT Identity) (RVarT m)
instance MonadTrans RVarT
instance Applicative (RVarT n)
instance Monad (RVarT n)
instance Functor (RVarT n)
module Data.Random.Distribution
-- | A Distribution is a data representation of a random variable's
-- probability structure. For example, in
-- Data.Random.Distribution.Normal, the Normal
-- distribution is defined as:
--
--
-- data Normal a
-- = StdNormal
-- | Normal a a
--
--
-- Where the two parameters of the Normal data constructor are
-- the mean and standard deviation of the random variable, respectively.
-- To make use of the Normal type, one can convert it to an
-- rvar and manipulate it or sample it directly:
--
--
-- x <- sample (rvar (Normal 10 2))
-- x <- sample (Normal 10 2)
--
--
-- A Distribution is typically more transparent than an
-- RVar but less composable (precisely because of that
-- transparency). There are several practical uses for types implementing
-- Distribution:
--
--
-- - Typically, a Distribution will expose several parameters of
-- a standard mathematical model of a probability distribution, such as
-- mean and std deviation for the normal distribution. Thus, they can be
-- manipulated analytically using mathematical insights about the
-- distributions they represent. For example, a collection of bernoulli
-- variables could be simplified into a (hopefully) smaller collection of
-- binomial variables.
-- - Because they are generally just containers for parameters, they
-- can be easily serialized to persistent storage or read from
-- user-supplied configurations (eg, initialization data for a
-- simulation).
-- - If a type additionally implements the CDF subclass, which
-- extends Distribution with a cumulative density function, an
-- arbitrary random variable x can be tested against the
-- distribution by testing fmap (cdf dist) x for
-- uniformity.
--
--
-- On the other hand, most Distributions will not be closed under
-- all the same operations as RVar (which, being a monad, has a
-- fully turing-complete internal computational model). The sum of two
-- uniformly-distributed variables, for example, is not uniformly
-- distributed. To support general composition, the Distribution
-- class defines a function rvar to construct the more-abstract
-- and more-composable RVar representation of a random variable.
class Distribution d t
rvar :: (Distribution d t) => d t -> RVar t
rvarT :: (Distribution d t) => d t -> RVarT n t
class (Distribution d t) => CDF d t
cdf :: (CDF d t) => d t -> t -> Double
module Data.Random.Sample
-- | A typeclass allowing Distributions and RVars to be
-- sampled. Both may also be sampled via runRVar or
-- runRVarT, but I find it psychologically pleasing to be able to
-- sample both using this function, as they are two separate abstractions
-- for one base concept: a random variable.
class Sampleable d m t
sampleFrom :: (Sampleable d m t, RandomSource m s) => s -> d t -> m t
-- | Sample a random variable using the default source of entropy for the
-- monad in which the sampling occurs.
sample :: (Sampleable d m t, MonadRandom m) => d t -> m t
-- | Sample a random variable in a "functional" style. Typical
-- instantiations of s are System.Random.StdGen or
-- System.Random.Mersenne.Pure64.PureMT.
sampleState :: (Sampleable d (State s) t, MonadRandom (State s)) => d t -> s -> (t, s)
-- | Sample a random variable in a "semi-functional" style. Typical
-- instantiations of s are System.Random.StdGen or
-- System.Random.Mersenne.Pure64.PureMT.
sampleStateT :: (Sampleable d (StateT s m) t, MonadRandom (StateT s m)) => d t -> s -> m (t, s)
instance [incoherent] (Lift m n) => Sampleable (RVarT m) n t
instance [incoherent] (Distribution d t) => Sampleable d m t
module Data.Random.Distribution.Uniform
-- | A definition of a uniform distribution over the type t. See
-- also uniform.
data Uniform t
-- | A uniform distribution defined by a lower and upper range bound. For
-- Integral and Enum types, the range is inclusive. For
-- Fractional types the range includes the lower bound but not the
-- upper.
Uniform :: !t -> !t -> Uniform t
uniform :: (Distribution Uniform a) => a -> a -> RVar a
uniformT :: (Distribution Uniform a) => a -> a -> RVarT m a
-- | A name for the "standard" uniform distribution over the type
-- t, if one exists. See also stdUniform.
--
-- For Integral and Enum types that are also
-- Bounded, this is the uniform distribution over the full range
-- of the type. For un-Bounded Integral types this is not
-- defined. For Fractional types this is a random variable in the
-- range [0,1) (that is, 0 to 1 including 0 but not including 1).
data StdUniform t
StdUniform :: StdUniform t
-- | Get a "standard" uniformly distributed variable. For integral types,
-- this means uniformly distributed over the full range of the type
-- (there is no support for Integer). For fractional types, this
-- means uniformly distributed on the interval [0,1).
stdUniform :: (Distribution StdUniform a) => RVar a
-- | Get a "standard" uniformly distributed process. For integral types,
-- this means uniformly distributed over the full range of the type
-- (there is no support for Integer). For fractional types, this
-- means uniformly distributed on the interval [0,1).
stdUniformT :: (Distribution StdUniform a) => RVarT m a
-- | Like stdUniform but only returns positive values.
stdUniformPos :: (Distribution StdUniform a, Num a) => RVar a
-- | Like stdUniform but only returns positive values.
stdUniformPosT :: (Distribution StdUniform a, Num a) => RVarT m a
-- | Compute a random Integral value between the 2 values provided
-- (inclusive).
integralUniform :: (Integral a) => a -> a -> RVarT m a
-- | realFloatUniform a b computes a uniform random value in the
-- range [a,b) for any RealFloat type
realFloatUniform :: (RealFloat a) => a -> a -> RVarT m a
-- | floatUniform a b computes a uniform random Float value
-- in the range [a,b)
floatUniform :: Float -> Float -> RVarT m Float
-- | doubleUniform a b computes a uniform random Double
-- value in the range [a,b)
doubleUniform :: Double -> Double -> RVarT m Double
-- | fixedUniform a b computes a uniform random Fixed value
-- in the range [a,b), with any desired precision.
fixedUniform :: (HasResolution r) => Fixed r -> Fixed r -> RVarT m (Fixed r)
-- | Compute a random value for a Bounded type, between
-- minBound and maxBound (inclusive for Integral or
-- Enum types, in [minBound, maxBound) for
-- Fractional types.)
boundedStdUniform :: (Distribution Uniform a, Bounded a) => RVar a
-- | Compute a random value for a Bounded Enum type, between
-- minBound and maxBound (inclusive)
boundedEnumStdUniform :: (Enum a, Bounded a) => RVarT m a
-- | Compute a uniform random value in the range [0,1) for any
-- RealFloat type
realFloatStdUniform :: (RealFloat a) => RVarT m a
-- | Compute a uniform random Fixed value in the range [0,1), with
-- any desired precision.
fixedStdUniform :: (HasResolution r) => RVarT m (Fixed r)
-- | Compute a uniform random Float value in the range [0,1)
floatStdUniform :: RVarT m Float
-- | Compute a uniform random Double value in the range [0,1)
doubleStdUniform :: RVarT m Double
-- | The CDF of the random variable realFloatStdUniform.
realStdUniformCDF :: (Real a) => a -> Double
-- | realUniformCDF a b is the CDF of the random variable
-- realFloatUniform a b.
realUniformCDF :: (RealFrac a) => a -> a -> a -> Double
instance CDF StdUniform Ordering
instance Distribution StdUniform Ordering
instance CDF StdUniform Char
instance Distribution StdUniform Char
instance CDF StdUniform Bool
instance Distribution StdUniform Bool
instance CDF StdUniform ()
instance Distribution StdUniform ()
instance CDF Uniform Ordering
instance Distribution Uniform Ordering
instance CDF Uniform Bool
instance Distribution Uniform Bool
instance CDF Uniform Char
instance Distribution Uniform Char
instance CDF Uniform ()
instance Distribution Uniform ()
instance (HasResolution r) => CDF StdUniform (Fixed r)
instance (HasResolution r) => Distribution StdUniform (Fixed r)
instance (HasResolution r) => CDF Uniform (Fixed r)
instance (HasResolution r) => Distribution Uniform (Fixed r)
instance CDF StdUniform Double
instance CDF StdUniform Float
instance Distribution StdUniform Double
instance Distribution StdUniform Float
instance CDF Uniform Double
instance CDF Uniform Float
instance Distribution Uniform Double
instance Distribution Uniform Float
instance CDF StdUniform Word64
instance CDF StdUniform Word32
instance CDF StdUniform Word16
instance CDF StdUniform Word8
instance CDF StdUniform Word
instance CDF StdUniform Int64
instance CDF StdUniform Int32
instance CDF StdUniform Int16
instance CDF StdUniform Int8
instance CDF StdUniform Int
instance Distribution StdUniform Word
instance Distribution StdUniform Int
instance Distribution StdUniform Int64
instance Distribution StdUniform Int32
instance Distribution StdUniform Int16
instance Distribution StdUniform Int8
instance Distribution StdUniform Word64
instance Distribution StdUniform Word32
instance Distribution StdUniform Word16
instance Distribution StdUniform Word8
instance CDF Uniform Word64
instance Distribution Uniform Word64
instance CDF Uniform Word32
instance Distribution Uniform Word32
instance CDF Uniform Word16
instance Distribution Uniform Word16
instance CDF Uniform Word8
instance Distribution Uniform Word8
instance CDF Uniform Word
instance Distribution Uniform Word
instance CDF Uniform Int64
instance Distribution Uniform Int64
instance CDF Uniform Int32
instance Distribution Uniform Int32
instance CDF Uniform Int16
instance Distribution Uniform Int16
instance CDF Uniform Int8
instance Distribution Uniform Int8
instance CDF Uniform Int
instance Distribution Uniform Int
instance CDF Uniform Integer
instance Distribution Uniform Integer
module Data.Random.Distribution.Weibull
data Weibull a
Weibull :: !a -> !a -> Weibull a
weibullLambda :: Weibull a -> !a
weibullK :: Weibull a -> !a
instance (Eq a) => Eq (Weibull a)
instance (Show a) => Show (Weibull a)
instance (Real a, Distribution Weibull a) => CDF Weibull a
instance (Floating a, Distribution StdUniform a) => Distribution Weibull a
module Data.Random.List
-- | A random variable returning an arbitrary element of the given list.
-- Every element has equal probability of being chosen. Because it is a
-- pure RVar it has no memory - that is, it "draws with
-- replacement."
randomElement :: [a] -> RVar a
-- | A random variable that returns the given list in an arbitrary shuffled
-- order. Every ordering of the list has equal probability.
shuffle :: [a] -> RVar [a]
-- | A random variable that shuffles a list of a known length (or a list
-- prefix of the specified length). Useful for shuffling large lists when
-- the length is known in advance. Avoids needing to traverse the list to
-- discover its length. Each ordering has equal probability.
shuffleN :: Int -> [a] -> RVar [a]
-- | A random variable that selects N arbitrary elements of a list of known
-- length M.
shuffleNofM :: Int -> Int -> [a] -> RVar [a]
module Data.Random.Distribution.Bernoulli
-- | Generate a Bernoulli variate with the given probability. For
-- Bool results, bernoulli p will return True (p*100)%
-- of the time and False otherwise. For numerical types, True is replaced
-- by 1 and False by 0.
bernoulli :: (Distribution (Bernoulli b) a) => b -> RVar a
-- | Generate a Bernoulli process with the given probability. For
-- Bool results, bernoulli p will return True (p*100)%
-- of the time and False otherwise. For numerical types, True is replaced
-- by 1 and False by 0.
bernoulliT :: (Distribution (Bernoulli b) a) => b -> RVarT m a
-- | A random variable whose value is True the given fraction of the
-- time and False the rest.
boolBernoulli :: (Fractional a, Ord a, Distribution StdUniform a) => a -> RVarT m Bool
boolBernoulliCDF :: (Real a) => a -> Bool -> Double
-- | generalBernoulli t f p generates a random variable whose
-- value is t with probability p and f with
-- probability 1-p.
generalBernoulli :: (Distribution (Bernoulli b) Bool) => a -> a -> b -> RVarT m a
generalBernoulliCDF :: (CDF (Bernoulli b) Bool) => (a -> a -> Bool) -> a -> a -> b -> a -> Double
data Bernoulli b a
Bernoulli :: b -> Bernoulli b a
instance (CDF (Bernoulli b) Bool, RealFloat a) => CDF (Bernoulli b) (Complex a)
instance (Distribution (Bernoulli b) Bool, RealFloat a) => Distribution (Bernoulli b) (Complex a)
instance (CDF (Bernoulli b) Bool, Integral a) => CDF (Bernoulli b) (Ratio a)
instance (Distribution (Bernoulli b) Bool, Integral a) => Distribution (Bernoulli b) (Ratio a)
instance (CDF (Bernoulli b[aS9R]) Bool) => CDF (Bernoulli b[aS9R]) Double
instance (Distribution (Bernoulli b[aS9P]) Bool) => Distribution (Bernoulli b[aS9P]) Double
instance (CDF (Bernoulli b[aS9N]) Bool) => CDF (Bernoulli b[aS9N]) Float
instance (Distribution (Bernoulli b[aS9L]) Bool) => Distribution (Bernoulli b[aS9L]) Float
instance (CDF (Bernoulli b[aRSs]) Bool) => CDF (Bernoulli b[aRSs]) Word64
instance (Distribution (Bernoulli b[aRSq]) Bool) => Distribution (Bernoulli b[aRSq]) Word64
instance (CDF (Bernoulli b[aRSo]) Bool) => CDF (Bernoulli b[aRSo]) Word32
instance (Distribution (Bernoulli b[aRSm]) Bool) => Distribution (Bernoulli b[aRSm]) Word32
instance (CDF (Bernoulli b[aRSk]) Bool) => CDF (Bernoulli b[aRSk]) Word16
instance (Distribution (Bernoulli b[aRSi]) Bool) => Distribution (Bernoulli b[aRSi]) Word16
instance (CDF (Bernoulli b[aRSg]) Bool) => CDF (Bernoulli b[aRSg]) Word8
instance (Distribution (Bernoulli b[aRSe]) Bool) => Distribution (Bernoulli b[aRSe]) Word8
instance (CDF (Bernoulli b[aRSc]) Bool) => CDF (Bernoulli b[aRSc]) Word
instance (Distribution (Bernoulli b[aRSa]) Bool) => Distribution (Bernoulli b[aRSa]) Word
instance (CDF (Bernoulli b[aRS8]) Bool) => CDF (Bernoulli b[aRS8]) Int64
instance (Distribution (Bernoulli b[aRS6]) Bool) => Distribution (Bernoulli b[aRS6]) Int64
instance (CDF (Bernoulli b[aRS4]) Bool) => CDF (Bernoulli b[aRS4]) Int32
instance (Distribution (Bernoulli b[aRS2]) Bool) => Distribution (Bernoulli b[aRS2]) Int32
instance (CDF (Bernoulli b[aRS0]) Bool) => CDF (Bernoulli b[aRS0]) Int16
instance (Distribution (Bernoulli b[aRRY]) Bool) => Distribution (Bernoulli b[aRRY]) Int16
instance (CDF (Bernoulli b[aRRW]) Bool) => CDF (Bernoulli b[aRRW]) Int8
instance (Distribution (Bernoulli b[aRRU]) Bool) => Distribution (Bernoulli b[aRRU]) Int8
instance (CDF (Bernoulli b[aRRS]) Bool) => CDF (Bernoulli b[aRRS]) Int
instance (Distribution (Bernoulli b[aRRQ]) Bool) => Distribution (Bernoulli b[aRRQ]) Int
instance (CDF (Bernoulli b[aRRL]) Bool) => CDF (Bernoulli b[aRRL]) Integer
instance (Distribution (Bernoulli b[aRRJ]) Bool) => Distribution (Bernoulli b[aRRJ]) Integer
instance (Distribution (Bernoulli b) Bool, Real b) => CDF (Bernoulli b) Bool
instance (Fractional b, Ord b, Distribution StdUniform b) => Distribution (Bernoulli b) Bool
module Data.Random.Distribution.Categorical
-- | Construct a Categorical random variable from a list of
-- probabilities and categories, where the probabilities all sum to 1.
categorical :: (Distribution (Categorical p) a) => [(p, a)] -> RVar a
-- | Construct a Categorical random process from a list of
-- probabilities and categories, where the probabilities all sum to 1.
categoricalT :: (Distribution (Categorical p) a) => [(p, a)] -> RVarT m a
-- | Construct a Categorical distribution from a list of weighted
-- categories, where the weights do not necessarily sum to 1.
weightedCategorical :: (Fractional p) => [(p, a)] -> Categorical p a
-- | Construct a Categorical distribution from a list of observed
-- outcomes. Equivalent events will be grouped and counted, and the
-- probabilities of each event in the returned distribution will be
-- proportional to the number of occurrences of that event.
empirical :: (Fractional p, Ord a) => [a] -> Categorical p a
-- | Categorical distribution; a list of events with corresponding
-- probabilities. The sum of the probabilities must be 1, and no event
-- should have a zero or negative probability (at least, at time of
-- sampling; very clever users can do what they want with the numbers
-- before sampling, just make sure that if you're one of those clever
-- ones, you normalize before sampling).
newtype Categorical p a
Categorical :: [(p, a)] -> Categorical p a
-- | Like fmap, but for the probabilities of a categorical
-- distribution.
mapCategoricalPs :: (p -> q) -> Categorical p e -> Categorical q e
-- | Adjust all the weights of a categorical distribution so that they sum
-- to unity.
normalizeCategoricalPs :: (Fractional p) => Categorical p e -> Categorical p e
-- | Simplify a categorical distribution by combining equivalent categories
-- (the new category will have a probability equal to the sum of all the
-- originals).
collectEvents :: (Ord e, Num p, Ord p) => Categorical p e -> Categorical p e
-- | Simplify a categorical distribution by combining equivalent events
-- (the new event will have a weight equal to the sum of all the
-- originals). The comparator function is used to identify events to
-- combine. Once chosen, the events and their weights are combined by the
-- provided probability and event aggregation function.
collectEventsBy :: (e -> e -> Ordering) -> ([(p, e)] -> (p, e)) -> Categorical p e -> Categorical p e
instance (Eq p, Eq a) => Eq (Categorical p a)
instance (Show p, Show a) => Show (Categorical p a)
instance (Fractional p) => Applicative (Categorical p)
instance (Fractional p) => Monad (Categorical p)
instance Traversable (Categorical p)
instance Foldable (Categorical p)
instance Functor (Categorical p)
instance (Fractional p, Ord p, Distribution StdUniform p) => Distribution (Categorical p) a
module Data.Random.Distribution.Exponential
data Exponential a
Exp :: a -> Exponential a
floatingExponential :: (Floating a, Distribution StdUniform a) => a -> RVarT m a
floatingExponentialCDF :: (Real a) => a -> a -> Double
exponential :: (Distribution Exponential a) => a -> RVar a
exponentialT :: (Distribution Exponential a) => a -> RVarT m a
instance (Real a, Distribution Exponential a) => CDF Exponential a
instance (Floating a, Distribution StdUniform a) => Distribution Exponential a
-- | A generic "ziggurat algorithm" implementation. Fairly rough right now.
--
-- There is a lot of room for improvement in findBin0 especially.
-- It needs a fair amount of cleanup and elimination of redundant
-- calculation, as well as either a justification for using the simple
-- findMinFrom or a proper root-finding algorithm.
--
-- It would also be nice to add (preferably by pulling in an external
-- package) support for numerical integration and differentiation, so
-- that tables can be derived from only a PDF (if the end user is willing
-- to take the performance and accuracy hit for the convenience).
module Data.Random.Distribution.Ziggurat
-- | A data structure containing all the data that is needed to implement
-- Marsaglia & Tang's "ziggurat" algorithm for sampling certain kinds
-- of random distributions.
--
-- The documentation here is probably not sufficient to tell a user
-- exactly how to build one of these from scratch, but it is not really
-- intended to be. There are several helper functions that will build
-- Ziggurats. The pathologically curious may wish to read the
-- runZiggurat source. That is the ultimate specification of the
-- semantics of all these fields.
data Ziggurat v t
Ziggurat :: !v t -> !v t -> !v t -> !forall m. RVarT m (Int, t) -> (forall m. RVarT m t) -> !forall m. t -> t -> RVarT m t -> !t -> t -> !Bool -> Ziggurat v t
-- | The X locations of each bin in the distribution. Bin 0 is the
-- infinite one.
--
-- In the case of bin 0, the value given is sort of magical - x[0] is
-- defined to be V/f(R). It's not actually the location of any bin, but a
-- value computed to make the algorithm more concise and slightly faster
-- by not needing to specially-handle bin 0 quite as often. If you really
-- need to know why it works, see the runZiggurat source or "the
-- literature" - it's a fairly standard setup.
zTable_xs :: Ziggurat v t -> !v t
-- | The ratio of each bin's Y value to the next bin's Y value
zTable_y_ratios :: Ziggurat v t -> !v t
-- | The Y value (zFunc x) of each bin
zTable_ys :: Ziggurat v t -> !v t
-- | An RVar providing a random tuple consisting of:
--
--
-- - a bin index, uniform over [0,c) :: Int (where c is the
-- number of bins in the tables)
-- - a uniformly distributed fractional value, from -1 to 1 if not
-- mirrored, from 0 to 1 otherwise.
--
--
-- This is provided as a single RVar because it can be implemented
-- more efficiently than naively sampling 2 separate values - a single
-- random word (64 bits) can be efficiently converted to a double (using
-- 52 bits) and a bin number (using up to 12 bits), for example.
zGetIU :: Ziggurat v t -> !forall m. RVarT m (Int, t)
-- | The distribution for the final "virtual" bin (the ziggurat algorithm
-- does not handle distributions that wander off to infinity, so another
-- distribution is needed to handle the last "bin" that stretches to
-- infinity)
zTailDist :: Ziggurat v t -> (forall m. RVarT m t)
-- | A copy of the uniform RVar generator for the base type, so that
-- Distribution Uniform t is not needed when sampling from a
-- Ziggurat (makes it a bit more self-contained).
zUniform :: Ziggurat v t -> !forall m. t -> t -> RVarT m t
-- | The (one-sided antitone) PDF, not necessarily normalized
zFunc :: Ziggurat v t -> !t -> t
-- | A flag indicating whether the distribution should be mirrored about
-- the origin (the ziggurat algorithm it its native form only samples
-- from one-sided distributions. By mirroring, we can extend it to
-- symmetric distributions such as the normal distribution)
zMirror :: Ziggurat v t -> !Bool
-- | Build a lazy recursive ziggurat. Uses a lazily-constructed ziggurat as
-- its tail distribution (with another as its tail, ad nauseum).
--
-- Arguments:
--
--
-- - flag indicating whether to mirror the distribution
-- - the (one-sided antitone) PDF, not necessarily normalized
-- - the inverse of the PDF
-- - the integral of the PDF (definite, from 0)
-- - the estimated volume under the PDF (from 0 to +infinity)
-- - the chunk size (number of bins in each layer). 64 seems to perform
-- well in practice.
-- - an RVar providing the zGetIU random tuple
--
mkZigguratRec :: (RealFloat t, Vector v t, Distribution Uniform t) => Bool -> (t -> t) -> (t -> t) -> (t -> t) -> t -> Int -> (forall m. RVarT m (Int, t)) -> Ziggurat v t
-- | Build the tables to implement the "ziggurat algorithm" devised by
-- Marsaglia & Tang, attempting to automatically compute the R and V
-- values.
--
-- Arguments are the same as for mkZigguratRec, with an additional
-- argument for the tail distribution as a function of the selected R
-- value.
mkZiggurat :: (RealFloat t, Vector v t, Distribution Uniform t) => Bool -> (t -> t) -> (t -> t) -> (t -> t) -> t -> Int -> (forall m. RVarT m (Int, t)) -> (forall m. t -> RVarT m t) -> Ziggurat v t
-- | Build the tables to implement the "ziggurat algorithm" devised by
-- Marsaglia & Tang, attempting to automatically compute the R and V
-- values.
--
-- Arguments:
--
--
-- - flag indicating whether to mirror the distribution
-- - the (one-sided antitone) PDF, not necessarily normalized
-- - the inverse of the PDF
-- - the number of bins
-- - R, the x value of the first bin
-- - V, the volume of each bin
-- - an RVar providing the zGetIU random tuple
-- - an RVar sampling from the tail (the region where x > R)
--
mkZiggurat_ :: (RealFloat t, Vector v t, Distribution Uniform t) => Bool -> (t -> t) -> (t -> t) -> Int -> t -> t -> (forall m. RVarT m (Int, t)) -> (forall m. RVarT m t) -> Ziggurat v t
-- | I suspect this isn't completely right, but it works well so far.
-- Search the distribution for an appropriate R and V.
--
-- Arguments:
--
--
-- - Number of bins
-- - target function (one-sided antitone PDF, not necessarily
-- normalized)
-- - function inverse
-- - function definite integral (from 0 to _)
-- - estimate of total volume under function (integral from 0 to
-- infinity)
--
--
-- Result: (R,V)
findBin0 :: (RealFloat b) => Int -> (b -> b) -> (b -> b) -> (b -> b) -> b -> (b, b)
-- | Sample from the distribution encoded in a Ziggurat data
-- structure.
runZiggurat :: (Num a, Ord a, Vector v a) => Ziggurat v a -> RVarT m a
instance (Num t, Ord t, Vector v t) => Distribution (Ziggurat v) t
module Data.Random.Distribution.Normal
-- | A specification of a normal distribution over the type a.
data Normal a
-- | The "standard" normal distribution - mean 0, stddev 1
StdNormal :: Normal a
-- | Normal m s is a normal distribution with mean m and
-- stddev sd.
Normal :: a -> a -> Normal a
-- | normal m s is a random variable with distribution
-- Normal m s.
normal :: (Distribution Normal a) => a -> a -> RVar a
-- | normalT m s is a random process with distribution
-- Normal m s.
normalT :: (Distribution Normal a) => a -> a -> RVarT m a
-- | stdNormal is a normal variable with distribution
-- StdNormal.
stdNormal :: (Distribution Normal a) => RVar a
-- | stdNormalT is a normal process with distribution
-- StdNormal.
stdNormalT :: (Distribution Normal a) => RVarT m a
-- | A random variable sampling from the standard normal distribution over
-- the Double type.
doubleStdNormal :: RVarT m Double
-- | A random variable sampling from the standard normal distribution over
-- the Float type.
floatStdNormal :: RVarT m Float
-- | A random variable sampling from the standard normal distribution over
-- any RealFloat type (subject to the rest of the constraints - it
-- builds and uses a Ziggurat internally, which requires the
-- Erf class).
--
-- Because it computes a Ziggurat, it is very expensive to use for
-- just one evaluation, or even for multiple evaluations if not used and
-- reused monomorphically (to enable the ziggurat table to be let-floated
-- out). If you don't know whether your use case fits this description
-- then you're probably better off using a different algorithm, such as
-- boxMullerNormalPair or knuthPolarNormalPair. And of
-- course if you don't need the full generality of this definition then
-- you're much better off using doubleStdNormal or
-- floatStdNormal.
--
-- As far as I know, this should be safe to use in any monomorphic
-- Distribution Normal instance declaration.
realFloatStdNormal :: (RealFloat a, Erf a, Distribution Uniform a) => RVarT m a
-- | Draw from the tail of a normal distribution (the region beyond the
-- provided value)
normalTail :: (Distribution StdUniform a, Floating a, Ord a) => a -> RVarT m a
-- | A random variable that produces a pair of independent
-- normally-distributed values.
normalPair :: (Floating a, Distribution StdUniform a) => RVar (a, a)
-- | A random variable that produces a pair of independent
-- normally-distributed values, computed using the Box-Muller method.
-- This algorithm is slightly slower than Knuth's method but using a
-- constant amount of entropy (Knuth's method is a rejection method). It
-- is also slightly more general (Knuth's method require an Ord
-- instance).
boxMullerNormalPair :: (Floating a, Distribution StdUniform a) => RVar (a, a)
-- | A random variable that produces a pair of independent
-- normally-distributed values, computed using Knuth's polar method.
-- Slightly faster than boxMullerNormalPair when it accepts on the
-- first try, but does not always do so.
knuthPolarNormalPair :: (Floating a, Ord a, Distribution Uniform a) => RVar (a, a)
instance (Real a, Distribution Normal a) => CDF Normal a
instance Distribution Normal Float
instance Distribution Normal Double
module Data.Random.Distribution.Gamma
data Gamma a
Gamma :: a -> a -> Gamma a
gamma :: (Distribution Gamma a) => a -> a -> RVar a
gammaT :: (Distribution Gamma a) => a -> a -> RVarT m a
data Erlang a b
Erlang :: a -> Erlang a b
erlang :: (Distribution (Erlang a) b) => a -> RVar b
erlangT :: (Distribution (Erlang a) b) => a -> RVarT m b
-- | derived from Marsaglia & Tang, A Simple Method for generating
-- gamma variables, ACM Transactions on Mathematical Software, Vol
-- 26, No 3 (2000), p363-372.
mtGamma :: (Floating a, Ord a, Distribution StdUniform a, Distribution Normal a) => a -> a -> RVarT m a
instance (Integral a, Floating b, Ord b, Distribution Normal b, Distribution StdUniform b) => Distribution (Erlang a) b
instance (Floating a, Ord a, Distribution Normal a, Distribution StdUniform a) => Distribution Gamma a
-- | Flexible modeling and sampling of random variables.
--
-- The central abstraction in this library is the concept of a random
-- variable. It is not fully formalized in the standard measure-theoretic
-- language, but rather is informally defined as a "thing you can get
-- random values out of". Different random variables may have different
-- types of values they can return or the same types but different
-- probabilities for each value they can return. The random values you
-- get out of them are traditionally called "random variates".
--
-- Most imperative-language random number libraries are all about
-- obtaining and manipulating random variates. This one is about
-- defining, manipulating and sampling random variables. Computationally,
-- the distinction is small and mostly just a matter of perspective, but
-- from a program design perspective it provides both a powerfully
-- composable abstraction and a very useful separation of concerns.
--
-- Abstract random variables as implemented by RVar are
-- composable. They can be defined in a monadic / "imperative" style that
-- amounts to manipulating variates, but with strict type-level
-- isolation. Concrete random variables are also provided, but they do
-- not compose as generically. The Distribution type class allows
-- concrete random variables to "forget" their concreteness so that they
-- can be composed. For examples of both, see the documentation for
-- RVar and Distribution, as well as the code for any of
-- the concrete distributions such as Uniform, Gamma, etc.
--
-- Both abstract and concrete random variables can be sampled (despite
-- the types GHCi may list for the functions) by the functions in
-- Data.Random.Sample.
--
-- Random variable sampling is done with regard to a generic basis of
-- primitive random variables defined in
-- Data.Random.Internal.Primitives. This basis is very low-level
-- and the actual set of primitives is still fairly experimental, which
-- is why it is in the "Internal" sub-heirarchy. User-defined variables
-- should use the existing high-level variables such as Uniform
-- and Normal rather than these basis variables.
-- Data.Random.Source defines classes for entropy sources that
-- provide implementations of these primitive variables. Several
-- implementations are available in the Data.Random.Source.* modules.
module Data.Random
-- | An opaque type modeling a "random variable" - a value which depends on
-- the outcome of some random event. RVars can be conveniently
-- defined by an imperative-looking style:
--
--
-- normalPair = do
-- u <- stdUniform
-- t <- stdUniform
-- let r = sqrt (-2 * log u)
-- theta = (2 * pi) * t
--
-- x = r * cos theta
-- y = r * sin theta
-- return (x,y)
--
--
-- OR by a more applicative style:
--
--
-- logNormal = exp <$> stdNormal
--
--
-- Once defined (in any style), there are several ways to sample
-- RVars:
--
--
--
--
-- sampleFrom DevRandom (uniform 1 100) :: IO Int
--
--
--
--
--
-- sample (uniform 1 100) :: State PureMT Int
--
--
--
-- - As a pure function transforming a functional RNG:
--
--
--
-- sampleState (uniform 1 100) :: StdGen -> (Int, StdGen)
--
type RVar = RVarT Identity
-- | A random variable with access to operations in an underlying monad.
-- Useful examples include any form of state for implementing random
-- processes with hysteresis, or writer monads for implementing tracing
-- of complicated algorithms.
--
-- For example, a simple random walk can be implemented as an
-- RVarT IO value:
--
--
-- rwalkIO :: IO (RVarT IO Double)
-- rwalkIO d = do
-- lastVal <- newIORef 0
--
-- let x = do
-- prev <- lift (readIORef lastVal)
-- change <- rvarT StdNormal
--
-- let new = prev + change
-- lift (writeIORef lastVal new)
-- return new
--
-- return x
--
--
-- To run the random walk, it must first be initialized, and then it can
-- be sampled as usual:
--
--
-- do
-- rw <- rwalkIO
-- x <- sampleFrom DevURandom rw
-- y <- sampleFrom DevURandom rw
-- ...
--
--
-- The same random-walk process as above can be implemented using MTL
-- types as follows (using import Control.Monad.Trans as MTL):
--
--
-- rwalkState :: RVarT (State Double) Double
-- rwalkState = do
-- prev <- MTL.lift get
-- change <- rvarT StdNormal
--
-- let new = prev + change
-- MTL.lift (put new)
-- return new
--
--
-- Invocation is straightforward (although a bit noisy) if you're used to
-- MTL, but there is a gotcha lurking here: sample and
-- runRVarT inherit the extreme generality of lift, so
-- there will almost always need to be an explicit type signature lurking
-- somewhere in any client code making use of RVarT with MTL
-- types. In this example, the inferred type of start would be
-- too general to be practical, so the signature for rwalk
-- explicitly fixes it to Double. Alternatively, in this case
-- sample could be replaced with \x -> runRVarTWith
-- MTL.lift x StdRandom.
--
--
-- rwalk :: Int -> Double -> StdGen -> ([Double], StdGen)
-- rwalk count start gen = evalState (runStateT (sample (replicateM count rwalkState)) gen) start
--
data RVarT m a
-- | "Run" an RVar - samples the random variable from the provided
-- source of entropy. Typically sample, sampleFrom or
-- sampleState will be more convenient to use.
runRVar :: (RandomSource m s) => RVar a -> s -> m a
-- | "Runs" an RVarT, sampling the random variable it defines.
--
-- The Lift context allows random variables to be defined using a
-- minimal underlying functor (Identity is sufficient for
-- "conventional" random variables) and then sampled in any monad into
-- which the underlying functor can be embedded (which, for
-- Identity, is all monads).
--
-- The lifting is very important - without it, every RVar would
-- have to either be given access to the full capability of the monad in
-- which it will eventually be sampled (which, incidentally, would also
-- have to be monomorphic so you couldn't sample one RVar in more
-- than one monad) or functions manipulating RVars would have to
-- use higher-ranked types to enforce the same kind of isolation and
-- polymorphism.
--
-- For non-standard liftings or those where you would rather not
-- introduce a Lift instance, see runRVarTWith.
runRVarT :: (Lift n m, RandomSource m s) => RVarT n a -> s -> m a
-- | Like runRVarT but allowing a user-specified lift operation.
-- This operation must obey the "monad transformer" laws:
--
--
-- lift . return = return
-- lift (x >>= f) = (lift x) >>= (lift . f)
--
--
-- One example of a useful non-standard lifting would be one that takes
-- State s to another monad with a different state
-- representation (such as IO with the state mapped to an
-- IORef):
--
--
-- embedState :: (Monad m) => m s -> (s -> m ()) -> State s a -> m a
-- embedState get put = \m -> do
-- s <- get
-- (res,s) <- return (runState m s)
-- put s
-- return res
--
runRVarTWith :: (RandomSource m s) => (forall t. n t -> m t) -> RVarT n a -> s -> m a
-- | A Distribution is a data representation of a random variable's
-- probability structure. For example, in
-- Data.Random.Distribution.Normal, the Normal
-- distribution is defined as:
--
--
-- data Normal a
-- = StdNormal
-- | Normal a a
--
--
-- Where the two parameters of the Normal data constructor are
-- the mean and standard deviation of the random variable, respectively.
-- To make use of the Normal type, one can convert it to an
-- rvar and manipulate it or sample it directly:
--
--
-- x <- sample (rvar (Normal 10 2))
-- x <- sample (Normal 10 2)
--
--
-- A Distribution is typically more transparent than an
-- RVar but less composable (precisely because of that
-- transparency). There are several practical uses for types implementing
-- Distribution:
--
--
-- - Typically, a Distribution will expose several parameters of
-- a standard mathematical model of a probability distribution, such as
-- mean and std deviation for the normal distribution. Thus, they can be
-- manipulated analytically using mathematical insights about the
-- distributions they represent. For example, a collection of bernoulli
-- variables could be simplified into a (hopefully) smaller collection of
-- binomial variables.
-- - Because they are generally just containers for parameters, they
-- can be easily serialized to persistent storage or read from
-- user-supplied configurations (eg, initialization data for a
-- simulation).
-- - If a type additionally implements the CDF subclass, which
-- extends Distribution with a cumulative density function, an
-- arbitrary random variable x can be tested against the
-- distribution by testing fmap (cdf dist) x for
-- uniformity.
--
--
-- On the other hand, most Distributions will not be closed under
-- all the same operations as RVar (which, being a monad, has a
-- fully turing-complete internal computational model). The sum of two
-- uniformly-distributed variables, for example, is not uniformly
-- distributed. To support general composition, the Distribution
-- class defines a function rvar to construct the more-abstract
-- and more-composable RVar representation of a random variable.
class Distribution d t
rvar :: (Distribution d t) => d t -> RVar t
rvarT :: (Distribution d t) => d t -> RVarT n t
class (Distribution d t) => CDF d t
cdf :: (CDF d t) => d t -> t -> Double
-- | A typeclass allowing Distributions and RVars to be
-- sampled. Both may also be sampled via runRVar or
-- runRVarT, but I find it psychologically pleasing to be able to
-- sample both using this function, as they are two separate abstractions
-- for one base concept: a random variable.
class Sampleable d m t
sampleFrom :: (Sampleable d m t, RandomSource m s) => s -> d t -> m t
-- | Sample a random variable using the default source of entropy for the
-- monad in which the sampling occurs.
sample :: (Sampleable d m t, MonadRandom m) => d t -> m t
-- | Sample a random variable in a "functional" style. Typical
-- instantiations of s are System.Random.StdGen or
-- System.Random.Mersenne.Pure64.PureMT.
sampleState :: (Sampleable d (State s) t, MonadRandom (State s)) => d t -> s -> (t, s)
-- | Sample a random variable in a "semi-functional" style. Typical
-- instantiations of s are System.Random.StdGen or
-- System.Random.Mersenne.Pure64.PureMT.
sampleStateT :: (Sampleable d (StateT s m) t, MonadRandom (StateT s m)) => d t -> s -> m (t, s)
-- | A definition of a uniform distribution over the type t. See
-- also uniform.
data Uniform t
-- | A uniform distribution defined by a lower and upper range bound. For
-- Integral and Enum types, the range is inclusive. For
-- Fractional types the range includes the lower bound but not the
-- upper.
Uniform :: !t -> !t -> Uniform t
uniform :: (Distribution Uniform a) => a -> a -> RVar a
uniformT :: (Distribution Uniform a) => a -> a -> RVarT m a
-- | A name for the "standard" uniform distribution over the type
-- t, if one exists. See also stdUniform.
--
-- For Integral and Enum types that are also
-- Bounded, this is the uniform distribution over the full range
-- of the type. For un-Bounded Integral types this is not
-- defined. For Fractional types this is a random variable in the
-- range [0,1) (that is, 0 to 1 including 0 but not including 1).
data StdUniform t
StdUniform :: StdUniform t
-- | Get a "standard" uniformly distributed variable. For integral types,
-- this means uniformly distributed over the full range of the type
-- (there is no support for Integer). For fractional types, this
-- means uniformly distributed on the interval [0,1).
stdUniform :: (Distribution StdUniform a) => RVar a
-- | Get a "standard" uniformly distributed process. For integral types,
-- this means uniformly distributed over the full range of the type
-- (there is no support for Integer). For fractional types, this
-- means uniformly distributed on the interval [0,1).
stdUniformT :: (Distribution StdUniform a) => RVarT m a
-- | A specification of a normal distribution over the type a.
data Normal a
-- | The "standard" normal distribution - mean 0, stddev 1
StdNormal :: Normal a
-- | Normal m s is a normal distribution with mean m and
-- stddev sd.
Normal :: a -> a -> Normal a
-- | normal m s is a random variable with distribution
-- Normal m s.
normal :: (Distribution Normal a) => a -> a -> RVar a
-- | stdNormal is a normal variable with distribution
-- StdNormal.
stdNormal :: (Distribution Normal a) => RVar a
-- | normalT m s is a random process with distribution
-- Normal m s.
normalT :: (Distribution Normal a) => a -> a -> RVarT m a
-- | stdNormalT is a normal process with distribution
-- StdNormal.
stdNormalT :: (Distribution Normal a) => RVarT m a
data Gamma a
Gamma :: a -> a -> Gamma a
gamma :: (Distribution Gamma a) => a -> a -> RVar a
gammaT :: (Distribution Gamma a) => a -> a -> RVarT m a
-- | 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.
--
-- Occasionally one might want a RandomSource specifying the
-- MonadRandom instance (for example, when using
-- runRVar). For those cases,
-- Data.Random.Source.Std.StdRandom provides a
-- RandomSource that maps to the MonadRandom instance.
--
-- For example, State StdGen has a MonadRandom instance,
-- so to run an RVar (called x in this example) in this
-- monad one could write runRVar x StdRandom (or more concisely
-- with the sample function: sample x).
class (Monad m) => MonadRandom m
-- | A source of entropy which can be used in the given monad.
--
-- See also MonadRandom.
class (Monad m) => RandomSource m s
-- | A token representing the "standard" entropy source in a
-- MonadRandom monad. Its sole purpose is to make the following
-- true (when the types check):
--
--
-- sampleFrom StdRandom === sample
--
data StdRandom
StdRandom :: StdRandom
-- | A random variable returning an arbitrary element of the given list.
-- Every element has equal probability of being chosen. Because it is a
-- pure RVar it has no memory - that is, it "draws with
-- replacement."
randomElement :: [a] -> RVar a
-- | A random variable that returns the given list in an arbitrary shuffled
-- order. Every ordering of the list has equal probability.
shuffle :: [a] -> RVar [a]
-- | A random variable that shuffles a list of a known length (or a list
-- prefix of the specified length). Useful for shuffling large lists when
-- the length is known in advance. Avoids needing to traverse the list to
-- discover its length. Each ordering has equal probability.
shuffleN :: Int -> [a] -> RVar [a]
-- | A random variable that selects N arbitrary elements of a list of known
-- length M.
shuffleNofM :: Int -> Int -> [a] -> RVar [a]
module Data.Random.Distribution.Beta
fractionalBeta :: (Fractional a, Distribution Gamma a, Distribution StdUniform a) => a -> a -> RVarT m a
beta :: (Distribution Beta a) => a -> a -> RVar a
betaT :: (Distribution Beta a) => a -> a -> RVarT m a
data Beta a
Beta :: a -> a -> Beta a
instance Distribution Beta Double
instance Distribution Beta Float
module Data.Random.Distribution.Binomial
integralBinomial :: (Integral a, Floating b, Ord b, Distribution Beta b, Distribution StdUniform b) => a -> b -> RVarT m a
integralBinomialCDF :: (Integral a, Real b) => a -> b -> a -> Double
floatingBinomial :: (RealFrac a, Distribution (Binomial b) Integer) => a -> b -> RVar a
floatingBinomialCDF :: (CDF (Binomial b) Integer, RealFrac a) => a -> b -> a -> Double
binomial :: (Distribution (Binomial b) a) => a -> b -> RVar a
binomialT :: (Distribution (Binomial b) a) => a -> b -> RVarT m a
data Binomial b a
Binomial :: a -> b -> Binomial b a
instance (CDF (Binomial b[a1d6d]) Integer) => CDF (Binomial b[a1d6d]) Double
instance (Distribution (Binomial b[a1d6a]) Integer) => Distribution (Binomial b[a1d6a]) Double
instance (CDF (Binomial b[a1d67]) Integer) => CDF (Binomial b[a1d67]) Float
instance (Distribution (Binomial b[a1d64]) Integer) => Distribution (Binomial b[a1d64]) Float
instance (Real b[a1cLt], Distribution (Binomial b[a1cLt]) Word64) => CDF (Binomial b[a1cLt]) Word64
instance (Floating b[a1cLq], Ord b[a1cLq], Distribution Beta b[a1cLq], Distribution StdUniform b[a1cLq]) => Distribution (Binomial b[a1cLq]) Word64
instance (Real b[a1cLn], Distribution (Binomial b[a1cLn]) Word32) => CDF (Binomial b[a1cLn]) Word32
instance (Floating b[a1cLk], Ord b[a1cLk], Distribution Beta b[a1cLk], Distribution StdUniform b[a1cLk]) => Distribution (Binomial b[a1cLk]) Word32
instance (Real b[a1cLh], Distribution (Binomial b[a1cLh]) Word16) => CDF (Binomial b[a1cLh]) Word16
instance (Floating b[a1cLe], Ord b[a1cLe], Distribution Beta b[a1cLe], Distribution StdUniform b[a1cLe]) => Distribution (Binomial b[a1cLe]) Word16
instance (Real b[a1cLb], Distribution (Binomial b[a1cLb]) Word8) => CDF (Binomial b[a1cLb]) Word8
instance (Floating b[a1cL8], Ord b[a1cL8], Distribution Beta b[a1cL8], Distribution StdUniform b[a1cL8]) => Distribution (Binomial b[a1cL8]) Word8
instance (Real b[a1cL5], Distribution (Binomial b[a1cL5]) Word) => CDF (Binomial b[a1cL5]) Word
instance (Floating b[a1cL2], Ord b[a1cL2], Distribution Beta b[a1cL2], Distribution StdUniform b[a1cL2]) => Distribution (Binomial b[a1cL2]) Word
instance (Real b[a1cKZ], Distribution (Binomial b[a1cKZ]) Int64) => CDF (Binomial b[a1cKZ]) Int64
instance (Floating b[a1cKW], Ord b[a1cKW], Distribution Beta b[a1cKW], Distribution StdUniform b[a1cKW]) => Distribution (Binomial b[a1cKW]) Int64
instance (Real b[a1cKT], Distribution (Binomial b[a1cKT]) Int32) => CDF (Binomial b[a1cKT]) Int32
instance (Floating b[a1cKQ], Ord b[a1cKQ], Distribution Beta b[a1cKQ], Distribution StdUniform b[a1cKQ]) => Distribution (Binomial b[a1cKQ]) Int32
instance (Real b[a1cKN], Distribution (Binomial b[a1cKN]) Int16) => CDF (Binomial b[a1cKN]) Int16
instance (Floating b[a1cKK], Ord b[a1cKK], Distribution Beta b[a1cKK], Distribution StdUniform b[a1cKK]) => Distribution (Binomial b[a1cKK]) Int16
instance (Real b[a1cKH], Distribution (Binomial b[a1cKH]) Int8) => CDF (Binomial b[a1cKH]) Int8
instance (Floating b[a1cKE], Ord b[a1cKE], Distribution Beta b[a1cKE], Distribution StdUniform b[a1cKE]) => Distribution (Binomial b[a1cKE]) Int8
instance (Real b[a1cKB], Distribution (Binomial b[a1cKB]) Int) => CDF (Binomial b[a1cKB]) Int
instance (Floating b[a1cKy], Ord b[a1cKy], Distribution Beta b[a1cKy], Distribution StdUniform b[a1cKy]) => Distribution (Binomial b[a1cKy]) Int
instance (Real b[a1cKv], Distribution (Binomial b[a1cKv]) Integer) => CDF (Binomial b[a1cKv]) Integer
instance (Floating b[a1cKs], Ord b[a1cKs], Distribution Beta b[a1cKs], Distribution StdUniform b[a1cKs]) => Distribution (Binomial b[a1cKs]) Integer
module Data.Random.Distribution.Multinomial
multinomial :: (Distribution (Multinomial p) [a]) => [p] -> a -> RVar [a]
multinomialT :: (Distribution (Multinomial p) [a]) => [p] -> a -> RVarT m [a]
data Multinomial p a
Multinomial :: [p] -> a -> Multinomial p [a]
instance (Num a, Fractional p, Distribution (Binomial p) a) => Distribution (Multinomial p) [a]
module Data.Random.Distribution.Dirichlet
fractionalDirichlet :: (Fractional a, Distribution Gamma a) => [a] -> RVarT m [a]
dirichlet :: (Distribution Dirichlet [a]) => [a] -> RVar [a]
dirichletT :: (Distribution Dirichlet [a]) => [a] -> RVarT m [a]
newtype Dirichlet a
Dirichlet :: a -> Dirichlet a
instance (Eq a) => Eq (Dirichlet a)
instance (Show a) => Show (Dirichlet a)
instance (Fractional a, Distribution Gamma a) => Distribution Dirichlet [a]
module Data.Random.Distribution.Poisson
integralPoisson :: (Integral a, RealFloat b, Distribution StdUniform b, Distribution (Erlang a) b, Distribution (Binomial b) a) => b -> RVarT m a
integralPoissonCDF :: (Integral a, Real b) => b -> a -> Double
fractionalPoisson :: (Num a, Distribution (Poisson b) Integer) => b -> RVarT m a
fractionalPoissonCDF :: (CDF (Poisson b) Integer, RealFrac a) => b -> a -> Double
poisson :: (Distribution (Poisson b) a) => b -> RVar a
poissonT :: (Distribution (Poisson b) a) => b -> RVarT m a
data Poisson b a
Poisson :: b -> Poisson b a
instance (CDF (Poisson b[a1j5N]) Integer) => CDF (Poisson b[a1j5N]) Double
instance (Distribution (Poisson b[a1j5L]) Integer) => Distribution (Poisson b[a1j5L]) Double
instance (CDF (Poisson b[a1j5J]) Integer) => CDF (Poisson b[a1j5J]) Float
instance (Distribution (Poisson b[a1j5H]) Integer) => Distribution (Poisson b[a1j5H]) Float
instance (Real b[a1iFa], Distribution (Poisson b[a1iFa]) Word64) => CDF (Poisson b[a1iFa]) Word64
instance (RealFloat b[a1iF8], Distribution StdUniform b[a1iF8], Distribution (Erlang Word64) b[a1iF8], Distribution (Binomial b[a1iF8]) Word64) => Distribution (Poisson b[a1iF8]) Word64
instance (Real b[a1iF6], Distribution (Poisson b[a1iF6]) Word32) => CDF (Poisson b[a1iF6]) Word32
instance (RealFloat b[a1iF4], Distribution StdUniform b[a1iF4], Distribution (Erlang Word32) b[a1iF4], Distribution (Binomial b[a1iF4]) Word32) => Distribution (Poisson b[a1iF4]) Word32
instance (Real b[a1iF2], Distribution (Poisson b[a1iF2]) Word16) => CDF (Poisson b[a1iF2]) Word16
instance (RealFloat b[a1iF0], Distribution StdUniform b[a1iF0], Distribution (Erlang Word16) b[a1iF0], Distribution (Binomial b[a1iF0]) Word16) => Distribution (Poisson b[a1iF0]) Word16
instance (Real b[a1iEY], Distribution (Poisson b[a1iEY]) Word8) => CDF (Poisson b[a1iEY]) Word8
instance (RealFloat b[a1iEW], Distribution StdUniform b[a1iEW], Distribution (Erlang Word8) b[a1iEW], Distribution (Binomial b[a1iEW]) Word8) => Distribution (Poisson b[a1iEW]) Word8
instance (Real b[a1iEU], Distribution (Poisson b[a1iEU]) Word) => CDF (Poisson b[a1iEU]) Word
instance (RealFloat b[a1iES], Distribution StdUniform b[a1iES], Distribution (Erlang Word) b[a1iES], Distribution (Binomial b[a1iES]) Word) => Distribution (Poisson b[a1iES]) Word
instance (Real b[a1iEQ], Distribution (Poisson b[a1iEQ]) Int64) => CDF (Poisson b[a1iEQ]) Int64
instance (RealFloat b[a1iEO], Distribution StdUniform b[a1iEO], Distribution (Erlang Int64) b[a1iEO], Distribution (Binomial b[a1iEO]) Int64) => Distribution (Poisson b[a1iEO]) Int64
instance (Real b[a1iEM], Distribution (Poisson b[a1iEM]) Int32) => CDF (Poisson b[a1iEM]) Int32
instance (RealFloat b[a1iEK], Distribution StdUniform b[a1iEK], Distribution (Erlang Int32) b[a1iEK], Distribution (Binomial b[a1iEK]) Int32) => Distribution (Poisson b[a1iEK]) Int32
instance (Real b[a1iEI], Distribution (Poisson b[a1iEI]) Int16) => CDF (Poisson b[a1iEI]) Int16
instance (RealFloat b[a1iEG], Distribution StdUniform b[a1iEG], Distribution (Erlang Int16) b[a1iEG], Distribution (Binomial b[a1iEG]) Int16) => Distribution (Poisson b[a1iEG]) Int16
instance (Real b[a1iEE], Distribution (Poisson b[a1iEE]) Int8) => CDF (Poisson b[a1iEE]) Int8
instance (RealFloat b[a1iEC], Distribution StdUniform b[a1iEC], Distribution (Erlang Int8) b[a1iEC], Distribution (Binomial b[a1iEC]) Int8) => Distribution (Poisson b[a1iEC]) Int8
instance (Real b[a1iEA], Distribution (Poisson b[a1iEA]) Int) => CDF (Poisson b[a1iEA]) Int
instance (RealFloat b[a1iEy], Distribution StdUniform b[a1iEy], Distribution (Erlang Int) b[a1iEy], Distribution (Binomial b[a1iEy]) Int) => Distribution (Poisson b[a1iEy]) Int
instance (Real b[a1iEw], Distribution (Poisson b[a1iEw]) Integer) => CDF (Poisson b[a1iEw]) Integer
instance (RealFloat b[a1iEu], Distribution StdUniform b[a1iEu], Distribution (Erlang Integer) b[a1iEu], Distribution (Binomial b[a1iEu]) Integer) => Distribution (Poisson b[a1iEu]) Integer
module Data.Random.Distribution.Rayleigh
floatingRayleigh :: (Floating a, Distribution StdUniform a) => a -> RVarT m a
-- | The rayleigh distribution with a specified mode ("sigma") parameter.
-- Its mean will be sigma*sqrt(pi2)@ and its variance will be
-- @sigma^2*(4-pi)2
--
-- (therefore if you want one with a particular mean m,
-- sigma should be m*sqrt(2/pi))
newtype Rayleigh a
Rayleigh :: a -> Rayleigh a
rayleigh :: (Distribution Rayleigh a) => a -> RVar a
rayleighT :: (Distribution Rayleigh a) => a -> RVarT m a
rayleighCDF :: (Real a) => a -> a -> Double
instance (Real a, Distribution Rayleigh a) => CDF Rayleigh a
instance (RealFloat a, Distribution StdUniform a) => Distribution Rayleigh a
module Data.Random.Distribution.Triangular
-- | A description of a triangular distribution - a distribution whose PDF
-- is a triangle ramping up from a lower bound to a specified midpoint
-- and back down to the upper bound. This is a very simple distribution
-- that does not generally occur naturally but is used sometimes as an
-- estimate of a true distribution when only the range of the values and
-- an approximate mode of the true distribution are known.
data Triangular a
Triangular :: a -> a -> a -> Triangular a
-- | The lower bound of the triangle in the PDF (the smallest number the
-- distribution can generate)
triLower :: Triangular a -> a
-- | The midpoint of the triangle (also the mode of the distribution)
triMid :: Triangular a -> a
-- | The upper bound of the triangle (and the largest number the
-- distribution can generate)
triUpper :: Triangular a -> a
-- | Compute a triangular distribution for a Floating type.
floatingTriangular :: (Floating a, Ord a, Distribution StdUniform a) => a -> a -> a -> RVarT m a
-- | triangularCDF a b c is the CDF of realFloatTriangular a b
-- c.
triangularCDF :: (RealFrac a) => a -> a -> a -> a -> Double
instance (Eq a) => Eq (Triangular a)
instance (Show a) => Show (Triangular a)
instance (RealFrac a, Distribution Triangular a) => CDF Triangular a
instance (RealFloat a, Ord a, Distribution StdUniform a) => Distribution Triangular a