package core_bench

You can search for identifiers within the package.

in-package search v0.2.0

core_bench
- Core_bench
  - Bench
    
    Analysis_config
    
    Analysis_result
    
    Ci95
    
    Coefficient
    
    Regression
    
    Display_config
    
    Measurement
    
    Quota
    
    Run_config
    
    Test
    
    Variable
  - Core_bench_private
    
    Simplified_benchmark
    
    Field_type
    
    Result
    
    Results
core_bench.inline_benchmarks
- Inline_benchmarks_public
  - Common
  - Runner
core_bench.runner
- Public_runner

Legend:
Library
Module
Module type
Parameter
Class
Class type

Test.t are benchmarked by calls to bench.

type t

val create : 
  name:string ->
  ?test_name:string ->
  ?file_name:string ->
  ?module_name:string ->
  ?key:int ->
  (unit -> 'a) ->
  t

Creates a simple benchmark. Here the benchmark may return some 'a which is then ignored. One should be careful when putting calls to ignore in benchmarks because OCaml versions 4.02 onwards can optimize away some ignored computations.

val create_with_initialization : 
  name:string ->
  ?test_name:string ->
  ?file_name:string ->
  ?module_name:string ->
  ?key:int ->
  ([ `init ] -> unit -> 'a) ->
  t

val create_indexed : 
  name:string ->
  ?test_name:string ->
  ?file_name:string ->
  ?module_name:string ->
  args:int list ->
  ?key:int ->
  (int -> (unit -> 'a) Core.Staged.t) ->
  t

Creates a group of benchmarks indexed by a size. Also see comment on create about the 'a below.

val create_group : 
  name:string ->
  ?test_name:string ->
  ?file_name:string ->
  ?module_name:string ->
  t list ->
  t

val name : t -> string