W3cubDocs

/Kotlin

DoubleArray

class DoubleArray

An array of doubles. When targeting the JVM, instances of this class are represented as double[].

Constructors

<init>

DoubleArray(size: Int, init: (Int) -> Double)

Creates a new array of the specified size, where each element is calculated by calling the specified init function. The init function returns an array element given its index.

DoubleArray(size: Int)

Creates a new array of the specified size, with all elements initialized to zero.

Properties

size

val size: Int

Returns the number of elements in the array.

Functions

get

operator fun get(index: Int): Double

Returns the array element at the given index. This method can be called using the index operator.

iterator

operator fun iterator(): DoubleIterator

Creates an iterator over the elements of the array.

set

operator fun set(index: Int, value: Double)

Sets the element at the given index to the given value. This method can be called using the index operator.

Inherited Functions

equals

open operator fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one. Implementations must fulfil the following requirements:

hashCode

open fun hashCode(): Int

Returns a hash code value for the object. The general contract of hashCode is:

toString

open fun toString(): String

Returns a string representation of the object.

Extension Properties

indices

val DoubleArray.indices: IntRange

Returns the range of valid indices for the array.

lastIndex

val DoubleArray.lastIndex: Int

Returns the last valid index for the array.

Extension Functions

all

fun DoubleArray.all(predicate: (Double) -> Boolean): Boolean

Returns true if all elements match the given predicate.

any

fun DoubleArray.any(): Boolean

Returns true if array has at least one element.

fun DoubleArray.any(predicate: (Double) -> Boolean): Boolean

Returns true if at least one element matches the given predicate.

asIterable

fun DoubleArray.asIterable(): Iterable<Double>

Creates an Iterable instance that wraps the original array returning its elements when being iterated.

asList

fun DoubleArray.asList(): List<Double>

Returns a List that wraps the original array.

asSequence

fun DoubleArray.asSequence(): Sequence<Double>

Creates a Sequence instance that wraps the original array returning its elements when being iterated.

associate

fun <K, V> DoubleArray.associate(
    transform: (Double) -> Pair<K, V>
): Map<K, V>

Returns a Map containing key-value pairs provided by transform function applied to elements of the given array.

associateBy

fun <K> DoubleArray.associateBy(
    keySelector: (Double) -> K
): Map<K, Double>

Returns a Map containing the elements from the given array indexed by the key returned from keySelector function applied to each element.

fun <K, V> DoubleArray.associateBy(
    keySelector: (Double) -> K, 
    valueTransform: (Double) -> V
): Map<K, V>

Returns a Map containing the values provided by valueTransform and indexed by keySelector functions applied to elements of the given array.

associateByTo

fun <K, M : MutableMap<in K, in Double>> DoubleArray.associateByTo(
    destination: M, 
    keySelector: (Double) -> K
): M

Populates and returns the destination mutable map with key-value pairs, where key is provided by the keySelector function applied to each element of the given array and value is the element itself.

fun <K, V, M : MutableMap<in K, in V>> DoubleArray.associateByTo(
    destination: M, 
    keySelector: (Double) -> K, 
    valueTransform: (Double) -> V
): M

Populates and returns the destination mutable map with key-value pairs, where key is provided by the keySelector function and and value is provided by the valueTransform function applied to elements of the given array.

associateTo

fun <K, V, M : MutableMap<in K, in V>> DoubleArray.associateTo(
    destination: M, 
    transform: (Double) -> Pair<K, V>
): M

Populates and returns the destination mutable map with key-value pairs provided by transform function applied to each element of the given array.

average

fun DoubleArray.average(): Double

Returns an average value of elements in the array.

binarySearch

fun DoubleArray.binarySearch(
    element: Double, 
    fromIndex: Int = 0, 
    toIndex: Int = size
): Int

Searches the array or the range of the array for the provided element using the binary search algorithm. The array is expected to be sorted, otherwise the result is undefined.

component1

operator fun DoubleArray.component1(): Double

Returns 1st element from the collection.

component2

