Index of values

Binding operator alias for QCheck2.Gen.pair.

Binding operator alias for QCheck2.Gen.bind.

a -- b is an alias for int_range a b.

Synonym for QCheck.Gen.int_range.

Synonym for QCheck.int_range.

a --. b is an alias for float_range ~origin:a a b.

Synonym for float_range

An infix synonym for QCheck2.Gen.map

An infix synonym for QCheck.Gen.map

Synonym for QCheck2.Gen.ap

Infix operator for composing a function generator and an argument generator into a result generator.

Synonym for QCheck.Iter.append.

b1 ==> b2 is the logical implication b1 => b2 ie not b1 || b2 (except that it is strict and will interact better with QCheck2.Test.check_exn and the likes, because they will know the precondition was not satisfied.).

b1 ==> b2 is the logical implication b1 => b2 ie not b1 || b2 (except that it is strict and will interact better with QCheck.Test.check_exn and the likes, because they will know the precondition was not satisfied.).

Same as OUnit.(>:::) but with a list of QCheck2 tests

Synonym for QCheck2.Gen.bind

Monadic bind for writing dependent generators.

An infix synonym for QCheck2.Gen.map.

An infix synonym for QCheck.Gen.map.

Alias for QCheck2.Tuple.o_cons.

Alias to B_cons.

Alias for QCheck2.Tuple.cons.

Alias to QCheck.Tuple.cons.

Update shrinker by only keeping smaller values satisfying the given invariant.

Add a statistic to the arbitrary instance.

Always return the same element.

Binding operator alias for QCheck2.Gen.pair.

ap fgen gen composes a function generator and an argument generator into a result generator.

apply f returns the underlying function to be used in tests.

array o wraps the observable o of 'a into an observable of 'a array.

array p is a printer of array, using p for each element.

Builds an array generator from an element generator.

Shrink an array.

Array printer.

Builds an array generator from an element generator.

Generates arrays with length generated by QCheck.Gen.nat.

Generates arrays with length from the given distribution.

array_repeat i g builds an array generator from exactly i elements generated by g.

array_repeat i g builds an array generator from exactly i elements generated by g.

Builds an array generator from a (non-negative) size generator and an element generator.

Builds an array generator from a (non-negative) size generator and an element generator.

array_subset k arr generates a sub-array of k elements at distinct positions in the input array arr, in the same order.

assume cond checks the precondition cond, and does nothing if cond=true.

assume cond checks the precondition cond, and does nothing if cond=true.

assume_fail () is like assume false, but can take any type since we know it always fails (like assert false).

assume_fail () is like assume false, but can take any type since we know it always fails (like assert false).

Generates natural numbers, possibly large (< 1_000_000).

Generates natural numbers, possibly large.

bind gen f first generates a value of type 'a with gen and then passes it to f to generate a value of type 'b.

bool is an observable of bool.

bool is a printer of boolean.

The boolean generator.

Boolean printer.

The boolean generator.

Uniform boolean generator.

bytes is an observable of bytes.

bytes is a printer of bytes.

Bytes generator using the QCheck2.Gen.char character generator.

Bytes printer.

Builds a bytes generator.

Generates bytes with a distribution of length of QCheck.Gen.nat and distribution of characters of char.

Builds a bytes generator from a (non-negative) size generator and a character generator.

Builds a bytes generator using the given character generator.

Builds a bytes generator using the given character generator.

Generates bytes with a distribution of length of QCheck.Gen.nat.

Generates bytes with distribution of characters of char.

Generator using the QCheck2.Gen.printable character generator.

Generator using the QCheck.Gen.printable character generator.

Generates bytes with a distribution of length of QCheck.Gen.nat and distribution of characters of printable_char.

Builds a bytes generator from a (non-negative) size generator.

Builds a bytes generator from a (non-negative) size generator.

Builds a bytes generator using the QCheck2.Gen.char character generator, length is QCheck2.Gen.small_nat.

Builds a bytes generator using the QCheck.Gen.char character generator, length is QCheck.Gen.small_nat

Same as QCheck.bytes but with a small length (ie QCheck.Gen.small_nat ).

Builds a bytes generator using the given character generator, length is QCheck2.Gen.small_nat.

Builds a bytes generator using the given character generator, length is QCheck.Gen.small_nat.

Same as QCheck.bytes_of but with a small length (ie QCheck.Gen.small_nat ).

char is an observable of char.

char is a printer of character.

Generates characters in the 0..255 range.

Shrinks towards 'a'.

Character printer.

Generates characters upto character code 255.

Uniformly distributed on all the chars (not just ascii or valid latin-1).

Shrinks towards '0'.

