package core_bench

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

Test.t are benchmarked by calls to bench.

type t = Test.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
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct