stdlib/kotlin.collections/maxBy

maxBy

@JvmName(name = "maxByOrThrow")
inline fun <T, R : Comparable<R>> Array<out T>.maxBy(selector: (T) -> R): T(source)
@JvmName(name = "maxByOrThrow")
inline fun <R : Comparable<R>> ByteArray.maxBy(selector: (Byte) -> R): Byte(source)
@JvmName(name = "maxByOrThrow")
inline fun <R : Comparable<R>> ShortArray.maxBy(selector: (Short) -> R): Short(source)
@JvmName(name = "maxByOrThrow")
inline fun <R : Comparable<R>> IntArray.maxBy(selector: (Int) -> R): Int(source)
@JvmName(name = "maxByOrThrow")
inline fun <R : Comparable<R>> LongArray.maxBy(selector: (Long) -> R): Long(source)
@JvmName(name = "maxByOrThrow")
inline fun <R : Comparable<R>> FloatArray.maxBy(selector: (Float) -> R): Float(source)
@JvmName(name = "maxByOrThrow")
inline fun <R : Comparable<R>> DoubleArray.maxBy(selector: (Double) -> R): Double(source)
@JvmName(name = "maxByOrThrow")
inline fun <R : Comparable<R>> BooleanArray.maxBy(selector: (Boolean) -> R): Boolean(source)
@JvmName(name = "maxByOrThrow")
inline fun <R : Comparable<R>> CharArray.maxBy(selector: (Char) -> R): Char(source)
@JvmName(name = "maxByOrThrow-U")
@ExperimentalUnsignedTypes
inline fun <R : Comparable<R>> UIntArray.maxBy(selector: (UInt) -> R): UInt(source)
@JvmName(name = "maxByOrThrow-U")
@ExperimentalUnsignedTypes
inline fun <R : Comparable<R>> ULongArray.maxBy(selector: (ULong) -> R): ULong(source)
@JvmName(name = "maxByOrThrow-U")
@ExperimentalUnsignedTypes
inline fun <R : Comparable<R>> UByteArray.maxBy(selector: (UByte) -> R): UByte(source)
@JvmName(name = "maxByOrThrow-U")
@ExperimentalUnsignedTypes
inline fun <R : Comparable<R>> UShortArray.maxBy(selector: (UShort) -> R): UShort(source)

Returns the first element yielding the largest value of the given function.

Since Kotlin

1.7

Samples

samples.collections.Collections.Aggregates.maxBy

Throws

if the array is empty.

@JvmName(name = "maxByOrThrow")
inline fun <T, R : Comparable<R>> Iterable<T>.maxBy(selector: (T) -> R): T(source)

Returns the first element yielding the largest value of the given function.

Since Kotlin

1.7

Samples

samples.collections.Collections.Aggregates.maxBy

Throws

if the collection is empty.

@JvmName(name = "maxByOrThrow")
inline fun <K, V, R : Comparable<R>> Map<out K, V>.maxBy(selector: (Map.Entry<K, V>) -> R): Map.Entry<K, V>(source)

Returns the first entry yielding the largest value of the given function.

Since Kotlin

1.7

Samples

samples.collections.Collections.Aggregates.maxBy

Throws

if the map is empty.

inline fun <T, R : Comparable<R>> Array<out T>.maxBy(selector: (T) -> R): T?(source)
inline fun <R : Comparable<R>> ByteArray.maxBy(selector: (Byte) -> R): Byte?(source)
inline fun <R : Comparable<R>> ShortArray.maxBy(selector: (Short) -> R): Short?(source)
inline fun <R : Comparable<R>> IntArray.maxBy(selector: (Int) -> R): Int?(source)
inline fun <R : Comparable<R>> LongArray.maxBy(selector: (Long) -> R): Long?(source)
inline fun <R : Comparable<R>> FloatArray.maxBy(selector: (Float) -> R): Float?(source)
inline fun <R : Comparable<R>> DoubleArray.maxBy(selector: (Double) -> R): Double?(source)
inline fun <R : Comparable<R>> BooleanArray.maxBy(selector: (Boolean) -> R): Boolean?(source)
inline fun <R : Comparable<R>> CharArray.maxBy(selector: (Char) -> R): Char?(source)
inline fun <T, R : Comparable<R>> Iterable<T>.maxBy(selector: (T) -> R): T?(source)
inline fun <K, V, R : Comparable<R>> Map<out K, V>.maxBy(selector: (Map.Entry<K, V>) -> R): Map.Entry<K, V>?(source)

Deprecated

Warning since 1.4

Error since 1.5

Hidden since 1.6

Use maxByOrNull instead.

Replace with

this.maxByOrNull(selector)
Content copied to clipboard

Since Kotlin

1.0
@ExperimentalUnsignedTypes
inline fun <R : Comparable<R>> UIntArray.maxBy(selector: (UInt) -> R): UInt?(source)
@ExperimentalUnsignedTypes
inline fun <R : Comparable<R>> ULongArray.maxBy(selector: (ULong) -> R): ULong?(source)
@ExperimentalUnsignedTypes
inline fun <R : Comparable<R>> UByteArray.maxBy(selector: (UByte) -> R): UByte?(source)
@ExperimentalUnsignedTypes
inline fun <R : Comparable<R>> UShortArray.maxBy(selector: (UShort) -> R): UShort?(source)

Deprecated

Warning since 1.4

Error since 1.5

Hidden since 1.6

Use maxByOrNull instead.

Replace with

this.maxByOrNull(selector)
Content copied to clipboard

Since Kotlin

1.3