Shrinks towards 'a' like !char.

char_range ?origin low high generates chars between low and high, inclusive.

Generates chars between the two bounds, inclusive.

check_cell ~long ~rand test generates up to count random values of type 'a using Gen.t and the random state st.

See QCheck2.Test.check_cell.

Same as QCheck2.Test.check_cell but calls QCheck2.Test.check_result on the result.

See QCheck2.Test.check_cell_exn.

Checks the property against some test cases, and calls QCheck2.Test.check_result, which might raise an exception in case of failure.

See QCheck2.Test.check_exn.

For a positive test check_result cell res checks that res is Ok _, and returns unit.

children tree returns the direct sub-trees of the tree of generated values t.

Choose among the given list of generators.

Obtain statistics

comap f p maps p, a printer of type 'b, to a printer of type 'a by first converting a printed value using f : 'a -> 'b.

cons is Cons.

contramap f o maps the function f on observable o.

contramap f p transforms printer p into another using f.

The function used by the default handler to debug shrinking choices.

The default handler used.

Delay execution of some code until the generator is actually called.

Delay execution of some code until the generator is actually called.

equal o returns the equality function of o.

Fail the test with some additional message that will be reported.

Fail the test with some additional message that will be reported.

Format version of QCheck2.Test.fail_report.

Format version of QCheck.Test.fail_report

filter f shrink shrinks values the same as shrink, but only keep smaller values that satisfy f.

find_example ~f gen uses gen to generate some values of type 'a, and checks them against f.

find_example ~f gen uses gen to generate some values of type 'a, and checks them against f.

Toplevel version of QCheck2.find_example.

Toplevel version of QCheck.find_example.

Parametrized fixpoint combinator for generating recursive values.

Parametrized fixpoint combinator for generating recursive values.

Generate an array of elements from individual generators.

Generate an array of elements from individual generators

Generate a list of elements from individual generators.

Generate a list of elements from individual generators

Generate an option from an optional generator.

Generate an option from an optional generator

Generate a result from Ok gen, an error from Error e.

Generate a result from Ok g, an error from Error e

float is an observable of float.

float is a printer of float.

Generates floating point numbers.

Floating point number printer.

Generates floating point numbers.

Generates regular floats (no nan and no infinities).

float_bound_exclusive origin bound returns a random floating-point number between 0. and bound (exclusive).

float_bound_exclusive bound returns a random floating-point number between 0 and bound (exclusive).

float_bound_exclusive n is uniform between 0 included and n excluded.

float_bound_inclusive ?origin bound returns a random floating-point number between 0. and bound (inclusive).

float_bound_inclusive bound returns a random floating-point number between 0 and bound (inclusive).

float_bound_inclusive n is uniform between 0 and n included.

float_range ?origin low high generates floating-point numbers within low and high (inclusive).

float_range low high generates floating-point numbers within low and high (inclusive)

float_range low high is uniform between low included and high included.

QCheck2.Shrink.number_towards specialized to float.

Constructs a generator that selects among a given list of generators.

Constructs a generator that selects among a given list of generators.

Similar to QCheck.oneof but with frequencies.

Constructs a generator that selects among a given array of values.

Constructs a generator that selects among a given array of values.

Same as QCheck.frequencyl, but with an array.

Constructs a generator that selects among a given list of values.

Constructs a generator that selects among a given list of values.

Same as QCheck.oneofl, but each element is paired with its frequency in the probability distribution (the higher, the more likely).

fun1 obs gen generates random functions that take an argument observable via obs and map to random values generated with gen.

fun1 o ret makes random functions that take an argument observable via o and map to random values generated from ret.

Specialized version of QCheck2.fun_nary for functions of 2 arguments, for convenience.

Specialized version of QCheck2.fun_nary for functions of 3 arguments, for convenience.

Specialized version of QCheck2.fun_nary for functions of 4 arguments, for convenience.

fun_nary tuple_obs gen generates random n-ary functions.

fun_nary makes random n-ary functions.

Access the underlying random generator of this arbitrary object.

generate ~n gen generates n values using gen (shrinks are discarded).

generate ~n g generates n instances of g.

generate1 gen generates one instance of gen (shrinks are discarded).

generate1 g generates one instance of g.

generate_tree ?rand gen generates a random value and its shrinks using gen.

get_collect t returns the repartition of generated values.

Get the count of a cell.

get_count t returns the number of tests executed.

Get the count of a cell.

get_count_gen t returns the number of generated cases.

Access the underlying random generator of this arbitrary object.

get_instances t returns the generated instances, with no guarantee on the order.

Get the long factor of a cell.

