Modulerandom-fu-0.3.0.1Haskell2010

Data.Random.Distribution.Normal

1 type
11 values

Packagerandom-fu-0.3.0.1
Exports12
LanguageHaskell2010
LicenceLicenseRef-PublicDomain
SourceNormal.hs

datadata Normal a

A specification of a normal distribution over the type a.

Constructors

StdNormal
The "standard" normal distribution - mean 0, stddev 1
Normal a a
Normal m s is a normal distribution with mean m and stddev sd.

Instances4CDF, Distribution, PDF

(Real a, Distribution Normal a) => CDF Normal aDefined in random-fu-0.3.0.1 · Data.Random.Distribution.Normal
Distribution Normal DoubleDefined in random-fu-0.3.0.1 · Data.Random.Distribution.Normal
Distribution Normal FloatDefined in random-fu-0.3.0.1 · Data.Random.Distribution.Normal
(Real a, Floating a, Distribution Normal a) => PDF Normal aDefined in random-fu-0.3.0.1 · Data.Random.Distribution.Normal

valuenormal :: Distribution Normal a => a -> a -> RVar a

normal m s is a random variable with distribution Normal m s.

valuenormalT :: Distribution Normal a => a -> a -> RVarT m a

normalT m s is a random process with distribution Normal m s.

valuestdNormal :: Distribution Normal a => RVar a

stdNormal is a normal variable with distribution StdNormal.

valuestdNormalT :: Distribution Normal a => RVarT m a

stdNormalT is a normal process with distribution StdNormal.

valuedoubleStdNormal :: RVarT m Double

A random variable sampling from the standard normal distribution over the Double type.

valuefloatStdNormal :: RVarT m Float

A random variable sampling from the standard normal distribution over the Float type.

valuerealFloatStdNormal :: (RealFloat a, Erf a, Distribution Uniform a) => RVarT m a

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.

valuenormalTail

:: (Distribution StdUniform a, Floating a, Ord a)
=> a
-> RVarT m a

Draw from the tail of a normal distribution (the region beyond the provided value)

valuenormalPair :: (Floating a, Distribution StdUniform a) => RVar (a, a)

A random variable that produces a pair of independent normally-distributed values.

valueboxMullerNormalPair :: (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).

valueknuthPolarNormalPair :: (Floating a, Ord a, Distribution Uniform 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.