stats

Documentation

Index

• Constants
• type Iterable
• type Iterator
• type Measure
  • func (m Measure) Divide(n int64) Measure
  • func (m Measure) IsSuccess() bool
  • func (m Measure) IsValid() bool
  • func (m Measure) SumIfValid(o Measure) Measure
  • func (m Measure) ToFloat(unit time.Duration) float64
• type Observation
• type PingStats
  • func PingStatsFromLatencies(measures []Measure) *PingStats
  • func (ps *PingStats) String() string
• type Stats
  • func ComputeStats(collection Iterable) *Stats

Constants

const (
	MeasureNotValid       = Measure(invalid)
	MeasureNotInitialized = Measure(invalid - 1)
)

Some variables for invalid measures. Naming should be explicit enough

Types

type Iterable

type Iterable interface {
	Iterator() Iterator
}

Iterable is used to define a collection providing an Iterator

type Iterator

type Iterator interface {
	HasNext() bool
	Next() Observation
}

Iterator is used to iterate over Observation

type Measure

type Measure time.Duration

Measure represent a time measurement which can be successful or not

func (Measure) Divide

func (m Measure) Divide(n int64) Measure

Divide returns the result of the division of a measure with n if the measure is invalid the returned value is invalid as well

func (Measure) IsSuccess

func (m Measure) IsSuccess() bool

IsSuccess returns true if the measurement is valid and positive.

func (Measure) IsValid

func (m Measure) IsValid() bool

IsValid returns true if the measurement is valid (might be negative (!), but is the difference between two time measurements

func (Measure) SumIfValid

func (m Measure) SumIfValid(o Measure) Measure

SumIfValid returns - if both measures are valid: the sum of them - if one of them is invalid, it returns this specific one - otherwise it returns an invalid measure

func (Measure) ToFloat

func (m Measure) ToFloat(unit time.Duration) float64

ToFloat converts the current measurement to a float in a specified unit

type Observation

type Observation struct {
	Value  float64
	Weight float64
}

Observation represents an item in the population we would extract statistics

type PingStats

type PingStats struct {
	Average Measure
	Min     Measure
	Max     Measure
	StdDev  Measure
}

PingStats represents the statistics which can be computed from an array of latencies

func PingStatsFromLatencies

func PingStatsFromLatencies(measures []Measure) *PingStats

PingStatsFromLatencies computes PingStats from a serie of ping measurements.

func (*PingStats) String

func (ps *PingStats) String() string

type Stats

type Stats struct {
	Average float64
	Min     float64
	Max     float64
	StdDev  float64
}

Stats is the type returned by ComputeStats

func ComputeStats

func ComputeStats(collection Iterable) *Stats

ComputeStats return statistical information about collection as Stats instance