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

A quota can be specified as an amount of wall time, or a number of times to run the function.

(Strictly speaking, for Num_calls n, it is possible that the function is called fewer than n times if the array of measurements fills up. But with default settings for how batches are sized, you don't run into this issue until n is over 1.9e16.)

type t =

| Span of Core.Time.Span.t
| Num_calls of int

include Ppx_sexp_conv_lib.Sexpable.S with type t := t

val t_of_sexp : Sexplib0.Sexp.t -> t

val sexp_of_t : t -> Sexplib0.Sexp.t

include Core.Bin_prot.Binable.S with type t := t

include Bin_prot.Binable.S_only_functions with type t := t

val bin_size_t : t Bin_prot.Size.sizer

val bin_write_t : t Bin_prot.Write.writer

val bin_read_t : t Bin_prot.Read.reader

val __bin_read_t__ : (int -> t) Bin_prot.Read.reader

This function only needs implementation if t exposed to be a polymorphic variant. Despite what the type reads, this does *not* produce a function after reading; instead it takes the constructor tag (int) before reading and reads the rest of the variant t afterwards.

val bin_shape_t : Bin_prot.Shape.t

val bin_writer_t : t Bin_prot.Type_class.writer

val bin_reader_t : t Bin_prot.Type_class.reader

val bin_t : t Bin_prot.Type_class.t

Examples:

"10" -> Span 10s (float-like: convert to seconds)
"1m" -> Span 1m (span-like: keep as span)
"5x" -> Num_calls 5
"1e9x" -> Num_calls 1_000_000_000

include Core.Stringable.S with type t := t

val of_string : string -> t

val to_string : t -> string

val arg_type : t Core.Command.Param.Arg_type.t

val fulfilled : t -> start:Core.Time.t -> num_calls:int -> bool

fulfilled t ~start ~num_calls returns true iff we have fulfilled the quota, given that we *started* at time start and have run the function num_calls times.

val max_count : t -> int

max_count (Num_calls n) returns n, max_count (Span _) returns max_int.

val scale_int : t -> int -> t

Scale by an integer factor