benchmark

package

v0.0.10 Latest Latest Go to latest Published: Jan 19, 2026 License: MIT Imports: 2 Imported by: 0

Details

This section is empty.

This section is empty.

func AddMetricDescriptor(m MetricDescriptor)

type CalculatedDiff struct {
	Name           string
	PreviousCommit string
	CurrentCommit  string
	MetricDiff     []MetricDiff
}

func Diff(previous, current []Series) []CalculatedDiff

type CompareVerdict int

const (
	CompareVerdictSame CompareVerdict = iota
	CompareVerdictBetter
	CompareVerdictWorse
)

type Measurement struct {
	Name       string   `json:"-"`
	CommitHash string   `json:"commit_hash"`
	Metrics    []Metric `json:"metrics"`
}

type Metric struct {
	Unit   string    `json:"unit"`
	Values []float64 `json:"values"`
}

type MetricDescriptor struct {
	Unit       string
	Reduce     func([]float64) float64
	Comparator func(float64, float64) CompareVerdict
}

func GetMetricDescriptor(unit string) (MetricDescriptor, bool)

func NewMetricDescriptor(
	unit string, better string,
	threshold float64, reduce string,
) MetricDescriptor

type MetricDescriptorRegistry map[string]MetricDescriptor

type MetricDiff struct {
	Unit string

	PreviousValues []float64
	CurrentValues  []float64
}

func (m MetricDiff) CurrentValue() float64

func (m MetricDiff) Emoji() string

func (m MetricDiff) PreviousValue() float64

func (m MetricDiff) Ratio() float64

type Series struct {
	Name         string        `json:"name"`
	Measurements []Measurement `json:"measurements"`
}

func Merge(previous, current []Series) []Series