Spec-Zone.ru › Kotlin 1.6

Пакет kotlin.comparisons

kotlin-stdlib / kotlin.comparisons

Вспомогательные функции для создания экземпляров Comparator.

Вспомогательные функции для создания экземпляров Comparator.

Функции

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

compareBy

Создает компаратор, используя последовательность функций для вычисления результата сравнения. Функции вызываются последовательно, принимают заданные значения a и b и возвращают объекты Comparable. Как только объекты Comparable, возвращаемые функцией для значений a и b, не сравниваются как равные, результат этого сравнения возвращается из компаратора .

fun <T> compareBy(
    vararg selectors: (T) -> Comparable<*>?
): Comparator<T>

Создаёт компаратор, используя функцию для преобразования значения в объект Comparable для сравнения.

fun <T> compareBy(
    selector: (T) -> Comparable<*>?
): Comparator<T>

Создаёт компаратор, используя функцию selector для преобразования сравниваемых значений, а затем применяет указанный компаратор для сравнения преобразованных значений.

fun <T, K> compareBy(
    comparator: Comparator<in K>, 
    selector: (T) -> K
): Comparator<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

compareByDescending

Создаёт компаратор в порядке убывания, используя функцию для преобразования значения в объект Comparable для сравнения.

fun <T> compareByDescending(
    selector: (T) -> Comparable<*>?
): Comparator<T>

Создаёт компаратор в порядке убывания, используя функцию selector для преобразования сравниваемых значений, а затем применяет указанный компаратор для сравнения преобразованных значений.

fun <T, K> compareByDescending(
    comparator: Comparator<in K>, 
    selector: (T) -> K
): Comparator<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

compareValues

Сравнивает два значения Comparable с возможностью значения null. Значение null считается меньше любого значения.

fun <T : Comparable<*>> compareValues(a: T?, b: T?): Int
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

compareValuesBy

Сравнивает два значения, используя указанные функции selectors для вычисления результата сравнения. Функции вызываются последовательно, принимают заданные значения a и b и возвращают объекты Comparable. Как только объекты Comparable, возвращаемые функцией для значений a и b, не сравниваются как равные, возвращается результат этого сравнения.

fun <T> compareValuesBy(
    a: T, 
    b: T, 
    vararg selectors: (T) -> Comparable<*>?
): Int

Сравнивает два значения, используя указанную функцию selector для вычисления результата сравнения. Функция применяется к заданным значениям a и b и возвращает объекты Comparable. Возвращается результат сравнения этих объектов Comparable.

fun <T> compareValuesBy(
    a: T, 
    b: T, 
    selector: (T) -> Comparable<*>?
): Int

Сравнивает два значения, используя указанную функцию selector для вычисления результата сравнения. Функция применяется к заданным значениям a и b и возвращает объекты типа K, которые затем сравниваются с заданным компаратором.

fun <T, K> compareValuesBy(
    a: T, 
    b: T, 
    comparator: Comparator<in K>, 
    selector: (T) -> K
): Int
Требования к платформе и версии: JVM (1.1), JS (1.1), Native (1.1)

maxOf

Возвращает наибольшее из трех значений в соответствии с порядком, заданным данным компаратором.

fun <T> maxOf(
    a: T, 
    b: T, 
    c: T, 
    comparator: Comparator<in T>
): T

Возвращает наибольшее из двух значений в соответствии с порядком, заданным данным компаратором.

fun <T> maxOf(a: T, b: T, comparator: Comparator<in T>): T

Возвращает наибольшее из заданных значений в соответствии с порядком, заданным данным компаратором.

fun <T> maxOf(
    a: T, 
    vararg other: T, 
    comparator: Comparator<in T>
): T

Возвращает наибольшее из двух значений.

fun maxOf(a: UInt, b: UInt): UInt
fun maxOf(a: ULong, b: ULong): ULong
fun maxOf(a: UByte, b: UByte): UByte
fun maxOf(a: UShort, b: UShort): UShort
fun <T : Comparable<T>> maxOf(a: T, b: T): T
fun maxOf(a: Byte, b: Byte): Byte
fun maxOf(a: Short, b: Short): Short
fun maxOf(a: Int, b: Int): Int
fun maxOf(a: Long, b: Long): Long
fun maxOf(a: Float, b: Float): Float
fun maxOf(a: Double, b: Double): Double

Возвращает наибольшее из трех значений.

fun maxOf(a: UInt, b: UInt, c: UInt): UInt
fun maxOf(a: ULong, b: ULong, c: ULong): ULong
fun maxOf(a: UByte, b: UByte, c: UByte): UByte
fun maxOf(a: UShort, b: UShort, c: UShort): UShort
fun <T : Comparable<T>> maxOf(a: T, b: T, c: T): T
fun maxOf(a: Byte, b: Byte, c: Byte): Byte
fun maxOf(a: Short, b: Short, c: Short): Short
fun maxOf(a: Int, b: Int, c: Int): Int
fun maxOf(a: Long, b: Long, c: Long): Long
fun maxOf(a: Float, b: Float, c: Float): Float
fun maxOf(a: Double, b: Double, c: Double): Double

Возвращает наибольшее из заданных значений.

fun maxOf(a: UInt, vararg other: UInt): UInt
fun maxOf(a: ULong, vararg other: ULong): ULong
fun maxOf(a: UByte, vararg other: UByte): UByte
fun maxOf(a: UShort, vararg other: UShort): UShort
fun <T : Comparable<T>> maxOf(a: T, vararg other: T): T
fun maxOf(a: Byte, vararg other: Byte): Byte
fun maxOf(a: Short, vararg other: Short): Short
fun maxOf(a: Int, vararg other: Int): Int
fun maxOf(a: Long, vararg other: Long): Long
fun maxOf(a: Float, vararg other: Float): Float
fun maxOf(a: Double, vararg other: Double): Double
Требования к платформе и версии: JVM (1.1), JS (1.1), Native (1.1)

