Common Array.fill for unsigned arrays, improve docs, native impl name

KT-32359
This commit is contained in:
Ilya Gorbunov
2019-07-25 01:28:51 +03:00
parent 1a6069382e
commit 3751a8a797
9 changed files with 377 additions and 323 deletions
@@ -1024,137 +1024,146 @@ public actual fun CharArray.copyOfRange(fromIndex: Int, toIndex: Int): CharArray
}
/**
* Fills original array with the provided value.
* Fills this array or its subrange with the specified [element] value.
*
* @param fromIndex the start of the range (inclusive), 0 by default.
* @param toIndex the end of the range (exclusive), size of this array by default.
*
* @throws IndexOutOfBoundsException if [fromIndex] is less than zero or [toIndex] is greater than the size of this array.
* @throws IllegalArgumentException if [fromIndex] is greater than [toIndex].
*/
@SinceKotlin("1.3")
@Suppress("ACTUAL_FUNCTION_WITH_DEFAULT_ARGUMENTS")
public actual fun <T> Array<T>.fill(element: T, fromIndex: Int = 0, toIndex: Int = size): Unit {
if (fromIndex !in 0..size) {
throw IndexOutOfBoundsException("fromIndex $fromIndex out of range [0, $size]")
}
if (toIndex > size) {
throw IndexOutOfBoundsException("toIndex $toIndex out of range [$fromIndex, $size]")
}
require(fromIndex <= toIndex) { "fromIndex($fromIndex) > toIndex($toIndex)" }
AbstractList.checkRangeIndexes(fromIndex, toIndex, size)
this.asDynamic().fill(element, fromIndex, toIndex);
}
/**
* Fills original array with the provided value.
* Fills this array or its subrange with the specified [element] value.
*
* @param fromIndex the start of the range (inclusive), 0 by default.
* @param toIndex the end of the range (exclusive), size of this array by default.
*
* @throws IndexOutOfBoundsException if [fromIndex] is less than zero or [toIndex] is greater than the size of this array.
* @throws IllegalArgumentException if [fromIndex] is greater than [toIndex].
*/
@SinceKotlin("1.3")
@Suppress("ACTUAL_FUNCTION_WITH_DEFAULT_ARGUMENTS")
public actual fun ByteArray.fill(element: Byte, fromIndex: Int = 0, toIndex: Int = size): Unit {
if (fromIndex !in 0..size) {
throw IndexOutOfBoundsException("fromIndex $fromIndex out of range [0, $size]")
}
if (toIndex > size) {
throw IndexOutOfBoundsException("toIndex $toIndex out of range [$fromIndex, $size]")
}
require(fromIndex <= toIndex) { "fromIndex($fromIndex) > toIndex($toIndex)" }
AbstractList.checkRangeIndexes(fromIndex, toIndex, size)
this.asDynamic().fill(element, fromIndex, toIndex);
}
/**
* Fills original array with the provided value.
* Fills this array or its subrange with the specified [element] value.
*
* @param fromIndex the start of the range (inclusive), 0 by default.
* @param toIndex the end of the range (exclusive), size of this array by default.
*
* @throws IndexOutOfBoundsException if [fromIndex] is less than zero or [toIndex] is greater than the size of this array.
* @throws IllegalArgumentException if [fromIndex] is greater than [toIndex].
*/
@SinceKotlin("1.3")
@Suppress("ACTUAL_FUNCTION_WITH_DEFAULT_ARGUMENTS")
public actual fun ShortArray.fill(element: Short, fromIndex: Int = 0, toIndex: Int = size): Unit {
if (fromIndex !in 0..size) {
throw IndexOutOfBoundsException("fromIndex $fromIndex out of range [0, $size]")
}
if (toIndex > size) {
throw IndexOutOfBoundsException("toIndex $toIndex out of range [$fromIndex, $size]")
}
require(fromIndex <= toIndex) { "fromIndex($fromIndex) > toIndex($toIndex)" }
AbstractList.checkRangeIndexes(fromIndex, toIndex, size)
this.asDynamic().fill(element, fromIndex, toIndex);
}
/**
* Fills original array with the provided value.
* Fills this array or its subrange with the specified [element] value.
*
* @param fromIndex the start of the range (inclusive), 0 by default.
* @param toIndex the end of the range (exclusive), size of this array by default.
*
* @throws IndexOutOfBoundsException if [fromIndex] is less than zero or [toIndex] is greater than the size of this array.
* @throws IllegalArgumentException if [fromIndex] is greater than [toIndex].
*/
@SinceKotlin("1.3")
@Suppress("ACTUAL_FUNCTION_WITH_DEFAULT_ARGUMENTS")
public actual fun IntArray.fill(element: Int, fromIndex: Int = 0, toIndex: Int = size): Unit {
if (fromIndex !in 0..size) {
throw IndexOutOfBoundsException("fromIndex $fromIndex out of range [0, $size]")
}
if (toIndex > size) {
throw IndexOutOfBoundsException("toIndex $toIndex out of range [$fromIndex, $size]")
}
require(fromIndex <= toIndex) { "fromIndex($fromIndex) > toIndex($toIndex)" }
AbstractList.checkRangeIndexes(fromIndex, toIndex, size)
this.asDynamic().fill(element, fromIndex, toIndex);
}
/**
* Fills original array with the provided value.
* Fills this array or its subrange with the specified [element] value.
*
* @param fromIndex the start of the range (inclusive), 0 by default.
* @param toIndex the end of the range (exclusive), size of this array by default.
*
* @throws IndexOutOfBoundsException if [fromIndex] is less than zero or [toIndex] is greater than the size of this array.
* @throws IllegalArgumentException if [fromIndex] is greater than [toIndex].
*/
@SinceKotlin("1.3")
@Suppress("ACTUAL_FUNCTION_WITH_DEFAULT_ARGUMENTS")
public actual fun LongArray.fill(element: Long, fromIndex: Int = 0, toIndex: Int = size): Unit {
if (fromIndex !in 0..size) {
throw IndexOutOfBoundsException("fromIndex $fromIndex out of range [0, $size]")
}
if (toIndex > size) {
throw IndexOutOfBoundsException("toIndex $toIndex out of range [$fromIndex, $size]")
}
require(fromIndex <= toIndex) { "fromIndex($fromIndex) > toIndex($toIndex)" }
AbstractList.checkRangeIndexes(fromIndex, toIndex, size)
this.asDynamic().fill(element, fromIndex, toIndex);
}
/**
* Fills original array with the provided value.
* Fills this array or its subrange with the specified [element] value.
*
* @param fromIndex the start of the range (inclusive), 0 by default.
* @param toIndex the end of the range (exclusive), size of this array by default.
*
* @throws IndexOutOfBoundsException if [fromIndex] is less than zero or [toIndex] is greater than the size of this array.
* @throws IllegalArgumentException if [fromIndex] is greater than [toIndex].
*/
@SinceKotlin("1.3")
@Suppress("ACTUAL_FUNCTION_WITH_DEFAULT_ARGUMENTS")
public actual fun FloatArray.fill(element: Float, fromIndex: Int = 0, toIndex: Int = size): Unit {
if (fromIndex !in 0..size) {
throw IndexOutOfBoundsException("fromIndex $fromIndex out of range [0, $size]")
}
if (toIndex > size) {
throw IndexOutOfBoundsException("toIndex $toIndex out of range [$fromIndex, $size]")
}
require(fromIndex <= toIndex) { "fromIndex($fromIndex) > toIndex($toIndex)" }
AbstractList.checkRangeIndexes(fromIndex, toIndex, size)
this.asDynamic().fill(element, fromIndex, toIndex);
}
/**
* Fills original array with the provided value.
* Fills this array or its subrange with the specified [element] value.
*
* @param fromIndex the start of the range (inclusive), 0 by default.
* @param toIndex the end of the range (exclusive), size of this array by default.
*
* @throws IndexOutOfBoundsException if [fromIndex] is less than zero or [toIndex] is greater than the size of this array.
* @throws IllegalArgumentException if [fromIndex] is greater than [toIndex].
*/
@SinceKotlin("1.3")
@Suppress("ACTUAL_FUNCTION_WITH_DEFAULT_ARGUMENTS")
public actual fun DoubleArray.fill(element: Double, fromIndex: Int = 0, toIndex: Int = size): Unit {
if (fromIndex !in 0..size) {
throw IndexOutOfBoundsException("fromIndex $fromIndex out of range [0, $size]")
}
if (toIndex > size) {
throw IndexOutOfBoundsException("toIndex $toIndex out of range [$fromIndex, $size]")
}
require(fromIndex <= toIndex) { "fromIndex($fromIndex) > toIndex($toIndex)" }
AbstractList.checkRangeIndexes(fromIndex, toIndex, size)
this.asDynamic().fill(element, fromIndex, toIndex);
}
/**
* Fills original array with the provided value.
* Fills this array or its subrange with the specified [element] value.
*
* @param fromIndex the start of the range (inclusive), 0 by default.
* @param toIndex the end of the range (exclusive), size of this array by default.
*
* @throws IndexOutOfBoundsException if [fromIndex] is less than zero or [toIndex] is greater than the size of this array.
* @throws IllegalArgumentException if [fromIndex] is greater than [toIndex].
*/
@SinceKotlin("1.3")
@Suppress("ACTUAL_FUNCTION_WITH_DEFAULT_ARGUMENTS")
public actual fun BooleanArray.fill(element: Boolean, fromIndex: Int = 0, toIndex: Int = size): Unit {
if (fromIndex !in 0..size) {
throw IndexOutOfBoundsException("fromIndex $fromIndex out of range [0, $size]")
}
if (toIndex > size) {
throw IndexOutOfBoundsException("toIndex $toIndex out of range [$fromIndex, $size]")
}
require(fromIndex <= toIndex) { "fromIndex($fromIndex) > toIndex($toIndex)" }
AbstractList.checkRangeIndexes(fromIndex, toIndex, size)
this.asDynamic().fill(element, fromIndex, toIndex);
}
/**
* Fills original array with the provided value.
* Fills this array or its subrange with the specified [element] value.
*
* @param fromIndex the start of the range (inclusive), 0 by default.
* @param toIndex the end of the range (exclusive), size of this array by default.
*
* @throws IndexOutOfBoundsException if [fromIndex] is less than zero or [toIndex] is greater than the size of this array.
* @throws IllegalArgumentException if [fromIndex] is greater than [toIndex].
*/
@SinceKotlin("1.3")
@Suppress("ACTUAL_FUNCTION_WITH_DEFAULT_ARGUMENTS")
public actual fun CharArray.fill(element: Char, fromIndex: Int = 0, toIndex: Int = size): Unit {
if (fromIndex !in 0..size) {
throw IndexOutOfBoundsException("fromIndex $fromIndex out of range [0, $size]")
}
if (toIndex > size) {
throw IndexOutOfBoundsException("toIndex $toIndex out of range [$fromIndex, $size]")
}
require(fromIndex <= toIndex) { "fromIndex($fromIndex) > toIndex($toIndex)" }
AbstractList.checkRangeIndexes(fromIndex, toIndex, size)
this.asDynamic().fill(element, fromIndex, toIndex);
}
@@ -158,43 +158,3 @@ public actual fun UShortArray.asList(): List<UShort> {
}
}
/**
* Fills original array with the provided value.
*/
@SinceKotlin("1.3")
@ExperimentalUnsignedTypes
@Suppress("ACTUAL_FUNCTION_WITH_DEFAULT_ARGUMENTS")
public actual fun UIntArray.fill(element: UInt, fromIndex: Int = 0, toIndex: Int = size): Unit {
storage.fill(element.toInt(), fromIndex, toIndex)
}
/**
* Fills original array with the provided value.
*/
@SinceKotlin("1.3")
@ExperimentalUnsignedTypes
@Suppress("ACTUAL_FUNCTION_WITH_DEFAULT_ARGUMENTS")
public actual fun ULongArray.fill(element: ULong, fromIndex: Int = 0, toIndex: Int = size): Unit {
storage.fill(element.toLong(), fromIndex, toIndex)
}
/**
* Fills original array with the provided value.
*/
@SinceKotlin("1.3")
@ExperimentalUnsignedTypes
@Suppress("ACTUAL_FUNCTION_WITH_DEFAULT_ARGUMENTS")
public actual fun UByteArray.fill(element: UByte, fromIndex: Int = 0, toIndex: Int = size): Unit {
storage.fill(element.toByte(), fromIndex, toIndex)
}
/**
* Fills original array with the provided value.
*/
@SinceKotlin("1.3")
@ExperimentalUnsignedTypes
@Suppress("ACTUAL_FUNCTION_WITH_DEFAULT_ARGUMENTS")
public actual fun UShortArray.fill(element: UShort, fromIndex: Int = 0, toIndex: Int = size): Unit {
storage.fill(element.toShort(), fromIndex, toIndex)
}