Data.Histogram.Bin.Classes

Type classes for binning algorithms. This is mapping from set of interest to integer indices and approximate reverse.

Bin type class

class Bin b where

This type represent some abstract data binning algorithms. It maps sets/intervals of values of type 'BinValue b' to integer indices.

Following invariant is expected to hold:

toIndex . fromIndex == id

Minimal complete definition

toIndex, fromIndex, nBins

Associated Types

type BinValue b

Type of value to bin

Methods

toIndex :: b -> BinValue b -> Int

Convert from value to index. Function must not fail for any input and should produce out of range indices for invalid input.

fromIndex :: b -> Int -> BinValue b

Convert from index to value. Returned value should correspond to center of bin. Definition of center is left for definition of instance. Funtion may fail for invalid indices but encouraged not to do so.

nBins :: b -> Int

Total number of bins. Must be non-negative.

inRange :: b -> BinValue b -> Bool

Check whether value in range. Have default implementation. Should satisfy: inRange b x ⇔ toIndex b x ∈ [0,nBins b)

Instances

Bin LogBinD

Associated Types

type BinValue LogBinD :: *

Methods

toIndex :: LogBinD -> BinValue LogBinD -> Int

fromIndex :: LogBinD -> Int -> BinValue LogBinD

nBins :: LogBinD -> Int

inRange :: LogBinD -> BinValue LogBinD -> Bool

Bin BinInt

Associated Types

type BinValue BinInt :: *

Methods

toIndex :: BinInt -> BinValue BinInt -> Int

fromIndex :: BinInt -> Int -> BinValue BinInt

nBins :: BinInt -> Int

inRange :: BinInt -> BinValue BinInt -> Bool

Bin BinI

Associated Types

type BinValue BinI :: *

Methods

toIndex :: BinI -> BinValue BinI -> Int

fromIndex :: BinI -> Int -> BinValue BinI

nBins :: BinI -> Int

inRange :: BinI -> BinValue BinI -> Bool

Bin BinD

Associated Types

type BinValue BinD :: *

Methods

toIndex :: BinD -> BinValue BinD -> Int

fromIndex :: BinD -> Int -> BinValue BinD

nBins :: BinD -> Int

inRange :: BinD -> BinValue BinD -> Bool

RealFrac f => Bin (BinF f)

Associated Types

type BinValue (BinF f) :: *

Methods

toIndex :: BinF f -> BinValue (BinF f) -> Int

fromIndex :: BinF f -> Int -> BinValue (BinF f)

nBins :: BinF f -> Int

inRange :: BinF f -> BinValue (BinF f) -> Bool

Enum a => Bin (BinEnum a)

Associated Types

type BinValue (BinEnum a) :: *

Methods

toIndex :: BinEnum a -> BinValue (BinEnum a) -> Int

fromIndex :: BinEnum a -> Int -> BinValue (BinEnum a)

nBins :: BinEnum a -> Int

inRange :: BinEnum a -> BinValue (BinEnum a) -> Bool

Bin b => Bin (BinPermute b)

Associated Types

type BinValue (BinPermute b) :: *

Methods

toIndex :: BinPermute b -> BinValue (BinPermute b) -> Int

fromIndex :: BinPermute b -> Int -> BinValue (BinPermute b)

nBins :: BinPermute b -> Int

inRange :: BinPermute b -> BinValue (BinPermute b) -> Bool

Enum2D i => Bin (BinEnum2D i)

Associated Types

type BinValue (BinEnum2D i) :: *

Methods

toIndex :: BinEnum2D i -> BinValue (BinEnum2D i) -> Int

fromIndex :: BinEnum2D i -> Int -> BinValue (BinEnum2D i)

nBins :: BinEnum2D i -> Int

inRange :: BinEnum2D i -> BinValue (BinEnum2D i) -> Bool

Bin bin => Bin (MaybeBin bin)

Associated Types

type BinValue (MaybeBin bin) :: *

Methods

toIndex :: MaybeBin bin -> BinValue (MaybeBin bin) -> Int

fromIndex :: MaybeBin bin -> Int -> BinValue (MaybeBin bin)

nBins :: MaybeBin bin -> Int

inRange :: MaybeBin bin -> BinValue (MaybeBin bin) -> Bool

(Vector v a, Ord a, Fractional a) => Bin (BinVarG v a)

Associated Types

type BinValue (BinVarG v a) :: *

Methods

