stats

Documentation

Index

• type Float64Values
  • func (vals Float64Values) Len() int
  • func (vals Float64Values) SetValueAt(n int, v float64)
  • func (vals Float64Values) ValueAt(n int) float64
• type MutableValues
• type Statistics
  • func Calc(values Values) Statistics
  • func Merge(statistics []Statistics) Statistics
  • func SingleCountStatistics(value float64) Statistics
  • func ZeroCountStatistics() Statistics
• type Values

Types

type Float64Values

type Float64Values []float64

Float64Values is a simple Values implementation around a slice

func (Float64Values) Len

func (vals Float64Values) Len() int

Len returns the number of elements in the array

func (Float64Values) SetValueAt

func (vals Float64Values) SetValueAt(n int, v float64)

SetValueAt sets the value at the nth element

func (Float64Values) ValueAt

func (vals Float64Values) ValueAt(n int) float64

ValueAt returns the value at the nth element

type MutableValues

type MutableValues interface {
	Values

	// SetValueAt sets the value at the nth element
	SetValueAt(n int, v float64)
}

MutableValues is a set of data values that can be modified

type Statistics

type Statistics struct {
	Min    float64
	Max    float64
	Mean   float64
	Count  uint
	Sum    float64
	StdDev float64
}

Statistics are the computation of standard statistics (min, max, mean, count, stddev) over a group of values.

func Calc

func Calc(values Values) Statistics

Calc calculates statistics for a set of values

func Merge

func Merge(statistics []Statistics) Statistics

Merge merges a group of statistics

func SingleCountStatistics

func SingleCountStatistics(value float64) Statistics

SingleCountStatistics returns Statistics for a single value

func ZeroCountStatistics

func ZeroCountStatistics() Statistics

ZeroCountStatistics returns statistics when no values are present (or when all values are NaNs)

type Values

type Values interface {
	// Len returns the number of values present
	Len() int

	// ValueAt returns the value at the nth element
	ValueAt(n int) float64
}

Values presents a set of data values as an array, for the purposes of aggregation