libraries/stdlib/js/builtins/Arrays.kt

/*
 * Copyright 2010-2024 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.
 */

// Auto-generated file. DO NOT EDIT!
// Generated by org.jetbrains.kotlin.generators.builtins.arrays.GenerateJsArrays

@file:Suppress("UNUSED_PARAMETER")

package kotlin

/**
 * An array of bytes.
 *
 * See [Kotlin language documentation](https://kotlinlang.org/docs/arrays.html)
 * for more information on arrays.
 */
public actual class ByteArray
/**
 * Creates a new array of the specified [size], with all elements initialized to zero.
 * @throws RuntimeException if the specified [size] is negative.
 */
public actual constructor(size: Int) {
    /**
     * Creates a new array of the specified [size], where each element is calculated by calling the specified
     * [init] function.
     *
     * The function [init] is called for each array element sequentially starting from the first one.
     * It should return the value for an array element given its index.
     *
     * @throws RuntimeException if the specified [size] is negative.
     */
    @Suppress("WRONG_MODIFIER_TARGET", "PRIMARY_CONSTRUCTOR_DELEGATION_CALL_EXPECTED")
    public actual inline constructor(size: Int, init: (Int) -> Byte)

    /**
     * Returns the array element at the given [index].
     *
     * This method can be called using the index operator:
     * ```
     * value = array[index]
     * ```
     *
     * If the [index] is out of bounds of this array, the behavior is unspecified
     */
    @Suppress("NON_ABSTRACT_FUNCTION_WITH_NO_BODY")
    public actual operator fun get(index: Int): Byte

    /**
     * Sets the array element at the given [index] to the given [value].
     *
     * This method can be called using the index operator:
     * ```
     * array[index] = value
     * ```
     *
     * If the [index] is out of bounds of this array, the behavior is unspecified
     */
    @Suppress("NON_ABSTRACT_FUNCTION_WITH_NO_BODY")
    public actual operator fun set(index: Int, value: Byte): Unit

    /**
     * Returns the number of elements in the array.
     */
    @Suppress("MUST_BE_INITIALIZED_OR_BE_ABSTRACT")
    public actual val size: Int

    /** Creates a specialized [ByteIterator] for iterating over the elements of the array. */
    @Suppress("NON_ABSTRACT_FUNCTION_WITH_NO_BODY")
    public actual operator fun iterator(): ByteIterator

    companion {
        /**
         * Returns an array containing the specified elements.
         *
         * @sample samples.collections.Arrays.Constructors.byteArrayLiteralSample
         */
        @SinceKotlin("2.5")
        @ExperimentalCollectionLiteralsApi
        @Suppress("NOTHING_TO_INLINE")
        public actual inline operator fun of(vararg elements: Byte): ByteArray =
            elements
    }
}

/**
 * An array of chars.
 *
 * See [Kotlin language documentation](https://kotlinlang.org/docs/arrays.html)
 * for more information on arrays.
 */
public actual class CharArray
/**
 * Creates a new array of the specified [size], with all elements initialized to null char (`\u0000').
 * @throws RuntimeException if the specified [size] is negative.
 */
