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 ​

針對更具體的使用案例,Kotlin 提供了 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()。