All Downloads are FREE. Search and download functionalities are using the official Maven repository.

kotlin.comparisons.Comparisons.kt Maven / Gradle / Ivy

There is a newer version: 1.0.7
Show newest version
/*
 * Copyright 2010-2014 JetBrains s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
@file:kotlin.jvm.JvmName("ComparisonsKt")

package kotlin.comparisons

import java.util.Comparator

/**
 * Compares two values using the specified functions [selectors] to calculate the result of the comparison.
 * The functions are called sequentially, receive the given values [a] and [b] and return [Comparable]
 * objects. As soon as the [Comparable] instances returned by a function for [a] and [b] values do not
 * compare as equal, the result of that comparison is returned.
 */
public fun  compareValuesBy(a: T, b: T, vararg selectors: (T) -> Comparable<*>?): Int {
    require(selectors.size > 0)
    for (fn in selectors) {
        val v1 = fn(a)
        val v2 = fn(b)
        val diff = compareValues(v1, v2)
        if (diff != 0) return diff
    }
    return 0
}

/**
 * Compares two values using the specified [selector] function to calculate the result of the comparison.
 * The function is applied to the given values [a] and [b] and return [Comparable] objects.
 * The result of comparison of these [Comparable] instances is returned.
 */
@kotlin.internal.InlineOnly
public inline fun  compareValuesBy(a: T, b: T, selector: (T) -> Comparable<*>?): Int {
    return compareValues(selector(a), selector(b))
}

/**
 * Compares two values using the specified [selector] function to calculate the result of the comparison.
 * The function is applied to the given values [a] and [b] and return objects of type K which are then being
 * compared with the given [comparator].
 */
@kotlin.internal.InlineOnly
public inline fun  compareValuesBy(a: T, b: T, comparator: Comparator, selector: (T) -> K): Int {
    return comparator.compare(selector(a), selector(b))
}

//// Not so useful without type inference for receiver of expression
//// compareValuesWith(v1, v2, compareBy { it.prop1 } thenByDescending { it.prop2 })
///**
// * Compares two values using the specified [comparator].
// */
//@Suppress("NOTHING_TO_INLINE")
//public inline fun  compareValuesWith(a: T, b: T, comparator: Comparator): Int = comparator.compare(a, b)
//


/**
 * Compares two nullable [Comparable] values. Null is considered less than any value.
 */
public fun > compareValues(a: T?, b: T?): Int {
    if (a === b) return 0
    if (a == null) return -1
    if (b == null) return 1

    @Suppress("UNCHECKED_CAST")
    return (a as Comparable).compareTo(b)
}

/**
 * Creates a comparator using the sequence of functions to calculate a result of comparison.
 * The functions are called sequentially, receive the given values `a` and `b` and return [Comparable]
 * objects. As soon as the [Comparable] instances returned by a function for `a` and `b` values do not
 * compare as equal, the result of that comparison is returned from the [Comparator].
 */
public fun  compareBy(vararg selectors: (T) -> Comparable<*>?): Comparator {
    return object : Comparator {
        public override fun compare(a: T, b: T): Int = compareValuesBy(a, b, *selectors)
    }
}



/**
 * Creates a comparator using the function to transform value to a [Comparable] instance for comparison.
 */
@kotlin.internal.InlineOnly
public inline fun  compareBy(crossinline selector: (T) -> Comparable<*>?): Comparator {
    return object : Comparator {
        public override fun compare(a: T, b: T): Int = compareValuesBy(a, b, selector)
    }
}

/**
 * Creates a comparator using the [selector] function to transform values being compared and then applying
 * the specified [comparator] to compare transformed values.
 */
@kotlin.internal.InlineOnly
public inline fun  compareBy(comparator: Comparator, crossinline selector: (T) -> K): Comparator {
    return object : Comparator {
        public override fun compare(a: T, b: T): Int = compareValuesBy(a, b, comparator, selector)
    }
}

/**
 * Creates a descending comparator using the function to transform value to a [Comparable] instance for comparison.
 */
@kotlin.internal.InlineOnly
public inline fun  compareByDescending(crossinline selector: (T) -> Comparable<*>?): Comparator {
    return object : Comparator {
        public override fun compare(a: T, b: T): Int = compareValuesBy(b, a, selector)
    }
}

/**
 * Creates a descending comparator using the [selector] function to transform values being compared and then applying
 * the specified [comparator] to compare transformed values.
 *
 * Note that an order of [comparator] is reversed by this wrapper.
 */
@kotlin.internal.InlineOnly
public inline fun  compareByDescending(comparator: Comparator, crossinline selector: (T) -> K): Comparator {
    return object : Comparator {
        public override fun compare(a: T, b: T): Int = compareValuesBy(b, a, comparator, selector)
    }
}

/**
 * Creates a comparator comparing values after the primary comparator defined them equal. It uses
 * the function to transform value to a [Comparable] instance for comparison.
 */
@kotlin.internal.InlineOnly
public inline fun  Comparator.thenBy(crossinline selector: (T) -> Comparable<*>?): Comparator {
    return object : Comparator {
        public override fun compare(a: T, b: T): Int {
            val previousCompare = [email protected](a, b)
            return if (previousCompare != 0) previousCompare else compareValuesBy(a, b, selector)
        }
    }
}

/**
 * Creates a comparator comparing values after the primary comparator defined them equal. It uses
 * the [selector] function to transform values and then compares them with the given [comparator].
 */
