DoubleList

Artifact: androidx.collection:collection

Kotlin |Java

public sealed class DoubleList

Known direct subclasses

MutableDoubleList

MutableDoubleList

MutableDoubleList is a MutableList-like collection for Double values.

DoubleList is a List-like collection for Double values. It allows retrieving the elements without boxing. DoubleList is always backed by a MutableDoubleList, its MutableList-like subclass. The purpose of this class is to avoid the performance overhead of auto-boxing due to generics since Collection classes all operate on objects.

This implementation is not thread-safe: if multiple threads access this container concurrently, and one or more threads modify the structure of the list (insertion or removal for instance), the calling code must provide the appropriate synchronization. It is also not safe to mutate during reentrancy -- in the middle of a forEach, for example. However, concurrent reads are safe.

Summary

Protected constructors
`DoubleList(int initialCapacity)`

Public methods
`final boolean`	`any()` Returns `true` if there's at least one element in the collection.
`final boolean`	`any(@NonNull Function1<@NonNull Double, @NonNull Boolean> predicate)` Returns `true` if any of the elements give a `true` return value for `predicate`.
`final int`	`binarySearch(int element, int fromIndex, int toIndex)` Searches this list the specified element in the range defined by `fromIndex` and `toIndex`.
`final boolean`	`contains(double element)` Returns `true` if the `DoubleList` contains `element` or `false` otherwise.
`final boolean`	`containsAll(@NonNull DoubleList elements)` Returns `true` if the `DoubleList` contains all elements in `elements` or `false` if one or more are missing.
`final int`	`count()` Returns the number of elements in this list.
`final int`	`count(@NonNull Function1<@NonNull Double, @NonNull Boolean> predicate)` Counts the number of elements matching `predicate`.
`final double`	`elementAt(@IntRange(from = 0) int index)` Returns the element at the given `index` or throws `IndexOutOfBoundsException` if the `index` is out of bounds of this collection.
`final double`	`elementAtOrElse( @IntRange(from = 0) int index, @NonNull Function1<@NonNull Integer, @NonNull Double> defaultValue )` Returns the element at the given `index` or `defaultValue` if `index` is out of bounds of the collection.
`boolean`	`equals(Object other)` Returns `true` if `other` is a `DoubleList` and the contents of this and `other` are the same.
`final double`	`first()` Returns the first element in the `DoubleList` or throws a `NoSuchElementException` if it `isEmpty`.
`final double`	`first(@NonNull Function1<@NonNull Double, @NonNull Boolean> predicate)` Returns the first element in the `DoubleList` for which `predicate` returns `true` or throws `NoSuchElementException` if nothing matches.
`final @NonNull R`	`<R extends Object> fold( @NonNull R initial, @NonNull Function2<@NonNull acc, @NonNull Double, @NonNull R> operation )` Accumulates values, starting with `initial`, and applying `operation` to each element in the `DoubleList` in order.
`final @NonNull R`	`<R extends Object> foldIndexed( @NonNull R initial, @NonNull Function3<@NonNull Integer, @NonNull acc, @NonNull Double, @NonNull R> operation )` Accumulates values, starting with `initial`, and applying `operation` to each element in the `DoubleList` in order.
`final @NonNull R`	`<R extends Object> foldRight( @NonNull R initial, @NonNull Function2<@NonNull Double, @NonNull acc, @NonNull R> operation )` Accumulates values, starting with `initial`, and applying `operation` to each element in the `DoubleList` in reverse order.
`final @NonNull R`	`<R extends Object> foldRightIndexed( @NonNull R initial, @NonNull Function3<@NonNull Integer, @NonNull Double, @NonNull acc, @NonNull R> operation )` Accumulates values, starting with `initial`, and applying `operation` to each element in the `DoubleList` in reverse order.
`final void`	`forEach(@NonNull Function1<@NonNull Double, Unit> block)` Calls `block` for each element in the `DoubleList`, in order.
`final void`	`forEachIndexed( @NonNull Function2<@NonNull Integer, @NonNull Double, Unit> block )` Calls `block` for each element in the `DoubleList` along with its index, in order.
`final void`	`forEachReversed(@NonNull Function1<@NonNull Double, Unit> block)` Calls `block` for each element in the `DoubleList` in reverse order.
`final void`	`forEachReversedIndexed( @NonNull Function2<@NonNull Integer, @NonNull Double, Unit> block )` Calls `block` for each element in the `DoubleList` along with its index, in reverse order.
`final double`	`get(@IntRange(from = 0) int index)` Returns the element at the given `index` or throws `IndexOutOfBoundsException` if the `index` is out of bounds of this collection.
`final @NonNull IntRange`	`getIndices()` Returns an `IntRange` of the valid indices for this `DoubleList`.
`final @IntRange(from = -1) int`	`getLastIndex()` Returns the last valid index in the `DoubleList`.
`final @IntRange(from = 0) int`	`getSize()` The number of elements in the `DoubleList`.
`int`	`hashCode()` Returns a hash code based on the contents of the `DoubleList`.
`final int`	`indexOf(double element)` Returns the index of `element` in the `DoubleList` or `-1` if `element` is not there.
`final int`	`indexOfFirst( @NonNull Function1<@NonNull Double, @NonNull Boolean> predicate )` Returns the index if the first element in the `DoubleList` for which `predicate` returns `true`.
`final int`	`indexOfLast(@NonNull Function1<@NonNull Double, @NonNull Boolean> predicate)` Returns the index if the last element in the `DoubleList` for which `predicate` returns `true`.
`final boolean`	`isEmpty()` Returns `true` if the `DoubleList` has no elements in it or `false` otherwise.
`final boolean`	`isNotEmpty()` Returns `true` if there are elements in the `DoubleList` or `false` if it is empty.
`final @NonNull String`	`joinToString( @NonNull CharSequence separator, @NonNull CharSequence prefix, @NonNull CharSequence postfix, int limit, @NonNull CharSequence truncated )` Creates a String from the elements separated by `separator` and using `prefix` before and `postfix` after, if supplied.
`final @NonNull String`	`joinToString( @NonNull CharSequence separator, @NonNull CharSequence prefix, @NonNull CharSequence postfix, int limit, @NonNull CharSequence truncated, @NonNull Function1<@NonNull Double, @NonNull CharSequence> transform )` Creates a String from the elements separated by `separator` and using `prefix` before and `postfix` after, if supplied.
`final double`	`last()` Returns the last element in the `DoubleList` or throws a `NoSuchElementException` if it `isEmpty`.
`final double`	`last(@NonNull Function1<@NonNull Double, @NonNull Boolean> predicate)` Returns the last element in the `DoubleList` for which `predicate` returns `true` or throws `NoSuchElementException` if nothing matches.
`final int`	`lastIndexOf(double element)` Returns the index of the last element in the `DoubleList` that is the same as `element` or `-1` if no elements match.
`final boolean`	`none()` Returns `true` if the collection has no elements in it.
`final boolean`	`reversedAny(@NonNull Function1<@NonNull Double, @NonNull Boolean> predicate)` Returns `true` if any of the elements give a `true` return value for `predicate` while iterating in the reverse order.
`@NonNull String`	`toString()` Returns a String representation of the list, surrounded by "[]" and each element separated by ", ".

