package
0.0.0-20241118162539-34caac850176
Repository: https://go.googlesource.com/perf
Documentation: pkg.go.dev

# Functions

ByDelta sorts tables by the Delta column, reversing the order when larger is better (for "speed" results).
ByName sorts tables by the Benchmark name column.
FormatCSV appends a CSV formatting of the tables to w.
FormatHTML appends an HTML formatting of the tables to buf.
FormatText appends a fixed-width text formatting of the tables to w.
NewScaler returns a Scaler appropriate for formatting the measurement val, which has the given unit.
NoDeltaTest applies no delta test; it returns -1, nil.
Reverse returns the reverse of the given order.
SafeFormatHTML returns the HTML formatting of the tables.
Sort sorts a Table t (in place) by the given order.
TTest is a DeltaTest using the two-sample Welch t-test.
UTest is a DeltaTest using the Mann-Whitney U test.

# Variables

Errors returned by DeltaTest.
Errors returned by DeltaTest.
Errors returned by DeltaTest.

# Structs

A Collection is a collection of benchmark results.
A Key identifies one metric (e.g., "ns/op", "B/op") from one benchmark (function name sans "Benchmark" prefix) and optional group in one configuration (input file name).
A Metrics holds the measurements of a single metric (for example, ns/op or MB/s) for all runs of a particular benchmark.
A Row is a table row for display in the benchstat output.
A Table is a table for display in the benchstat output.

# Type aliases

A DeltaTest compares the old and new metrics and returns the expected probability that they are drawn from the same distribution.
An Order defines a sort order for a table.
A Scaler is a function that scales and formats a measurement.