operator fun DoubleArray.component2(): Double

Returns 2nd element from the collection.

component3

operator fun DoubleArray.component3(): Double

Returns 3rd element from the collection.

component4

operator fun DoubleArray.component4(): Double

Returns 4th element from the collection.

component5

operator fun DoubleArray.component5(): Double

Returns 5th element from the collection.

contains

operator fun DoubleArray.contains(element: Double): Boolean

Returns true if element is found in the array.

contentEquals

infix fun DoubleArray.contentEquals(
    other: DoubleArray
): Boolean

Returns true if the two specified arrays are structurally equal to one another, i.e. contain the same number of the same elements in the same order.

contentHashCode

fun DoubleArray.contentHashCode(): Int

Returns a hash code based on the contents of this array as if it is List.

contentToString

fun DoubleArray.contentToString(): String

Returns a string representation of the contents of the specified array as if it is List.

copyOf

fun DoubleArray.copyOf(): DoubleArray

Returns new array which is a copy of the original array.

fun DoubleArray.copyOf(newSize: Int): DoubleArray

Returns new array which is a copy of the original array, resized to the given newSize.

copyOfRange

fun DoubleArray.copyOfRange(
    fromIndex: Int, 
    toIndex: Int
): DoubleArray

Returns new array which is a copy of range of original array.

count

fun DoubleArray.count(): Int

Returns the number of elements in this array.

fun DoubleArray.count(predicate: (Double) -> Boolean): Int

Returns the number of elements matching the given predicate.

distinct

fun DoubleArray.distinct(): List<Double>

Returns a list containing only distinct elements from the given array.

distinctBy

fun <K> DoubleArray.distinctBy(
    selector: (Double) -> K
): List<Double>

Returns a list containing only elements from the given array having distinct keys returned by the given selector function.

drop

fun DoubleArray.drop(n: Int): List<Double>

Returns a list containing all elements except first n elements.

dropLast

fun DoubleArray.dropLast(n: Int): List<Double>

Returns a list containing all elements except last n elements.

dropLastWhile

fun DoubleArray.dropLastWhile(
    predicate: (Double) -> Boolean
): List<Double>

Returns a list containing all elements except last elements that satisfy the given predicate.

dropWhile

fun DoubleArray.dropWhile(
    predicate: (Double) -> Boolean
): List<Double>

Returns a list containing all elements except first elements that satisfy the given predicate.

elementAt

fun DoubleArray.elementAt(index: Int): Double

Returns an element at the given index or throws an IndexOutOfBoundsException if the index is out of bounds of this array.

elementAtOrElse

fun DoubleArray.elementAtOrElse(
    index: Int, 
    defaultValue: (Int) -> Double
): Double

Returns an element at the given index or the result of calling the defaultValue function if the index is out of bounds of this array.

elementAtOrNull

fun DoubleArray.elementAtOrNull(index: Int): Double?

Returns an element at the given index or null if the index is out of bounds of this array.

fill

fun DoubleArray.fill(
    element: Double, 
    fromIndex: Int = 0, 
    toIndex: Int = size)

Fills original array with the provided value.

filter

fun DoubleArray.filter(
    predicate: (Double) -> Boolean
): List<Double>

Returns a list containing only elements matching the given predicate.

filterIndexed

fun DoubleArray.filterIndexed(
    predicate: (index: Int, Double) -> Boolean
): List<Double>

Returns a list containing only elements matching the given predicate.

filterIndexedTo

fun <C : MutableCollection<in Double>> DoubleArray.filterIndexedTo(
    destination: C, 
    predicate: (index: Int, Double) -> Boolean
): C

Appends all elements matching the given predicate to the given destination.

filterNot

fun DoubleArray.filterNot(
    predicate: (Double) -> Boolean
): List<Double>

Returns a list containing all elements not matching the given predicate.

filterNotTo

fun <C : MutableCollection<in Double>> DoubleArray.filterNotTo(
    destination: C, 
    predicate: (Double) -> Boolean
): C

Appends all elements not matching the given predicate to the given destination.

