Упорядочивание

Естественный порядок

Основные функции .sorted() и .sortedDescending() возвращают элементы коллекции, отсортированные по возрастанию и убыванию в соответствии с естественным порядком. Эти функции применяются к коллекциям элементов типа Comparable.

fun main() {
//sampleStart
    val numbers = listOf("one", "two", "three", "four")

    println("Sorted ascending: ${numbers.sorted()}")
    println("Sorted descending: ${numbers.sortedDescending()}")
//sampleEnd
}

Пользовательские порядки

Для сортировки в пользовательском порядке или сортировки объектов, не поддерживающих сравнение, предназначены функции .sortedBy() и .sortedByDescending(). Они принимают функцию-селектор, преобразующую элементы коллекции в значения типа Comparable, и сортируют коллекцию в естественном порядке этих значений.

fun main() {
//sampleStart
    val numbers = listOf("one", "two", "three", "four")

    val sortedNumbers = numbers.sortedBy { it.length }
    println("Sorted by length ascending: $sortedNumbers")
    val sortedByLast = numbers.sortedByDescending { it.last() }
    println("Sorted by the last letter descending: $sortedByLast")
//sampleEnd
}

Чтобы задать пользовательский порядок сортировки коллекции, можно передать собственный Comparator. Для этого вызовите функцию расширения .sortedWith(), передав ей свой Comparator. С помощью этой функции сортировка строк по длине выглядит так:

fun main() {
//sampleStart
    val numbers = listOf("one", "two", "three", "four")
    println("Sorted by length ascending: ${numbers.sortedWith(compareBy { it.length })}")
//sampleEnd
}

Проверка порядка сортировки

С помощью следующих функций расширения можно проверить, упорядочены ли элементы в соответствии с заданным порядком:

• .isSorted()

• .isSortedDescending()

• .isSortedWith(comparator)

• .isSortedBy(selector)

• .isSortedByDescending(selector)

Эти функции расширения возвращают true, если элементы расположены в указанном порядке или если элементов меньше двух. Они возвращают false и прекращают проверку, как только находят пару элементов, расположенных не по порядку.

Для коллекций без гарантированного порядка итерации, например HashSet, результат может различаться при каждом вызове. То же относится к последовательностям, которые не выдают элементы в постоянном порядке. Чтобы получать одинаковые результаты при каждом вызове, используйте эти функции только для коллекций с гарантированным порядком итерации, например List.

При проверке значений Double и Float эти функции считают NaN больше любого другого значения, а -0.0 — меньше 0.0. Кроме того, функции .isSortedBy() и .isSortedByDescending() считают результаты селектора null меньше любого ненулевого значения.

При вызове этих функций для последовательности операция является терминальной. Она обрабатывает последовательность и возвращает значение типа Boolean вместо другой последовательности.

Вот пример проверки порядка сортировки с помощью функций .isSorted() и .isSortedBy():

data class User(val name: String, val age: Int)

fun main() {
//sampleStart
    val numbers = listOf(1, 2, 3, 4)
    println(numbers.isSorted())
    // true

    val users = listOf(
        User("Alice", 24),
        User("Bob", 31),
        User("Charlie", 29),
    )
    println(users.isSortedBy(User::age))
    // false

    val descending = listOf(4, 3, 2, 1)
    println(descending.isSortedDescending())
    // true
   
//sampleEnd
}

Обратный порядок

Получить коллекцию в обратном порядке можно с помощью функции .reversed().

fun main() {
//sampleStart
    val numbers = listOf("one", "two", "three", "four")
    println(numbers.reversed())
//sampleEnd
}

Функция расширения .reversed() возвращает новую коллекцию с копиями элементов. Поэтому, если позднее изменить исходную коллекцию, это не повлияет на ранее полученные результаты .reversed().

Другая функция для изменения порядка на обратный — .asReversed()

• возвращает представление той же коллекции в обратном порядке, поэтому оно может быть более лёгким и предпочтительным, чем .reversed(), если исходный список не будет изменяться.

fun main() {
//sampleStart
    val numbers = listOf("one", "two", "three", "four")
    val reversedNumbers = numbers.asReversed()
    println(reversedNumbers)
//sampleEnd
}

Если исходный список изменяемый, все его изменения отражаются в представлениях с обратным порядком, и наоборот.

fun main() {
//sampleStart
    val numbers = mutableListOf("one", "two", "three", "four")
    val reversedNumbers = numbers.asReversed()
    println(reversedNumbers)
    numbers.add("five")
    println(reversedNumbers)
//sampleEnd
}

Однако, если неизвестно, является ли список изменяемым, или источник вообще не является списком, предпочтительнее использовать .reversed(), поскольку эта функция возвращает копию, которая впоследствии не изменится.

Случайный порядок

Наконец, существует функция .shuffled(), которая возвращает новую коллекцию List с элементами в случайном порядке. Её можно вызвать без аргументов или передать объект Random.

fun main() {
//sampleStart
     val numbers = listOf("one", "two", "three", "four")
     println(numbers.shuffled())
//sampleEnd
}