benchmark

README

Benchmarks

Arche's benchmarks and profiling.

See also the internal benchmarks in packages ecs, generic and filter.

Running the benchmarks

From here (benchmarks/), run:

go test -benchmem -run=^$ -bench ^.*$ ./...

Documentation

Overview

Package benchmark contains benchmarking and profiling code for Arche, an archetype-based Entity Component System (ECS) for Go.

See package github.com/mlange-42/arche/ecs for Arche's API.

Index

• func RunBenchmarks(title string, benches []Benchmark, format func([]Benchmark) string)
• func ToMarkdown(benches []Benchmark) string
• type Benchmark

Functions

func RunBenchmarks

func RunBenchmarks(title string, benches []Benchmark, format func([]Benchmark) string)

func ToMarkdown

func ToMarkdown(benches []Benchmark) string

Types

type Benchmark

type Benchmark struct {
	Name   string
	Desc   string
	F      func(b *testing.B)
	N      int
	T      float64
	Factor float64
	Units  string
}