class FloatArray
An array of floats. When targeting the JVM, instances of this class are represented as float[]
.
An array of floats.
Creates a new array of the specified size, where each element is calculated by calling the specified init function.
<init>(size: Int, init: (Int) -> Float)
Creates a new array of the specified size, with all elements initialized to zero.
<init>(size: Int)
Returns the number of elements in the array.
val size: Int
Returns the array element at the given index. This method can be called using the index operator.
operator fun get(index: Int): Float
Creates an iterator over the elements of the array.
operator fun iterator(): FloatIterator
Returns the range of valid indices for the array.
val FloatArray.indices: IntRange
Returns the last valid index for the array.
val FloatArray.lastIndex: Int
Returns true
if all elements match the given predicate.
fun FloatArray.all(predicate: (Float) -> Boolean): Boolean
Returns true
if array has at least one element.
fun FloatArray.any(): Boolean
Returns true
if at least one element matches the given predicate.
fun FloatArray.any(predicate: (Float) -> Boolean): Boolean
Creates an Iterable instance that wraps the original array returning its elements when being iterated.
fun FloatArray.asIterable(): Iterable<Float>
Creates a Sequence instance that wraps the original array returning its elements when being iterated.
fun FloatArray.asSequence(): Sequence<Float>
Returns a Map containing the elements from the given array indexed by the key returned from keySelector function applied to each element.
fun <K> FloatArray.associateBy( keySelector: (Float) -> K ): Map<K, Float>
Returns a Map containing the values provided by valueTransform and indexed by keySelector functions applied to elements of the given array.
fun <K, V> FloatArray.associateBy( keySelector: (Float) -> K, valueTransform: (Float) -> V ): Map<K, V>
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, M : MutableMap<in K, in Float>> FloatArray.associateByTo( destination: M, keySelector: (Float) -> K ): 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.
fun <K, V, M : MutableMap<in K, in V>> FloatArray.associateByTo( destination: M, keySelector: (Float) -> K, valueTransform: (Float) -> 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.
fun <K, V, M : MutableMap<in K, in V>> FloatArray.associateTo( destination: M, transform: (Float) -> Pair<K, V> ): M
Returns a Map where keys are elements from the given array and values are produced by the valueSelector function applied to each element.
fun <V> FloatArray.associateWith( valueSelector: (Float) -> V ): Map<Float, V>
Populates and returns the destination mutable map with key-value pairs for each element of the given array, where key is the element itself and value is provided by the valueSelector function applied to that key.
fun <V, M : MutableMap<in Float, in V>> FloatArray.associateWithTo( destination: M, valueSelector: (Float) -> V ): M
Returns an average value of elements in the array.
fun FloatArray.average(): Double
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.
fun FloatArray.binarySearch( element: Float, fromIndex: Int = 0, toIndex: Int = size ): Int
Returns 1st element from the array.
operator fun FloatArray.component1(): Float
Returns 2nd element from the array.
operator fun FloatArray.component2(): Float
Returns 3rd element from the array.
operator fun FloatArray.component3(): Float
Returns 4th element from the array.
operator fun FloatArray.component4(): Float
Returns 5th element from the array.
operator fun FloatArray.component5(): Float
Returns true
if element is found in the array.
operator fun FloatArray.contains(element: Float): Boolean
Returns the number of elements in this array.
fun FloatArray.count(): Int
Returns the number of elements matching the given predicate.
fun FloatArray.count(predicate: (Float) -> Boolean): Int
Returns a list containing only distinct elements from the given array.
fun FloatArray.distinct(): List<Float>
Returns a list containing only elements from the given array having distinct keys returned by the given selector function.
fun <K> FloatArray.distinctBy( selector: (Float) -> K ): List<Float>
Returns a list containing all elements except first n elements.
fun FloatArray.drop(n: Int): List<Float>
Returns a list containing all elements except last n elements.
fun FloatArray.dropLast(n: Int): List<Float>
Returns a list containing all elements except last elements that satisfy the given predicate.
fun FloatArray.dropLastWhile( predicate: (Float) -> Boolean ): List<Float>
Returns a list containing all elements except first elements that satisfy the given predicate.
fun FloatArray.dropWhile( predicate: (Float) -> Boolean ): List<Float>
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.
fun FloatArray.elementAtOrElse( index: Int, defaultValue: (Int) -> Float ): Float
Returns a list containing only elements matching the given predicate.
fun FloatArray.filter( predicate: (Float) -> Boolean ): List<Float>
Returns a list containing only elements matching the given predicate.
fun FloatArray.filterIndexed( predicate: (index: Int, Float) -> Boolean ): List<Float>
Appends all elements matching the given predicate to the given destination.
fun <C : MutableCollection<in Float>> FloatArray.filterIndexedTo( destination: C, predicate: (index: Int, Float) -> Boolean ): C
Returns a list containing all elements not matching the given predicate.
fun FloatArray.filterNot( predicate: (Float) -> Boolean ): List<Float>
Appends all elements not matching the given predicate to the given destination.
fun <C : MutableCollection<in Float>> FloatArray.filterNotTo( destination: C, predicate: (Float) -> Boolean ): C
Appends all elements matching the given predicate to the given destination.
fun <C : MutableCollection<in Float>> FloatArray.filterTo( destination: C, predicate: (Float) -> Boolean ): C
Returns the first element matching the given predicate, or null
if no such element was found.
fun FloatArray.find(predicate: (Float) -> Boolean): Float?
Returns the last element matching the given predicate, or null
if no such element was found.
fun FloatArray.findLast( predicate: (Float) -> Boolean ): Float?
Returns first element.
fun FloatArray.first(): Float
Returns the first element matching the given predicate.
fun FloatArray.first(predicate: (Float) -> Boolean): Float
Returns the first element, or null
if the array is empty.
fun FloatArray.firstOrNull(): Float?
Returns the first element matching the given predicate, or null
if element was not found.
fun FloatArray.firstOrNull( predicate: (Float) -> Boolean ): Float?
Returns a single list of all elements yielded from results of transform function being invoked on each element of original array.
fun <R> FloatArray.flatMap( transform: (Float) -> Iterable<R> ): List<R>
Returns a single list of all elements yielded from results of transform function being invoked on each element and its index in the original array.
fun <R> FloatArray.flatMapIndexed( transform: (index: Int, Float) -> Iterable<R> ): List<R>
Appends all elements yielded from results of transform function being invoked on each element and its index in the original array, to the given destination.
fun <R, C : MutableCollection<in R>> FloatArray.flatMapIndexedTo( destination: C, transform: (index: Int, Float) -> Iterable<R> ): C
Appends all elements yielded from results of transform function being invoked on each element of original array, to the given destination.
fun <R, C : MutableCollection<in R>> FloatArray.flatMapTo( destination: C, transform: (Float) -> Iterable<R> ): C
Performs the given action on each element.
fun FloatArray.forEach(action: (Float) -> Unit)
Performs the given action on each element, providing sequential index with the element.
fun FloatArray.forEachIndexed( action: (index: Int, Float) -> Unit)
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.
fun FloatArray.getOrElse( index: Int, defaultValue: (Int) -> Float ): Float
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> FloatArray.groupBy( keySelector: (Float) -> K ): Map<K, List<Float>>
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.
fun <K, V> FloatArray.groupBy( keySelector: (Float) -> K, valueTransform: (Float) -> V ): Map<K, List<V>>
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, M : MutableMap<in K, MutableList<Float>>> FloatArray.groupByTo( destination: M, keySelector: (Float) -> K ): 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.
fun <K, V, M : MutableMap<in K, MutableList<V>>> FloatArray.groupByTo( destination: M, keySelector: (Float) -> K, valueTransform: (Float) -> V ): M
Returns first index of element, or -1 if the array does not contain element.
fun FloatArray.indexOf(element: Float): Int
Returns index of the first element matching the given predicate, or -1 if the array does not contain such element.
fun FloatArray.indexOfFirst( predicate: (Float) -> Boolean ): Int
Returns index of the last element matching the given predicate, or -1 if the array does not contain such element.
fun FloatArray.indexOfLast( predicate: (Float) -> Boolean ): Int
Returns a set containing all elements that are contained by both this array and the specified collection.
infix fun FloatArray.intersect( other: Iterable<Float> ): Set<Float>
Returns true
if the array is empty.
fun FloatArray.isEmpty(): Boolean
Returns true
if the array is not empty.
fun FloatArray.isNotEmpty(): Boolean
Appends the string from all the elements separated using separator and using the given prefix and postfix if supplied.
fun <A : Appendable> FloatArray.joinTo( buffer: A, separator: CharSequence = ", ", prefix: CharSequence = "", postfix: CharSequence = "", limit: Int = -1, truncated: CharSequence = "...", transform: ((Float) -> CharSequence)? = null ): A
Creates a string from all the elements separated using separator and using the given prefix and postfix if supplied.
fun FloatArray.joinToString( separator: CharSequence = ", ", prefix: CharSequence = "", postfix: CharSequence = "", limit: Int = -1, truncated: CharSequence = "...", transform: ((Float) -> CharSequence)? = null ): String
Returns the last element.
fun FloatArray.last(): Float
Returns the last element matching the given predicate.
fun FloatArray.last(predicate: (Float) -> Boolean): Float
Returns last index of element, or -1 if the array does not contain element.
fun FloatArray.lastIndexOf(element: Float): Int
Returns the last element, or null
if the array is empty.
fun FloatArray.lastOrNull(): Float?
Returns the last element matching the given predicate, or null
if no such element was found.
fun FloatArray.lastOrNull( predicate: (Float) -> Boolean ): Float?
Returns a list containing the results of applying the given transform function to each element in the original array.
fun <R> FloatArray.map(transform: (Float) -> 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.
fun <R> FloatArray.mapIndexed( transform: (index: Int, Float) -> R ): List<R>
Applies the given transform function to each element and its index in the original array and appends the results to the given destination.
fun <R, C : MutableCollection<in R>> FloatArray.mapIndexedTo( destination: C, transform: (index: Int, Float) -> R ): C
Applies the given transform function to each element of the original array and appends the results to the given destination.
fun <R, C : MutableCollection<in R>> FloatArray.mapTo( destination: C, transform: (Float) -> R ): C
fun FloatArray.max(): Float?
fun <R : Comparable<R>> FloatArray.maxBy( selector: (Float) -> R ): Float?
Returns the first element yielding the largest value of the given function or null
if there are no elements.
fun <R : Comparable<R>> FloatArray.maxByOrNull( selector: (Float) -> R ): Float?
Returns the largest value among all values produced by selector function applied to each element in the array.
fun <R : Comparable<R>> any_array<R>.maxOf( selector: (Float) -> R ): R
Returns the largest value among all values produced by selector function applied to each element in the array or null
if there are no elements.
fun <R : Comparable<R>> any_array<R>.maxOfOrNull( selector: (Float) -> R ): R?
Returns the largest value according to the provided comparator among all values produced by selector function applied to each element in the array.
fun <R> FloatArray.maxOfWith( comparator: Comparator<in R>, selector: (Float) -> R ): R
Returns the largest value according to the provided comparator among all values produced by selector function applied to each element in the array or null
if there are no elements.
fun <R> FloatArray.maxOfWithOrNull( comparator: Comparator<in R>, selector: (Float) -> R ): R?
Returns the largest element or null
if there are no elements.
fun FloatArray.maxOrNull(): Float?
fun FloatArray.maxWith( comparator: Comparator<in Float> ): Float?
Returns the first element having the largest value according to the provided comparator or null
if there are no elements.
fun FloatArray.maxWithOrNull( comparator: Comparator<in Float> ): Float?
fun FloatArray.min(): Float?
fun <R : Comparable<R>> FloatArray.minBy( selector: (Float) -> R ): Float?
Returns the first element yielding the smallest value of the given function or null
if there are no elements.
fun <R : Comparable<R>> FloatArray.minByOrNull( selector: (Float) -> R ): Float?
Returns the smallest value among all values produced by selector function applied to each element in the array.
fun <R : Comparable<R>> any_array<R>.minOf( selector: (Float) -> R ): R
Returns the smallest value among all values produced by selector function applied to each element in the array or null
if there are no elements.
fun <R : Comparable<R>> any_array<R>.minOfOrNull( selector: (Float) -> R ): R?
Returns the smallest value according to the provided comparator among all values produced by selector function applied to each element in the array.
fun <R> FloatArray.minOfWith( comparator: Comparator<in R>, selector: (Float) -> R ): R
Returns the smallest value according to the provided comparator among all values produced by selector function applied to each element in the array or null
if there are no elements.
fun <R> FloatArray.minOfWithOrNull( comparator: Comparator<in R>, selector: (Float) -> R ): R?
Returns the smallest element or null
if there are no elements.
fun FloatArray.minOrNull(): Float?
fun FloatArray.minWith( comparator: Comparator<in Float> ): Float?
Returns the first element having the smallest value according to the provided comparator or null
if there are no elements.
fun FloatArray.minWithOrNull( comparator: Comparator<in Float> ): Float?
Returns true
if the array has no elements.
fun FloatArray.none(): Boolean
Returns true
if no elements match the given predicate.
fun FloatArray.none(predicate: (Float) -> Boolean): Boolean
Performs the given action on each element and returns the array itself afterwards.
fun FloatArray.onEach(action: (Float) -> Unit): FloatArray
Performs the given action on each element, providing sequential index with the element, and returns the array itself afterwards.
fun FloatArray.onEachIndexed( action: (index: Int, Float) -> Unit ): FloatArray
Returns a random element from this array.
fun FloatArray.random(): Float
Returns a random element from this array using the specified source of randomness.
fun FloatArray.random(random: Random): Float
Returns a random element from this array, or null
if this array is empty.
fun FloatArray.randomOrNull(): Float?
Returns a random element from this array using the specified source of randomness, or null
if this array is empty.
fun FloatArray.randomOrNull(random: Random): Float?
Accumulates value starting with the first element and applying operation from left to right to current accumulator value and each element.
fun FloatArray.reduce( operation: (acc: Float, Float) -> Float ): Float
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.
fun FloatArray.reduceIndexed( operation: (index: Int, acc: Float, Float) -> Float ): Float
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.
fun FloatArray.reduceIndexedOrNull( operation: (index: Int, acc: Float, Float) -> Float ): Float?
Accumulates value starting with the first element and applying operation from left to right to current accumulator value and each element.
fun FloatArray.reduceOrNull( operation: (acc: Float, Float) -> Float ): Float?
Accumulates value starting with the last element and applying operation from right to left to each element and current accumulator value.
fun FloatArray.reduceRight( operation: (Float, acc: Float) -> Float ): Float
Accumulates value starting with the last element and applying operation from right to left to each element with its index in the original array and current accumulator value.
fun FloatArray.reduceRightIndexed( operation: (index: Int, Float, acc: Float) -> Float ): Float
Accumulates value starting with the last element and applying operation from right to left to each element with its index in the original array and current accumulator value.
fun FloatArray.reduceRightIndexedOrNull( operation: (index: Int, Float, acc: Float) -> Float ): Float?
Accumulates value starting with the last element and applying operation from right to left to each element and current accumulator value.
fun FloatArray.reduceRightOrNull( operation: (Float, acc: Float) -> Float ): Float?
fun FloatArray.refTo(index: Int): CValuesRef<FloatVar>
Reverses elements in the array in-place.
fun FloatArray.reverse()
Reverses elements of the array in the specified range in-place.
fun FloatArray.reverse(fromIndex: Int, toIndex: Int)
Returns a list with elements in reversed order.
fun FloatArray.reversed(): List<Float>
Returns an array with elements of this array in reversed order.
fun FloatArray.reversedArray(): FloatArray
Returns a list containing successive accumulation values generated by applying operation from left to right to each element, its index in the original array and current accumulator value that starts with initial value.
fun <R> FloatArray.runningFoldIndexed( initial: R, operation: (index: Int, acc: R, Float) -> R ): List<R>
Returns a list containing successive accumulation values generated by applying operation from left to right to each element and current accumulator value that starts with the first element of this array.
fun FloatArray.runningReduce( operation: (acc: Float, Float) -> Float ): List<Float>
Returns a list containing successive accumulation values generated by applying operation from left to right to each element, its index in the original array and current accumulator value that starts with the first element of this array.
fun FloatArray.runningReduceIndexed( operation: (index: Int, acc: Float, Float) -> Float ): List<Float>
Returns a list containing successive accumulation values generated by applying operation from left to right to each element, its index in the original array and current accumulator value that starts with initial value.
fun <R> FloatArray.scanIndexed( initial: R, operation: (index: Int, acc: R, Float) -> R ): List<R>
fun FloatArray.scanReduce( operation: (acc: Float, Float) -> Float ): List<Float>
fun FloatArray.scanReduceIndexed( operation: (index: Int, acc: Float, Float) -> Float ): List<Float>
Randomly shuffles elements in this array in-place.
fun FloatArray.shuffle()
Randomly shuffles elements in this array in-place using the specified random instance as the source of randomness.
fun FloatArray.shuffle(random: Random)
Returns the single element, or throws an exception if the array is empty or has more than one element.
fun FloatArray.single(): Float
Returns the single element matching the given predicate, or throws exception if there is no or more than one matching element.
fun FloatArray.single(predicate: (Float) -> Boolean): Float
Returns single element, or null
if the array is empty or has more than one element.
fun FloatArray.singleOrNull(): Float?
Returns the single element matching the given predicate, or null
if element was not found or more than one element was found.
fun FloatArray.singleOrNull( predicate: (Float) -> Boolean ): Float?
Returns a list containing elements at indices in the specified indices range.
fun FloatArray.slice(indices: IntRange): List<Float>
Returns a list containing elements at specified indices.
fun FloatArray.slice(indices: Iterable<Int>): List<Float>
Returns an array containing elements of this array at specified indices.
fun FloatArray.sliceArray( indices: Collection<Int> ): FloatArray
Returns an array containing elements at indices in the specified indices range.
fun FloatArray.sliceArray(indices: IntRange): FloatArray
Sorts the array in-place according to the order specified by the given comparison function.
fun FloatArray.sort(comparison: (a: Float, b: Float) -> Int)
Sorts elements in the array in-place descending according to their natural sort order.
fun FloatArray.sortDescending()
Sorts elements of the array in the specified range in-place. The elements are sorted descending according to their natural sort order.
fun FloatArray.sortDescending(fromIndex: Int, toIndex: Int)
Returns a list of all elements sorted according to their natural sort order.
fun FloatArray.sorted(): List<Float>
Returns an array with all elements of this array sorted according to their natural sort order.
fun FloatArray.sortedArray(): FloatArray
Returns an array with all elements of this array sorted descending according to their natural sort order.
fun FloatArray.sortedArrayDescending(): FloatArray
Returns a list of all elements sorted according to natural sort order of the value returned by specified selector function.
fun <R : Comparable<R>> FloatArray.sortedBy( selector: (Float) -> R? ): List<Float>
Returns a list of all elements sorted descending according to natural sort order of the value returned by specified selector function.
fun <R : Comparable<R>> FloatArray.sortedByDescending( selector: (Float) -> R? ): List<Float>
Returns a list of all elements sorted descending according to their natural sort order.
fun FloatArray.sortedDescending(): List<Float>
Returns a list of all elements sorted according to the specified comparator.
fun FloatArray.sortedWith( comparator: Comparator<in Float> ): List<Float>
Returns a set containing all elements that are contained by this array and not contained by the specified collection.
infix fun FloatArray.subtract( other: Iterable<Float> ): Set<Float>
Returns the sum of all elements in the array.
fun FloatArray.sum(): Float
Returns the sum of all values produced by selector function applied to each element in the array.
fun FloatArray.sumBy(selector: (Float) -> Int): Int
Returns the sum of all values produced by selector function applied to each element in the array.
fun FloatArray.sumByDouble( selector: (Float) -> Double ): Double
Returns the sum of all values produced by selector function applied to each element in the array.
fun FloatArray.sumOf(selector: (Float) -> Double): Double
fun FloatArray.sumOf(selector: (Float) -> Int): Int
fun FloatArray.sumOf(selector: (Float) -> Long): Long
fun FloatArray.sumOf(selector: (Float) -> UInt): UInt
fun FloatArray.sumOf(selector: (Float) -> ULong): ULong
fun FloatArray.sumOf( selector: (Float) -> BigDecimal ): BigDecimal
fun FloatArray.sumOf( selector: (Float) -> BigInteger ): BigInteger
Returns a list containing first n elements.
fun FloatArray.take(n: Int): List<Float>
Returns a list containing last n elements.
fun FloatArray.takeLast(n: Int): List<Float>
Returns a list containing last elements satisfying the given predicate.
fun FloatArray.takeLastWhile( predicate: (Float) -> Boolean ): List<Float>
Returns a list containing first elements satisfying the given predicate.
fun FloatArray.takeWhile( predicate: (Float) -> Boolean ): List<Float>
Appends all elements to the given destination collection.
fun <C : MutableCollection<in Float>> FloatArray.toCollection( destination: C ): C
fun FloatArray.toCValues(): CValues<FloatVar>
Returns a new HashSet of all elements.
fun FloatArray.toHashSet(): HashSet<Float>
Returns a List containing all elements.
fun FloatArray.toList(): List<Float>
Returns a new MutableList filled with all elements of this array.
fun FloatArray.toMutableList(): MutableList<Float>
Returns a new MutableSet containing all distinct elements from the given array.
fun FloatArray.toMutableSet(): MutableSet<Float>
Returns a Set of all elements.
fun FloatArray.toSet(): Set<Float>
Returns a new SortedSet of all elements.
fun FloatArray.toSortedSet(): SortedSet<Float>
Returns a set containing all distinct elements from both collections.
infix fun FloatArray.union( other: Iterable<Float> ): Set<Float>
Returns a lazy Iterable that wraps each element of the original array into an IndexedValue containing the index of that element and the element itself.
fun FloatArray.withIndex(): Iterable<IndexedValue<Float>>
Returns a list of pairs built from the elements of this
array and the other array with the same index. The returned list has length of the shortest collection.
infix fun <R> any_array<R>.zip( other: Array<out R> ): List<Pair<Float, R>>
Returns a list of values built from the elements of this
array and the other array with the same index using the provided transform function applied to each pair of elements. The returned list has length of the shortest collection.
fun <R, V> FloatArray.zip( other: Array<out R>, transform: (a: Float, b: R) -> V ): List<V>
Returns a list of pairs built from the elements of this
collection and other array with the same index. The returned list has length of the shortest collection.
infix fun <R> FloatArray.zip( other: Iterable<R> ): List<Pair<Float, R>>
Returns a list of values built from the elements of this
array and the other collection with the same index using the provided transform function applied to each pair of elements. The returned list has length of the shortest collection.
fun <R, V> FloatArray.zip( other: Iterable<R>, transform: (a: Float, b: R) -> V ): List<V>
Returns a list of values built from the elements of this
array and the other array with the same index using the provided transform function applied to each pair of elements. The returned list has length of the shortest array.
fun <V> FloatArray.zip( other: FloatArray, transform: (a: Float, b: Float) -> V ): List<V>
© 2010–2020 JetBrains s.r.o. and Kotlin Programming Language contributors
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float-array/index.html