minOf

Возвращает меньшее из трёх значений в соответствии с порядком, заданным данным компаратором.

fun <T> minOf(
    a: T, 
    b: T, 
    c: T, 
    comparator: Comparator<in T>
): T

Возвращает меньшее из двух значений в соответствии с порядком, заданным данным компаратором.

fun <T> minOf(a: T, b: T, comparator: Comparator<in T>): T

Возвращает меньшее из заданных значений в соответствии с порядком, заданным данным компаратором.

fun <T> minOf(
    a: T, 
    vararg other: T, 
    comparator: Comparator<in T>
): T

Возвращает меньшее из двух значений.

fun minOf(a: UInt, b: UInt): UInt
fun minOf(a: ULong, b: ULong): ULong
fun minOf(a: UByte, b: UByte): UByte
fun minOf(a: UShort, b: UShort): UShort
fun <T : Comparable<T>> minOf(a: T, b: T): T
fun minOf(a: Byte, b: Byte): Byte
fun minOf(a: Short, b: Short): Short
fun minOf(a: Int, b: Int): Int
fun minOf(a: Long, b: Long): Long
fun minOf(a: Float, b: Float): Float
fun minOf(a: Double, b: Double): Double

Возвращает меньшее из трёх значений.

fun minOf(a: UInt, b: UInt, c: UInt): UInt
fun minOf(a: ULong, b: ULong, c: ULong): ULong
fun minOf(a: UByte, b: UByte, c: UByte): UByte
fun minOf(a: UShort, b: UShort, c: UShort): UShort
fun <T : Comparable<T>> minOf(a: T, b: T, c: T): T
fun minOf(a: Byte, b: Byte, c: Byte): Byte
fun minOf(a: Short, b: Short, c: Short): Short
fun minOf(a: Int, b: Int, c: Int): Int
fun minOf(a: Long, b: Long, c: Long): Long
fun minOf(a: Float, b: Float, c: Float): Float
fun minOf(a: Double, b: Double, c: Double): Double

Возвращает меньшее из заданных значений.

fun minOf(a: UInt, vararg other: UInt): UInt
fun minOf(a: ULong, vararg other: ULong): ULong
fun minOf(a: UByte, vararg other: UByte): UByte
fun minOf(a: UShort, vararg other: UShort): UShort
fun <T : Comparable<T>> minOf(a: T, vararg other: T): T
fun minOf(a: Byte, vararg other: Byte): Byte
fun minOf(a: Short, vararg other: Short): Short
fun minOf(a: Int, vararg other: Int): Int
fun minOf(a: Long, vararg other: Long): Long
fun minOf(a: Float, vararg other: Float): Float
fun minOf(a: Double, vararg other: Double): Double
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

naturalOrder

Возвращает компаратор, сравнивающий объекты Comparable в естественном порядке.

fun <T : Comparable<T>> naturalOrder(): Comparator<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

nullsFirst

Расширяет данный компаратор для значений без null на компаратор для значений с null, считая значение null меньшим, чем любое другое значение.

fun <T : Any> nullsFirst(
    comparator: Comparator<in T>
): Comparator<T?>

Предоставляет компаратор для значений Comparable с null, считая значение null меньшим, чем любое другое значение.

fun <T : Comparable<T>> nullsFirst(): Comparator<T?>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

nullsLast

Расширяет данный компаратор для значений без null на компаратор для значений с null, считая значение null большим, чем любое другое значение.

fun <T : Any> nullsLast(
    comparator: Comparator<in T>
): Comparator<T?>

Предоставляет компаратор для значений Comparable с null, считая значение null большим, чем любое другое значение.

fun <T : Comparable<T>> nullsLast(): Comparator<T?>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

reversed

Возвращает компаратор, накладывающий обратный порядок этого компаратора.

fun <T> Comparator<T>.reversed(): Comparator<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

reverseOrder

Возвращает компаратор, сравнивающий объекты Comparable в обратном естественном порядке.

fun <T : Comparable<T>> reverseOrder(): Comparator<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

then

Объединяет этот компаратор и заданный компаратор таким образом, что второй применяется только тогда, когда первый считает значения равными.

infix fun <T> Comparator<T>.then(
    comparator: Comparator<in T>
): Comparator<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

thenBy

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

fun <T> Comparator<T>.thenBy(
    selector: (T) -> Comparable<*>?
): Comparator<T>

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

fun <T, K> Comparator<T>.thenBy(
    comparator: Comparator<in K>, 
    selector: (T) -> K
): Comparator<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

thenByDescending

Создает компаратор в порядке убывания, используя первичный компаратор и функцию для преобразования значения в экземпляр Comparable для сравнения.

fun <T> Comparator<T>.thenByDescending(
    selector: (T) -> Comparable<*>?
): Comparator<T>

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

fun <T, K> Comparator<T>.thenByDescending(
    comparator: Comparator<in K>, 
    selector: (T) -> K
): Comparator<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

thenComparator

Создает компаратор, используя первичный компаратор и функцию для вычисления результата сравнения.

fun <T> Comparator<T>.thenComparator(
    comparison: (a: T, b: T) -> Int
): Comparator<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

thenDescending

Объединяет этот компаратор и заданный компаратор таким образом, что последний применяется только тогда, когда первый считает значения равными.

infix fun <T> Comparator<T>.thenDescending(
    comparator: Comparator<in T>
): Comparator<T>

© 2010–2022 JetBrains s.r.o. and Kotlin Programming Language contributors
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.comparisons/index.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API