filterTo

fun <C : MutableCollection<in Double>> DoubleArray.filterTo(
    destination: C, 
    predicate: (Double) -> Boolean
): C

Appends all elements matching the given predicate to the given destination.

find

fun DoubleArray.find(predicate: (Double) -> Boolean): Double?

Returns the first element matching the given predicate, or null if no such element was found.

findLast

fun DoubleArray.findLast(
    predicate: (Double) -> Boolean
): Double?

Returns the last element matching the given predicate, or null if no such element was found.

first

fun DoubleArray.first(): Double

Returns first element.

fun DoubleArray.first(predicate: (Double) -> Boolean): Double

Returns the first element matching the given predicate.

firstOrNull

fun DoubleArray.firstOrNull(): Double?

Returns the first element, or null if the array is empty.

fun DoubleArray.firstOrNull(
    predicate: (Double) -> Boolean
): Double?

Returns the first element matching the given predicate, or null if element was not found.

flatMap

fun <R> DoubleArray.flatMap(
    transform: (Double) -> Iterable<R>
): List<R>

Returns a single list of all elements yielded from results of transform function being invoked on each element of original array.

flatMapTo

fun <R, C : MutableCollection<in R>> DoubleArray.flatMapTo(
    destination: C, 
    transform: (Double) -> Iterable<R>
): C

Appends all elements yielded from results of transform function being invoked on each element of original array, to the given destination.

fold

fun <R> DoubleArray.fold(
    initial: R, 
    operation: (acc: R, Double) -> R
): R

Accumulates value starting with initial value and applying operation from left to right to current accumulator value and each element.

foldIndexed

fun <R> DoubleArray.foldIndexed(
    initial: R, 
    operation: (index: Int, acc: R, Double) -> R
): R

Accumulates value starting with initial value and applying operation from left to right to current accumulator value and each element with its index in the original array.

foldRight

fun <R> DoubleArray.foldRight(
    initial: R, 
    operation: (Double, acc: R) -> R
): R

Accumulates value starting with initial value and applying operation from right to left to each element and current accumulator value.

foldRightIndexed

fun <R> DoubleArray.foldRightIndexed(
    initial: R, 
    operation: (index: Int, Double, acc: R) -> R
): R

Accumulates value starting with initial value and applying operation from right to left to each element with its index in the original array and current accumulator value.

forEach

fun DoubleArray.forEach(action: (Double) -> Unit)

Performs the given action on each element.

forEachIndexed

fun DoubleArray.forEachIndexed(
    action: (index: Int, Double) -> Unit)

Performs the given action on each element, providing sequential index with the element.

getOrElse

fun DoubleArray.getOrElse(
    index: Int, 
    defaultValue: (Int) -> Double
): Double

Returns an element at the given index or the result of calling the defaultValue function if the index is out of bounds of this array.

getOrNull

fun DoubleArray.getOrNull(index: Int): Double?

Returns an element at the given index or null if the index is out of bounds of this array.

groupBy

fun <K> DoubleArray.groupBy(
    keySelector: (Double) -> K
): Map<K, List<Double>>

Groups elements of the original array by the key returned by the given keySelector function applied to each element and returns a map where each group key is associated with a list of corresponding elements.

fun <K, V> DoubleArray.groupBy(
    keySelector: (Double) -> K, 
    valueTransform: (Double) -> V
): Map<K, List<V>>

Groups values returned by the valueTransform function applied to each element of the original array by the key returned by the given keySelector function applied to the element and returns a map where each group key is associated with a list of corresponding values.

groupByTo

fun <K, M : MutableMap<in K, MutableList<Double>>> DoubleArray.groupByTo(
    destination: M, 
    keySelector: (Double) -> K
): M

Groups elements of the original array by the key returned by the given keySelector function applied to each element and puts to the destination map each group key associated with a list of corresponding elements.

fun <K, V, M : MutableMap<in K, MutableList<V>>> DoubleArray.groupByTo(
    destination: M, 
    keySelector: (Double) -> K, 
    valueTransform: (Double) -> V
): M

