Data.Histogram

Immutable histograms. This module export same APi as Generic but specialzed to unboxed vectors. Refer aforementioned module for documentation.

Immutable histogram

Data type

type Histogram bin a = Histogram Vector bin a

Immutable histogram. Histogram consists of binning algorithm, optional number of under and overflows, and data.

module Data.Histogram.Bin

histogram :: (Unbox a, Bin bin) => bin -> Vector a -> Histogram bin a

histogramUO :: (Unbox a, Bin bin) => bin -> Maybe (a, a) -> Vector a -> Histogram bin a

data HistIndex b

Point inside histogram's domain. It could be either bin index or bin value.

Constructors

Index Int

Index for a bin

Value (BinValue b)

Value

Instances

Typeable1 HistIndex

histIndex :: Bin b => b -> HistIndex b -> Int

Convert HistIndex to actual index

Read histograms from string

readHistogram :: (Read bin, Read a, Bin bin, Unbox a) => String -> Histogram bin a

readFileHistogram :: (Read bin, Read a, Bin bin, Unbox a) => FilePath -> IO (Histogram bin a)

Accessors

bins :: Histogram bin a -> bin

histData :: Histogram bin a -> Vector a

underflows :: Histogram bin a -> Maybe a

overflows :: Histogram bin a -> Maybe a

outOfRange :: Histogram bin a -> Maybe (a, a)

Convert to other data types

asList :: (Unbox a, Bin bin) => Histogram bin a -> [(BinValue bin, a)]

asVector :: (Bin bin, Unbox a, Unbox (BinValue bin), Unbox (BinValue bin, a)) => Histogram bin a -> Vector (BinValue bin, a)

Modification

map :: (Unbox a, Unbox b) => (a -> b) -> Histogram bin a -> Histogram bin b

bmap :: (Unbox a, Unbox b, Bin bin) => (BinValue bin -> a -> b) -> Histogram bin a -> Histogram bin b

mapData :: (Unbox a, Unbox b, Bin bin) => (Vector a -> Vector b) -> Histogram bin a -> Histogram bin b

zip :: (Bin bin, BinEq bin, Unbox a, Unbox b, Unbox c) => (a -> b -> c) -> Histogram bin a -> Histogram bin b -> Histogram bin c

zipSafe :: (Bin bin, BinEq bin, Unbox a, Unbox b, Unbox c) => (a -> b -> c) -> Histogram bin a -> Histogram bin b -> Maybe (Histogram bin c)

Type conversion

convertBinning :: (ConvertBin bin bin', Unbox a) => Histogram bin a -> Histogram bin' a

Folding

foldl :: (Bin bin, Unbox a) => (b -> a -> b) -> b -> Histogram bin a -> b

bfoldl :: (Bin bin, Unbox a) => (b -> BinValue bin -> a -> b) -> b -> Histogram bin a -> b

Slicing & rebinning

slice

Arguments

:: (SliceableBin bin, Unbox a)

=> HistIndex bin

Lower inclusive bound

-> HistIndex bin

Upper inclusive bound

-> Histogram bin a

Histogram to slice

-> Histogram bin a

rebin

Arguments

:: (MergeableBin bin, Unbox a)

=> CutDirection

-> Int

-> (a -> a -> a)

Accumulation function

-> Histogram bin a

-> Histogram bin a

rebinFold

Arguments

:: (MergeableBin bin, Unbox a, Unbox b)

=> CutDirection

-> Int

-> (b -> a -> b)

Accumulation function

-> b

Initial value

-> Histogram bin a

-> Histogram bin b

Rebin histogram

2D histograms

Slicing

sliceAlongX

Arguments

:: (Unbox a, Bin bX, Bin bY)

=> Histogram (Bin2D bX bY) a

2D histogram

-> HistIndex bY

Position along Y axis

-> Histogram bX a

sliceAlongY

Arguments

:: (Unbox a, Bin bX, Bin bY)

=> Histogram (Bin2D bX bY) a

2D histogram

-> HistIndex bX

Position along X axis

-> Histogram bY a

listSlicesAlongX :: (Unbox a, Bin bX, Bin bY) => Histogram (Bin2D bX bY) a -> [(BinValue bY, Histogram bX a)]

listSlicesAlongY :: (Unbox a, Bin bX, Bin bY) => Histogram (Bin2D bX bY) a -> [(BinValue bX, Histogram bY a)]

Reducing along axis

reduceX

Arguments

:: (Unbox a, Unbox b, Bin bX, Bin bY)

=> (Histogram bX a -> b)

Function to reduce single slice along X axis

-> Histogram (Bin2D bX bY) a

2D histogram

-> Histogram bY b

reduceY

Arguments

:: (Unbox a, Unbox b, Bin bX, Bin bY)

=> (Histogram bY a -> b)

Function to reduce histogram along Y axis

-> Histogram (Bin2D bX bY) a

2D histogram

-> Histogram bX b

Lift histogram transform to 2D

liftX :: (Bin bX, Bin bY, Bin bX', BinEq bX', Unbox a, Unbox b) => (Histogram bX a -> Histogram bX' b) -> Histogram (Bin2D bX bY) a -> Histogram (Bin2D bX' bY) b

liftY :: (Bin bX, Bin bY, Bin bY', BinEq bY', Unbox a, Unbox b) => (Histogram bY a -> Histogram bY' b) -> Histogram (Bin2D bX bY) a -> Histogram (Bin2D bX bY') b