package core_bench

  1. Overview
  2. Docs
package core_bench
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Bench.QuotaSource

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.)

Sourcetype t =
  1. | Span of Core.Time.Span.t
  2. | Num_calls of int
include Ppx_sexp_conv_lib.Sexpable.S with type t := t
Sourceval t_of_sexp : Sexplib0__.Sexp.t -> t
Sourceval sexp_of_t : t -> Sexplib0__.Sexp.t
include Core.Bin_prot.Binable.S with type t := t
Sourceval bin_size_t : t Bin_prot.Size.sizer
Sourceval bin_write_t : t Bin_prot.Write.writer
Sourceval bin_read_t : t Bin_prot.Read.reader
Sourceval __bin_read_t__ : (int -> t) Bin_prot.Read.reader
Sourceval bin_shape_t : Bin_prot.Shape.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
Sourceval of_string : string -> t
Sourceval to_string : t -> string
Sourceval 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.

Sourceval max_count : t -> int

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

Sourceval scale_int : t -> int -> t

Scale by an integer factor