hdr-histogram-0.1.0.0: Haskell implementation of High Dynamic Range (HDR) Histograms

Safe HaskellNone
LanguageHaskell2010

Data.HdrHistogram.Config.Internal

Synopsis

Documentation

data HistogramConfig a Source #

Supporting data to transform a value from a within a range of lowest to highest, while maintaining sigFigures amount of precision, to an Int.

Instances

Eq a => Eq (HistogramConfig a) Source # 
Show a => Show (HistogramConfig a) Source # 
Generic (HistogramConfig a) Source # 

Associated Types

type Rep (HistogramConfig a) :: * -> * #

(Arbitrary a, Bounded a, Integral a, Bits a) => Arbitrary (HistogramConfig a) Source # 
NFData a => NFData (HistogramConfig a) Source # 

Methods

rnf :: HistogramConfig a -> () #

type Rep (HistogramConfig a) Source # 

config Source #

Arguments

:: (Integral a, Bits a) 
=> a

The lowest recordable value

-> a

The highest recordable value

-> SignificantFigures 
-> HistogramConfig a 

smart constructor for HistogramConfig

lowest :: HistogramConfig a -> a Source #

The lowest expected recorded value

highest :: HistogramConfig a -> a Source #

The highest expected recorded value

sigFigures :: HistogramConfig a -> SignificantFigures Source #

The number of significant figures for recorded values

bucketCount :: HistogramConfig a -> Int Source #

the total number of buckets

subBucketCount :: HistogramConfig a -> Int Source #

the total number sub buckets per bucket

size :: HistogramConfig a -> Int Source #

the total number of elements distinct indices

significantFigures :: Int -> Either String SignificantFigures Source #

Construct a SignificantFigures. Valid values are between 1 and 5

data Range a Source #

A range of values between lower and upper

Constructors

Range 

Fields

Instances

Eq a => Eq (Range a) Source # 

Methods

(==) :: Range a -> Range a -> Bool #

(/=) :: Range a -> Range a -> Bool #

Show a => Show (Range a) Source # 

Methods

showsPrec :: Int -> Range a -> ShowS #

show :: Range a -> String #

showList :: [Range a] -> ShowS #

data Index Source #

An HistogramConfig specific internal representation of an index

Constructors

Index 

Fields

fromIndex :: (Integral a, Bits a) => HistogramConfig a -> Index -> Range a Source #

The range of possible values represented by this Index

bitLength :: FiniteBits b => b -> Int Source #

The number of bits required to represent this data, disregarding leading zeros