Операции агрегирования

Свертка и редукция

Для более специфических случаев существуют функции reduce() и fold(), которые последовательно применяют заданную операцию к элементам коллекции и возвращают накопленный результат. Операция принимает два аргумента: ранее накопленное значение и элемент коллекции.

Различие между этими функциями заключается в том, что fold() принимает начальное значение и использует его как накопленное значение на первом шаге, тогда как на первом шаге reduce() использует первый и второй элементы в качестве аргументов операции.

fun main() {
//sampleStart
    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)

    //incorrect: the first element isn't doubled in the result
    //val sumDoubledReduce = numbers.reduce { sum, element -> sum + element * 2 } 
    //println(sumDoubledReduce)
//sampleEnd
}

Приведённый выше пример демонстрирует разницу: fold() используется для вычисления суммы удвоенных элементов. Если передать ту же функцию в reduce(), она вернёт другой результат, так как она использует первый и второй элементы списка в качестве аргументов на первом шаге, поэтому первый элемент не будет удвоен.

Для применения функции к элементам в обратном порядке используйте функции reduceRight() и foldRight(). Они работают аналогично fold() и reduce(), но начинаются с последнего элемента и затем продолжаются к предыдущим. Обратите внимание, что при свёртке или редукции справа, аргументы операции меняют свой порядок: сначала идёт элемент, а затем накопленное значение.

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

Также можно применять операции, принимающие индексы элементов в качестве параметров. Для этого используйте функции reduceIndexed() и foldIndexed(), передавая индекс элемента в качестве первого аргумента операции.

Наконец, существуют функции, которые применяют такие операции к элементам коллекции справа налево — reduceRightIndexed() и foldRightIndexed().

fun main() {
//sampleStart
    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)
//sampleEnd
}

Все операции редукции выбрасывают исключение при пустых коллекциях. Чтобы получить null вместо этого, используйте их *OrNull() аналоги:

• reduceOrNull()

• reduceRightOrNull()

• reduceIndexedOrNull()

• reduceRightIndexedOrNull()

В тех случаях, когда вы хотите сохранить промежуточные значения аккумулятора, существуют функции runningFold() (или её синоним scan()) и runningReduce().

fun main() {
//sampleStart
    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 }
//sampleEnd
    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().