Table of Contents

Class Generators

Namespace
Hegel
Assembly
Hegel.dll

The built-in generators. Each returns a generator you can narrow with its methods (Generators.Integers().Min(0), Generators.Lists(g).MaxSize(5)) or combine with Map<TResult>(Func<T, TResult>), Filter(Func<T, bool>) and FlatMap<TResult>(Func<T, Generator<TResult>>).

public static class Generators
Inheritance
Generators
Inherited Members

Methods

Arrays<T>(Generator<T>)

Arrays of values from element.

public static ArrayGenerator<T> Arrays<T>(Generator<T> element)

Parameters

element Generator<T>

Returns

ArrayGenerator<T>

Type Parameters

T

BigIntegers()

Any BigInteger (around ±2^127 until bounded).

public static BigIntegerGenerator BigIntegers()

Returns

BigIntegerGenerator

Binary()

Any byte array.

public static BinaryGenerator Binary()

Returns

BinaryGenerator

Booleans()

true or false.

public static PrintableGenerator<bool> Booleans()

Returns

PrintableGenerator<bool>

Characters()

A single Unicode code point, as a string (a code point may not fit a char).

public static TextGenerator Characters()

Returns

TextGenerator

Composite<T>(Func<TestCase, Printer, T>)

A generator written as a function of the test case and the printer it prints to.

public static PrintableGenerator<T> Composite<T>(Func<TestCase, Printer, T> body)

Parameters

body Func<TestCase, Printer, T>

Returns

PrintableGenerator<T>

Type Parameters

T

Composite<T>(Func<TestCase, T>)

A generator written as a function of the test case, printed with Repr(object?).

public static PrintableGenerator<T> Composite<T>(Func<TestCase, T> body)

Parameters

body Func<TestCase, T>

Returns

PrintableGenerator<T>

Type Parameters

T

DateTimes()

Date-times without a time zone.

[Obsolete("Use Generators.Temporal.DateTimes().")]
public static DateTimeGenerator DateTimes()

Returns

DateTimeGenerator

Dates()

Dates.

[Obsolete("Use Generators.Temporal.Dates().")]
public static DateGenerator Dates()

Returns

DateGenerator

Deferred<T>()

A generator defined later with Set(Generator<T>), for recursive definitions.

public static Deferred<T> Deferred<T>()

Returns

Deferred<T>

Type Parameters

T

Domains()

Domain names.

public static DomainGenerator Domains()

Returns

DomainGenerator

Doubles()

Any double, NaN and infinities included until bounded.

public static DoubleGenerator Doubles()

Returns

DoubleGenerator

Emails()

Email addresses.

public static PrintableGenerator<string> Emails()

Returns

PrintableGenerator<string>

Floats()

Any float, NaN and infinities included until bounded.

public static FloatGenerator Floats()

Returns

FloatGenerator

ForType<T>()

A generator derived from T: a built-in type, an enum, a collection, a tuple or a record of them.

public static PrintableGenerator<T> ForType<T>()

Returns

PrintableGenerator<T>

Type Parameters

T

FromLark(string)

Strings from grammar, in Lark syntax.

public static LarkGenerator FromLark(string grammar)

Parameters

grammar string

Returns

LarkGenerator

FromRegex(string)

Strings matching pattern, a regular expression in Python syntax.

public static RegexGenerator FromRegex(string pattern)

Parameters

pattern string

Returns

RegexGenerator

Integers()

Any int.

public static IntegerGenerator Integers()

Returns

IntegerGenerator

IpAddresses()

IP addresses, as text.

public static IpAddressGenerator IpAddresses()

Returns

IpAddressGenerator

Just<T>(T)

Always value.

public static PrintableGenerator<T> Just<T>(T value)

Parameters

value T

Returns

PrintableGenerator<T>

Type Parameters

T

Lists<T>(Generator<T>)

Lists of values from element.

public static ListGenerator<T> Lists<T>(Generator<T> element)

Parameters

element Generator<T>

Returns

ListGenerator<T>

Type Parameters

T

Longs()

Any long.

public static LongGenerator Longs()

Returns

LongGenerator

Maps<TKey, TValue>(Generator<TKey>, Generator<TValue>)

Dictionaries with keys from keys and values from values.

public static MapGenerator<TKey, TValue> Maps<TKey, TValue>(Generator<TKey> keys, Generator<TValue> values) where TKey : notnull

Parameters

keys Generator<TKey>
values Generator<TValue>

Returns

MapGenerator<TKey, TValue>

Type Parameters

TKey
TValue

