FloatArray
For Common, JVM, JS
An array of floats. When targeting the JVM, instances of this class are represented as float[].
For Native
An array of floats.
Constructors
Properties
size
Returns the number of elements in the array.
val size: IntFunctions
get
Returns the array element at the given index. This method can be called using the index operator.
operator fun get(index: Int): Floatiterator
Creates an iterator over the elements of the array.
operator fun iterator(): FloatIteratorExtension Properties
indices
Returns the range of valid indices for the array.
val FloatArray.indices: IntRangelastIndex
Returns the last valid index for the array.
val FloatArray.lastIndex: IntExtension Functions
all
Returns true if all elements match the given predicate.
fun FloatArray.all(predicate: (Float) -> Boolean): Booleanany
Returns true if array has at least one element.
fun FloatArray.any(): BooleanReturns true if at least one element matches the given predicate.
fun FloatArray.any(predicate: (Float) -> Boolean): BooleanasIterable
Creates an Iterable instance that wraps the original array returning its elements when being iterated.
fun FloatArray.asIterable(): Iterable<Float>asSequence
Creates a Sequence instance that wraps the original array returning its elements when being iterated.
fun FloatArray.asSequence(): Sequence<Float>associate
Returns a Map containing key-value pairs provided by transform function applied to elements of the given array.
fun <K, V> FloatArray.associate(
transform: (Float) -> Pair<K, V>
): Map<K, V>associateBy
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>associateByTo
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
): MPopulates 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
): MassociateTo
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>
): Maverage
Returns an average value of elements in the array.
fun FloatArray.average(): DoublebinarySearch
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
): Intcomponent1
Returns 1st element from the array.
operator fun FloatArray.component1(): Floatcomponent2
Returns 2nd element from the array.
operator fun FloatArray.component2(): Floatcomponent3
Returns 3rd element from the array.
operator fun FloatArray.component3(): Floatcomponent4
Returns 4th element from the array.
operator fun FloatArray.component4(): Floatcomponent5
Returns 5th element from the array.
operator fun FloatArray.component5(): Floatcontains
Returns true if element is found in the array.
operator fun FloatArray.contains(element: Float): Booleancount
Returns the number of elements in this array.
fun FloatArray.count(): IntReturns the number of elements matching the given predicate.
fun FloatArray.count(predicate: (Float) -> Boolean): Intdistinct
Returns a list containing only distinct elements from the given array.
fun FloatArray.distinct(): List<Float>distinctBy
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>drop
Returns a list containing all elements except first n elements.
fun FloatArray.drop(n: Int): List<Float>dropLast
Returns a list containing all elements except last n elements.
fun FloatArray.dropLast(n: Int): List<Float>dropLastWhile
Returns a list containing all elements except last elements that satisfy the given predicate.
fun FloatArray.dropLastWhile(
predicate: (Float) -> Boolean
): List<Float>dropWhile
Returns a list containing all elements except first elements that satisfy the given predicate.
fun FloatArray.dropWhile(
predicate: (Float) -> Boolean
): List<Float>elementAtOrElse
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
): FloatelementAtOrNull
Returns an element at the given index or null if the index is out of bounds of this array.
fun FloatArray.elementAtOrNull(index: Int): Float?filter
Returns a list containing only elements matching the given predicate.
fun FloatArray.filter(
predicate: (Float) -> Boolean
): List<Float>filterIndexed
Returns a list containing only elements matching the given predicate.
fun FloatArray.filterIndexed(
predicate: (index: Int, Float) -> Boolean
): List<Float>filterIndexedTo
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
): CfilterNot
Returns a list containing all elements not matching the given predicate.
fun FloatArray.filterNot(
predicate: (Float) -> Boolean
): List<Float>filterNotTo
Appends all elements not matching the given predicate to the given destination.
fun <C : MutableCollection<in Float>> FloatArray.filterNotTo(
destination: C,
predicate: (Float) -> Boolean
): CfilterTo
Appends all elements matching the given predicate to the given destination.
fun <C : MutableCollection<in Float>> FloatArray.filterTo(
destination: C,
predicate: (Float) -> Boolean
): Cfind
Returns the first element matching the given predicate, or null if no such element was found.
fun FloatArray.find(predicate: (Float) -> Boolean): Float?findLast
Returns the last element matching the given predicate, or null if no such element was found.
fun FloatArray.findLast(
predicate: (Float) -> Boolean
): Float?first
Returns first element.
fun FloatArray.first(): FloatReturns the first element matching the given predicate.
fun FloatArray.first(predicate: (Float) -> Boolean): FloatfirstOrNull
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?flatMap
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>flatMapTo
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>
): Cfold
Accumulates value starting with initial value and applying operation from left to right to current accumulator value and each element.
fun <R> FloatArray.fold(
initial: R,
operation: (acc: R, Float) -> R
): RfoldIndexed
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.
fun <R> FloatArray.foldIndexed(
initial: R,
operation: (index: Int, acc: R, Float) -> R
): RfoldRight
Accumulates value starting with initial value and applying operation from right to left to each element and current accumulator value.
fun <R> FloatArray.foldRight(
initial: R,
operation: (Float, acc: R) -> R
): RfoldRightIndexed
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.
fun <R> FloatArray.foldRightIndexed(
initial: R,
operation: (index: Int, Float, acc: R) -> R
): RforEach
Performs the given action on each element.
fun FloatArray.forEach(action: (Float) -> Unit)forEachIndexed
Performs the given action on each element, providing sequential index with the element.
fun FloatArray.forEachIndexed(
action: (index: Int, Float) -> Unit)getOrElse
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
): FloatgetOrNull
Returns an element at the given index or null if the index is out of bounds of this array.
fun FloatArray.getOrNull(index: Int): Float?groupBy
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>>groupByTo
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
): MGroups 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
): MindexOf
Returns first index of element, or -1 if the array does not contain element.
fun FloatArray.indexOf(element: Float): IntindexOfFirst
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
): IntindexOfLast
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
): Intintersect
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>isEmpty
Returns true if the array is empty.
fun FloatArray.isEmpty(): BooleanisNotEmpty
Returns true if the array is not empty.
fun FloatArray.isNotEmpty(): BooleanjoinTo
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
): AjoinToString
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
): Stringlast
Returns the last element.
fun FloatArray.last(): FloatReturns the last element matching the given predicate.
fun FloatArray.last(predicate: (Float) -> Boolean): FloatlastIndexOf
Returns last index of element, or -1 if the array does not contain element.
fun FloatArray.lastIndexOf(element: Float): IntlastOrNull
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?map
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>mapIndexed
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>mapIndexedTo
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
): CmapTo
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
): Cmax
Returns the largest element or null if there are no elements.
fun FloatArray.max(): Float?maxBy
Returns the first element yielding the largest value of the given function or null if there are no elements.
fun <R : Comparable<R>> FloatArray.maxBy(
selector: (Float) -> R
): Float?maxWith
Returns the first element having the largest value according to the provided comparator or null if there are no elements.
fun FloatArray.maxWith(
comparator: Comparator<in Float>
): Float?min
Returns the smallest element or null if there are no elements.
fun FloatArray.min(): Float?minBy
Returns the first element yielding the smallest value of the given function or null if there are no elements.
fun <R : Comparable<R>> FloatArray.minBy(
selector: (Float) -> R
): Float?minWith
Returns the first element having the smallest value according to the provided comparator or null if there are no elements.
fun FloatArray.minWith(
comparator: Comparator<in Float>
): Float?none
Returns true if the array has no elements.
fun FloatArray.none(): BooleanReturns true if no elements match the given predicate.
fun FloatArray.none(predicate: (Float) -> Boolean): Booleanrandom
Returns a random element from this array.
fun FloatArray.random(): FloatReturns a random element from this array using the specified source of randomness.
fun FloatArray.random(random: Random): FloatrandomOrNull
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?reduce
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
): FloatreduceIndexed
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
): FloatreduceOrNull
Accumulates value starting with the first element and applying operation from left to right to current accumulator value and each element. Returns null if the array is empty.
fun FloatArray.reduceOrNull(
operation: (acc: Float, Float) -> Float
): Float?reduceRight
Accumulates value starting with last element and applying operation from right to left to each element and current accumulator value.
fun FloatArray.reduceRight(
operation: (Float, acc: Float) -> Float
): FloatreduceRightIndexed
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.
fun FloatArray.reduceRightIndexed(
operation: (index: Int, Float, acc: Float) -> Float
): FloatreduceRightOrNull
Accumulates value starting with last element and applying operation from right to left to each element and current accumulator value. Returns null if the array is empty.
fun FloatArray.reduceRightOrNull(
operation: (Float, acc: Float) -> Float
): Float?refTo
fun FloatArray.refTo(index: Int): CValuesRef<FloatVar>reverse
Reverses elements in the array in-place.
fun FloatArray.reverse()reversed
Returns a list with elements in reversed order.
fun FloatArray.reversed(): List<Float>reversedArray
Returns an array with elements of this array in reversed order.
fun FloatArray.reversedArray(): FloatArrayscan
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 initial value.
fun <R> FloatArray.scan(
initial: R,
operation: (acc: R, Float) -> R
): List<R>scanIndexed
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>scanReduce
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.scanReduce(
operation: (acc: Float, Float) -> Float
): List<Float>scanReduceIndexed
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.scanReduceIndexed(
operation: (index: Int, acc: Float, Float) -> Float
): List<Float>single
Returns the single element, or throws an exception if the array is empty or has more than one element.
fun FloatArray.single(): FloatReturns 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): FloatsingleOrNull
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?slice
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>sliceArray
Returns an array containing elements of this array at specified indices.
fun FloatArray.sliceArray(
indices: Collection<Int>
): FloatArrayReturns an array containing elements at indices in the specified indices range.
fun FloatArray.sliceArray(indices: IntRange): FloatArraysort
Sorts a range in the array in-place.
fun FloatArray.sort(fromIndex: Int = 0, toIndex: Int = size)Sorts the array in-place according to the order specified by the given comparison function.
fun FloatArray.sort(comparison: (a: Float, b: Float) -> Int)sortDescending
Sorts elements in the array in-place descending according to their natural sort order.
fun FloatArray.sortDescending()sorted
Returns a list of all elements sorted according to their natural sort order.
fun FloatArray.sorted(): List<Float>sortedArray
Returns an array with all elements of this array sorted according to their natural sort order.
fun FloatArray.sortedArray(): FloatArraysortedArrayDescending
Returns an array with all elements of this array sorted descending according to their natural sort order.
fun FloatArray.sortedArrayDescending(): FloatArraysortedBy
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>sortedByDescending
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>sortedDescending
Returns a list of all elements sorted descending according to their natural sort order.
fun FloatArray.sortedDescending(): List<Float>sortedWith
Returns a list of all elements sorted according to the specified comparator.
fun FloatArray.sortedWith(
comparator: Comparator<in Float>
): List<Float>subtract
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>sum
Returns the sum of all elements in the array.
fun FloatArray.sum(): FloatsumBy
Returns the sum of all values produced by selector function applied to each element in the array.
fun FloatArray.sumBy(selector: (Float) -> Int): IntsumByDouble
Returns the sum of all values produced by selector function applied to each element in the array.
fun FloatArray.sumByDouble(
selector: (Float) -> Double
): Doubletake
Returns a list containing first n elements.
fun FloatArray.take(n: Int): List<Float>takeLast
Returns a list containing last n elements.
fun FloatArray.takeLast(n: Int): List<Float>takeLastWhile
Returns a list containing last elements satisfying the given predicate.
fun FloatArray.takeLastWhile(
predicate: (Float) -> Boolean
): List<Float>takeWhile
Returns a list containing first elements satisfying the given predicate.
fun FloatArray.takeWhile(
predicate: (Float) -> Boolean
): List<Float>toCollection
Appends all elements to the given destination collection.
fun <C : MutableCollection<in Float>> FloatArray.toCollection(
destination: C
): CtoCValues
fun FloatArray.toCValues(): CValues<FloatVar>toHashSet
Returns a HashSet of all elements.
fun FloatArray.toHashSet(): HashSet<Float>toList
Returns a List containing all elements.
fun FloatArray.toList(): List<Float>toMutableList
Returns a MutableList filled with all elements of this array.
fun FloatArray.toMutableList(): MutableList<Float>toMutableSet
Returns a mutable set containing all distinct elements from the given array.
fun FloatArray.toMutableSet(): MutableSet<Float>toSet
Returns a Set of all elements.
fun FloatArray.toSet(): Set<Float>toSortedSet
Returns a SortedSet of all elements.
fun FloatArray.toSortedSet(): SortedSet<Float>union
Returns a set containing all distinct elements from both collections.
infix fun FloatArray.union(
other: Iterable<Float>
): Set<Float>withIndex
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>>zip
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.
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>