Remove brittle ‘contains’ optimization in minus/removeAll/retainAll #KT-45438
This commit is contained in:
committed by
Ilya Gorbunov
parent
fbc43cbebe
commit
94b371af5b
@@ -0,0 +1,66 @@
|
||||
/*
|
||||
* Copyright 2010-2021 JetBrains s.r.o. and Kotlin Programming Language contributors.
|
||||
* Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file.
|
||||
*/
|
||||
|
||||
package kotlin.collections
|
||||
|
||||
|
||||
/** Returns true if the brittle contains optimization is enabled. See KT-45438. */
|
||||
internal expect fun brittleContainsOptimizationEnabled(): Boolean
|
||||
|
||||
/**
|
||||
* Returns true if [brittleContainsOptimizationEnabled] is true
|
||||
* and it's safe to convert this collection to a set without changing contains method behavior.
|
||||
*/
|
||||
private fun <T> Collection<T>.safeToConvertToSet() = brittleContainsOptimizationEnabled() && size > 2 && this is ArrayList
|
||||
|
||||
/**
|
||||
* When [brittleContainsOptimizationEnabled] is true:
|
||||
* - Converts this [Iterable] to a set if it is not a [Collection].
|
||||
* - Converts this [Collection] to a set, when it's worth so and it doesn't change contains method behavior.
|
||||
* - Otherwise returns this.
|
||||
* When [brittleContainsOptimizationEnabled] is false:
|
||||
* - Converts this [Iterable] to a list if it is not a [Collection].
|
||||
* - Otherwise returns this.
|
||||
*/
|
||||
internal fun <T> Iterable<T>.convertToSetForSetOperationWith(source: Iterable<T>): Collection<T> =
|
||||
when (this) {
|
||||
is Set -> this
|
||||
is Collection ->
|
||||
when {
|
||||
source is Collection && source.size < 2 -> this
|
||||
else -> if (this.safeToConvertToSet()) toHashSet() else this
|
||||
}
|
||||
else -> if (brittleContainsOptimizationEnabled()) toHashSet() else toList()
|
||||
}
|
||||
|
||||
/**
|
||||
* When [brittleContainsOptimizationEnabled] is true:
|
||||
* - Converts this [Iterable] to a set if it is not a [Collection].
|
||||
* - Converts this [Collection] to a set, when it's worth so and it doesn't change contains method behavior.
|
||||
* - Otherwise returns this.
|
||||
* When [brittleContainsOptimizationEnabled] is false:
|
||||
* - Converts this [Iterable] to a list if it is not a [Collection].
|
||||
* - Otherwise returns this.
|
||||
*/
|
||||
internal fun <T> Iterable<T>.convertToSetForSetOperation(): Collection<T> =
|
||||
when (this) {
|
||||
is Set -> this
|
||||
is Collection -> if (this.safeToConvertToSet()) toHashSet() else this
|
||||
else -> if (brittleContainsOptimizationEnabled()) toHashSet() else toList()
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts this sequence to a set if [brittleContainsOptimizationEnabled] is true,
|
||||
* otherwise converts it to a list.
|
||||
*/
|
||||
internal fun <T> Sequence<T>.convertToSetForSetOperation(): Collection<T> =
|
||||
if (brittleContainsOptimizationEnabled()) toHashSet() else toList()
|
||||
|
||||
/**
|
||||
* Converts this array to a set if [brittleContainsOptimizationEnabled] is true,
|
||||
* otherwise converts it to a list.
|
||||
*/
|
||||
internal fun <T> Array<T>.convertToSetForSetOperation(): Collection<T> =
|
||||
if (brittleContainsOptimizationEnabled()) toHashSet() else asList()
|
||||
@@ -38,29 +38,6 @@ internal fun <T> Iterable<T>.collectionSizeOrNull(): Int? = if (this is Collecti
|
||||
@PublishedApi
|
||||
internal fun <T> Iterable<T>.collectionSizeOrDefault(default: Int): Int = if (this is Collection<*>) this.size else default
|
||||
|
||||
/** Returns true when it's safe to convert this collection to a set without changing contains method behavior. */
|
||||
private fun <T> Collection<T>.safeToConvertToSet() = size > 2 && this is ArrayList
|
||||
|
||||
/** Converts this collection to a set, when it's worth so and it doesn't change contains method behavior. */
|
||||
internal fun <T> Iterable<T>.convertToSetForSetOperationWith(source: Iterable<T>): Collection<T> =
|
||||
when (this) {
|
||||
is Set -> this
|
||||
is Collection ->
|
||||
when {
|
||||
source is Collection && source.size < 2 -> this
|
||||
else -> if (this.safeToConvertToSet()) toHashSet() else this
|
||||
}
|
||||
else -> toHashSet()
|
||||
}
|
||||
|
||||
/** Converts this collection to a set, when it's worth so and it doesn't change contains method behavior. */
|
||||
internal fun <T> Iterable<T>.convertToSetForSetOperation(): Collection<T> =
|
||||
when (this) {
|
||||
is Set -> this
|
||||
is Collection -> if (this.safeToConvertToSet()) toHashSet() else this
|
||||
else -> toHashSet()
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Returns a single list of all elements from all collections in the given collection.
|
||||
|
||||
@@ -152,7 +152,7 @@ public fun <T> MutableCollection<in T>.removeAll(elements: Iterable<T>): Boolean
|
||||
* Removes all elements from this [MutableCollection] that are also contained in the given [elements] sequence.
|
||||
*/
|
||||
public fun <T> MutableCollection<in T>.removeAll(elements: Sequence<T>): Boolean {
|
||||
val set = elements.toHashSet()
|
||||
val set = elements.convertToSetForSetOperation()
|
||||
return set.isNotEmpty() && removeAll(set)
|
||||
}
|
||||
|
||||
@@ -160,7 +160,7 @@ public fun <T> MutableCollection<in T>.removeAll(elements: Sequence<T>): Boolean
|
||||
* Removes all elements from this [MutableCollection] that are also contained in the given [elements] array.
|
||||
*/
|
||||
public fun <T> MutableCollection<in T>.removeAll(elements: Array<out T>): Boolean {
|
||||
return elements.isNotEmpty() && removeAll(elements.toHashSet())
|
||||
return elements.isNotEmpty() && removeAll(elements.convertToSetForSetOperation())
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -175,7 +175,7 @@ public fun <T> MutableCollection<in T>.retainAll(elements: Iterable<T>): Boolean
|
||||
*/
|
||||
public fun <T> MutableCollection<in T>.retainAll(elements: Array<out T>): Boolean {
|
||||
if (elements.isNotEmpty())
|
||||
return retainAll(elements.toHashSet())
|
||||
return retainAll(elements.convertToSetForSetOperation())
|
||||
else
|
||||
return retainNothing()
|
||||
}
|
||||
@@ -184,7 +184,7 @@ public fun <T> MutableCollection<in T>.retainAll(elements: Array<out T>): Boolea
|
||||
* Retains only elements of this [MutableCollection] that are contained in the given [elements] sequence.
|
||||
*/
|
||||
public fun <T> MutableCollection<in T>.retainAll(elements: Sequence<T>): Boolean {
|
||||
val set = elements.toHashSet()
|
||||
val set = elements.convertToSetForSetOperation()
|
||||
if (set.isNotEmpty())
|
||||
return retainAll(set)
|
||||
else
|
||||
|
||||
Reference in New Issue
Block a user