jqwik-kotlin/net.jqwik.kotlin.api/combine

combine

@API(status = API.Status.EXPERIMENTAL, since = "1.8.0")
fun <R> combine(combinator: CombinatorScope.() -> Combined<R>): Arbitrary<R>

Combine arbitraries using the combinator DSL:

combine {
    val first by Arbitraries.strings()
    val second by Arbitraries.strings()

    filter { first.isNotEmpty() }
    filter { first != second }

    combineAs {
        "first: $first, second: $second"
    }
}
Content copied to clipboard

Return

new Arbitrary instance

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <T1, T2, R> combine(a1: Arbitrary<T1>, a2: Arbitrary<T2>, filter: (T1, T2) -> Boolean? = null, combinator: (v1: T1, v2: T2) -> R): Arbitrary<R>

Combine 2 arbitraries into one.

Return

new Arbitrary instance

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <T1, T2, T3, R> combine(a1: Arbitrary<T1>, a2: Arbitrary<T2>, a3: Arbitrary<T3>, filter: (v1: T1, v2: T2, v3: T3) -> Boolean? = null, combinator: (v1: T1, v2: T2, v3: T3) -> R): Arbitrary<R>

Combine 3 arbitraries into one.

Return

new Arbitrary instance

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <T1, T2, T3, T4, R> combine(a1: Arbitrary<T1>, a2: Arbitrary<T2>, a3: Arbitrary<T3>, a4: Arbitrary<T4>, filter: (v1: T1, v2: T2, v3: T3, v4: T4) -> Boolean? = null, combinator: (v1: T1, v2: T2, v3: T3, v4: T4) -> R): Arbitrary<R>

Combine 4 arbitraries into one.

Return

new Arbitrary instance

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <T1, T2, T3, T4, T5, R> combine(a1: Arbitrary<T1>, a2: Arbitrary<T2>, a3: Arbitrary<T3>, a4: Arbitrary<T4>, a5: Arbitrary<T5>, filter: (v1: T1, v2: T2, v3: T3, v4: T4, v5: T5) -> Boolean? = null, combinator: (v1: T1, v2: T2, v3: T3, v4: T4, v5: T5) -> R): Arbitrary<R>

Combine 5 arbitraries into one.

Return

new Arbitrary instance

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <T1, T2, T3, T4, T5, T6, R> combine(a1: Arbitrary<T1>, a2: Arbitrary<T2>, a3: Arbitrary<T3>, a4: Arbitrary<T4>, a5: Arbitrary<T5>, a6: Arbitrary<T6>, filter: (v1: T1, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6) -> Boolean? = null, combinator: (v1: T1, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6) -> R): Arbitrary<R>

Combine 6 arbitraries into one.

Return

new Arbitrary instance

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <T1, T2, T3, T4, T5, T6, T7, R> combine(a1: Arbitrary<T1>, a2: Arbitrary<T2>, a3: Arbitrary<T3>, a4: Arbitrary<T4>, a5: Arbitrary<T5>, a6: Arbitrary<T6>, a7: Arbitrary<T7>, filter: (v1: T1, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6, v7: T7) -> Boolean? = null, combinator: (v1: T1, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6, v7: T7) -> R): Arbitrary<R>

Combine 7 arbitraries into one.

Return

new Arbitrary instance

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <T1, T2, T3, T4, T5, T6, T7, T8, R> combine(a1: Arbitrary<T1>, a2: Arbitrary<T2>, a3: Arbitrary<T3>, a4: Arbitrary<T4>, a5: Arbitrary<T5>, a6: Arbitrary<T6>, a7: Arbitrary<T7>, a8: Arbitrary<T8>, filter: (v1: T1, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6, v7: T7, v8: T8) -> Boolean? = null, combinator: (v1: T1, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6, v7: T7, v8: T8) -> R): Arbitrary<R>

Combine 8 arbitraries into one.

Return

new Arbitrary instance

@API(status = API.Status.EXPERIMENTAL, since = "1.6.0")
fun <T, R> combine(arbitraries: List<Arbitrary<T>>, filter: (v1: List<T>) -> Boolean? = null, combinator: (v1: List<T>) -> R): Arbitrary<R>

Combine list of arbitraries into one.

Return

new Arbitrary instance