benchdiff

package module
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 29, 2020 License: MIT Imports: 9 Imported by: 0

README

benchdiff

godoc ci

Documentation

Index

Constants

View Source 
const (
	DegradingChange     = -1 // represents a statistically significant degradation
	InsignificantChange = 0  // represents no statistically significant change
	ImprovingChange     = 1  // represents a statistically significant improvement
)

BenchmarkChangeType values

Variables

This section is empty.

Functions

This section is empty.

Types

type BenchmarkChangeType added in v0.2.0 

type BenchmarkChangeType int

BenchmarkChangeType is whether a change is an improvement or degradation

type Differ 

type Differ struct {
	BenchCmd   string
	BenchArgs  string
	ResultsDir string
	BaseRef    string
	Path       string
	Writer     io.Writer
	Benchstat  *pkgbenchstat.Benchstat
	Force      bool
}

Differ runs benchstats and outputs their deltas

func (*Differ) OutputResult added in v0.2.0 

func (c *Differ) OutputResult(runResult *RunResult) error

OutputResult outputs a Run result

func (*Differ) Run 

func (c *Differ) Run() (*RunResult, error)

Run runs the Differ

type RunResult added in v0.2.0 

type RunResult struct {
	// contains filtered or unexported fields
}

RunResult is the result of a Run

func (*RunResult) HasChangeType added in v0.2.0 

func (r *RunResult) HasChangeType(changeType BenchmarkChangeType) bool

HasChangeType returns true if the result has at least one change with the given type

Source Files

View all Source files

Directories

Path Synopsis
cmd
benchdiff command
pkg
benchstat
Package benchstat is used to run benchstat programmatically
 Package benchstat is used to run benchstat programmatically

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.