package core_kernel

  1. Overview
  2. Docs
package core_kernel
Legend:
Library
Module
Module type
Parameter
Class
Class type
type nonrec seed = Quickcheck_intf.seed
type nonrec shrink_attempts = Quickcheck_intf.shrink_attempts
module Observer : Quickcheck_intf.Observer with type 'a gen := 'a Generator.t

A 'a Quickcheck.Shrinker.t takes a value of type 'a and produces similar values that are smaller by some metric.

module type S = Quickcheck_intf.S with type 'a gen := 'a Generator.t with type 'a obs := 'a Observer.t with type 'a shr := 'a Shrinker.t
module type S1 = Quickcheck_intf.S1 with type 'a gen := 'a Generator.t with type 'a obs := 'a Observer.t with type 'a shr := 'a Shrinker.t
module type S2 = Quickcheck_intf.S2 with type 'a gen := 'a Generator.t with type 'a obs := 'a Observer.t with type 'a shr := 'a Shrinker.t
module type S_int = Quickcheck_intf.S_int with type 'a gen := 'a Generator.t with type 'a obs := 'a Observer.t with type 'a shr := 'a Shrinker.t
module Let_syntax : module type of Generator.Let_syntax with module Let_syntax.Open_on_rhs = Generator
module Make_int (M : Quickcheck_intf.Pre_int) : S_int with type t := M.t
module For_int : S_int with type t := Base.Int.t
module type Quickcheck_config = Quickcheck_intf.Quickcheck_config
module type Quickcheck_configured = Quickcheck_intf.Quickcheck_configured with type 'a gen := 'a Generator.t with type 'a shr := 'a Shrinker.t

with a default config

include Quickcheck_configured
include Quickcheck_intf.Quickcheck_config
val default_seed : Quickcheck_intf.seed

default_seed is used initialize the pseudo-random generator that chooses random values from generators, in each test that is not provided its own seed.

val default_sizes : Base.Int.t Sequence.t

default_sizes determines the default sequence of sizes used in generating values.

val default_trial_count : Base.Int.t

default_trial_count determines the number of trials per test, except in tests that explicitly override it.

val default_can_generate_trial_count : Base.Int.t

default_can_generate_trial_count determines the number of trials used in attempts to generate satisfying values, except in tests that explicitly override it.

val default_attempts_per_trial : Base.Float.t

default_attempts_per_trial determines the maximum number of attempts to generate inputs for trials, as a multiplier for the number of trials, except in tests that explicitly override it.

val default_shrink_attempts : Quickcheck_intf.shrink_attempts

default_shrink_attempts determines the number of attempts at shrinking when running test or iter with ~shrinker and without ~shrink_attempts

val random_value : ?seed:Quickcheck_intf.seed -> ?size:Base.Int.t -> 'a Generator.t -> 'a

random_value ~seed gen produces a single value chosen from gen using seed.

val iter : ?seed:Quickcheck_intf.seed -> ?sizes:Base.Int.t Sequence.t -> ?trials:Base.Int.t -> ?attempts:Base.Int.t -> ?filter:('a -> Base.Bool.t) -> 'a Generator.t -> f:('a -> Base.Unit.t) -> Base.Unit.t

iter ~seed ~trials ~attempts ~filter gen ~f runs f on up to trials different values generated by gen. It stops successfully after trials successful trials or if gen runs out of values. It raises an exception if f raises an exception or if it fails to produce trials inputs from gen after attempts attempts. If filter is provided, iteration proceeds over Generator.filter gen ~f:filter.

val test : ?seed:Quickcheck_intf.seed -> ?sizes:Base.Int.t Sequence.t -> ?trials:Base.Int.t -> ?attempts:Base.Int.t -> ?filter:('a -> Base.Bool.t) -> ?shrinker:'a Shrinker.t -> ?shrink_attempts:Quickcheck_intf.shrink_attempts -> ?sexp_of:('a -> Base.Sexp.t) -> ?examples:'a Base.List.t -> 'a Generator.t -> f:('a -> Base.Unit.t) -> Base.Unit.t

test ~seed ~trials ~attempts ~sexp_of ~examples gen ~f is like iter, with optional concrete examples that are tested before values from gen, and additional information provided on failure. If f raises an exception and sexp_of is provided, the exception is re-raised with a description of the random input that triggered the failure. If f raises an exception and shrinker is provided, it will be used to attempt to shrink the value that caused the exception with re-raising behaving the same as for unshrunk inputs.

val test_or_error : ?seed:Quickcheck_intf.seed -> ?sizes:Base.Int.t Sequence.t -> ?trials:Base.Int.t -> ?attempts:Base.Int.t -> ?filter:('a -> Base.Bool.t) -> ?shrinker:'a Shrinker.t -> ?shrink_attempts:Quickcheck_intf.shrink_attempts -> ?sexp_of:('a -> Base.Sexp.t) -> ?examples:'a Base.List.t -> 'a Generator.t -> f:('a -> Base.Unit.t Or_error.t) -> Base.Unit.t Or_error.t

test_or_error is like test, except failure is determined using Or_error.t. Any exceptions raised by f are not caught.

val test_can_generate : ?seed:Quickcheck_intf.seed -> ?sizes:Base.Int.t Sequence.t -> ?trials:Base.Int.t -> ?attempts:Base.Int.t -> ?filter:('a -> Base.Bool.t) -> ?sexp_of:('a -> Base.Sexp.t) -> 'a Generator.t -> f:('a -> Base.Bool.t) -> Base.Unit.t

test_can_generate ~seed ~trials ~attempts ~sexp_of gen ~f is useful for testing gen values, to make sure they can generate useful examples. It tests gen by generating up to trials values and passing them to f. Once a value satisfies f, the iteration stops. If no values satisfy f, test_can_generate raises an exception. If sexp_of is provided, the exception includes all of the generated values.

val test_distinct_values : ?seed:Quickcheck_intf.seed -> ?sizes:Base.Int.t Sequence.t -> ?attempts:Base.Int.t -> ?filter:('a -> Base.Bool.t) -> ?sexp_of:('a -> Base.Sexp.t) -> 'a Generator.t -> trials:Base.Int.t -> distinct_values:Base.Int.t -> compare:('a -> 'a -> Base.Int.t) -> Base.Unit.t

test_distinct_values gen ~compare ~trials ~distinct_values is useful for testing gen values, to make sure they create sufficient distinct values. It tests gen by generating up to trials values and making sure at least distinct_values of the resulting values are unique with respect to compare. If too few distinct values are generated, test_distinct_values raises an exception. If sexp_of is provided, the exception includes the values generated.

val random_sequence : ?seed:Quickcheck_intf.seed -> ?sizes:Base.Int.t Sequence.t -> 'a Generator.t -> 'a Sequence.t

random_sequence ~seed gen produces a sequence of values chosen from gen.

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