toIndex :: BinVarG v a -> BinValue (BinVarG v a) -> Int

fromIndex :: BinVarG v a -> Int -> BinValue (BinVarG v a)

nBins :: BinVarG v a -> Int

inRange :: BinVarG v a -> BinValue (BinVarG v a) -> Bool

(Bin binX, Bin binY) => Bin (Bin2D binX binY)

Associated Types

type BinValue (Bin2D binX binY) :: *

Methods

toIndex :: Bin2D binX binY -> BinValue (Bin2D binX binY) -> Int

fromIndex :: Bin2D binX binY -> Int -> BinValue (Bin2D binX binY)

nBins :: Bin2D binX binY -> Int

inRange :: Bin2D binX binY -> BinValue (Bin2D binX binY) -> Bool

binsCenters :: (Bin b, Vector v (BinValue b)) => b -> v (BinValue b)

Return vector of bin centers

Approximate equality

class Bin b => BinEq b where

Approximate equality for bins. It's nessesary to define approximate equality since exact equality is ill defined for bins which work with floating point data. It's not safe to compare floating point numbers for exact equality

Minimal complete definition

binEq

Methods

binEq :: b -> b -> Bool

Approximate equality

Instances

BinEq LogBinD

Methods

binEq :: LogBinD -> LogBinD -> Bool

BinEq BinInt

Methods

binEq :: BinInt -> BinInt -> Bool

BinEq BinI

Methods

binEq :: BinI -> BinI -> Bool

BinEq BinD

Equality is up to 3e-11 (2/3th of digits)

Methods

binEq :: BinD -> BinD -> Bool

RealFloat f => BinEq (BinF f)

Equality is up to 2/3th of digits

Methods

binEq :: BinF f -> BinF f -> Bool

Enum a => BinEq (BinEnum a)

Methods

binEq :: BinEnum a -> BinEnum a -> Bool

BinEq bin => BinEq (MaybeBin bin)

Methods

binEq :: MaybeBin bin -> MaybeBin bin -> Bool

(Vector v a, Vector v Bool, Ord a, Fractional a) => BinEq (BinVarG v a)

Equality is up to 3e-11 (2/3th of digits)

Methods

binEq :: BinVarG v a -> BinVarG v a -> Bool

(BinEq bx, BinEq by) => BinEq (Bin2D bx by)

Methods

binEq :: Bin2D bx by -> Bin2D bx by -> Bool

1D bins

class (Bin b, Ord (BinValue b)) => IntervalBin b where

For binning algorithms which work with bin values which have some natural ordering and every bin is continous interval.

Minimal complete definition

binInterval

Methods

binInterval :: b -> Int -> (BinValue b, BinValue b)

Interval for n'th bin

binsList :: Vector v (BinValue b, BinValue b) => b -> v (BinValue b, BinValue b)

List of all bins. Could be overridden for efficiency.

Instances

IntervalBin LogBinD

Methods

binInterval :: LogBinD -> Int -> (BinValue LogBinD, BinValue LogBinD)

binsList :: Vector v (BinValue LogBinD, BinValue LogBinD) => LogBinD -> v (BinValue LogBinD, BinValue LogBinD)

IntervalBin BinInt

Methods

binInterval :: BinInt -> Int -> (BinValue BinInt, BinValue BinInt)

binsList :: Vector v (BinValue BinInt, BinValue BinInt) => BinInt -> v (BinValue BinInt, BinValue BinInt)

IntervalBin BinI

Methods

binInterval :: BinI -> Int -> (BinValue BinI, BinValue BinI)

binsList :: Vector v (BinValue BinI, BinValue BinI) => BinI -> v (BinValue BinI, BinValue BinI)

IntervalBin BinD

Methods

binInterval :: BinD -> Int -> (BinValue BinD, BinValue BinD)

binsList :: Vector v (BinValue BinD, BinValue BinD) => BinD -> v (BinValue BinD, BinValue BinD)

RealFrac f => IntervalBin (BinF f)

Methods

binInterval :: BinF f -> Int -> (BinValue (BinF f), BinValue (BinF f))

binsList :: Vector v (BinValue (BinF f), BinValue (BinF f)) => BinF f -> v (BinValue (BinF f), BinValue (BinF f))

(Enum a, Ord a) => IntervalBin (BinEnum a)

Methods

binInterval :: BinEnum a -> Int -> (BinValue (BinEnum a), BinValue (BinEnum a))

