Index

Modules: criterion, criterion/blackbox, criterion/config, criterion/consoleExporter, criterion/cycles, criterion/exporter, criterion/impl, criterion/jsonExporter, criterion/statistics, criterion/sugar, criterion/timer.

API symbols

bench:

• impl: proc bench(cfg: Config; label: string; body: proc (): void): Statistics

benchmark:

• sugar: template benchmark(userCfg: Config; body: untyped): untyped

BenchmarkResult:

• exporter: tuple BenchmarkResult

blackBox:

• blackbox: template blackBox[T](x: var T)
• blackbox: template blackBox[T](x: T)

boringWrite:

• consoleExporter: macro boringWrite(f: File; m: varargs[typed]): untyped

CI:

• statistics: object CI

Config:

• config: object Config

cycles1:

• cycles: proc cycles1(): float64

Estimates:

• statistics: object Estimates

getMonotonicTime:

• timer: proc getMonotonicTime(): float64

isZero:

• statistics: proc isZero(o: Outliers): bool

measure:

• sugar: template measure()
• sugar: template measure(_: typed)

newDefaultConfig:

• config: proc newDefaultConfig(): Config

newEstimates:

• statistics: proc newEstimates(cfg: Config; iterations: seq[int]; rawSamples, samples: seq[float64]): Estimates

newStatistics:

• statistics: proc newStatistics(cfg: Config; label: string; iterations: seq[int]; samples, cycleSamples: seq[float64]): Statistics

NS_IN_S:

• timer: const NS_IN_S

Outliers:

• statistics: tuple Outliers

ParamTuple:

• exporter: tuple ParamTuple

Statistics:

• statistics: object Statistics

styledWriteLine:

• consoleExporter: template styledWriteLine(f: File; args: varargs[untyped])

toDisplay:

• consoleExporter: proc toDisplay(cfg: Config; strm: Stream; r: BenchmarkResult)
• consoleExporter: proc toDisplay(cfg: Config; strm: Stream; r: seq[BenchmarkResult])

toJson:

• jsonExporter: proc toJson(cfg: Config; strm: Stream; r: BenchmarkResult)
• jsonExporter: proc toJson(cfg: Config; strm: Stream; r: seq[BenchmarkResult])

toOrdinal:

• statistics: converter toOrdinal[T](v: CI[T]): T