maxOf

MaxOf is a function in the Kotlin standard library used to determine the greatest element among given values. It is designed to work with generic types and provides overloads for common use cases: two values, a vararg collection of values, and, when needed, a comparator to define a custom ordering. The function operates by selecting the maximum according to the defined ordering, without modifying the original inputs.

The basic forms include a two-value version and a vararg version. When the type parameter T implements Comparable<T>, maxOf(a, b) returns the larger of a and b according to the natural ordering. For types that do not have a natural order or when a non-standard order is desired, you can supply a Comparator<T> to guide the comparison. In such cases, maxOf(a, b, comparator) returns the maximum according to the provided comparator.

In addition to the two-value overloads, maxOf can be invoked with multiple values at once using the vararg form, enabling a concise way to find the maximum among many items.

Common usage examples include numeric values (maxOf(3, 7) -> 7) and comparable types like strings (maxOf("apple", "banana") -> "banana", due to lexicographic ordering). By supplying a custom comparator, maxOf can be adapted to alternative criteria, such as comparing objects by a particular property rather than their natural order.

MaxOf is typically used alongside minOf as a pair of convenience helpers for determining extreme values in a concise, readable way.