Data.Histogram.Fill

Module with algorithms for histogram filling. This is pure wrapper around stateful histograms.

Type classes & wrappers

class HBuilderCl h where

Histogram builder typeclass. Instance of this class contain instructions how to build histograms.

Methods

modifyIn :: (a' -> a) -> h a b -> h a' b

Convert input type of histogram from a to a'

modifyOut :: (b -> b') -> h a b -> h a b'

Convert output of histogram

runBuilder :: h a b -> ST s (Accum s a b)

Create stateful histogram from instructions. Histograms could be filled either in the ST monad or with createHistograms

Instances

HBuilderCl HistBuilder

HBuilderCl HBuilderList

HBuilderCl HBuilder

data HBuilder a b

Abstract histogram builder. All real builders should be wrapper in this type

Instances

HBuilderCl HBuilder

builderList :: [HBuilder a b] -> HBuilder a [b]

Wrap list of histogram builders into HBuilder.

builderListWrap :: [HBuilder a b] -> HBuilder a b

Wrap list of histogram builders into HBuilder and do not change return type.

Fill routines

createHistograms

Arguments

:: Monoid b

=> HBuilder a b

Instructions how to fill histograms

-> [a]

List of data to fill histogram with

-> b

Result

Create and fill histogram(s).

Histogram constructors

module Data.Histogram.Bin

mkHist

Arguments

:: (Bin bin, UA val, Num val)

=> bin

Bin information

-> (Histogram bin val -> b)

Output function

-> (a -> [BinValue bin])

Input function

-> HBuilder a b

Create histogram builder which take many items as input. Each item has weight 1. To set type of bin 'force*' function could be used.

mkHist1

Arguments

:: (Bin bin, UA val, Num val)

=> bin

Bin information

-> (Histogram bin val -> b)

Output function

-> (a -> BinValue bin)

Input function

-> HBuilder a b

Create histogram builder which take single item as input. Each item has weight 1. To set type of bin 'force*' function could be used.

mkHistWgh

Arguments

:: (Bin bin, UA val, Num val)

=> bin

Bin information

-> (Histogram bin val -> b)

Output function

-> (a -> [(BinValue bin, val)])

Input function

-> HBuilder a b

Create histogram with weighted bin. Takes many items at time.

mkHistWgh1

Arguments

:: (Bin bin, UA val, Num val)

=> bin

Bin information

-> (Histogram bin val -> b)

Output function

-> (a -> (BinValue bin, val))

Input function

-> HBuilder a b

Create histogram with weighted bin. Takes one item at time.

mkHistMonoid

Arguments

:: (Bin bin, UA val, Monoid val)

=> bin

Bin information

-> (Histogram bin val -> b)

Output function

-> (a -> [(BinValue bin, val)])

Input function

-> HBuilder a b

Create histogram with monoidal bins. Takes many items at time.

mkHistMonoid1

Arguments

:: (Bin bin, UA val, Monoid val)

=> bin

Bin information

-> (Histogram bin val -> b)

Output function

-> (a -> (BinValue bin, val))

Input function

-> HBuilder a b

Create histogram with monoidal bins

forceInt :: Histogram bin Int -> Histogram bin Int

Function used to restrict type of histrogram.

forceDouble :: Histogram bin Double -> Histogram bin Double

Function used to restrict type of histrogram.

forceFloat :: Histogram bin Float -> Histogram bin Float

Function used to restrict type of histrogram.

Internals

data HistBuilder a b

Generic histogram builder.

Instances

HBuilderCl HistBuilder