Get the expected mode of a cell: positive indicates expected to satisfy the tested property, negative indicates expected not to satisfy the tested property.

get_state t returns the final state after a test execution.

get_stats t returns the statistics captured by the test.

Get the minimum time to wait between printing messages.

get_warnings t returns the list of warnings emitted during the test.

graft_corners gen l () makes a new generator that enumerates the corner cases in l and then behaves like g.

graft_corners gen l () makes a new generator that enumerates the corner cases in l and then behaves like g.

hash o returns the hashing function of o.

int is an observable of int.

int is a printer of integer.

Generates integers uniformly.

Integer printer.

Generates integers uniformly.

Int generator.

Generates uniform QCheck2.Gen.int32 values.

Int32 generator.

QCheck2.Shrink.number_towards specialized to int32.

Generates uniform QCheck2.Gen.int64 values.

Int64 generator.

QCheck2.Shrink.number_towards specialized to int64.

Shrink integers by trying all smaller integers (can take a lot of time!)

int_agressive_towards destination n gives all integers from destination to n (excluded).

Uniform integer generator producing integers within 0..bound.

Uniform integer generator producing integers between 0 and bound (inclusive).

int_bound n is uniform between 0 and n included.

All corner cases for int.

All corner cases for int.

Non-negative corner cases for int.

Non-negative corner cases for int.

int_range ?origin low high is an uniform integer generator producing integers within low..high (inclusive).

Uniform integer generator producing integers within low,high (inclusive).

int_range a b is uniform between a and b included.

QCheck2.Shrink.number_towards specialized to int.

Returns true iff the state is Failed _

Returns true iff the state is Success

Returns true iff the state if Success

Collapses a generator of generators to a generator.

Collapses a generator of generators to simply a generator.

Binding operator alias for QCheck2.Gen.map.

list o wraps the observable o of 'a into an observable of 'a list.

list p is a printer of list, using p for each element.

Builds a list generator from an element generator.

Try to shrink lists by removing one or more elements.

List printer.

Builds a list generator from an element generator.

Generates lists with length generated by QCheck.Gen.nat.

Shrinks the elements of a list, without changing the list size.

Generates lists with length from the given distribution.

list_repeat i g builds a list generator from exactly i elements generated by g.

list_repeat i g builds a list generator from exactly i elements generated by g.

Builds a list generator from a (non-negative) size generator and an element generator.

Builds a list generator from a (non-negative) size generator and an element generator.

Try to shrink lists by removing one or more elements.

Is the default mode to run long tests or nor?

make gen prop builds a test that checks property prop on instances of the generator gen.

make ?eq ?hash print creates an observable of 'a.

make arb prop builds a test that checks property prop on instances of the generator arb.

Builder for arbitrary.

make_cell gen prop builds a test that checks property prop on instances of the generator gen.

make_cell arb prop builds a test that checks property prop on instances of the generator arb.

make_neg gen prop builds a test that checks property prop on instances of the generator gen.

make_neg arb prop builds a test that checks property prop on instances of the generator arb.

make_primitive ~gen ~shrink creates a generator from a function gen that creates a random value (this function must only use the given Random.State.t for randomness) and a function shrink that, given a value a, returns a lazy list of "smaller" values (used when a test fails).

map f gen transforms a generator gen by applying f to each generated element.

map f g transforms a generator g by applying f to each generated element.

map f a returns a new arbitrary instance that generates values using a#gen and then transforms them through f.

map2 f gen1 gen2 transforms two generators gen1 and gen2 by applying f to each pair of generated elements.

map2 f g1 g2 transforms two generators g1 and g2 by applying f to each pair of generated elements.

map3 f gen1 gen2 gen3 transforms three generators gen1, gen2, and gen3 by applying f to each triple of generated elements.

map3 f g1 g2 g3 transforms three generators g1, g2, and g3 by applying f to each triple of generated elements.

map_keep_input f g transforms a generator g by applying f to each generated element.

map_keep_input f a generates random values from a, and maps them into values of type 'b using the function f, but it also keeps the original value.

Specialization of map when the transformation preserves the type, which makes shrinker, printer, etc.

Generates natural numbers (< 10_000).

Generates small natural numbers.

nat_split ~size:k n generates k-sized arrays n1,n2,..nk of natural numbers in [0;n] with n1 + n2 + ... + nk = n.

nat_split2 n generates pairs (n1, n2) of natural numbers with n1 + n2 = n.

Negative float generator (no nan and no infinities).

Generates non-strictly negative integers (0 included).

Generates non-strictly negative integers (0 included).

Negative int generator (0 included, see QCheck.Gen.neg_int).

Generates negative floating point numbers.

