集計操作
Kotlinのコレクションには、一般的に使用される_集計操作_（コレクションの内容に基づいて単一の値を返す操作）のための関数が含まれています。これらのほとんどはよく知られており、他の言語と同様に機能します。
minOrNull()とmaxOrNull()は、それぞれ最小および最大の要素を返します。空のコレクションでは、nullを返します。average()は、数値のコレクション内の要素の平均値を返します。sum()は、数値のコレクション内の要素の合計を返します。count()は、コレクション内の要素の数を返します。
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 を使用して、最小および最大の要素を取得するための関数も存在します。
maxByOrNull()とminByOrNull()はセレクター関数を受け取り、それが最大または最小の値を返す要素を返します。maxWithOrNull()とminWithOrNull()はComparatorオブジェクトを受け取り、そのComparatorに従って最大または最小の要素を返します。maxOfOrNull()とminOfOrNull()はセレクター関数を受け取り、セレクター自体の最大または最小の戻り値を返します。maxOfWithOrNull()とminOfWithOrNull()はComparatorオブジェクトを受け取り、そのComparatorに従って最大または最小のセレクター戻り値を返します。
これらの関数は空のコレクションに対して null を返します。また、maxOf、minOf、maxOfWith、minOfWith といった代替関数もあります。これらは対応する関数と同じことを行いますが、空のコレクションに対しては NoSuchElementException をスローします。
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 も) といった異なる数値型を返すことができます。
fun main() {
val numbers = listOf(5, 42, 10, 4)
println(numbers.sumOf { it * 2 })
println(numbers.sumOf { it.toDouble() / 2 })
}fold と reduce
より特殊なケースでは、提供された操作をコレクション要素に順次適用し、累積された結果を返す reduce() および fold() 関数があります。この操作は2つの引数を取ります。以前に累積された値とコレクション要素です。
これら2つの関数の違いは、fold() が初期値を受け取り、それを最初のステップでの累積値として使用する点です。一方、reduce() の最初のステップでは、最初の要素と2番目の要素を操作の引数として使用します。
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)
//incorrect: the first element isn't doubled in the result
//val sumDoubledReduce = numbers.reduce { sum, element -> sum + element * 2 }
//println(sumDoubledReduce)
}上の例は、その違いを示しています。fold() は、要素を2倍にした値の合計を計算するために使用されます。同じ関数を reduce() に渡すと、最初のステップでリストの最初の要素と2番目の要素を引数として使用するため、異なる結果が返されます。このため、最初の要素は2倍になりません。
要素に逆順で関数を適用するには、reduceRight() および foldRight() 関数を使用します。これらは fold() と reduce() と同様に機能しますが、最後の要素から開始し、前の要素へと続きます。右から fold または reduce する場合、操作の引数の順序が変わることに注意してください。まず要素が来て、次に累積値が来ます。
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() があります。
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() 関数があります。
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("
", "Sum of first N elements with runningReduce:
"))
println(runningFoldSum.mapIndexed(transform).joinToString("
", "Sum of first N elements with runningFold:
"))
}操作パラメータにインデックスが必要な場合、runningFoldIndexed() または runningReduceIndexed() を使用します。