Groups values returned by the valueTransform function applied to each element of the original array by the key returned by the given keySelector function applied to the element and puts to the destination map each group key associated with a list of corresponding values.

indexOf

fun DoubleArray.indexOf(element: Double): Int

Returns first index of element, or -1 if the array does not contain element.

indexOfFirst

fun DoubleArray.indexOfFirst(
    predicate: (Double) -> Boolean
): Int

Returns index of the first element matching the given predicate, or -1 if the array does not contain such element.

indexOfLast

fun DoubleArray.indexOfLast(
    predicate: (Double) -> Boolean
): Int

Returns index of the last element matching the given predicate, or -1 if the array does not contain such element.

intersect

infix fun DoubleArray.intersect(
    other: Iterable<Double>
): Set<Double>

Returns a set containing all elements that are contained by both this set and the specified collection.

isEmpty

fun DoubleArray.isEmpty(): Boolean

Returns true if the array is empty.

isNotEmpty

fun DoubleArray.isNotEmpty(): Boolean

Returns true if the array is not empty.

joinTo

fun <A> DoubleArray.joinTo(
    buffer: A, 
    separator: CharSequence = ", ", 
    prefix: CharSequence = "", 
    postfix: CharSequence = "", 
    limit: Int = -1, 
    truncated: CharSequence = "...", 
    transform: (Double) -> CharSequence = null
): A

Appends the string from all the elements separated using separator and using the given prefix and postfix if supplied.

joinToString

fun DoubleArray.joinToString(
    separator: CharSequence = ", ", 
    prefix: CharSequence = "", 
    postfix: CharSequence = "", 
    limit: Int = -1, 
    truncated: CharSequence = "...", 
    transform: (Double) -> CharSequence = null
): String

Creates a string from all the elements separated using separator and using the given prefix and postfix if supplied.

last

fun DoubleArray.last(): Double

Returns the last element.

fun DoubleArray.last(predicate: (Double) -> Boolean): Double

Returns the last element matching the given predicate.

lastIndexOf

fun DoubleArray.lastIndexOf(element: Double): Int

Returns last index of element, or -1 if the array does not contain element.

lastOrNull

fun DoubleArray.lastOrNull(): Double?

Returns the last element, or null if the array is empty.

fun DoubleArray.lastOrNull(
    predicate: (Double) -> Boolean
): Double?

Returns the last element matching the given predicate, or null if no such element was found.

map

fun <R> DoubleArray.map(transform: (Double) -> R): List<R>

Returns a list containing the results of applying the given transform function to each element in the original array.

mapIndexed

fun <R> DoubleArray.mapIndexed(
    transform: (index: Int, Double) -> R
): List<R>

Returns a list containing the results of applying the given transform function to each element and its index in the original array.

mapIndexedTo

fun <R, C : MutableCollection<in R>> DoubleArray.mapIndexedTo(
    destination: C, 
    transform: (index: Int, Double) -> R
): C

Applies the given transform function to each element and its index in the original array and appends the results to the given destination.

mapTo

fun <R, C : MutableCollection<in R>> DoubleArray.mapTo(
    destination: C, 
    transform: (Double) -> R
): C

Applies the given transform function to each element of the original array and appends the results to the given destination.

max

fun DoubleArray.max(): Double?

Returns the largest element or null if there are no elements.

maxBy

fun <R : Comparable<R>> DoubleArray.maxBy(
    selector: (Double) -> R
): Double?

Returns the first element yielding the largest value of the given function or null if there are no elements.

maxWith

fun DoubleArray.maxWith(
    comparator: Comparator<in Double>
): Double?
fun DoubleArray.maxWith(
    comparator: Comparator<in Double>
): Double?

Returns the first element having the largest value according to the provided comparator or null if there are no elements.

min

fun DoubleArray.min(): Double?

Returns the smallest element or null if there are no elements.

minBy

fun <R : Comparable<R>> DoubleArray.minBy(
    selector: (Double) -> R
): Double?