Generates negative floating point numbers.

nil is Nil.

No shrink

no_shrink gen returns a generator using gen but with shrinking disabled

Shrink a number by edging towards a destination.

Generates numeral characters '0'..'9'.

Generates numeral characters.

Uniformly distributed over '0'..'9'.

Generates strings with a distribution of length of QCheck.Gen.nat and distribution of characters of numeral_char.

Generates strings with a distribution of characters of numeral_char.

o_cons is the QCheck2.Tuple.obs equivalent of QCheck2.Tuple.cons.

o_nil is the QCheck2.Tuple.obs equivalent of QCheck2.Tuple.nil.

observable obs returns the underlying observable of obs.

oneof l constructs a generator that selects among the given list of generators l.

Constructs a generator that selects among a given list of generators.

oneofa a constructs a generator that selects among the given array of values a.

Constructs a generator that selects among a given array of values.

Pick an element randomly in the array.

oneofl l constructs a generator that selects among the given list of values l.

Constructs a generator that selects among a given list of values.

Pick an element randomly in the list.

opt is an alias of QCheck2.Gen.option for backward compatibility.

opt is an alias of QCheck.Gen.option for backward compatibility.

option o wraps the observable o of 'a into an observable of 'a option.

option p is a printer of 'a option, using p if it is a Some.

option gen is an option generator that uses gen when generating Some values.

Option printer.

An option generator, with optional ratio.

Choose between returning Some random value with optional ratio, or None.

pair o1 o2 is an observable of pairs of ('a * 'b).

pair p1 p2 is a printer of pair.

pair gen1 gen2 generates pairs.

pair a b uses a to shrink the first element of tuples, then tries to shrink the second element using b.

Pair printer.

Generates pairs.

Combines two generators into a generator of pairs.

Generates positive floating point numbers (0. included).