Nullable<T>(Generator<T>)

A value from generator, or null.

public static PrintableGenerator<T?> Nullable<T>(Generator<T> generator) where T : struct

Parameters

generator Generator<T>

Returns

PrintableGenerator<T?>

Type Parameters

T

Nulls<T>()

Always null.

public static PrintableGenerator<T?> Nulls<T>()

Returns

PrintableGenerator<T>

Type Parameters

T

OneOf<T>(params Generator<T>[])

A value from one of options.

public static PrintableGenerator<T> OneOf<T>(params Generator<T>[] options)

Parameters

options Generator<T>[]

Returns

PrintableGenerator<T>

Type Parameters

T

Optional<T>(Generator<T>)

A value from generator, or null.

public static PrintableGenerator<T?> Optional<T>(Generator<T> generator) where T : class

Parameters

generator Generator<T>

Returns

PrintableGenerator<T>

Type Parameters

T

Permutations<T>(IEnumerable<T>)

Reorderings of elements.

public static PrintableGenerator<List<T>> Permutations<T>(IEnumerable<T> elements)

Parameters

elements IEnumerable<T>

Returns

PrintableGenerator<List<T>>

Type Parameters

T

Records<T>()

A generator for the record T, each component derived from its type unless With<TComponent>(string, Generator<TComponent>) says otherwise.

public static RecordGenerator<T> Records<T>()

Returns

RecordGenerator<T>

Type Parameters

T

Recursive<T>(Generator<T>, Func<Generator<T>, Generator<T>>)

Recursive structures: base cases, extended by extend.

public static RecursiveGenerator<T> Recursive<T>(Generator<T> @base, Func<Generator<T>, Generator<T>> extend)

Parameters

base Generator<T>
extend Func<Generator<T>, Generator<T>>

Returns

RecursiveGenerator<T>

Type Parameters

T

SampledFrom<T>(IEnumerable<T>)

One of values.

public static PrintableGenerator<T> SampledFrom<T>(IEnumerable<T> values)

Parameters

values IEnumerable<T>

Returns

PrintableGenerator<T>

Type Parameters

T

Samples<T>(IEnumerable<T>)

Samples of elements: some of them in any order, with replacement unless told otherwise.

public static SampleGenerator<T> Samples<T>(IEnumerable<T> elements)

Parameters

elements IEnumerable<T>

Returns

SampleGenerator<T>

Type Parameters

T

Sets<T>(Generator<T>)

Sets of distinct values from element.

public static SetGenerator<T> Sets<T>(Generator<T> element)

Parameters

element Generator<T>

Returns

SetGenerator<T>

Type Parameters

T

Subsequences<T>(IEnumerable<T>)

Subsequences of elements: some of them, in order.

public static SubsequenceGenerator<T> Subsequences<T>(IEnumerable<T> elements)

Parameters

elements IEnumerable<T>

Returns

SubsequenceGenerator<T>

Type Parameters

T

Text()

Any Unicode text.

public static TextGenerator Text()

Returns

TextGenerator

TimeSpans()

Durations, from zero up.

[Obsolete("Use Generators.Temporal.Durations(), which draws durations of either sign: Generators.Temporal.Durations().Min(TimeSpan.Zero) is this generator.")]
public static DurationGenerator TimeSpans()

Returns

DurationGenerator

TimeZones()

The system's time zones.

[Obsolete("Use Generators.Temporal.Zones().")]
public static ZoneGenerator TimeZones()

Returns

ZoneGenerator

Times()

Times of day.

[Obsolete("Use Generators.Temporal.Times().")]
public static TimeGenerator Times()

Returns

TimeGenerator

Tuples<T1, T2>(Generator<T1>, Generator<T2>)

Pairs drawn from a and b.

public static PrintableGenerator<(T1, T2)> Tuples<T1, T2>(Generator<T1> a, Generator<T2> b)

Parameters

a Generator<T1>
b Generator<T2>

Returns

PrintableGenerator<(T1, T2)>

Type Parameters

T1
T2

Tuples<T1, T2, T3>(Generator<T1>, Generator<T2>, Generator<T3>)

Triples drawn from the generators.

public static PrintableGenerator<(T1, T2, T3)> Tuples<T1, T2, T3>(Generator<T1> a, Generator<T2> b, Generator<T3> c)

Parameters

a Generator<T1>
b Generator<T2>
c Generator<T3>

Returns

PrintableGenerator<(T1, T2, T3)>

Type Parameters

T1
T2
T3

