package osnap

You can search for identifiers within the package.

in-package search v0.2.0

package osnap

osnap
- Osnap
  - Runner
  - Spec
    
    Gen
  - Test

Legend:
Library
Module
Module type
Parameter
Class
Class type

include module type of QCheck.Gen

Generate Random Values

type 'a t = Random.State.t -> 'a

A random generator for values of type 'a.

type 'a sized = int -> Random.State.t -> 'a

Random generator with a size bound.

val return : 'a -> 'a t

Create a constant generator.

val pure : 'a -> 'a t

Synonym for return

since 0.8

val (>>=) : 'a t -> ('a -> 'b t) -> 'b t

Monadic bind for writing dependent generators. First generates an 'a and then passes it to the given function, to generate a 'b.

val (<*>) : ('a -> 'b) t -> 'a t -> 'b t

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

val map : ('a -> 'b) -> 'a t -> 'b t

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

val map2 : ('a -> 'b -> 'c) -> 'a t -> 'b t -> 'c t

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

val map3 : ('a -> 'b -> 'c -> 'd) -> 'a t -> 'b t -> 'c t -> 'd t

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

val map_keep_input : ('a -> 'b) -> 'a t -> ('a * 'b) t

map_keep_input f g transforms a generator g by applying f to each generated element. Returns both the generated element from g and the output from f.

val (>|=) : 'a t -> ('a -> 'b) -> 'b t

An infix synonym for map.

val (<$>) : ('a -> 'b) -> 'a t -> 'b t

An infix synonym for map

since 0.13

val oneof : 'a t list -> 'a t

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

raises Invalid_argument
or Failure if list is empty

val oneofl : 'a list -> 'a t

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

raises Invalid_argument
or Failure if list is empty

val oneofa : 'a array -> 'a t

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

raises Invalid_argument
or Failure if list is empty

val frequency : (int * 'a t) list -> 'a t

Constructs a generator that selects among a given list of generators. Each of the given generators are chosen based on a positive integer weight.

val frequencyl : (int * 'a) list -> 'a t

Constructs a generator that selects among a given list of values. Each of the given values are chosen based on a positive integer weight.

val frequencya : (int * 'a) array -> 'a t

Constructs a generator that selects among a given array of values. Each of the array entries are chosen based on a positive integer weight.

val shuffle_a : 'a array -> unit t

Shuffles the array in place.

val shuffle_l : 'a list -> 'a list t

Creates a generator of shuffled lists.

val shuffle_w_l : (int * 'a) list -> 'a list t

Creates a generator of weighted shuffled lists. A given list is shuffled on each generation according to the weights of its elements. An element with a larger weight is more likely to be at the front of the list than an element with a smaller weight. If we want to pick random elements from the (head of) list but need to prioritize some elements over others, this generator can be useful.

Example: given a weighted list [1, "one"; 5, "five"; 10, "ten"], the generator is more likely to generate ["ten"; "five"; "one"] or ["five"; "ten"; "one"] than ["one"; "ten"; "five"] because "ten" and "five" have larger weights than "one".

since 0.11

val range_subset : size:int -> int -> int -> int array t

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

Complexity O(k log k), drawing k random integers.

raises Invalid_argument
outside the valid region 0 <= k <= high-low+1.

since 0.18

val array_subset : int -> 'a array -> 'a array t

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

Complexity O(k log k), drawing k random integers.

raises Invalid_argument
outside the valid region 0 <= size <= Array.length arr.

since 0.18

val unit : unit t

The unit generator.

val bool : bool t

The boolean generator.

val float : float t

Generates floating point numbers.

val pfloat : float t

Generates positive floating point numbers (0. included).

val nfloat : float t

Generates negative floating point numbers. (-0. included)

val float_bound_inclusive : float -> float t

float_bound_inclusive bound returns a random floating-point number between 0 and bound (inclusive). If bound is negative, the result is negative or zero. If bound is 0, the result is 0.

since 0.11

val float_bound_exclusive : float -> float t

float_bound_exclusive bound returns a random floating-point number between 0 and bound (exclusive). If bound is negative, the result is negative or zero.

raises Invalid_argument
if bound is zero.

since 0.11

val float_range : float -> float -> float t

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

raises Invalid_argument
if high < low or if the range is larger than max_float.

since 0.11

val (--.) : float -> float -> float t

Synonym for float_range

since 0.11

val nat : int t

Generates small natural numbers.

val big_nat : int t

Generates natural numbers, possibly large.

since 0.10

val neg_int : int t

Generates non-strictly negative integers (0 included).

val pint : int t

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

val int : int t

Generates integers uniformly.

val small_nat : int t

Small integers (< 100)

since 0.5.1

val small_int : int t

Small UNSIGNED integers, for retrocompatibility.

deprecated
use small_nat.

val small_signed_int : int t

Small SIGNED integers, based on small_nat.

since 0.5.2

val int_bound : int -> int t

Uniform integer generator producing integers between 0 and bound (inclusive). For bound < 2^{30} - 1 uses Random.State.int for integer generation.

raises Invalid_argument
if the argument is negative.

val int_range : int -> int -> int t

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

raises Invalid_argument
if low > high.

val graft_corners : 'a t -> 'a list -> unit -> 'a t

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

since 0.6

val int_pos_corners : int list

Non-negative corner cases for int.

since 0.6

val int_corners : int list

All corner cases for int.

since 0.6

val (--) : int -> int -> int t

Synonym for int_range.

val ui32 : int32 t

Generates (unsigned) int32 values.

val ui64 : int64 t

Generates (unsigned) int64 values.

val list : 'a t -> 'a list t

Builds a list generator from an element generator. List size is generated by nat.

val list_size : int t -> 'a t -> 'a list t

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

val list_repeat : int -> 'a t -> 'a list t

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

val array : 'a t -> 'a array t

Builds an array generator from an element generator. Array size is generated by nat.

val array_size : int t -> 'a t -> 'a array t

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

val array_repeat : int -> 'a t -> 'a array t

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

val option : ?ratio:float -> 'a t -> 'a option t

An option generator, with optional ratio.

parameter ratio
a float between 0. and 1. indicating the probability of a sample to be Some _ rather than None.

since 0.19 (renamed from [opt])

val opt : ?ratio:float -> 'a t -> 'a option t

opt is an alias of option for backward compatibility.

since 0.18 ([?ratio] parameter)

val pair : 'a t -> 'b t -> ('a * 'b) t

Generates pairs.

val triple : 'a t -> 'b t -> 'c t -> ('a * 'b * 'c) t

Generates triples.

val quad : 'a t -> 'b t -> 'c t -> 'd t -> ('a * 'b * 'c * 'd) t

Generates quadruples.

since 0.5.1

Tuple of generators

Shrinks on `gen1`, then `gen2`, then ...

val tup2 : 'a t -> 'b t -> ('a * 'b) t

val tup3 : 'a t -> 'b t -> 'c t -> ('a * 'b * 'c) t

val tup4 : 'a t -> 'b t -> 'c t -> 'd t -> ('a * 'b * 'c * 'd) t

val tup5 : 'a t -> 'b t -> 'c t -> 'd t -> 'e t -> ('a * 'b * 'c * 'd * 'e) t

val tup6 : 
  'a t ->
  'b t ->
  'c t ->
  'd t ->
  'e t ->
  'f t ->
  ('a * 'b * 'c * 'd * 'e * 'f) t

val tup7 : 
  'a t ->
  'b t ->
  'c t ->
  'd t ->
  'e t ->
  'f t ->
  'g t ->
  ('a * 'b * 'c * 'd * 'e * 'f * 'g) t

val tup8 : 
  'a t ->
  'b t ->
  'c t ->
  'd t ->
  'e t ->
  'f t ->
  'g t ->
  'h t ->
  ('a * 'b * 'c * 'd * 'e * 'f * 'g * 'h) t

val tup9 : 
  'a t ->
  'b t ->
  'c t ->
  'd t ->
  'e t ->
  'f t ->
  'g t ->
  'h t ->
  'i t ->
  ('a * 'b * 'c * 'd * 'e * 'f * 'g * 'h * 'i) t

val char : char t

Generates characters upto character code 255.

val printable : char t

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

val numeral : char t

Generates numeral characters.

val char_range : char -> char -> char t

Generates chars between the two bounds, inclusive. Example: char_range 'a' 'z' for all lower case ascii letters.

since 0.13

val bytes_size : ?gen:char t -> int t -> bytes t

Builds a bytes generator from a (non-negative) size generator. Accepts an optional character generator (the default is char).

since 0.20

val bytes : ?gen:char t -> bytes t

Builds a bytes generator. Bytes size is generated by nat. Accepts an optional character generator (the default is char). See also bytes_of and bytes_readable for versions without optional parameters.

since 0.20

val bytes_of : char t -> bytes t

Builds a bytes generator using the given character generator.

since 0.20

val bytes_printable : bytes t

Generator using the printable character generator.

since 0.20

val bytes_small : bytes t

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

since 0.20

val bytes_small_of : char t -> bytes t

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

since 0.20

val string_size : ?gen:char t -> int t -> string t

Builds a string generator from a (non-negative) size generator. Accepts an optional character generator (the default is char).

val string : ?gen:char t -> string t

Builds a string generator. String size is generated by nat. Accepts an optional character generator (the default is char). See also string_of and string_readable for versions without optional parameters.

val string_of : char t -> string t

Builds a string generator using the given character generator.

since 0.11

val string_readable : string t

deprecated see string_printable

val string_printable : string t

Builds a string generator using the printable character generator.

since 0.18

val small_string : ?gen:char t -> string t

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

val string_small : string t

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

since 0.20

val string_small_of : char t -> string t

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

since 0.20

val small_list : 'a t -> 'a list t

Generates lists of small size (see small_nat).

since 0.5.3

val flatten_l : 'a t list -> 'a list t

Generate a list of elements from individual generators

since 0.13

val flatten_a : 'a t array -> 'a array t

Generate an array of elements from individual generators

since 0.13

val flatten_opt : 'a t option -> 'a option t

Generate an option from an optional generator

since 0.13

val flatten_res : ('a t, 'e) result -> ('a, 'e) result t

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

since 0.13

val small_array : 'a t -> 'a array t

Generates arrays of small size (see small_nat).

since 0.10

val join : 'a t t -> 'a t

Collapses a generator of generators to simply a generator.

since 0.5

val sized : 'a sized -> 'a t

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

val sized_size : int t -> 'a sized -> 'a t

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.

since 0.5

val fix : (('a -> 'b t) -> 'a -> 'b t) -> 'a -> 'b t

Parametrized fixpoint combinator for generating recursive values.

The fixpoint is parametrized over an arbitrary state ('a), and the fixpoint computation may change the value of this state in the recursive calls.

In particular, this can be used for size-bounded generators ('a is int). The passed size-parameter should decrease to ensure termination.

Example:

type tree = Leaf of int | Node of tree * tree

let leaf x = Leaf x
let node x y = Node (x,y)

let g = QCheck.Gen.(sized @@ fix
                      (fun self n -> match n with
                         | 0 -> map leaf nat
                         | n ->
                           frequency
                             [1, map leaf nat;
                              2, map2 node (self (n/2)) (self (n/2))]
                      ))

val nat_split2 : int -> (int * int) t

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

This is useful to split sizes to combine sized generators.

since 0.18

val pos_split2 : int -> (int * int) t

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

raises Invalid_argument
unless n >= 2.
This is useful to split sizes to combine sized generators.

since 0.18

val nat_split : size:int -> int -> int array t

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

This is useful to split sizes to combine sized generators.

Complexity O(k log k).

since 0.18

val pos_split : size:int -> int -> int array t

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

This is useful to split sizes to combine sized generators.

Complexity O(k log k).

raises Invalid_argument
unless 0 < k <= n or 0 = k = n.

since 0.18

val delay : (unit -> 'a t) -> 'a t

Delay execution of some code until the generator is actually called. This can be used to manually implement recursion or control flow in a generator.

since 0.17

val generate : ?rand:Random.State.t -> n:int -> 'a t -> 'a list

generate ~n g generates n instances of g.

val generate1 : ?rand:Random.State.t -> 'a t -> 'a

generate1 g generates one instance of g.

val let+ : 'a t -> ('a -> 'b) -> 'b t

val and+ : 'a t -> 'b t -> ('a * 'b) t

val let* : 'a t -> ('a -> 'b t) -> 'b t

val and* : 'a t -> 'b t -> ('a * 'b) t

package osnap

Generate Random Values

Tuple of generators

Shrinks on gen1, then gen2, then ...

Shrinks on `gen1`, then `gen2`, then ...