Generates positive floating point numbers (0.

Generates non-strictly positive integers uniformly (0 included).

Generates non-strictly positive integers uniformly (0 included).

Positive float generator (no nan and no infinities).

Positive int generator (0 included).

pos_split ~size:k n generates k-sized arrays n1,n2,..nk of strictly positive (non-zero) natural numbers with n1 + n2 + ... + nk = n.

pos_split2 n generates pairs (n1, n2) of strictly positive (nonzero) natural numbers with n1 + n2 = n.

pp ?depth pp_a ppf tree pretty-prints the tree of generated values tree using the pretty-print formatter ppf.

print f prints the implementation of generated function f.

print o returns the printing function of o.

Print "collect" results.

Print statistics.

Generates printable characters.

Generates printable ascii characters - either '\n' or in the range 32 to 126, inclusive

Uniformly distributed over a subset of printable ascii chars.

Generates strings with a distribution of length of QCheck.Gen.nat and distribution of characters of printable_char.

Generates strings with distribution of characters of printable_char.

pure a creates a generator that always returns a.

Synonym for QCheck.Gen.return

quad o1 o2 o3 o4 is an observable of quadruples of ('a * 'b * 'c * 'd).

quad p1 p2 p3 p4 is a printer of quadruple.

quad gen1 gen2 gen3 gen4 generates quadruples.

Similar to QCheck.Shrink.pair

Quadruple (4-tuple) printer.

Generates quadruples.

Combines four generators into a generator of 4-tuples.

Access the current random state

range_subset ~size:k low high generates an array of length k of sorted distinct integers in the range low..high (included).

Synonym for QCheck2.Gen.pure

Create a constant generator.

root tree returns the root value of the tree of generated values t.

run test runs the test, and returns an error code that is 0 if all tests passed, 1 otherwise.

TAP-compatible test runner, in case we want to use a test harness.

Run a suite of tests, and print its results.

Can be used as the main function of a test file.

Change the generator

Change the value of long_tests ()

Change the QCheck_base_runner.random_state by creating a new one, initialized with the given seed.

set_shrink shrink gen sets the shrinker to shrink for gen.

Set the minimum tiem between messages.

Change the value of verbose ()

Returns a copy of the array with its elements shuffled.

Shuffles the array in place.

Creates a generator of shuffled lists.

Creates a generator of shuffled lists.

Creates a generator of weighted shuffled lists.

Creates a generator of weighted shuffled lists.

Creates a generator from a size-bounded generator by first generating a size using QCheck2.Gen.nat and passing the result to the size-bounded generator.

Creates a generator from a size-bounded generator by first generating a size using QCheck.Gen.nat and passing the result to the size-bounded generator.

Creates a generator from a size-bounded generator by first generating a size using the integer generator and passing the result to the size-bounded generator.

Creates a generator from a size-bounded generator by first generating a size using the integer generator and passing the result to the size-bounded generator.

Generates arrays of small size (see QCheck2.Gen.small_nat).

Generates arrays of small size (see QCheck.Gen.small_nat).

As QCheck2.Gen.small_int, but each newly created generator starts with a list of corner cases before falling back on random generation.

As small_int, but each newly created generator starts with a list of corner cases before falling back on random generation.

Generates lists of small size (see QCheck2.Gen.small_nat).

Generates lists of small size (see QCheck.Gen.small_nat).

Generates lists of small size (see QCheck.Gen.small_nat).

Small positive integers (< 100, 0 included).

Small integers (< 100)

Small unsigned integers.

Generates strings with a length of small_nat and distribution of characters of printable_char.

Small SIGNED integers, based on QCheck2.Gen.small_nat.

Small SIGNED integers, based on QCheck.Gen.small_nat.

Small signed integers.

Builds a string generator, length is QCheck2.Gen.small_nat.

Builds a string generator, length is QCheck.Gen.small_nat Accepts an optional character generator (the default is QCheck.Gen.char).

Same as QCheck.string but with a small length (ie QCheck.Gen.small_nat ).

Obtain statistics

string is an observable of string.

string is a printer of string.

Builds a string generator.

String printer.

Builds a string generator.

Generates strings with a distribution of length of QCheck.Gen.nat and distribution of characters of char.

Generates strings with a distribution of length of QCheck.Gen.nat.

Builds a string generator from a (non-negative) size generator and a character generator.

Synonym for numeral_string added for convenience.

Synonym for numeral_string_of_size added for convenience.

Builds a string generator using the given character generator.

Builds a string generator using the given character generator.

Synonym for QCheck.string_gen added for convenience.

Generates strings with distribution of characters of char.

Builds a string generator using the QCheck2.Gen.printable character generator.

Builds a string generator using the QCheck.Gen.printable character generator.

Synonym for printable_string added for convenience.

Synonym for printable_string_of_size added for convenience.

Builds a string generator from a (non-negative) size generator.

Builds a string generator from a (non-negative) size generator.

Builds a string generator using the QCheck2.Gen.char characher generator, length is QCheck2.Gen.small_nat.

Builds a string generator using the QCheck.Gen.char character generator, length is QCheck.Gen.small_nat

Synonym for small_string added for convenience.

Builds a string generator using the given characher generator, length is QCheck2.Gen.small_nat.

Builds a string generator using the given character generator, length is QCheck.Gen.small_nat.

Same as QCheck.string_of but with a small length (ie QCheck.Gen.small_nat ).

Synonym for small_printable_string added for convenience.

to_ounit2_test ?rand t wraps t into a OUnit2 test

to_ounit2_test_list ?rand t like to_ounit2_test but for a list of tests

to_ounit_test ~rand t wraps t into a OUnit test

Same as QCheck_ounit.to_ounit_test but with a polymorphic test cell

triple o1 o2 o3 is an observable of triples of ('a * 'b * 'c).

triple p1 p2 p3 is a printer of triple.

triple gen1 gen2 gen3 generates triples.

Similar to QCheck.Shrink.pair

Triple (3-tuple) printer.

Generates triples.

Combines three generators into a generator of 3-tuples.

2-tuple printer.

tup2 a b uses a to shrink the first element of tuples, then tries to shrink the second element using b.

2-tuple printer.

Combines two generators into a 2-tuple generator.

3-tuple printer.

Similar to QCheck.Shrink.tup2

3-tuple printer.

Combines three generators into a 3-tuple generator.

4-tuple printer.

Similar to QCheck.Shrink.tup2

4-tuple printer.

Combines four generators into a 4-tuple generator.

5-tuple printer.

Similar to QCheck.Shrink.tup2

5-tuple printer.

Combines five generators into a 5-tuple generator.

6-tuple printer.

Similar to QCheck.Shrink.tup2

6-tuple printer.

Combines six generators into a 6-tuple generator.

7-tuple printer.

Similar to QCheck.Shrink.tup2

7-tuple printer.

Combines seven generators into a 7-tuple generator.

8-tuple printer.

Similar to QCheck.Shrink.tup2

8-tuple printer.

Combines eight generators into a 8-tuple generator.

9-tuple printer.

Similar to QCheck.Shrink.tup2

9-tuple printer.

Combines nine generators into a 9-tuple generator.

Generates (unsigned) int32 values.

Generates (unsigned) int64 values.

unit is an observable of unit.

unit is a printer of unit.

The unit generator.

The unit generator.

Always generates (), obviously.

Is the default mode verbose or quiet?

Obtain list of warnings