public actual constructor(size: Int) {
    /**
     * Creates a new array of the specified [size], where each element is calculated by calling the specified
     * [init] function.
     *
     * The function [init] is called for each array element sequentially starting from the first one.
     * It should return the value for an array element given its index.
     *
     * @throws RuntimeException if the specified [size] is negative.
     */
    @Suppress("WRONG_MODIFIER_TARGET", "PRIMARY_CONSTRUCTOR_DELEGATION_CALL_EXPECTED")
    public actual inline constructor(size: Int, init: (Int) -> Char)

    /**
     * Returns the array element at the given [index].
     *
     * This method can be called using the index operator:
     * ```
     * value = array[index]
     * ```
     *
     * If the [index] is out of bounds of this array, the behavior is unspecified
     */
    @Suppress("NON_ABSTRACT_FUNCTION_WITH_NO_BODY")
    public actual operator fun get(index: Int): Char

    /**
     * Sets the array element at the given [index] to the given [value].
     *
     * This method can be called using the index operator:
     * ```
     * array[index] = value
     * ```
     *
     * If the [index] is out of bounds of this array, the behavior is unspecified
     */
    @Suppress("NON_ABSTRACT_FUNCTION_WITH_NO_BODY")
    public actual operator fun set(index: Int, value: Char): Unit

    /**
     * Returns the number of elements in the array.
     */
    @Suppress("MUST_BE_INITIALIZED_OR_BE_ABSTRACT")
    public actual val size: Int

    /** Creates a specialized [CharIterator] for iterating over the elements of the array. */
    @Suppress("NON_ABSTRACT_FUNCTION_WITH_NO_BODY")
    public actual operator fun iterator(): CharIterator

    companion {
        /**
         * Returns an array containing the specified elements.
         *
         * @sample samples.collections.Arrays.Constructors.charArrayLiteralSample
         */
        @SinceKotlin("2.5")
        @ExperimentalCollectionLiteralsApi
        @Suppress("NOTHING_TO_INLINE")
        public actual inline operator fun of(vararg elements: Char): CharArray =
            elements
    }
}

/**
 * An array of shorts.
 *
 * See [Kotlin language documentation](https://kotlinlang.org/docs/arrays.html)
 * for more information on arrays.
 */
public actual class ShortArray
/**
 * Creates a new array of the specified [size], with all elements initialized to zero.
 * @throws RuntimeException if the specified [size] is negative.
 */
public actual constructor(size: Int) {
    /**
     * Creates a new array of the specified [size], where each element is calculated by calling the specified
     * [init] function.
     *
     * The function [init] is called for each array element sequentially starting from the first one.
     * It should return the value for an array element given its index.
     *
     * @throws RuntimeException if the specified [size] is negative.
     */
    @Suppress("WRONG_MODIFIER_TARGET", "PRIMARY_CONSTRUCTOR_DELEGATION_CALL_EXPECTED")
    public actual inline constructor(size: Int, init: (Int) -> Short)

    /**
     * Returns the array element at the given [index].
     *
     * This method can be called using the index operator:
     * ```
     * value = array[index]
     * ```
     *
     * If the [index] is out of bounds of this array, the behavior is unspecified
     */
    @Suppress("NON_ABSTRACT_FUNCTION_WITH_NO_BODY")
    public actual operator fun get(index: Int): Short

    /**
     * Sets the array element at the given [index] to the given [value].
     *
     * This method can be called using the index operator:
     * ```
     * array[index] = value
     * ```
     *
     * If the [index] is out of bounds of this array, the behavior is unspecified
     */
    @Suppress("NON_ABSTRACT_FUNCTION_WITH_NO_BODY")
    public actual operator fun set(index: Int, value: Short): Unit

    /**
     * Returns the number of elements in the array.
     */
    @Suppress("MUST_BE_INITIALIZED_OR_BE_ABSTRACT")
    public actual val size: Int

    /** Creates a specialized [ShortIterator] for iterating over the elements of the array. */
    @Suppress("NON_ABSTRACT_FUNCTION_WITH_NO_BODY")
    public actual operator fun iterator(): ShortIterator

    companion {
        /**
         * Returns an array containing the specified elements.
         *
         * @sample samples.collections.Arrays.Constructors.shortArrayLiteralSample
         */
        @SinceKotlin("2.5")
        @ExperimentalCollectionLiteralsApi
        @Suppress("NOTHING_TO_INLINE")
        public actual inline operator fun of(vararg elements: Short): ShortArray =
            elements
    }
}

/**
 * An array of ints.
 *
 * See [Kotlin language documentation](https://kotlinlang.org/docs/arrays.html)
 * for more information on arrays.
 */
public actual class IntArray
/**
 * Creates a new array of the specified [size], with all elements initialized to zero.
 * @throws RuntimeException if the specified [size] is negative.
 */
