Data.Histogram.Generic

Generic immutable histograms.

Data type

data Histogram v bin a

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

Instances

Typeable1 v => Typeable2 (Histogram v)

(Eq bin, Eq a, Eq (v a)) => Eq (Histogram v bin a)

(Show a, Show (BinValue bin), Show bin, Bin bin, Vector v a) => Show (Histogram v bin a)

module Data.Histogram.Bin

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

Create histogram from binning algorithm and vector with data. Overflows are set to Nothing.

Number of bins and vector size must match.

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

Create histogram from binning algorithm and vector with data.

Number of bins and vector size must match.

Read histograms from string

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

Convert String to histogram. Histogram do not have Read instance because of slowness of ReadP

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

Read histogram from file.

Accessors

bins :: Histogram v bin a -> bin

Histogram bins

histData :: Histogram v bin a -> v a

Histogram data as vector

underflows :: Histogram v bin a -> Maybe a

Number of underflows

overflows :: Histogram v bin a -> Maybe a

Number of overflows

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

Underflows and overflows

Convert to other data types

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

Convert histogram data to list.

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

Convert histogram data to vector

Slicing histogram

sliceByIx :: (Bin1D bin, Vector v a) => Int -> Int -> Histogram v bin a -> Histogram v bin a

Slice histogram using indices.

sliceByVal :: (Bin1D bin, Vector v a) => BinValue bin -> BinValue bin -> Histogram v bin a -> Histogram v bin a

Slice histogram using bin values. Value will be included in range.

Splitting 2D histograms

sliceX :: (Vector v a, Bin bX, Bin bY) => Histogram v (Bin2D bX bY) a -> [(BinValue bX, Histogram v bY a)]

Slice 2D histogram along X axis.

sliceY :: (Vector v a, Bin bX, Bin bY) => Histogram v (Bin2D bX bY) a -> [(BinValue bY, Histogram v bX a)]

Slice 2D histogram along Y axis. This function is fast because it does not require reallocations.

Modify histogram

histMap :: (Vector v a, Vector v b) => (a -> b) -> Histogram v bin a -> Histogram v bin b

fmap lookalike. It's not possible to create Functor instance because of class restrictions

histMapBin :: (Bin bin, Bin bin') => (bin -> bin') -> Histogram v bin a -> Histogram v bin' a

Apply function to histogram bins. Function must not change number of bins. If it does error is thrown.

histZip :: (Bin bin, Eq bin, Vector v a, Vector v b, Vector v c) => (a -> b -> c) -> Histogram v bin a -> Histogram v bin b -> Histogram v bin c

Zip two histograms elementwise. Bins of histograms must be equal otherwise error will be called.

histZipSafe :: (Bin bin, Eq bin, Vector v a, Vector v b, Vector v c) => (a -> b -> c) -> Histogram v bin a -> Histogram v bin b -> Maybe (Histogram v bin c)

Zip two histogram elementwise. If bins are not equal return Nothing