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.inline_benchmarks
- Inline_benchmarks_public
  - Common
  - Runner
core_bench.internals
- Core_bench_internals
  - Analysis_config
  - Analysis_result
    
    Ci95
    
    Coefficient
    
    Regression
  - Analysis_result_intf
    
    Analysis_result
    
    Ci95
    
    Coefficient
    
    Regression
  - Bench
  - Bench_command_column
  - Defaults
  - Display
    
    Warnings
  - Display_column
  - Display_config
    
    Table
    
    How_to_print
    
    Human_readable
  - Linear_algebra
    
    Mat
    
    Vec
  - Linear_algebra_wrapper
  - Measurement
  - Measurement_sample
  - Quota
  - Run_config
  - Simplified_benchmark
    
    Field_type
    
    Result
    
    Results
  - Test
    
    Basic_test
    
    Id
    
    For_testing
    
    Hash_queue
    
    Hash_set
    
    Provide_bin_io
    
    X
    
    Provide_of_sexp
    
    X
    
    Map
    
    Diff
    
    Key
    
    Provide_bin_io
    
    Key
    
    Provide_hash
    
    Provide_of_sexp
    
    Key
    
    Set
    
    Diff
    
    Elt
    
    Provide_bin_io
    
    Elt
    
    Provide_hash
    
    Provide_of_sexp
    
    Elt
    
    Table
    
    Provide_bin_io
    
    Key
    
    Provide_of_sexp
    
    Key
  - Variable
  - Verbosity
core_bench.js
- Core_bench_js
core_bench.runner
- Public_runner

Legend:
Library
Module
Module type
Parameter
Class
Class type

The purpose of functions in this module are documented in the Core_bench.Bench module

These functions are different in one main regard: they take first-class functions for platform-specific functionality, like displaying the tables, or performing the actual measurement for the benchmark. That is what these measure_with and display parameters are for.

val bench : 
  ?run_config:Run_config.t ->
  ?analysis_configs:Analysis_config.t list ->
  ?display_config:Display_config.t ->
  ?save_to_file:(Measurement.t -> string) ->
  ?libname:'b ->
  Test.t list ->
  measure_with:
    (?postprocess:(Measurement.t -> unit) ->
      Run_config.t ->
      Test.Basic_test.t list ->
      Measurement.t list) ->
  display:
    (?libname:'b ->
      ?display_config:Display_config.t ->
      Analysis_result.t list ->
      unit) ->
  unit

val measure : 
  ?run_config:Run_config.t ->
  Test.t list ->
  measure_with:(Run_config.t -> Test.Basic_test.t list -> Measurement.t list) ->
  Measurement.t list

val analyze : 
  ?analysis_configs:Analysis_config.t list ->
  Measurement.t ->
  Analysis_result.t Core.Or_error.t

val analyze_and_display : 
  measurements:Measurement.t list ->
  ?analysis_configs:Analysis_config.t list ->
  ?display_config:Display_config.t ->
  ?libname:'b ->
  display:
    (?libname:'b ->
      ?display_config:Display_config.t ->
      Analysis_result.t list ->
      unit) ->
  unit ->
  unit