public actual constructor(size: Int) {
    /**
     * Creates a new array of the specified [size], where each element is calculated by calling the specified
     * [init] function.
     *
     * The function [init] is called for each array element sequentially starting from the first one.
     * It should return the value for an array element given its index.
     *
     * @throws RuntimeException if the specified [size] is negative.
     */
    @Suppress("WRONG_MODIFIER_TARGET", "PRIMARY_CONSTRUCTOR_DELEGATION_CALL_EXPECTED")
    public actual inline constructor(size: Int, init: (Int) -> Int)

    /**
     * Returns the array element at the given [index].
     *
     * This method can be called using the index operator:
     * ```
     * value = array[index]
     * ```
     *
     * If the [index] is out of bounds of this array, the behavior is unspecified
     */
    @Suppress("NON_ABSTRACT_FUNCTION_WITH_NO_BODY")
    public actual operator fun get(index: Int): Int

    /**
     * Sets the array element at the given [index] to the given [value].
     *
     * This method can be called using the index operator:
     * ```
     * array[index] = value
     * ```
     *
     * If the [index] is out of bounds of this array, the behavior is unspecified
     */
    @Suppress("NON_ABSTRACT_FUNCTION_WITH_NO_BODY")
    public actual operator fun set(index: Int, value: Int): Unit

    /**
     * Returns the number of elements in the array.
     */
    @Suppress("MUST_BE_INITIALIZED_OR_BE_ABSTRACT")
    public actual val size: Int

    /** Creates a specialized [IntIterator] for iterating over the elements of the array. */
    @Suppress("NON_ABSTRACT_FUNCTION_WITH_NO_BODY")
    public actual operator fun iterator(): IntIterator

    companion {
        /**
         * Returns an array containing the specified elements.
         *
         * @sample samples.collections.Arrays.Constructors.intArrayLiteralSample
         */
        @SinceKotlin("2.5")
        @ExperimentalCollectionLiteralsApi
        @Suppress("NOTHING_TO_INLINE")
        public actual inline operator fun of(vararg elements: Int): IntArray =
            elements
    }
}

/**
 * An array of longs.
 *
 * See [Kotlin language documentation](https://kotlinlang.org/docs/arrays.html)
 * for more information on arrays.
 */
public actual class LongArray
/**
 * Creates a new array of the specified [size], with all elements initialized to zero.
 * @throws RuntimeException if the specified [size] is negative.
 */
public actual constructor(size: Int) {
    /**
     * Creates a new array of the specified [size], where each element is calculated by calling the specified
     * [init] function.
     *
     * The function [init] is called for each array element sequentially starting from the first one.
     * It should return the value for an array element given its index.
     *
     * @throws RuntimeException if the specified [size] is negative.
     */
    @Suppress("WRONG_MODIFIER_TARGET", "PRIMARY_CONSTRUCTOR_DELEGATION_CALL_EXPECTED")
    public actual inline constructor(size: Int, init: (Int) -> Long)

    /**
     * Returns the array element at the given [index].
     *
     * This method can be called using the index operator:
     * ```
     * value = array[index]
     * ```
     *
     * If the [index] is out of bounds of this array, the behavior is unspecified
     */
    @Suppress("NON_ABSTRACT_FUNCTION_WITH_NO_BODY")
    public actual operator fun get(index: Int): Long

    /**
     * Sets the array element at the given [index] to the given [value].
     *
     * This method can be called using the index operator:
     * ```
     * array[index] = value
     * ```
     *
     * If the [index] is out of bounds of this array, the behavior is unspecified
     */
    @Suppress("NON_ABSTRACT_FUNCTION_WITH_NO_BODY")
    public actual operator fun set(index: Int, value: Long): Unit

    /**
     * Returns the number of elements in the array.
     */
    @Suppress("MUST_BE_INITIALIZED_OR_BE_ABSTRACT")
    public actual val size: Int

    /** Creates a specialized [LongIterator] for iterating over the elements of the array. */
    @Suppress("NON_ABSTRACT_FUNCTION_WITH_NO_BODY")
    public actual operator fun iterator(): LongIterator

    companion {
        /**
         * Returns an array containing the specified elements.
         *
         * @sample samples.collections.Arrays.Constructors.longArrayLiteralSample
         */
        @SinceKotlin("2.5")
        @ExperimentalCollectionLiteralsApi
        @Suppress("NOTHING_TO_INLINE")
        public actual inline operator fun of(vararg elements: Long): LongArray =
            elements
    }
}

