package ppx_bench

You can search for identifiers within the package.

in-package search v0.2.0

Syntax extension for writing in-line benchmarks in ocaml code

Install

Dune Dependency

github.com Readme Changelog MIT License Edit opam file Versions (9)

Authors

J

Jane Street Group, LLC

Maintainers

J

Jane Street developers

Sources

ppx_bench-v0.13.0.tar.gz

sha256=6f37851e928595544e48204159b28366ed6e671c0d2a6a5b2d67f12c0cd7984b

md5=d800ee5e0b2a12401ba40e16865eabae

doc/ppx_bench.runtime-lib/Ppx_bench_lib/Benchmark_accumulator/index.html

Module `Ppx_bench_lib.Benchmark_accumulator`

The point of Benchmark_accumulator is to provide a global place where inline benchmarking macros can register themselves. Once registered here, the benchmarks are retrieved and analyzed using Core_bench.

This module holds the registered benchmarks in a global hashtable indexed by library name. We care about the registered benchmarks if and only if the library is being used in a inline_benchmarks_runner.exe. To avoid building this hashtable in cases where we will not use it, this module peeks into the commandline args of the running program to decide if the benchmarks should be registered or not.

module Current_libname : sig ... end

module Entry : sig ... end

val add_environment_var : bool

add_environment_var returns true if the benchmarks should be added to the hashtable

val lookup_lib : libname:string -> Entry.t list

lookup_lib returns all the benchmarks from the specified library

val add_bench : 
  name:string ->
  code:string ->
  filename:string ->
  type_conv_path:string ->
  line:int ->
  startpos:int ->
  endpos:int ->
  Entry.test_spec ->
  unit

add_bench registers benchmarks with the global hashtable maintained in ppx_bench_lib. This is meant to be called by the code generated for the BENCH and BENCH_INDEXED macros

val add_bench_module : 
  name:string ->
  code:string ->
  type_conv_path:string ->
  filename:string ->
  line:int ->
  startpos:int ->
  endpos:int ->
  (unit -> unit) ->
  unit

add_bench_module adds a bench module name to the benchmarks. This is called by BENCH_MODULE macro