Moduletdigest-0.3Haskell2010

Data.TDigest.Postprocess.Internal

TDigest postprocessing functions.

These are re-exported from Data.TDigest module.

1 type
2 classes
6 values

Packagetdigest-0.3
Exports9
LanguageHaskell2010
LicenceBSD-3-Clause
SourceInternal.hs

Histogram

3 declarations

classclass Affine f => HasHistogram a (f :: Type -> Type) | a -> f where

Types from which we can extract histogram.

Methods

histogram :: a -> f (NonEmpty HistBin)
totalWeight :: a -> Weight

Instances5HasHistogram

KnownNat comp => HasHistogram (TDigest comp) MaybeDefined in tdigest-0.3 · Data.TDigest.Vector.Internal
HasHistogram (TDigest comp) MaybeDefined in tdigest-0.3 · Data.TDigest.Tree.Internal
HasHistogram (TDigest comp) IdentityDefined in tdigest-0.3 · Data.TDigest.Tree.NonEmpty
HistBin ~ e => HasHistogram (NonEmpty HistBin) IdentityDefined in tdigest-0.3 · Data.TDigest.Postprocess.Internal
HistBin ~ e => HasHistogram [HistBin] MaybeDefined in tdigest-0.3 · Data.TDigest.Postprocess.Internal

datadata HistBin

Histogram bin

Constructors

HistBin
- hbMin :: !Mean
  lower bound
- hbMax :: !Mean
  upper bound
- hbValue :: !Mean
  original value: (mi + ma) / 2
- hbWeight :: !Weight
  weight ("area" of the bar)
- hbCumWeight :: !Weight
  weight from the right, excludes this bin

Instances3Show, HasHistogram

Show HistBinDefined in tdigest-0.3 · Data.TDigest.Postprocess.Internal
HistBin ~ e => HasHistogram (NonEmpty HistBin) IdentityDefined in tdigest-0.3 · Data.TDigest.Postprocess.Internal
HistBin ~ e => HasHistogram [HistBin] MaybeDefined in tdigest-0.3 · Data.TDigest.Postprocess.Internal

valuehistogramFromCentroids :: NonEmpty Centroid -> NonEmpty HistBin

Histogram from centroids

Quantiles

1 declaration

valuequantile :: Double -> Weight -> NonEmpty HistBin -> Double

Quantile from the histogram.

Mean & variance

2 declarations

As we have "full" histogram, we can calculate other statistical variables.

valuemean :: NonEmpty HistBin -> Double

Mean from the histogram.

valuevariance :: NonEmpty HistBin -> Double

Variance from the histogram.

CDF

1 declaration

valuecdf

:: Double
-> Double
total weight
-> [HistBin]
-> Double

Cumulative distribution function.

Debug

1 declaration

valuevalidateHistogram :: Foldable f => f HistBin -> Either String (f HistBin)

Validate that list of HistBin is a valid "histogram".

Affine - internal

1 declaration

classclass Traversable t => Affine (t :: Type -> Type) where

Affine containers, i.e. containing at most 1 element

This class doesn't have traverse analogie as it would require using Pointed which is disputed type class.

traverseAff :: Pointed f => (a -> f b) -> t a -> f (t b)

Methods

affine :: b -> (a -> b) -> t a -> b
Like foldMap
fromAffine :: a -> t a -> a

Instances4Affine

Affine IdentityDefined in tdigest-0.3 · Data.TDigest.Postprocess.Internal
Affine MaybeDefined in tdigest-0.3 · Data.TDigest.Postprocess.Internal
Affine ProxyDefined in tdigest-0.3 · Data.TDigest.Postprocess.Internal
(Affine f, Affine g) => Affine (Compose f g)Defined in tdigest-0.3 · Data.TDigest.Postprocess.Internal
Composition of Affine containers is Affine