Game.LambdaHack.Core.Frequency

A list of entities 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 less than 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.

Instances

Monad Frequency

Defined in Game.LambdaHack.Core.Frequency

Methods

(>>=) :: Frequency a -> (a -> Frequency b) -> Frequency b

(>>) :: Frequency a -> Frequency b -> Frequency b

return :: a -> Frequency a

Functor Frequency

Defined in Game.LambdaHack.Core.Frequency

Methods

fmap :: (a -> b) -> Frequency a -> Frequency b

(<$) :: a -> Frequency b -> Frequency a

Applicative Frequency

Defined in Game.LambdaHack.Core.Frequency

Methods

pure :: a -> Frequency a

(<*>) :: Frequency (a -> b) -> Frequency a -> Frequency b

liftA2 :: (a -> b -> c) -> Frequency a -> Frequency b -> Frequency c

(*>) :: Frequency a -> Frequency b -> Frequency b

(<*) :: Frequency a -> Frequency b -> Frequency a

Foldable Frequency

Defined in Game.LambdaHack.Core.Frequency

Methods

fold :: Monoid m => Frequency m -> m

foldMap :: Monoid m => (a -> m) -> Frequency a -> m

foldMap' :: Monoid m => (a -> m) -> Frequency a -> m

foldr :: (a -> b -> b) -> b -> Frequency a -> b

foldr' :: (a -> b -> b) -> b -> Frequency a -> b

foldl :: (b -> a -> b) -> b -> Frequency a -> b

foldl' :: (b -> a -> b) -> b -> Frequency a -> b

foldr1 :: (a -> a -> a) -> Frequency a -> a

foldl1 :: (a -> a -> a) -> Frequency a -> a

toList :: Frequency a -> [a]

null :: Frequency a -> Bool

length :: Frequency a -> Int

elem :: Eq a => a -> Frequency a -> Bool

maximum :: Ord a => Frequency a -> a

minimum :: Ord a => Frequency a -> a

sum :: Num a => Frequency a -> a

product :: Num a => Frequency a -> a

Traversable Frequency

Defined in Game.LambdaHack.Core.Frequency

Methods

traverse :: Applicative f => (a -> f b) -> Frequency a -> f (Frequency b)

sequenceA :: Applicative f => Frequency (f a) -> f (Frequency a)

mapM :: Monad m => (a -> m b) -> Frequency a -> m (Frequency b)

sequence :: Monad m => Frequency (m a) -> m (Frequency a)

Alternative Frequency

Defined in Game.LambdaHack.Core.Frequency

Methods

empty :: Frequency a

(<|>) :: Frequency a -> Frequency a -> Frequency a

some :: Frequency a -> Frequency [a]

many :: Frequency a -> Frequency [a]

MonadPlus Frequency

Defined in Game.LambdaHack.Core.Frequency

Methods

mzero :: Frequency a

mplus :: Frequency a -> Frequency a -> Frequency a

Eq a => Eq (Frequency a)

Defined in Game.LambdaHack.Core.Frequency

Methods

(==) :: Frequency a -> Frequency a -> Bool

(/=) :: Frequency a -> Frequency a -> Bool

Ord a => Ord (Frequency a)

Defined in Game.LambdaHack.Core.Frequency

Methods

compare :: Frequency a -> Frequency a -> Ordering

(<) :: Frequency a -> Frequency a -> Bool

(<=) :: Frequency a -> Frequency a -> Bool

(>) :: Frequency a -> Frequency a -> Bool

(>=) :: Frequency a -> Frequency a -> Bool

max :: Frequency a -> Frequency a -> Frequency a

min :: Frequency a -> Frequency a -> Frequency a

Show a => Show (Frequency a)

Defined in Game.LambdaHack.Core.Frequency

Methods

showsPrec :: Int -> Frequency a -> ShowS

show :: Frequency a -> String

showList :: [Frequency a] -> ShowS

Generic (Frequency a)

Defined in Game.LambdaHack.Core.Frequency

Associated Types

type Rep (Frequency a) :: Type -> Type

Methods

from :: Frequency a -> Rep (Frequency a) x

to :: Rep (Frequency a) x -> Frequency a

type Rep (Frequency a)

Defined in Game.LambdaHack.Core.Frequency

type Rep (Frequency a) = D1 ('MetaData "Frequency" "Game.LambdaHack.Core.Frequency" "LambdaHack-0.11.0.0-inplace" 'False) (C1 ('MetaCons "Frequency" 'PrefixI 'True) (S1 ('MetaSel ('Just "runFrequency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [(Int, a)]) :*: S1 ('MetaSel ('Just "nameFrequency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

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.

maxBoundInt32 :: Int

Transformation

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

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

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.