package ppx_bench

  1. Overview
  2. Docs
Syntax extension for writing in-line benchmarks in ocaml code

Install 

dune-project
 Dependency

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

Authors

  1. J
    Jane Street Group, LLC

Maintainers

  1. J
    Jane Street developers

Sources

v0.17.1.tar.gz
md5=496d7d989656c95860cf2434e1d8e0e0
sha512=7492c19b408709368f5a1ed020bea2c439ff562f765cd706637dbfb7ecdfc33478f9dd814fcf195292bf634769ae95f8b89b5b33b714e0fd6248f0754e1d37a4

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

Module Ppx_bench_lib.Benchmark_accumulatorSource

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.

Sourcemodule Current_libname : sig ... end
Sourcemodule Entry : sig ... end
Sourceval add_environment_var : bool

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

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

lookup_lib returns all the benchmarks from the specified library

Sourceval 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

Sourceval 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