binsList :: Vector v (BinValue (BinEnum a), BinValue (BinEnum a)) => BinEnum a -> v (BinValue (BinEnum a), BinValue (BinEnum a))

IntervalBin b => IntervalBin (BinPermute b)

Methods

binInterval :: BinPermute b -> Int -> (BinValue (BinPermute b), BinValue (BinPermute b))

binsList :: Vector v (BinValue (BinPermute b), BinValue (BinPermute b)) => BinPermute b -> v (BinValue (BinPermute b), BinValue (BinPermute b))

(Vector v a, Ord a, Fractional a) => IntervalBin (BinVarG v a)

Methods

binInterval :: BinVarG v a -> Int -> (BinValue (BinVarG v a), BinValue (BinVarG v a))

binsList :: Vector v (BinValue (BinVarG v a), BinValue (BinVarG v a)) => BinVarG v a -> v (BinValue (BinVarG v a), BinValue (BinVarG v a))

class IntervalBin b => Bin1D b where

IntervalBin which domain is single finite interval

Minimal complete definition

lowerLimit, upperLimit

Methods

lowerLimit :: b -> BinValue b

Minimal accepted value of histogram

upperLimit :: b -> BinValue b

Maximal accepted value of histogram

Instances

Bin1D LogBinD

Methods

lowerLimit :: LogBinD -> BinValue LogBinD

upperLimit :: LogBinD -> BinValue LogBinD

Bin1D BinInt

Methods

lowerLimit :: BinInt -> BinValue BinInt

upperLimit :: BinInt -> BinValue BinInt

Bin1D BinI

Methods

lowerLimit :: BinI -> BinValue BinI

upperLimit :: BinI -> BinValue BinI

Bin1D BinD

Methods

lowerLimit :: BinD -> BinValue BinD

upperLimit :: BinD -> BinValue BinD

RealFrac f => Bin1D (BinF f)

Methods

lowerLimit :: BinF f -> BinValue (BinF f)

upperLimit :: BinF f -> BinValue (BinF f)

(Enum a, Ord a) => Bin1D (BinEnum a)

Methods

lowerLimit :: BinEnum a -> BinValue (BinEnum a)

upperLimit :: BinEnum a -> BinValue (BinEnum a)

(Vector v a, Ord a, Fractional a) => Bin1D (BinVarG v a)

Methods

lowerLimit :: BinVarG v a -> BinValue (BinVarG v a)

upperLimit :: BinVarG v a -> BinValue (BinVarG v a)

class Bin b => SliceableBin b where

Binning algorithm which support slicing.

Minimal complete definition

unsafeSliceBin

Methods

unsafeSliceBin :: Int -> Int -> b -> b

Slice bin by indices. This function doesn't perform any checks and may produce invalid bin. Use sliceBin instead.

Instances

SliceableBin LogBinD

Methods

unsafeSliceBin :: Int -> Int -> LogBinD -> LogBinD

SliceableBin BinInt

Methods

unsafeSliceBin :: Int -> Int -> BinInt -> BinInt

SliceableBin BinI

Methods

unsafeSliceBin :: Int -> Int -> BinI -> BinI

SliceableBin BinD

Methods

unsafeSliceBin :: Int -> Int -> BinD -> BinD

RealFrac f => SliceableBin (BinF f)

Methods

unsafeSliceBin :: Int -> Int -> BinF f -> BinF f

(Enum a, Ord a) => SliceableBin (BinEnum a)

Methods

unsafeSliceBin :: Int -> Int -> BinEnum a -> BinEnum a

(Vector v a, Ord a, Fractional a) => SliceableBin (BinVarG v a)

Methods

unsafeSliceBin :: Int -> Int -> BinVarG v a -> BinVarG v a

sliceBin

Arguments

:: SliceableBin b

=> Int

Index of first bin

-> Int

Index of last bin

-> b

-> b

Slice bin using indices

class Bin b => MergeableBin b where

Bin which support rebinning.

Minimal complete definition

unsafeMergeBins

Methods

unsafeMergeBins :: CutDirection -> Int -> b -> b

N consecutive bins are joined into single bin. If number of bins isn't multiple of N remaining bins with highest or lowest index are dropped. This function doesn't do any checks. Use mergeBins instead.

Instances

MergeableBin LogBinD

Methods

unsafeMergeBins :: CutDirection -> Int -> LogBinD -> LogBinD

MergeableBin BinInt

Methods

