make ~name fn is a naming benchmark measuring fn. fn can be constructed with Staged.stage:

  let write =
    Test.make ~name:"unix-write"
      (Staged.stage @@ fun () -> Unix.write Unix.stdout "Hello World!")

make_with_resource ~name k ~allocate ~free fn is a naming benchmark measuring fn with a pre-allocated resource 'v (given by allocate). It permits to measure fn which requires a resource allocated before the benchmark. Then, this resource can be free-ed via the given free function.

Depending on the k given, the resource can be allocated only one time or per run:

• uniq, the resource is allocated one ime before the benchmark and used by fn for all runs. Then, it is free-ed at the end of the benchmark.
• multiple, the resource is allocated multiple times (depending on how many times we want to run fn) at the beginning of the benchmark and fn is executed with a structurally different resource per run. Then, these resources are free-ed at the end of the benchmark.

NOTE: the multiple case can ask a huge allocation (for instance, it can call 3000 times allocate). Be aware that such usage, depending on what you allocate, can lead an Out_of_memory exception.

make_indexed ~name ~fmt ~args fn is naming benchmarks indexed by an argument (by args). Name of each benchmark is Fmt.strf fmt name arg (default to "%s:%d").

  let make_list words =
    Staged.stage @@ fun () ->
    let rec go n acc = if n = 0 then acc else go (n - 1) (n :: acc) in
    go ((words / 3) + 1) []

  let test =
    make_indexed ~name:"make_list" ~args:[ 0; 10; 100; 100 ] make_list

This kind of test is helpful to see results of the same implementation with differents arguments (indexed by the given int).

make_grouped ~name ~fmt tests is naming benchmarks. Name of each benchmark is Fmt.strf fmt name arg (default to %s/%s).

  let f0 = Test.make ~name:"fib1" ... ;; let f1 = Test.make ~name:"fib0"
  ... ;;

  let test = Test.make_grouped ~name:"fibonacci" [ f0; f1; ] ;;

This kind of test is helpful to compare results between many implementations.

name t returns the name of the test.

names t returns names of sub-tests of t (such as indexed tests or grouped tests).

elements t returns all measuring functions of t.