Tuples<T1, T2, T3, T4>(Generator<T1>, Generator<T2>, Generator<T3>, Generator<T4>)

Quadruples drawn from the generators.

public static PrintableGenerator<(T1, T2, T3, T4)> Tuples<T1, T2, T3, T4>(Generator<T1> a, Generator<T2> b, Generator<T3> c, Generator<T4> d)

Parameters

a Generator<T1>
b Generator<T2>
c Generator<T3>
d Generator<T4>

Returns

PrintableGenerator<(T1, T2, T3, T4)>

Type Parameters

T1
T2
T3
T4

Tuples<T1, T2, T3, T4, T5>(Generator<T1>, Generator<T2>, Generator<T3>, Generator<T4>, Generator<T5>)

Quintuples drawn from the generators.

public static PrintableGenerator<(T1, T2, T3, T4, T5)> Tuples<T1, T2, T3, T4, T5>(Generator<T1> a, Generator<T2> b, Generator<T3> c, Generator<T4> d, Generator<T5> e)

Parameters

a Generator<T1>
b Generator<T2>
c Generator<T3>
d Generator<T4>
e Generator<T5>

Returns

PrintableGenerator<(T1, T2, T3, T4, T5)>

Type Parameters

T1
T2
T3
T4
T5

Tuples<T1, T2, T3, T4, T5, T6>(Generator<T1>, Generator<T2>, Generator<T3>, Generator<T4>, Generator<T5>, Generator<T6>)

Sextuples drawn from the generators.

public static PrintableGenerator<(T1, T2, T3, T4, T5, T6)> Tuples<T1, T2, T3, T4, T5, T6>(Generator<T1> a, Generator<T2> b, Generator<T3> c, Generator<T4> d, Generator<T5> e, Generator<T6> f)

Parameters

a Generator<T1>
b Generator<T2>
c Generator<T3>
d Generator<T4>
e Generator<T5>
f Generator<T6>

Returns

PrintableGenerator<(T1, T2, T3, T4, T5, T6)>

Type Parameters

T1
T2
T3
T4
T5
T6

Tuples<T1, T2, T3, T4, T5, T6, T7>(Generator<T1>, Generator<T2>, Generator<T3>, Generator<T4>, Generator<T5>, Generator<T6>, Generator<T7>)

Septuples drawn from the generators.

public static PrintableGenerator<(T1, T2, T3, T4, T5, T6, T7)> Tuples<T1, T2, T3, T4, T5, T6, T7>(Generator<T1> a, Generator<T2> b, Generator<T3> c, Generator<T4> d, Generator<T5> e, Generator<T6> f, Generator<T7> g)

Parameters

a Generator<T1>
b Generator<T2>
c Generator<T3>
d Generator<T4>
e Generator<T5>
f Generator<T6>
g Generator<T7>

Returns

PrintableGenerator<(T1, T2, T3, T4, T5, T6, T7)>

Type Parameters

T1
T2
T3
T4
T5
T6
T7

Tuples<T1, T2, T3, T4, T5, T6, T7, T8>(Generator<T1>, Generator<T2>, Generator<T3>, Generator<T4>, Generator<T5>, Generator<T6>, Generator<T7>, Generator<T8>)

Octuples drawn from the generators.

public static PrintableGenerator<(T1, T2, T3, T4, T5, T6, T7, T8)> Tuples<T1, T2, T3, T4, T5, T6, T7, T8>(Generator<T1> a, Generator<T2> b, Generator<T3> c, Generator<T4> d, Generator<T5> e, Generator<T6> f, Generator<T7> g, Generator<T8> h)

Parameters

a Generator<T1>
b Generator<T2>
c Generator<T3>
d Generator<T4>
e Generator<T5>
f Generator<T6>
g Generator<T7>
h Generator<T8>

Returns

PrintableGenerator<(T1, T2, T3, T4, T5, T6, T7, T8)>

Type Parameters

T1
T2
T3
T4
T5
T6
T7
T8

Urls()

URLs.

public static PrintableGenerator<string> Urls()

Returns

PrintableGenerator<string>

UtcOffsets()

UTC offsets: whole minutes between -14:00 and +14:00.

[Obsolete("Use Generators.Temporal.Offsets().")]
public static OffsetGenerator UtcOffsets()

Returns

OffsetGenerator

Uuids()

UUIDs.

public static UuidGenerator Uuids()

Returns

UuidGenerator

WeightedBooleans(double)

true with probability p.

public static PrintableGenerator<bool> WeightedBooleans(double p)

Parameters

p double

Returns

PrintableGenerator<bool>