luabench

Documentation

Overview

Package luabench measures runtime and memory performance of transpiled Lua code. Benchmarks are TypeScript files in benchmarks/ that export a default function. The harness transpiles them, wraps with os.clock/collectgarbage measurement, and runs via LuaJIT (or another runtime).

Index

• func LuaTargetForRuntime(runtime string) transpiler.LuaTarget
• func PrintLua(results []Result)
• func PrintTable(results []Result)
• type Bench
• type Result
  • func Run(b Bench, mode transpiler.EmitMode, runtime string) (Result, error)

Functions

func LuaTargetForRuntime

func LuaTargetForRuntime(runtime string) transpiler.LuaTarget

LuaTargetForRuntime maps a runtime binary name to a transpiler LuaTarget.

func PrintLua

func PrintLua(results []Result)

PrintLua prints the transpiled Lua for each benchmark, grouped by name with tstl and optimized side by side.

func PrintTable

func PrintTable(results []Result)

PrintTable prints benchmark results as an aligned table with deltas. Results are expected in pairs: [tstl, optimized] for each benchmark.

Types

type Bench

type Bench struct {
	Name       string
	Iterations int // how many times the function is called for timing
}

Bench defines a benchmark to run.

type Result

type Result struct {
	Name       string
	EmitMode   transpiler.EmitMode
	TimeSec    float64
	Iterations int
	GarbageKB  float64
	TotalMemKB float64
	Lua        string // transpiled Lua source (main.ts only)
}

Result holds measurements from a single benchmark run.

func Run

func Run(b Bench, mode transpiler.EmitMode, runtime string) (Result, error)

Run transpiles a benchmark .ts file and measures its Lua performance.