@kotlin.internal.InlineOnly
public inline fun  Comparator.thenBy(comparator: Comparator, crossinline selector: (T) -> K): Comparator {
    return object : Comparator {
        public override fun compare(a: T, b: T): Int {
            val previousCompare = [email protected](a, b)
            return if (previousCompare != 0) previousCompare else compareValuesBy(a, b, comparator, selector)
        }
    }
}

/**
 * Creates a descending comparator using the primary comparator and
 * the function to transform value to a [Comparable] instance for comparison.
 */
@kotlin.internal.InlineOnly
public inline fun  Comparator.thenByDescending(crossinline selector: (T) -> Comparable<*>?): Comparator {
    return object : Comparator {
        public override fun compare(a: T, b: T): Int {
            val previousCompare = [email protected](a, b)
            return if (previousCompare != 0) previousCompare else compareValuesBy(b, a, selector)
        }
    }
}

/**
 * Creates a descending comparator comparing values after the primary comparator defined them equal. It uses
 * the [selector] function to transform values and then compares them with the given [comparator].
 */
@kotlin.internal.InlineOnly
public inline fun  Comparator.thenByDescending(comparator: Comparator, crossinline selector: (T) -> K): Comparator {
    return object : Comparator {
        public override fun compare(a: T, b: T): Int {
            val previousCompare = [email protected](a, b)
            return if (previousCompare != 0) previousCompare else compareValuesBy(b, a, comparator, selector)
        }
    }
}


/**
 * Creates a comparator using the primary comparator and function to calculate a result of comparison.
 */
@kotlin.internal.InlineOnly
public inline fun  Comparator.thenComparator(crossinline comparison: (T, T) -> Int): Comparator {
    return object : Comparator {
        public override fun compare(a: T, b: T): Int {
            val previousCompare = [email protected](a, b)
            return if (previousCompare != 0) previousCompare else comparison(a, b)
        }
    }
}

/**
 * Combines this comparator and the given [comparator] such that the latter is applied only
 * when the former considered values equal.
 */
public infix fun  Comparator.then(comparator: Comparator): Comparator {
    return object : Comparator {
        public override fun compare(a: T, b: T): Int {
            val previousCompare = [email protected](a, b)
            return if (previousCompare != 0) previousCompare else comparator.compare(a, b)
        }
    }
}

/**
 * Combines this comparator and the given [comparator] such that the latter is applied only
 * when the former considered values equal.
 */
public infix fun  Comparator.thenDescending(comparator: Comparator): Comparator {
    return object : Comparator {
        public override fun compare(a: T, b: T): Int {
            val previousCompare = [email protected](a, b)
            return if (previousCompare != 0) previousCompare else comparator.compare(b, a)
        }
    }
}

// Not so useful without type inference for receiver of expression
/**
 * Extends the given [comparator] of non-nullable values to a comparator of nullable values
 * considering `null` value less than any other value.
 */
public fun  nullsFirst(comparator: Comparator): Comparator {
    return object: Comparator {
        override fun compare(a: T?, b: T?): Int {
            if (a === b) return 0
            if (a == null) return -1
            if (b == null) return 1
            return comparator.compare(a, b)
        }
    }
}

/**
 * Provides a comparator of nullable [Comparable] values
 * considering `null` value less than any other value.
 */
@kotlin.internal.InlineOnly
public inline fun > nullsFirst(): Comparator = nullsFirst(naturalOrder())

/**
 * Extends the given [comparator] of non-nullable values to a comparator of nullable values
 * considering `null` value greater than any other value.
 */
public fun  nullsLast(comparator: Comparator): Comparator {
    return object: Comparator {
        override fun compare(a: T?, b: T?): Int {
            if (a === b) return 0
            if (a == null) return 1
            if (b == null) return -1
            return comparator.compare(a, b)
        }
    }
}

/**
 * Provides a comparator of nullable [Comparable] values
 * considering `null` value greater than any other value.
 */
@kotlin.internal.InlineOnly
public inline fun > nullsLast(): Comparator = nullsLast(naturalOrder())

/**
 * Returns a comparator that compares [Comparable] objects in natural order.
 */
public fun > naturalOrder(): Comparator = @Suppress("UNCHECKED_CAST") (NaturalOrderComparator as Comparator)

/**
 * Returns a comparator that compares [Comparable] objects in reversed natural order.
 */
public fun > reverseOrder(): Comparator = @Suppress("UNCHECKED_CAST") (ReverseOrderComparator as Comparator)

/** Returns a comparator that imposes the reverse ordering of this comparator. */
public fun  Comparator.reversed(): Comparator = when (this) {
    is ReversedComparator -> this.comparator
    NaturalOrderComparator -> @Suppress("UNCHECKED_CAST") (ReverseOrderComparator as Comparator)
    ReverseOrderComparator -> @Suppress("UNCHECKED_CAST") (NaturalOrderComparator as Comparator)
    else -> ReversedComparator(this)
}


private class ReversedComparator(public val comparator: Comparator): Comparator {
    override fun compare(a: T, b: T): Int = comparator.compare(b, a)
    @Suppress("VIRTUAL_MEMBER_HIDDEN")
    fun reversed(): Comparator = comparator
}

private object NaturalOrderComparator : Comparator> {
    override fun compare(c1: Comparable, c2: Comparable): Int = c1.compareTo(c2)
    @Suppress("VIRTUAL_MEMBER_HIDDEN")
    fun reversed(): Comparator> = ReverseOrderComparator
}

private object ReverseOrderComparator: Comparator> {
    override fun compare(c1: Comparable, c2: Comparable): Int = c2.compareTo(c1)
    @Suppress("VIRTUAL_MEMBER_HIDDEN")
    fun reversed(): Comparator> = NaturalOrderComparator
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy