Module Bench

module Bench: Bench

Simple example:

open Core.Std module Bench = Core_extended.Bench

let main () = Bench.bench Bench.Test.create ~name:"test" (fun () -> ignore (Time.now ())) ;;

let () = main ()

module Test: sig .. end

module Result: sig .. end

verbosity (default low): If low, only prints results. If mid, additionally prints time estimates and a status line. If high, additionally prints information at each step of benchmarking.

gc_prefs: can be used to set custom GC settings during benchmarking (they will be reverted when the function returns)

no_compactions (default false): disables compactions during benchmarking, reverted when the function returns. Takes precedence over gc_prefs.

trials (default `Auto): runs this many trials for each sample. If `Auto, bench will automatically determine the number of trials to run based on how long it takes to run one trial. It will run enough trials n so that the mean cost of calling rdtscp is less than one percent of n, and it takes more than 0.01 seconds.

clock (default wall): controls time measurement method. Wall includes waiting on I/O and when the process is suspended/descheduled; cpu only counts time spent on computations.

type 'a with_benchmark_flags = ?verbosity:[ `High | `Low | `Mid ] ->
       ?gc_prefs:Core.Gc.Control.t ->
       ?no_compactions:bool ->
       ?trials:[ `Auto | `Num of int ] -> ?clock:[ `Cpu | `Wall ] -> 'a

type column = [ `Allocated
       | `Cycles
       | `Input_size
       | `Name
       | `Nanos
       | `Normalized_cycles
       | `Warnings ]

type 'a with_print_flags = ?limit_width_to:int ->
       ?columns:[ `Allocated
                | `Cycles
                | `If_not_empty of column
                | `Input_size
                | `Name
                | `Nanos
                | `Normalized_cycles
                | `Warnings ] list ->
       ?display:Ascii_table.Display.t -> 'a

The "Name" and "Input size" columns of the printed table reflect the values passed to Test.create. The "Normalized" column is run_time / input_size. "Stdev" reports the standard deviation for the "Run time" column. "Allocated" reports the average number of allocated words through the benchmarks.

"Warnings" may contain single characters indicating various things: 'm' indicates the minimum run time was less than 80% of the mean 'M' indicates the maximum run time was more than 120% of the mean 'c' indicates GC compactions occurred during testing 'a' indicates the number of words allocated was not the same in all tests

limit_with_to defaults to 72.

columns: select which columns to display. `If_not_empty c means print the column only if at least one cell contains something. It defaults to: [`If_not_empty `Name; `Normalized_cycles; `If_not_empty `Warnings].

val bench : (Test.t list -> unit) with_benchmark_flags with_print_flags

val bench_raw : (Test.t list -> Result.t list) with_benchmark_flags

bench_raw returns a list documenting the runtimes rather than printing to stdout. These can be fed to print for results identical to calling bench.

val print : (Result.t list -> unit) with_print_flags