Data.Histogram

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

Immutable histogram

Immutable histograms

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

Constructors

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

Conversion 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)

Serialization to strings

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)

Indexing

data HistIndex b

Point inside histogram's domain. It could be either bin index or bin value. First and Last constructors are useful for histogram slicing.

Constructors

Index Int

Index for a bin

Value (BinValue b)

Value

First

Bin with index 0

Last

Bin maximum index.

Instances

Typeable (* -> *) HistIndex

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

Convert HistIndex to actual index

at :: (Bin bin, Unbox a) => Histogram bin a -> HistIndex bin -> a

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

atI :: (Bin bin, Unbox a) => Histogram bin a -> Int -> a

Transformations

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

Specialized folds

sum :: (Bin bin, Unbox a, Num a) => Histogram bin a -> a

minimum :: (Bin bin, Unbox a, Ord a) => Histogram bin a -> a

minimumBy :: (Bin bin, Unbox a) => (a -> a -> Ordering) -> Histogram bin a -> a

maximum :: (Bin bin, Unbox a, Ord a) => Histogram bin a -> a

maximumBy :: (Bin bin, Unbox a) => (a -> a -> Ordering) -> Histogram bin a -> a

minIndex :: (Bin bin, Ord a, Unbox a) => Histogram bin a -> Int

minIndexBy :: (Bin bin, Ord a, Unbox a) => (a -> a -> Ordering) -> Histogram bin a -> Int

maxIndex :: (Bin bin, Ord a, Unbox a) => Histogram bin a -> Int

maxIndexBy :: (Bin bin, Ord a, Unbox a) => (a -> a -> Ordering) -> Histogram bin a -> Int

minBin :: (Bin bin, Ord a, Unbox a) => Histogram bin a -> BinValue bin

minBinBy :: (Bin bin, Ord a, Unbox a) => (a -> a -> Ordering) -> Histogram bin a -> BinValue bin

maxBin :: (Bin bin, Ord a, Unbox a) => Histogram bin a -> BinValue bin

maxBinBy :: (Bin bin, Ord a, Unbox a) => (a -> a -> Ordering) -> Histogram bin a -> BinValue bin

Slicing & rebinning

slice :: (SliceableBin bin, Unbox a) => HistIndex bin -> HistIndex bin -> Histogram bin a -> Histogram bin a

rebin :: (MergeableBin bin, Unbox a) => CutDirection -> Int -> (a -> a -> a) -> Histogram bin a -> Histogram bin a

rebinFold :: (MergeableBin bin, Unbox a, Unbox b) => CutDirection -> Int -> (b -> a -> b) -> b -> Histogram bin a -> Histogram bin b

2D histograms

Slicing

sliceAlongX :: (Unbox a, Bin bX, Bin bY) => Histogram (Bin2D bX bY) a -> HistIndex bY -> Histogram bX a

sliceAlongY :: (Unbox a, Bin bX, Bin bY) => Histogram (Bin2D bX bY) a -> HistIndex bX -> 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 :: (Unbox a, Unbox b, Bin bX, Bin bY) => (Histogram bX a -> b) -> Histogram (Bin2D bX bY) a -> Histogram bY b

breduceX :: (Unbox a, Unbox b, Bin bX, Bin bY) => (BinValue bY -> Histogram bX a -> b) -> Histogram (Bin2D bX bY) a -> Histogram bY b

reduceY :: (Unbox a, Unbox b, Bin bX, Bin bY) => (Histogram bY a -> b) -> Histogram (Bin2D bX bY) a -> Histogram bX b

breduceY :: (Unbox a, Unbox b, Bin bX, Bin bY) => (BinValue bX -> Histogram bY a -> b) -> Histogram (Bin2D bX bY) a -> 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