kotlin-stdlib/kotlin.collections/maxOrNull

maxOrNull

fun Array<out Double>.maxOrNull(): Double?(source)

fun Array<out Float>.maxOrNull(): Float?(source)

fun FloatArray.maxOrNull(): Float?(source)

fun DoubleArray.maxOrNull(): Double?(source)

Returns the largest element or null if the array is empty.

If any of elements is NaN, this function returns NaN.

Since Kotlin

1.4

Samples

import kotlin.math.*
import kotlin.test.*

fun main() { 
   //sampleStart 
   // The largest and smallest elements in the array
val numbers = doubleArrayOf(3.0, 7.2, 2.4, 6.5)
println(numbers.max()) // 7.2
println(numbers.min()) // 2.4

// max() and min() return `NaN` if any of elements is `NaN`
val numbersWithNaN = doubleArrayOf(3.0, Double.NaN, 7.2, 2.4, 6.5)
println(numbersWithNaN.max()) // NaN
println(numbersWithNaN.min()) // NaN

val emptyArray = doubleArrayOf()

// max() and min() throw if the array is empty
// emptyArray.max() // will fail with NoSuchElementException
// emptyArray.min() // will fail with NoSuchElementException

// maxOrNull() and minOrNull() return null if the array is empty
println(emptyArray.maxOrNull()) // null
println(emptyArray.minOrNull()) // null 
   //sampleEnd
}
xxxxxxxxxx
 
// The largest and smallest elements in the array
val numbers = doubleArrayOf(3.0, 7.2, 2.4, 6.5)
println(numbers.max()) // 7.2
println(numbers.min()) // 2.4
// max() and min() return `NaN` if any of elements is `NaN`
val numbersWithNaN = doubleArrayOf(3.0, Double.NaN, 7.2, 2.4, 6.5)
println(numbersWithNaN.max()) // NaN
println(numbersWithNaN.min()) // NaN
val emptyArray = doubleArrayOf()
// max() and min() throw if the array is empty
// emptyArray.max() // will fail with NoSuchElementException
// emptyArray.min() // will fail with NoSuchElementException
// maxOrNull() and minOrNull() return null if the array is empty
println(emptyArray.maxOrNull()) // null
println(emptyArray.minOrNull()) // null 
Open in Playground →
Target: JVMRunning on v.2.1.20

fun <T : Comparable<T>> Array<out T>.maxOrNull(): T?(source)

Returns the largest element or null if the array is empty.

If there are multiple equal maximal elements, this function returns the first of those elements.

Since Kotlin

1.4

Samples

import kotlin.math.*
import kotlin.test.*

fun main() { 
   //sampleStart 
   // The largest and smallest elements according to String.compareTo
val names = listOf("Alice", "Bob", "Carol")
println(names.max()) // Carol
println(names.min()) // Alice

val emptyList = emptyList<Int>()

// max() and min() throw if the collection is empty
// emptyList.max() // will fail with NoSuchElementException
// emptyList.min() // will fail with NoSuchElementException

// maxOrNull() and minOrNull() return null if the collection is empty
println(emptyList.maxOrNull()) // null
println(emptyList.minOrNull()) // null 
   //sampleEnd
}
xxxxxxxxxx
 
// The largest and smallest elements according to String.compareTo
val names = listOf("Alice", "Bob", "Carol")
println(names.max()) // Carol
println(names.min()) // Alice
val emptyList = emptyList<Int>()
// max() and min() throw if the collection is empty
// emptyList.max() // will fail with NoSuchElementException
// emptyList.min() // will fail with NoSuchElementException
// maxOrNull() and minOrNull() return null if the collection is empty
println(emptyList.maxOrNull()) // null
println(emptyList.minOrNull()) // null 
Open in Playground →
Target: JVMRunning on v.2.1.20

fun ByteArray.maxOrNull(): Byte?(source)

fun ShortArray.maxOrNull(): Short?(source)

fun IntArray.maxOrNull(): Int?(source)

fun LongArray.maxOrNull(): Long?(source)

fun CharArray.maxOrNull(): Char?(source)

@ExperimentalUnsignedTypes

fun UIntArray.maxOrNull(): UInt?(source)

@ExperimentalUnsignedTypes

fun ULongArray.maxOrNull(): ULong?(source)

@ExperimentalUnsignedTypes

fun UByteArray.maxOrNull(): UByte?(source)

@ExperimentalUnsignedTypes

fun UShortArray.maxOrNull(): UShort?(source)

Returns the largest element or null if the array is empty.

Since Kotlin

1.4

Samples

import kotlin.math.*
import kotlin.test.*