Returns the first element yielding the smallest value of the given function or null if there are no elements.

minWith

fun DoubleArray.minWith(
    comparator: Comparator<in Double>
): Double?
fun DoubleArray.minWith(
    comparator: Comparator<in Double>
): Double?

Returns the first element having the smallest value according to the provided comparator or null if there are no elements.

none

fun DoubleArray.none(): Boolean

Returns true if the array has no elements.

fun DoubleArray.none(predicate: (Double) -> Boolean): Boolean

Returns true if no elements match the given predicate.

partition

fun DoubleArray.partition(
    predicate: (Double) -> Boolean
): Pair<List<Double>, List<Double>>

Splits the original array into pair of lists, where first list contains elements for which predicate yielded true, while second list contains elements for which predicate yielded false.

plus

operator fun DoubleArray.plus(element: Double): DoubleArray

Returns an array containing all elements of the original array and then the given element.

operator fun DoubleArray.plus(
    elements: Collection<Double>
): DoubleArray

Returns an array containing all elements of the original array and then all elements of the given elements collection.

operator fun DoubleArray.plus(
    elements: DoubleArray
): DoubleArray

Returns an array containing all elements of the original array and then all elements of the given elements array.

reduce

fun DoubleArray.reduce(
    operation: (acc: Double, Double) -> Double
): Double

Accumulates value starting with the first element and applying operation from left to right to current accumulator value and each element.

reduceIndexed

fun DoubleArray.reduceIndexed(
    operation: (index: Int, acc: Double, Double) -> Double
): Double

Accumulates value starting with the first element and applying operation from left to right to current accumulator value and each element with its index in the original array.

reduceRight

fun DoubleArray.reduceRight(
    operation: (Double, acc: Double) -> Double
): Double

Accumulates value starting with last element and applying operation from right to left to each element and current accumulator value.

reduceRightIndexed

fun DoubleArray.reduceRightIndexed(
    operation: (index: Int, Double, acc: Double) -> Double
): Double

Accumulates value starting with last element and applying operation from right to left to each element with its index in the original array and current accumulator value.

reverse

fun DoubleArray.reverse()

Reverses elements in the array in-place.

reversed

fun DoubleArray.reversed(): List<Double>

Returns a list with elements in reversed order.

reversedArray

fun DoubleArray.reversedArray(): DoubleArray

Returns an array with elements of this array in reversed order.

single

fun DoubleArray.single(): Double

Returns the single element, or throws an exception if the array is empty or has more than one element.

fun DoubleArray.single(
    predicate: (Double) -> Boolean
): Double

Returns the single element matching the given predicate, or throws exception if there is no or more than one matching element.

singleOrNull

fun DoubleArray.singleOrNull(): Double?

Returns single element, or null if the array is empty or has more than one element.

fun DoubleArray.singleOrNull(
    predicate: (Double) -> Boolean
): Double?

Returns the single element matching the given predicate, or null if element was not found or more than one element was found.

slice

fun DoubleArray.slice(indices: IntRange): List<Double>

Returns a list containing elements at indices in the specified indices range.

fun DoubleArray.slice(indices: Iterable<Int>): List<Double>

Returns a list containing elements at specified indices.

sliceArray

fun DoubleArray.sliceArray(
    indices: Collection<Int>
): DoubleArray

Returns an array containing elements of this array at specified indices.

fun DoubleArray.sliceArray(indices: IntRange): DoubleArray

Returns a list containing elements at indices in the specified indices range.

sort

fun DoubleArray.sort()

Sorts the array in-place.

fun DoubleArray.sort(fromIndex: Int = 0, toIndex: Int = size)

Sorts a range in the array in-place.

fun DoubleArray.sort(
    comparison: (a: Double, b: Double) -> Int)

Sorts the array in-place according to the order specified by the given comparison function.

sortDescending

fun DoubleArray.sortDescending()

Sorts elements in the array in-place descending according to their natural sort order.

sorted

fun DoubleArray.sorted(): List<Double>

Returns a list of all elements sorted according to their natural sort order.

