Module

poke/generator

src/poke/generator.pooka

Generate a little trouble, then make it smaller.

Generators carry their seed explicitly. Sampling never changes global random state, so a failure can be replayed even when Pooka runs tests in parallel. The Generator interface is open: applications may supply their own samples and shrinking rules. This is test data, not cryptographic randomness.

API reference

class

Sample

src/poke/generator.pooka:16
class Sample(value: a, seed: Int)

A generated value and the seed for the next draw.

field

value

src/poke/generator.pooka:16
value: a
INFERREDa
field

seed

src/poke/generator.pooka:16
seed: Int
INFERREDInt
constructor

new

src/poke/generator.pooka:16
INFERREDfn(a, Int) -> poke/generator.Sample(a)
interface

Generator

src/poke/generator.pooka:21
interface Generator(a)

Supply deterministic samples and finite, preferably smaller candidates. Shrinkers must preserve the generator's domain. Property checking bounds the number of attempts and remembers visited candidates, even for custom rules.

method

sample

src/poke/generator.pooka:22
sample(seed: Int, size: Int) -> Sample(a)
method

shrink

src/poke/generator.pooka:24
shrink(value: a) -> List(a)
function

next_seed

src/poke/generator.pooka:28
next_seed(seed: Int) -> Int
INFERREDfn(Int) -> Int

Advance a Park–Miller stream. Negative and zero seeds are normalised too.

function

integers

src/poke/generator.pooka:49
integers(minimum: Int, maximum: Int) -> Generator(Int)
INFERREDfn(Int, Int) -> poke/generator.Generator(Int)

Integers within inclusive bounds, with extra visits to zero and endpoints.

Pooka
let sample = generator.integers(-10, 10).sample(42, 20)
assert sample.value >= -10 && sample.value <= 10
function

booleans

src/poke/generator.pooka:110
booleans() -> Generator(Bool)
INFERREDfn() -> poke/generator.Generator(Bool)

Both truth values, shrinking True towards False.

function

elements

src/poke/generator.pooka:129
elements(values: List(a)) -> Generator(a)
INFERREDfn(List(a)) -> poke/generator.Generator(a)

Pick from a nonempty list. Shrinking tries earlier choices.

function

constant

src/poke/generator.pooka:150
constant(value: a) -> Generator(a)
INFERREDfn(a) -> poke/generator.Generator(a)

Always produce one value. There is nothing smaller to try.

function

list_of

src/poke/generator.pooka:166
list_of(element: Generator(a), maximum: Int) -> Generator(List(a))
INFERREDfn(poke/generator.Generator(a), Int) -> poke/generator.Generator(List(a))

Lists from length zero to min(maximum, size). Nested sampling reduces size. Shrinking tries shorter lists, then smaller individual elements.

function

pair

src/poke/generator.pooka:236
pair(left: Generator(a), right: Generator(b)) -> Generator(#(a, b))

Draw both halves from the same deterministic stream; shrink either half.

function

map

src/poke/generator.pooka:258
map(source: Generator(a), transform: fn(a) -> b) -> Generator(b)
INFERREDfn(poke/generator.Generator(a), fn(a) -> b) -> poke/generator.Generator(b)

Transform a generator. Arbitrary transforms have no inverse, so mapped generators deliberately do not shrink. Implement Generator for domain rules.

function

strings

src/poke/generator.pooka:275
strings(alphabet: List(String), maximum: Int) -> Generator(String)
INFERREDfn(List(String), Int) -> poke/generator.Generator(String)

Strings made from a nonempty alphabet of String fragments. Empty fragments are allowed. Strings shrink to empty because fragments may span code points.