fun main() { 
   //sampleStart 
   // The largest and smallest elements in the array
val numbers = intArrayOf(3, 7, 2, 6)
println(numbers.max()) // 7
println(numbers.min()) // 2

val emptyArray = intArrayOf()

// max() and min() throw if the array is empty
// emptyArray.max() // will fail with NoSuchElementException
// emptyArray.min() // will fail with NoSuchElementException

// maxOrNull() and minOrNull() return null if the array is empty
println(emptyArray.maxOrNull()) // null
println(emptyArray.minOrNull()) // null 
   //sampleEnd
}
xxxxxxxxxx
 
// The largest and smallest elements in the array
val numbers = intArrayOf(3, 7, 2, 6)
println(numbers.max()) // 7
println(numbers.min()) // 2
val emptyArray = intArrayOf()
// max() and min() throw if the array is empty
// emptyArray.max() // will fail with NoSuchElementException
// emptyArray.min() // will fail with NoSuchElementException
// maxOrNull() and minOrNull() return null if the array is empty
println(emptyArray.maxOrNull()) // null
println(emptyArray.minOrNull()) // null 
Open in Playground →
Target: JVMRunning on v.2.1.20

fun Iterable<Double>.maxOrNull(): Double?(source)

fun Iterable<Float>.maxOrNull(): Float?(source)

Returns the largest element or null if the collection is empty.

If any of elements is NaN, this function returns NaN.

Since Kotlin

1.4

Samples

import kotlin.math.*
import kotlin.test.*

fun main() { 
   //sampleStart 
   // The largest and smallest elements in the array
val numbers = doubleArrayOf(3.0, 7.2, 2.4, 6.5)
println(numbers.max()) // 7.2
println(numbers.min()) // 2.4

// max() and min() return `NaN` if any of elements is `NaN`
val numbersWithNaN = doubleArrayOf(3.0, Double.NaN, 7.2, 2.4, 6.5)
println(numbersWithNaN.max()) // NaN
println(numbersWithNaN.min()) // NaN

val emptyArray = doubleArrayOf()

// max() and min() throw if the array is empty
// emptyArray.max() // will fail with NoSuchElementException
// emptyArray.min() // will fail with NoSuchElementException

// maxOrNull() and minOrNull() return null if the array is empty
println(emptyArray.maxOrNull()) // null
println(emptyArray.minOrNull()) // null 
   //sampleEnd
}
xxxxxxxxxx
 
// The largest and smallest elements in the array
val numbers = doubleArrayOf(3.0, 7.2, 2.4, 6.5)
println(numbers.max()) // 7.2
println(numbers.min()) // 2.4
// max() and min() return `NaN` if any of elements is `NaN`
val numbersWithNaN = doubleArrayOf(3.0, Double.NaN, 7.2, 2.4, 6.5)
println(numbersWithNaN.max()) // NaN
println(numbersWithNaN.min()) // NaN
val emptyArray = doubleArrayOf()
// max() and min() throw if the array is empty
// emptyArray.max() // will fail with NoSuchElementException
// emptyArray.min() // will fail with NoSuchElementException
// maxOrNull() and minOrNull() return null if the array is empty
println(emptyArray.maxOrNull()) // null
println(emptyArray.minOrNull()) // null 
Open in Playground →
Target: JVMRunning on v.2.1.20

fun <T : Comparable<T>> Iterable<T>.maxOrNull(): T?(source)

Returns the largest element or null if the collection is empty.

If there are multiple equal maximal elements, this function returns the first of those elements.

Since Kotlin

1.4

Samples

import kotlin.math.*
import kotlin.test.*

fun main() { 
   //sampleStart 
   // The largest and smallest elements according to String.compareTo
val names = listOf("Alice", "Bob", "Carol")
println(names.max()) // Carol
println(names.min()) // Alice

val emptyList = emptyList<Int>()

// max() and min() throw if the collection is empty
// emptyList.max() // will fail with NoSuchElementException
// emptyList.min() // will fail with NoSuchElementException

// maxOrNull() and minOrNull() return null if the collection is empty
println(emptyList.maxOrNull()) // null
println(emptyList.minOrNull()) // null 
   //sampleEnd
}
xxxxxxxxxx
 
// The largest and smallest elements according to String.compareTo
val names = listOf("Alice", "Bob", "Carol")
println(names.max()) // Carol
println(names.min()) // Alice
val emptyList = emptyList<Int>()
// max() and min() throw if the collection is empty
// emptyList.max() // will fail with NoSuchElementException
// emptyList.min() // will fail with NoSuchElementException
// maxOrNull() and minOrNull() return null if the collection is empty
println(emptyList.maxOrNull()) // null
println(emptyList.minOrNull()) // null 
Open in Playground →
Target: JVMRunning on v.2.1.20

Thanks for your feedback!

Was this page helpful?