sortedArray

fun DoubleArray.sortedArray(): DoubleArray

Returns an array with all elements of this array sorted according to their natural sort order.

sortedArrayDescending

fun DoubleArray.sortedArrayDescending(): DoubleArray

Returns an array with all elements of this array sorted descending according to their natural sort order.

sortedBy

fun <R : Comparable<R>> DoubleArray.sortedBy(
    selector: (Double) -> R?
): List<Double>

Returns a list of all elements sorted according to natural sort order of the value returned by specified selector function.

sortedByDescending

fun <R : Comparable<R>> DoubleArray.sortedByDescending(
    selector: (Double) -> R?
): List<Double>

Returns a list of all elements sorted descending according to natural sort order of the value returned by specified selector function.

sortedDescending

fun DoubleArray.sortedDescending(): List<Double>

Returns a list of all elements sorted descending according to their natural sort order.

sortedWith

fun DoubleArray.sortedWith(
    comparator: Comparator<in Double>
): List<Double>
fun DoubleArray.sortedWith(
    comparator: Comparator<in Double>
): List<Double>

Returns a list of all elements sorted according to the specified comparator.

subtract

infix fun DoubleArray.subtract(
    other: Iterable<Double>
): Set<Double>

Returns a set containing all elements that are contained by this array and not contained by the specified collection.

sum

fun DoubleArray.sum(): Double

Returns the sum of all elements in the array.

sumBy

fun DoubleArray.sumBy(selector: (Double) -> Int): Int

Returns the sum of all values produced by selector function applied to each element in the array.

sumByDouble

fun DoubleArray.sumByDouble(
    selector: (Double) -> Double
): Double

Returns the sum of all values produced by selector function applied to each element in the array.

take

fun DoubleArray.take(n: Int): List<Double>

Returns a list containing first n elements.

takeLast

fun DoubleArray.takeLast(n: Int): List<Double>

Returns a list containing last n elements.

takeLastWhile

fun DoubleArray.takeLastWhile(
    predicate: (Double) -> Boolean
): List<Double>

Returns a list containing last elements satisfying the given predicate.

takeWhile

fun DoubleArray.takeWhile(
    predicate: (Double) -> Boolean
): List<Double>

Returns a list containing first elements satisfying the given predicate.

toCollection

fun <C : MutableCollection<in Double>> DoubleArray.toCollection(
    destination: C
): C

Appends all elements to the given destination collection.

toHashSet

fun DoubleArray.toHashSet(): HashSet<Double>

Returns a HashSet of all elements.

toList

fun DoubleArray.toList(): List<Double>

Returns a List containing all elements.

toMutableList

fun DoubleArray.toMutableList(): MutableList<Double>

Returns a MutableList filled with all elements of this array.

toMutableSet

fun DoubleArray.toMutableSet(): MutableSet<Double>

Returns a mutable set containing all distinct elements from the given array.

toSet

fun DoubleArray.toSet(): Set<Double>

Returns a Set of all elements.

toSortedSet

fun DoubleArray.toSortedSet(): SortedSet<Double>

Returns a SortedSet of all elements.

toTypedArray

fun DoubleArray.toTypedArray(): Array<Double>

Returns a typed object array containing all of the elements of this primitive array.

union

infix fun DoubleArray.union(
    other: Iterable<Double>
): Set<Double>

Returns a set containing all distinct elements from both collections.

withIndex

fun DoubleArray.withIndex(): Iterable<IndexedValue<Double>>

Returns a lazy Iterable of IndexedValue for each element of the original array.

zip

infix fun <R> any_array<R>.zip(
    other: Array<out R>
): List<Pair<Double, R>>

Returns a list of pairs built from elements of both collections with same indexes. List has length of shortest collection.

fun <R, V> any_array<R>.zip(
    other: Array<out R>, 
    transform: (a: Double, b: R) -> V
): List<V>

Returns a list of values built from elements of both collections with same indexes using provided transform. List has length of shortest collection.

© 2010–2018 JetBrains s.r.o.
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double-array/index.html