Skip to content

聚合集合 ​

Kotlin 集合包含用于常用聚合操作(aggregate operations)的函数——即根据集合内容返回单个值的操作。其中大多数操作都是广为人知的,且用法与其他语言相同:

  • minOrNull() 与 maxOrNull() 分别返回最小和最大的元素。在空集合上,它们返回 null。
  • average() 返回数字集合中各元素的平均值。
  • sum() 返回数字集合中各元素的总和。
  • count() 返回集合中的元素数量。
kotlin

fun main() {
    val numbers = listOf(6, 42, 10, 4)

    println("Count: ${numbers.count()}")
    println("Max: ${numbers.maxOrNull()}")
    println("Min: ${numbers.minOrNull()}")
    println("Average: ${numbers.average()}")
    println("Sum: ${numbers.sum()}")
}

还有一些函数可以通过特定的选择器函数或自定义 Comparator 来检索最大和最小的元素:

这些函数在空集合上返回 null。此外还有替代函数——maxOf、minOf、maxOfWith 与 minOfWith——它们的功能与对应函数相同,但在空集合上会抛出 NoSuchElementException。

kotlin

fun main() {
    val numbers = listOf(5, 42, 10, 4)
    val min3Remainder = numbers.minByOrNull { it % 3 }
    println(min3Remainder)

    val strings = listOf("one", "two", "three", "four")
    val longestString = strings.maxWithOrNull(compareBy { it.length })
    println(longestString)
}

除了常规的 sum() 之外,还有一个高级求和函数 sumOf(),它接收一个选择器函数并返回将其应用于所有集合元素后的总和。选择器可以返回不同的数值类型:Int、Long、Double、UInt 与 ULong(在 JVM 上还支持 BigInteger 与 BigDecimal)。

kotlin

fun main() {
    val numbers = listOf(5, 42, 10, 4)
    println(numbers.sumOf { it * 2 })
    println(numbers.sumOf { it.toDouble() / 2 })
}

Fold 与 reduce ​

对于更具体的情况,可以使用函数 reduce() 和 fold(),它们会依次将提供的操作应用于集合元素,并返回累积的结果。该操作接收两个实参:先前累积的值和当前的集合元素。

这两个函数之间的区别在于:fold() 接收一个初始值,并将其作为第一步中的累积值;而 reduce() 的第一步则使用集合中的第一个和第二个元素作为操作的实参。

kotlin
fun main() {
    val numbers = listOf(5, 2, 10, 4)

    val simpleSum = numbers.reduce { sum, element -> sum + element }
    println(simpleSum)
    val sumDoubled = numbers.fold(0) { sum, element -> sum + element * 2 }
    println(sumDoubled)

    //错误:结果中的第一个元素未被翻倍
    //val sumDoubledReduce = numbers.reduce { sum, element -> sum + element * 2 } 
    //println(sumDoubledReduce)
}

上面的示例展示了它们之间的区别:fold() 用于计算元素翻倍后的总和。如果向 reduce() 传入相同的函数,它将返回不同的结果,因为它在第一步中使用列表的第一个和第二个元素作为实参,因此第一个元素不会被翻倍。

要按逆序将函数应用于元素,请使用函数 reduceRight() 和 foldRight()。它们的工作方式类似于 fold() 和 reduce(),但从最后一个元素开始,然后向前继续。请注意,在从右向左进行 fold 或 reduce 操作时,操作实参的顺序会发生变化:第一个是元素,第二个是累积值。

kotlin

fun main() {
    val numbers = listOf(5, 2, 10, 4)
    val sumDoubledRight = numbers.foldRight(0) { element, sum -> sum + element * 2 }
    println(sumDoubledRight)
}

你还可以应用将元素索引作为形参的操作。为此,可以使用函数 reduceIndexed() 和 foldIndexed(),并将元素索引作为操作的第一个实参传入。

最后,还有一些函数可以从右向左将此类操作应用于集合元素——reduceRightIndexed() 与 foldRightIndexed()。

kotlin

fun main() {
    val numbers = listOf(5, 2, 10, 4)
    val sumEven = numbers.foldIndexed(0) { idx, sum, element -> if (idx % 2 == 0) sum + element else sum }
    println(sumEven)

    val sumEvenRight = numbers.foldRightIndexed(0) { idx, element, sum -> if (idx % 2 == 0) sum + element else sum }
    println(sumEvenRight)
}

所有 reduce 操作在空集合上都会抛出异常。若要改为接收 null,请使用对应的 *OrNull() 函数:

如果需要保存累加器的中间值,可以使用函数 runningFold()(或其同义词 scan())以及 runningReduce()。

kotlin

fun main() {
    val numbers = listOf(0, 1, 2, 3, 4, 5)
    val runningReduceSum = numbers.runningReduce { sum, item -> sum + item }
    val runningFoldSum = numbers.runningFold(10) { sum, item -> sum + item }
    val transform = { index: Int, element: Int -> "N = ${index + 1}: $element" }
    println(runningReduceSum.mapIndexed(transform).joinToString("\n", "Sum of first N elements with runningReduce:\n"))
    println(runningFoldSum.mapIndexed(transform).joinToString("\n", "Sum of first N elements with runningFold:\n"))
}

如果操作形参中需要索引,请使用 runningFoldIndexed() 或 runningReduceIndexed()。