Game.LambdaHack.Common.Frequency

A list of items with relative frequencies of appearance.

The Frequency type

data Frequency a

The frequency distribution type. Not normalized (operations may or may not group the same elements and sum their frequencies). However, elements with zero frequency are removed upon construction.

The Eq instance compares raw representations, not relative, normalized frequencies, so operations don't need to preserve the expected equalities, unless they do some kind of normalization (see Dice).

Instances

Alternative Frequency

Monad Frequency

Functor Frequency

Num SimpleDice

MonadPlus Frequency

Applicative Frequency

Foldable Frequency

Traversable Frequency

Eq a => Eq (Frequency a)

Ord a => Ord (Frequency a)

Read a => Read (Frequency a)

Show a => Show (Frequency a)

Generic (Frequency a)

Binary a => Binary (Frequency a)

NFData a => NFData (Frequency a)

Hashable a => Hashable (Frequency a)

type Rep (Frequency a)

Construction

uniformFreq :: Text -> [a] -> Frequency a

Uniform discrete frequency distribution.

toFreq :: Text -> [(Int, a)] -> Frequency a

Takes a name and a list of frequencies and items into the frequency distribution.

Transformation

scaleFreq :: Show a => Int -> Frequency a -> Frequency a

Scale frequency distribution, multiplying it by a positive integer constant.

renameFreq :: Text -> Frequency a -> Frequency a

Change the description of the frequency.

setFreq :: Eq a => Frequency a -> a -> Int -> Frequency a

Set frequency of an element.

Consumption

nullFreq :: Frequency a -> Bool

Test if the frequency distribution is empty.

runFrequency :: Frequency a -> [(Int, a)]

give acces to raw frequency values

nameFrequency :: Frequency a -> Text

short description for debug, etc.; keep it lazy, because it's rarely used

maxFreq :: Ord a => Frequency a -> Maybe a

minFreq :: Ord a => Frequency a -> Maybe a

meanFreq :: Frequency Int -> Int

Average value of an Int distribution, rounded up to avoid truncating it in the other code higher up, which would equate 1d0 with 1d1.