Categorygithub.com/influxdata/tdigest
modulepackage
0.0.1
Repository: https://github.com/influxdata/tdigest.git
Documentation: pkg.go.dev

# README

tdigest

This is an implementation of Ted Dunning's t-digest in Go.

The implementation is based off Derrick Burns' C++ implementation.

Example

package main

import (
	"log"

	"github.com/influxdata/tdigest"
)

func main() {
	td := tdigest.NewWithCompression(1000)
	for _, x := range []float64{1, 2, 3, 4, 5, 5, 4, 3, 2, 1} {
		td.Add(x, 1)
	}

	// Compute Quantiles
	log.Println("50th", td.Quantile(0.5))
	log.Println("75th", td.Quantile(0.75))
	log.Println("90th", td.Quantile(0.9))
	log.Println("99th", td.Quantile(0.99))

	// Compute CDFs
	log.Println("CDF(1) = ", td.CDF(1))
	log.Println("CDF(2) = ", td.CDF(2))
	log.Println("CDF(3) = ", td.CDF(3))
	log.Println("CDF(4) = ", td.CDF(4))
	log.Println("CDF(5) = ", td.CDF(5))
}

TODO

Only the methods for a single TDigest have been implemented. The methods to merge two or more existing t-digests into a single t-digest have yet to be implemented.

# Packages

No description provided by the author

# Functions

New initializes a new distribution with a default compression.
NewCentroidList creates a priority queue for the centroids.
NewWithCompression initializes a new distribution with custom compression.

# Constants

ErrWeightLessThanZero is used when the weight is not able to be processed.

# Structs

Centroid average position of all points in a shape.
TDigest is a data structure for accurate on-line accumulation of rank-based statistics such as quantiles and trimmed means.

# Type aliases

CentroidList is sorted by the Mean of the centroid, ascending.
Error is a domain error encountered while processing tdigests.