package core_bench

You can search for identifiers within the package.

in-package search v0.2.0

package core_bench

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

module Quota = Core_bench_internals.Quota

module Test = Core_bench_internals.Test

module Run_config = Core_bench_internals.Run_config

module Display_column = Core_bench_internals.Display_column

module Display_config = Core_bench_internals.Display_config

module Variable = Core_bench_internals.Variable

module Measurement = Core_bench_internals.Measurement

module Analysis_config = Core_bench_internals.Analysis_config

module Analysis_result = Core_bench_internals.Analysis_result

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:string ->
  Test.t list ->
  unit

bench tests will run, analyze and display the specified tests. Use this when one needs more control over the execution parameters that what is exposed through make_command. bench can also save the measurements of each test to the filename returned by save_to_file.

val measure : ?run_config:Run_config.t -> Test.t list -> Measurement.t list

measure is a fragment of the functionality of bench. measure tests will run the specified tests and return the resulting measurement results.

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

analyze is a fragment of the functionality of bench. analyze ~analysis_configs m will analyze the measurement m using the regressions specified.

val display : 
  ?libname:string ->
  ?display_config:Display_config.t ->
  Analysis_result.t list ->
  unit

display is a fragment of the functionality of bench. display results will display a tabular summary of results on the terminal.