org.pkl.thirdparty.kotlin.collections.BrittleContainsOptimization.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pkl-tools Show documentation

Fat Jar containing pkl-cli, pkl-codegen-java, pkl-codegen-kotlin, pkl-config-java, pkl-core, pkl-doc, and their shaded third-party dependencies.

There is a newer version: 0.27.1

Show newest version

/*
 * 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 org.pkl.thirdparty.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  Collection.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  Iterable.convertToSetForSetOperationWith(source: Iterable): Collection =
    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  Iterable.convertToSetForSetOperation(): Collection =
    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  Sequence.convertToSetForSetOperation(): Collection =
    if (brittleContainsOptimizationEnabled()) toHashSet() else toList()

/**
 * Converts this array to a set if [brittleContainsOptimizationEnabled] is true,
 * otherwise converts it to a list.
 */
internal fun  Array.convertToSetForSetOperation(): Collection =
    if (brittleContainsOptimizationEnabled()) toHashSet() else asList()