kotlin-stdlib / kotlin.collections / reduceOrNull

reduceOrNull

Common
JVM
JS
Native
1.3
@ExperimentalStdlibApi inline fun <S, T : S> Array<out T>.reduceOrNull(
    operation: (acc: S, T) -> S
): S?
@ExperimentalStdlibApi inline fun ByteArray.reduceOrNull(
    operation: (acc: Byte, Byte) -> Byte
): Byte?
@ExperimentalStdlibApi inline fun ShortArray.reduceOrNull(
    operation: (acc: Short, Short) -> Short
): Short?
@ExperimentalStdlibApi inline fun IntArray.reduceOrNull(
    operation: (acc: Int, Int) -> Int
): Int?
@ExperimentalStdlibApi inline fun LongArray.reduceOrNull(
    operation: (acc: Long, Long) -> Long
): Long?
@ExperimentalStdlibApi inline fun FloatArray.reduceOrNull(
    operation: (acc: Float, Float) -> Float
): Float?
@ExperimentalStdlibApi inline fun DoubleArray.reduceOrNull(
    operation: (acc: Double, Double) -> Double
): Double?
@ExperimentalStdlibApi inline fun BooleanArray.reduceOrNull(
    operation: (acc: Boolean, Boolean) -> Boolean
): Boolean?
@ExperimentalStdlibApi inline fun CharArray.reduceOrNull(
    operation: (acc: Char, Char) -> Char
): Char?
@ExperimentalStdlibApi @ExperimentalUnsignedTypes inline fun UIntArray.reduceOrNull(
    operation: (acc: UInt, UInt) -> UInt
): UInt?
@ExperimentalStdlibApi @ExperimentalUnsignedTypes inline fun ULongArray.reduceOrNull(
    operation: (acc: ULong, ULong) -> ULong
): ULong?
@ExperimentalStdlibApi @ExperimentalUnsignedTypes inline fun UByteArray.reduceOrNull(
    operation: (acc: UByte, UByte) -> UByte
): UByte?
@ExperimentalStdlibApi @ExperimentalUnsignedTypes inline fun UShortArray.reduceOrNull(
    operation: (acc: UShort, UShort) -> UShort
): UShort?

Accumulates value starting with the first element and applying operation from left to right to current accumulator value and each element. Returns null if the array is empty.

import kotlin.test.*

fun main(args: Array<String>) {
//sampleStart
val strings = listOf("a", "b", "c", "d")
println(strings.reduceOrNull { acc, string -> acc + string }) // abcd

println(emptyList<String>().reduceOrNull { _, _ -> "" }) // null
//sampleEnd
}
Common
JVM
JS
Native
1.3
@ExperimentalStdlibApi inline fun <S, T : S> Iterable<T>.reduceOrNull(
    operation: (acc: S, T) -> S
): S?

Accumulates value starting with the first element and applying operation from left to right to current accumulator value and each element. Returns null if the collection is empty.

import kotlin.test.*

fun main(args: Array<String>) {
//sampleStart
val strings = listOf("a", "b", "c", "d")
println(strings.reduceOrNull { acc, string -> acc + string }) // abcd

println(emptyList<String>().reduceOrNull { _, _ -> "" }) // null
//sampleEnd
}