unsafeMergeBins :: CutDirection -> Int -> BinInt -> BinInt

MergeableBin BinD

Methods

unsafeMergeBins :: CutDirection -> Int -> BinD -> BinD

RealFrac f => MergeableBin (BinF f)

Methods

unsafeMergeBins :: CutDirection -> Int -> BinF f -> BinF f

data CutDirection

How index should be dropped

Constructors

CutLower

Drop bins with smallest index

CutHigher

Drop bins with bigger index

Instances

Data CutDirection

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CutDirection -> c CutDirection

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CutDirection

toConstr :: CutDirection -> Constr

dataTypeOf :: CutDirection -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CutDirection)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CutDirection)

gmapT :: (forall b. Data b => b -> b) -> CutDirection -> CutDirection

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CutDirection -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CutDirection -> r

gmapQ :: (forall d. Data d => d -> u) -> CutDirection -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CutDirection -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CutDirection -> m CutDirection

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CutDirection -> m CutDirection

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CutDirection -> m CutDirection

Show CutDirection

Methods

showsPrec :: Int -> CutDirection -> ShowS

show :: CutDirection -> String

showList :: [CutDirection] -> ShowS

Generic CutDirection

Associated Types

type Rep CutDirection :: * -> *

Methods

from :: CutDirection -> Rep CutDirection x

to :: Rep CutDirection x -> CutDirection

type Rep CutDirection

type Rep CutDirection = D1 * (MetaData "CutDirection" "Data.Histogram.Bin.Classes" "histogram-fill-0.9.0.0-FADHtei2qZHDWIqwzr4Kfe" False) ((:+:) * (C1 * (MetaCons "CutLower" PrefixI False) (U1 *)) (C1 * (MetaCons "CutHigher" PrefixI False) (U1 *)))

mergeBins :: MergeableBin b => CutDirection -> Int -> b -> b

N consecutive bins are joined into single bin. If number of bins isn't multiple of N remaining bins with highest or lowest index are dropped. If N is larger than number of bins all bins are merged into single one.

Sizes of bin

class Bin b => VariableBin b where

1D binning algorithms with variable bin size

Minimal complete definition

binSizeN

Methods

binSizeN :: b -> Int -> BinValue b

Size of n'th bin.

Instances

VariableBin LogBinD

Methods

binSizeN :: LogBinD -> Int -> BinValue LogBinD

VariableBin BinInt

Methods

binSizeN :: BinInt -> Int -> BinValue BinInt

VariableBin BinI

Methods

binSizeN :: BinI -> Int -> BinValue BinI

VariableBin BinD

Methods

binSizeN :: BinD -> Int -> BinValue BinD

RealFrac f => VariableBin (BinF f)

Methods

binSizeN :: BinF f -> Int -> BinValue (BinF f)

VariableBin b => VariableBin (BinPermute b)

Methods

binSizeN :: BinPermute b -> Int -> BinValue (BinPermute b)

VariableBin bin => VariableBin (MaybeBin bin)

Methods

binSizeN :: MaybeBin bin -> Int -> BinValue (MaybeBin bin)

(Vector v a, Ord a, Fractional a) => VariableBin (BinVarG v a)

Methods

binSizeN :: BinVarG v a -> Int -> BinValue (BinVarG v a)

class VariableBin b => UniformBin b where

1D binning algorithms with constant size bins. Constant sized bins could be thought as specialization of variable-sized bins therefore a superclass constraint.

Methods

binSize :: b -> BinValue b

Size of bin. Default implementation just uses 0th bin.

Instances

UniformBin BinInt

Methods

binSize :: BinInt -> BinValue BinInt

UniformBin BinI

Methods

binSize :: BinI -> BinValue BinI

UniformBin BinD

Methods

binSize :: BinD -> BinValue BinD

RealFrac f => UniformBin (BinF f)

Methods

binSize :: BinF f -> BinValue (BinF f)

UniformBin b => UniformBin (BinPermute b)

Methods

binSize :: BinPermute b -> BinValue (BinPermute b)

Conversion

class (Bin b, Bin b') => ConvertBin b b' where

Class for conversion between binning algorithms.

Minimal complete definition

convertBin

Methods

convertBin :: b -> b'

Convert bins

Instances

(Bin1D b, Vector v (BinValue b), Vector v Bool, (~) * a (BinValue b), Fractional a) => ConvertBin b (BinVarG v a)

Methods

convertBin :: b -> BinVarG v a