package core

  1. Overview
  2. No Docs
Industrial strength alternative to OCaml's standard library

Install 

dune-project
 Dependency

github.com Edit opam file Versions (13)

Authors

  1. J
    Jane Street Group, LLC

Maintainers

  1. J
    Jane Street developers

Sources

v0.16.2.tar.gz
md5=bcac85c0ec5795ccabf1dccf0968ecd9
sha512=2e68556773549e0bf302c8733c9fc57df3c0fd73a1b547dc17097f74c5b5482c816ef89853b437e49452da7c124ef32a8a0de0dff64d71145b2ab11befbe5bb2

doc/core/Core/Quickcheck/index.html

Module Core.QuickcheckSource

Sourcetype nonrec seed = Quickcheck_intf.seed
Sourcetype nonrec shrink_attempts = Quickcheck_intf.shrink_attempts

An 'a t a generates values of type 'a with a specific probability distribution.

An 'a Quickcheck.Observer.t represents a hash function on 'a. Observers are used to construct distributions of random functions; see Quickcheck.Generator.fn.

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

Sourcemodule type S = Quickcheck_intf.S
Sourcemodule type S1 = Quickcheck_intf.S1
Sourcemodule type S2 = Quickcheck_intf.S2
Sourcemodule type S_int = Quickcheck_intf.S_int
Sourcemodule type S_range = Quickcheck_intf.S_range
include Quickcheck_intf.Syntax with module Generator := Generator and module Open_on_rhs := Generator
include Base.Monad.Syntax with type 'a t := 'a Generator.t and module Let_syntax.Let_syntax.Open_on_rhs = Generator
Sourcemodule Let_syntax : sig ... end

These are convenient to have in scope when programming with a monad:

Sourcemodule type Quickcheck_config = Quickcheck_intf.Quickcheck_config
Sourcemodule type Quickcheck_configured = Quickcheck_intf.Quickcheck_configured

with a default config

include Quickcheck_configured
include Quickcheck_intf.Quickcheck_config
Sourceval 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.

Sourceval default_sizes : Base.Int.t Sequence.t

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

Sourceval default_trial_count : Base.Int.t

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

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

Sourceval 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

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

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

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

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

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

Sourceval test_or_error : ?seed:Quickcheck_intf.seed -> ?sizes:Base.Int.t Sequence.t -> ?trials:Base.Int.t -> ?shrinker:'a Base_quickcheck.Shrinker.t -> ?shrink_attempts:Quickcheck_intf.shrink_attempts -> ?sexp_of:('a -> Base.Sexp.t) -> ?examples:'a Base.List.t -> 'a Base_quickcheck.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 also treated as failures.

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

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

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

test_distinct_values gen 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.

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