Protected constructors

DoubleList

protected DoubleList(int initialCapacity)

Parameters
`index: int`	The index of the element whose value should be returned
`@NonNull Function1<@NonNull Integer, @NonNull Double> defaultValue`	A lambda to call with `index` as a parameter to return a value at an index not in the list.

Parameters
`@NonNull R initial`	The value of `acc` for the first call to `operation` or return value if there are no elements in this list.
`@NonNull Function2<@NonNull acc, @NonNull Double, @NonNull R> operation`	function that takes current accumulator value and an element, and calculates the next accumulator value.

Parameters
`@NonNull R initial`	The value of `acc` for the first call to `operation` or return value if there are no elements in this list.
`@NonNull Function2<@NonNull Double, @NonNull acc, @NonNull R> operation`	function that takes an element and the current accumulator value, and calculates the next accumulator value.

DoubleList

Summary

Protected constructors

Public methods

Protected constructors

DoubleList

Public methods

any

any

binarySearch

contains

containsAll

count

count

elementAt

elementAtOrElse

equals

first

first

fold

foldIndexed

foldRight

foldRightIndexed

forEach

forEachIndexed

forEachReversed

forEachReversedIndexed

get

getIndices

getLastIndex

getSize

hashCode

indexOf

indexOfFirst

indexOfLast

isEmpty

isNotEmpty

joinToString

joinToString

last

last

lastIndexOf

none

reversedAny

toString