/**
 * An array of floats.
 *
 * See [Kotlin language documentation](https://kotlinlang.org/docs/arrays.html)
 * for more information on arrays.
 */
public actual class FloatArray
/**
 * Creates a new array of the specified [size], with all elements initialized to zero.
 * @throws RuntimeException if the specified [size] is negative.
 */
public actual constructor(size: Int) {
    /**
     * Creates a new array of the specified [size], where each element is calculated by calling the specified
     * [init] function.
     *
     * The function [init] is called for each array element sequentially starting from the first one.
     * It should return the value for an array element given its index.
     *
     * @throws RuntimeException if the specified [size] is negative.
     */
    @Suppress("WRONG_MODIFIER_TARGET", "PRIMARY_CONSTRUCTOR_DELEGATION_CALL_EXPECTED")
    public actual inline constructor(size: Int, init: (Int) -> Float)

    /**
     * Returns the array element at the given [index].
     *
     * This method can be called using the index operator:
     * ```
     * value = array[index]
     * ```
     *
     * If the [index] is out of bounds of this array, the behavior is unspecified
     */
    @Suppress("NON_ABSTRACT_FUNCTION_WITH_NO_BODY")
    public actual operator fun get(index: Int): Float

    /**
     * Sets the array element at the given [index] to the given [value].
     *
     * This method can be called using the index operator:
     * ```
     * array[index] = value
     * ```
     *
     * If the [index] is out of bounds of this array, the behavior is unspecified
     */
    @Suppress("NON_ABSTRACT_FUNCTION_WITH_NO_BODY")
    public actual operator fun set(index: Int, value: Float): Unit

    /**
     * Returns the number of elements in the array.
     */
    @Suppress("MUST_BE_INITIALIZED_OR_BE_ABSTRACT")
    public actual val size: Int

    /** Creates a specialized [FloatIterator] for iterating over the elements of the array. */
    @Suppress("NON_ABSTRACT_FUNCTION_WITH_NO_BODY")
    public actual operator fun iterator(): FloatIterator

    companion {
        /**
         * Returns an array containing the specified elements.
         *
         * @sample samples.collections.Arrays.Constructors.floatArrayLiteralSample
         */
        @SinceKotlin("2.5")
        @ExperimentalCollectionLiteralsApi
        @Suppress("NOTHING_TO_INLINE")
        public actual inline operator fun of(vararg elements: Float): FloatArray =
            elements
    }
}

/**
 * An array of doubles.
 *
 * See [Kotlin language documentation](https://kotlinlang.org/docs/arrays.html)
 * for more information on arrays.
 */
public actual class DoubleArray
/**
 * Creates a new array of the specified [size], with all elements initialized to zero.
 * @throws RuntimeException if the specified [size] is negative.
 */
