modulepackage
0.0.0-20170714194401-3392ed7c9b5a
Repository: https://github.com/mohae/benchutil.git
Documentation: pkg.go.dev
# README
benchutil
Helper library to generate formatted output from testing.BenchmarkResult
data.
Supported formats:
- text (default)
- CSV
- Markdown; results are formatted as a table
Benchmark results can be labeled by providing a name. Additional information for the benchmark can be added through the description and notes fields. Related benchmarks can be labeled by providing a group (grouping of groups is not done, the output is in the same order as they were added.)
Groups can be separated out to their own sections. For markdown
output, these sections can be created as their own table, and, optionally, the table can use the group identifier as its label, which results in the group column being omitted from the table.
# Functions
Dot prints a .
No description provided by the author
No description provided by the author
No description provided by the author
NewSeed gets a random int64 to use for a seed value.
No description provided by the author
RandBool returns a pseudo-random bool value.
RandBytes returns a randomly generated []byte of length l.
RandString returns a randomly generated string of length l.
ResultFromBenchmarkResult creates a Result{} from a testing.BenchmarkResult.
# Structs
Bench holds information about a benchmark.
Benches is a collection of benchmark informtion and their results.
CSVBench Benches is a collection of benchmark informtion and their results.
MDBench Benches is a collection of benchmark informtion and their results.
Result holds information about a benchmark's results.
StringBench generates string output from the benchmarks.
# Interfaces
Benchmarker defines common behavior for a Benchmark output harness; format specific methods may be.