/**
 * 返回由起始值[seed]和函数[nextFunction]定义的序列，每次迭代时，该函数被调用以根据前一个值计算下一个值
 *
 * 序列产生值，直到遇到第一个null值。
 * 如果[seed]是null，则生成一个空序列。
 * 
 * 该序列可以多次迭代，每次都从[seed]开始。
 *
 * @see kotlin.sequences.sequence
 *
 * @sample samples.collections.Sequences.Building.generateSequenceWithSeed
 */
@kotlin.internal.LowPriorityInOverloadResolution
public fun <T : Any> generateSequence(seed: T?, nextFunction: (T) -> T?): Sequence<T> =
    if (seed == null)
        EmptySequence
    else
        GeneratorSequence({ seed }, nextFunction)

seed: T? 参数 : 该参数是序列的第一个元素值 , 初始值 , 又称为随机种子 ;

nextFunction: (T) -> T? 参数 : 该参数是一个匿名函数 / Lambda 表达式 / 闭包 , 可以根据前一个值计算出下一个值 ;

3、函数简介

Kotlin 的 generateSequence 函数是一种生成序列的方法，它可以生成可迭代的、有限或无限的序列。

generateSequence 函数接收两个参数：

起始值 seed

生成下一个值的匿名函数 nextFunction。

每次迭代时，nextFunction 都会被调用以生成下一个值，并且该序列会不断生成值，直到遇到第一个 null 值。如果起始值为 null，那么将会生成一个空序列。

该序列可以多次迭代，每次都从起始值开始。这是因为 generateSequence 返回一个实现了 Sequence 接口的对象，这意味着你可以在多次迭代之间重用该序列。

通过使用 generateSequence，你可以简化代码，提高可读性和可维护性，并且可以生成更复杂的序列，如斐波那契数列、自然数序列等。

4、使用示例

使用方法 : 使用 “generateSequence” 函数并传递一个函数作为参数 ; 函数必须返回 “Nullable” 类型的值，当序列不再生成元素时返回 “null”。

“generateSequence” 函数是一种高效且灵活的生成序列的方法，它可以用于许多应用程序，如生成指定数量的元素、生成无限循环的序列等。

示例 : 以下代码生成一个从 1 开始的整数序列：

val sequence = generateSequence(1) { it + 1 }
println(sequence.take(10).toList()) // prints [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]

四、序列代码示例

取从 2 开始的前 20 个素数 ;

1、使用传统的函数式编程实现

代码示例 : 下面的代码中 , 从 1 ~ 1000 的区间内查找素数 , 必须将 1000 个元素的集合生成出来 , 然后逐个遍历 ;

/**
 * 为 Int 定义扩展函数, 判断接收者是否是素数
 */
fun Int.isPrimeNumber(): Boolean {
    // number 参数是被遍历的 接收者集合 的 受检元素
    // 符合下面的要求 才会被放入新集合
    // 遍历时每个 受检元素 都要 被 [2..number - 1] 区间的数值进行遍历
    val isPrimeNumber = (2..this - 1)
        // 计算 number 与 [2..number - 1] 区间中的数值 相除的 余数
        // 也就是验证 是否 只有 1 和 其本身 可以被其整除
        .map { this % it }
        // 通过 map 变换计算出的余数
        // 不能出现 余数 为 0 的情况
        // 一旦出现 就返回 false
        .none{it == 0}
    return isPrimeNumber
}

fun main() {
    val numbers = (2..1000)
        .toList()   // 将 IntRange 转为 List 集合
        .filter { it.isPrimeNumber() }  // 筛选出集合中是素数的人
        .take(20) // 从筛选出来的数值中取 20 个元素

    println(numbers)
}

执行结果 :

[2, 3, 5, 7, 11, 13, 17, 19, 23, 29, 31, 37, 41, 43, 47, 53, 59, 61, 67, 71]

2、使用序列 Sequence 实现

使用传统方式实现素数查找 , 如 : 从 1 ~ 1000 的区间内查找素数 , 必须将 1000 个元素的集合生成出来 , 然后逐个遍历 ;

如果使用序列 Sequence 实现 , 则只需要实现需要的部分 , 没有遍历的元素不会生成 ;

代码示例 :

/**
 * 为 Int 定义扩展函数, 判断接收者是否是素数
 */
fun Int.isPrimeNumber(): Boolean {
    // number 参数是被遍历的 接收者集合 的 受检元素
    // 符合下面的要求 才会被放入新集合
    // 遍历时每个 受检元素 都要 被 [2..number - 1] 区间的数值进行遍历
    val isPrimeNumber = (2..this - 1)
        // 计算 number 与 [2..number - 1] 区间中的数值 相除的 余数
        // 也就是验证 是否 只有 1 和 其本身 可以被其整除
        .map { this % it }
        // 通过 map 变换计算出的余数
        // 不能出现 余数 为 0 的情况
        // 一旦出现 就返回 false
        .none{it == 0}
    return isPrimeNumber
}

fun main() {
    val numbers = generateSequence(2) { it + 1 }    // 设置初始值为 2 , 然后每次值自增 1
        .filter { it.isPrimeNumber() }  // 遍历序列元素 , 查询是否是素数
        .take(20)   // 取前 20 个素数

    println(numbers)
}

执行结果 :

[2, 3, 5, 7, 11, 13, 17, 19, 23, 29, 31, 37, 41, 43, 47, 53, 59, 61, 67, 71]

3、take 扩展函数分析

下面是普通集合调用的 take 扩展函数原型和序列 Sequence 调用的 take 扩展函数的对比 , 两个函数是不同的 , take 函数决定了取值的个数 ;

序列 Sequence 调用 take 函数时 , take 函数调用了序列的部分内容 , 决定了序列 Sequence 的执行次数 , 生成多少元素 , 如 : 上述代码示例中 take 函数取够了 20 个素数 , 之后 Sequence 就不再继续生成后续元素了 ;

普通集合调用的 take 扩展函数原型和序列 Sequence 调用的 take 扩展函数的对比 :

普通集合调用的 take 扩展函数原型 :

/**
 * Returns a list containing first [n] elements.
 * 
 * @throws IllegalArgumentException if [n] is negative.
 * 
 * @sample samples.collections.Collections.Transformations.take
 */
public fun <T> Iterable<T>.take(n: Int): List<T> {
    require(n >= 0) { "Requested element count $n is less than zero." }
    if (n == 0) return emptyList()
    if (this is Collection<T>) {
        if (n >= size) return toList()
        if (n == 1) return listOf(first())
    }
    var count = 0
    val list = ArrayList<T>(n)
    for (item in this) {
        list.add(item)
        if (++count == n)
            break
    }
    return list.optimizeReadOnlyList()
}

序列 Sequence 调用的 take 扩展函数原型 :

/**
 * Returns a sequence containing first [n] elements.
 *
 * The operation is _intermediate_ and _stateless_.
 * 
 * @throws IllegalArgumentException if [n] is negative.
 * 
 * @sample samples.collections.Collections.Transformations.take
 */
public fun <T> Sequence<T>.take(n: Int): Sequence<T> {
    require(n >= 0) { "Requested element count $n is less than zero." }
    return when {
        n == 0 -> emptySequence()
        this is DropTakeSequence -> this.take(n)
        else -> TakeSequence(this, n)
    }
}