public actual constructor(size: Int) {
    /**
     * Creates a new array of the specified [size], where each element is calculated by calling the specified
     * [init] function.
     *
     * The function [init] is called for each array element sequentially starting from the first one.
     * It should return the value for an array element given its index.
     *
     * @throws RuntimeException if the specified [size] is negative.
     */
    @Suppress("WRONG_MODIFIER_TARGET", "PRIMARY_CONSTRUCTOR_DELEGATION_CALL_EXPECTED")
    public actual inline constructor(size: Int, init: (Int) -> Double)

    /**
     * Returns the array element at the given [index].
     *
     * This method can be called using the index operator:
     * ```
     * value = array[index]
     * ```
     *
     * If the [index] is out of bounds of this array, the behavior is unspecified
     */
    @Suppress("NON_ABSTRACT_FUNCTION_WITH_NO_BODY")
    public actual operator fun get(index: Int): Double

    /**
     * Sets the array element at the given [index] to the given [value].
     *
     * This method can be called using the index operator:
     * ```
     * array[index] = value
     * ```
     *
     * If the [index] is out of bounds of this array, the behavior is unspecified
     */
    @Suppress("NON_ABSTRACT_FUNCTION_WITH_NO_BODY")
    public actual operator fun set(index: Int, value: Double): Unit

    /**
     * Returns the number of elements in the array.
     */
    @Suppress("MUST_BE_INITIALIZED_OR_BE_ABSTRACT")
    public actual val size: Int

    /** Creates a specialized [DoubleIterator] for iterating over the elements of the array. */
    @Suppress("NON_ABSTRACT_FUNCTION_WITH_NO_BODY")
    public actual operator fun iterator(): DoubleIterator

    companion {
        /**
         * Returns an array containing the specified elements.
         *
         * @sample samples.collections.Arrays.Constructors.doubleArrayLiteralSample
         */
        @SinceKotlin("2.5")
        @ExperimentalCollectionLiteralsApi
        @Suppress("NOTHING_TO_INLINE")
        public actual inline operator fun of(vararg elements: Double): DoubleArray =
            elements
    }
}

/**
 * An array of booleans.
 *
 * See [Kotlin language documentation](https://kotlinlang.org/docs/arrays.html)
 * for more information on arrays.
 */
public actual class BooleanArray
/**
 * Creates a new array of the specified [size], with all elements initialized to `false`.
 * @throws RuntimeException if the specified [size] is negative.
 */
public actual constructor(size: Int) {
    /**
     * Creates a new array of the specified [size], where each element is calculated by calling the specified
     * [init] function.
     *
     * The function [init] is called for each array element sequentially starting from the first one.
     * It should return the value for an array element given its index.
     *
     * @throws RuntimeException if the specified [size] is negative.
     */
    @Suppress("WRONG_MODIFIER_TARGET", "PRIMARY_CONSTRUCTOR_DELEGATION_CALL_EXPECTED")
    public actual inline constructor(size: Int, init: (Int) -> Boolean)

    /**
     * Returns the array element at the given [index].
     *
     * This method can be called using the index operator:
     * ```
     * value = array[index]
     * ```
     *
     * If the [index] is out of bounds of this array, the behavior is unspecified
     */
    @Suppress("NON_ABSTRACT_FUNCTION_WITH_NO_BODY")
    public actual operator fun get(index: Int): Boolean

    /**
     * Sets the array element at the given [index] to the given [value].
     *
     * This method can be called using the index operator:
     * ```
     * array[index] = value
     * ```
     *
     * If the [index] is out of bounds of this array, the behavior is unspecified
     */
    @Suppress("NON_ABSTRACT_FUNCTION_WITH_NO_BODY")
    public actual operator fun set(index: Int, value: Boolean): Unit

    /**
     * Returns the number of elements in the array.
     */
    @Suppress("MUST_BE_INITIALIZED_OR_BE_ABSTRACT")
    public actual val size: Int

    /** Creates a specialized [BooleanIterator] for iterating over the elements of the array. */
    @Suppress("NON_ABSTRACT_FUNCTION_WITH_NO_BODY")
    public actual operator fun iterator(): BooleanIterator

    companion {
        /**
         * Returns an array containing the specified elements.
         *
         * @sample samples.collections.Arrays.Constructors.booleanArrayLiteralSample
         */
        @SinceKotlin("2.5")
        @ExperimentalCollectionLiteralsApi
        @Suppress("NOTHING_TO_INLINE")
        public actual inline operator fun of(vararg elements: Boolean): BooleanArray =
            elements
    }
}