Arb (FsCheck)

Arb Module

Namespace: FsCheck.FSharp
Assembly: FsCheck.dll

Functions and values

Function or value	Description
`Arb.array elements` Full Usage: `Arb.array elements` Parameters: elements : `Arbitrary<'T>` Returns: `Arbitrary<'T[]>` Type parameters: 'T	Generates one-dimensional arrays. The length of the generated array is between 0 and size. The sum of the sizes of the elements is equal to the size of the generated array. elements : `Arbitrary<'T>` Returns: `Arbitrary<'T[]>`
`Arb.convert convertTo convertFrom a` Full Usage: `Arb.convert convertTo convertFrom a` Parameters: convertTo : `'T -> 'U` convertFrom : `'U -> 'T` a : `Arbitrary<'T>` Returns: `Arbitrary<'U>` Type parameters: 'T, 'U	Construct an Arbitrary instance for a type that can be mapped to and from another type (e.g. a wrapper), based on a Arbitrary instance for the source type and two mapping functions. convertTo : `'T -> 'U` convertFrom : `'U -> 'T` a : `Arbitrary<'T>` Returns: `Arbitrary<'U>`
`Arb.filter pred a` Full Usage: `Arb.filter pred a` Parameters: pred : `'T -> bool` a : `Arbitrary<'T>` Returns: `Arbitrary<'T>` Type parameters: 'T	Return an Arbitrary instance that is a filtered version of an existing arbitrary instance. The generator uses Gen.where, and the shrinks are filtered using Seq.filter with the given predicate. pred : `'T -> bool` a : `Arbitrary<'T>` Returns: `Arbitrary<'T>`
`Arb.fromGen gen` Full Usage: `Arb.fromGen gen` Parameters: gen : `Gen<'Value>` Returns: `Arbitrary<'Value>` Type parameters: 'Value	Construct an Arbitrary instance from a generator. Shrink is not supported for this type. gen : `Gen<'Value>` Returns: `Arbitrary<'Value>`
`Arb.fromGenShrink (gen, shrinker)` Full Usage: `Arb.fromGenShrink (gen, shrinker)` Parameters: gen : `Gen<'Value>` shrinker : `'Value -> 'Value seq` Returns: `Arbitrary<'Value>` Type parameters: 'Value	Construct an Arbitrary instance from a generator and shrinker. gen : `Gen<'Value>` shrinker : `'Value -> 'Value seq` Returns: `Arbitrary<'Value>`
`Arb.list elements` Full Usage: `Arb.list elements` Parameters: elements : `Arbitrary<'T>` Returns: `Arbitrary<'T list>` Type parameters: 'T	Generates FSharp.Core list<'T> values. The length of the generated list is between 0 and size. The sum of the sizes of the elements is equal to the size of the generated list. elements : `Arbitrary<'T>` Returns: `Arbitrary<'T list>`
`Arb.mapFilter mapper pred a` Full Usage: `Arb.mapFilter mapper pred a` Parameters: mapper : `'T -> 'T` pred : `'T -> bool` a : `Arbitrary<'T>` Returns: `Arbitrary<'T>` Type parameters: 'T	Return an Arbitrary instance that is a mapped and filtered version of an existing arbitrary instance. The generator uses Gen.map with the given mapper and then Gen.where with the given predicate, and the shrinks are filtered using Seq.filter with the given predicate. This is sometimes useful if using just a filter would reduce the chance of getting a good value from the generator - and you can map the value instead. E.g. PositiveInt. mapper : `'T -> 'T` pred : `'T -> bool` a : `Arbitrary<'T>` Returns: `Arbitrary<'T>`
`Arb.mapKV (keys, values)` Full Usage: `Arb.mapKV (keys, values)` Parameters: keys : `Arbitrary<'TKey>` values : `Arbitrary<'TValue>` Returns: `Arbitrary<Map<'TKey, 'TValue>>` Type parameters: 'TKey, 'TValue (requires comparison)	Generates Map values. Not named `map` because that has other meanings. keys : `Arbitrary<'TKey>` values : `Arbitrary<'TValue>` Returns: `Arbitrary<Map<'TKey, 'TValue>>`
`Arb.nullable value` Full Usage: `Arb.nullable value` Parameters: value : `Arbitrary<'T>` Returns: `Arbitrary<Nullable<'T>>` Type parameters: 'T (requires (new : unit -> 'T) and struct and :> System.ValueType)	Generates nullable values that are null 1/8 of the time. value : `Arbitrary<'T>` Returns: `Arbitrary<Nullable<'T>>`
`Arb.nullableRef value` Full Usage: `Arb.nullableRef value` Parameters: value : `Arbitrary<'T>` Returns: `Arbitrary<NullableRef<'T>>` Type parameters: 'T	Generates reference values that are null 1/8 of the time. value : `Arbitrary<'T>` Returns: `Arbitrary<NullableRef<'T>>`
`Arb.option value` Full Usage: `Arb.option value` Parameters: value : `Arbitrary<'T>` Returns: `Arbitrary<'T option>` Type parameters: 'T	Generates option values that are None 1/8 of the time. value : `Arbitrary<'T>` Returns: `Arbitrary<'T option>`
`Arb.pureFunction target` Full Usage: `Arb.pureFunction target` Parameters: target : `Arbitrary<'U>` Returns: `Arbitrary<('T -> 'U)>` Type parameters: 'U, 'T (requires equality)	Generates pure functions that produce the given output values 'U. There is no shrinking for functions. target : `Arbitrary<'U>` Returns: `Arbitrary<('T -> 'U)>`
`Arb.set elements` Full Usage: `Arb.set elements` Parameters: elements : `Arbitrary<'T>` Returns: `Arbitrary<Set<'T>>` Type parameters: 'T (requires comparison)	Generates Set<'T> values. elements : `Arbitrary<'T>` Returns: `Arbitrary<Set<'T>>`
`Arb.throwingFunction exceptions target` Full Usage: `Arb.throwingFunction exceptions target` Parameters: exceptions : `Exception seq` target : `Arbitrary<'U>` Returns: `Arbitrary<('T -> 'U)>` Type parameters: 'T, 'U (requires equality)	Generates F# function values that generate an instance of the function result type about half the time. The other times it generate one of the given exceptions. exceptions : `Exception seq` target : `Arbitrary<'U>` Returns: `Arbitrary<('T -> 'U)>`
`Arb.toGen arb` Full Usage: `Arb.toGen arb` Parameters: arb : `Arbitrary<'Value>` Returns: `Gen<'Value>` Type parameters: 'Value	Get the Gen from the given Arbitary. arb : `Arbitrary<'Value>` Returns: `Gen<'Value>`
`Arb.toShrink arb` Full Usage: `Arb.toShrink arb` Parameters: arb : `Arbitrary<'Value>` Returns: `'Value -> 'Value seq` Type parameters: 'Value	Get the shrinker function from the given Arbitrary. arb : `Arbitrary<'Value>` Returns: `'Value -> 'Value seq`
`Arb.zip (t1, t2)` Full Usage: `Arb.zip (t1, t2)` Parameters: t1 : `Arbitrary<'T1>` t2 : `Arbitrary<'T2>` Returns: `Arbitrary<'T1 * 'T2>` Type parameters: 'T1, 'T2	Generates 2-tuples. t1 : `Arbitrary<'T1>` t2 : `Arbitrary<'T2>` Returns: `Arbitrary<'T1 * 'T2>`