DoubleList

Artifact: androidx.collection:collection

View Source

Added in 1.5.0-alpha06

Kotlin |Java

Cmn
```
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(initialCapacity: Int)`	Cmn

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

Public properties
`IntRange`	`indices` Returns an `IntRange` of the valid indices for this `DoubleList`.	Cmn
`Int`	`lastIndex` Returns the last valid index in the `DoubleList`.	Cmn
`Int`	`size` The number of elements in the `DoubleList`.	Cmn

Protected constructors

DoubleList

Cmn

protected DoubleList(initialCapacity: Int)

Public functions

any

Cmn

Added in 1.5.0-alpha06

inline fun any(): Boolean

Returns true if there's at least one element in the collection.

any

Cmn

Added in 1.5.0-alpha06

inline fun any(predicate: (element: Double) -> Boolean): Boolean

Returns true if any of the elements give a true return value for predicate.

binarySearch

Cmn

Added in 1.5.0-alpha06

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

Searches this list the specified element in the range defined by fromIndex and toIndex. The list is expected to be sorted into ascending order according to the natural ordering of its elements, otherwise the result is undefined.

fromIndex must be >= 0 and <toIndex, and toIndex must be <= size, otherwise an an IndexOutOfBoundsException will be thrown.

Returns
`Int`	the index of the element if it is contained in the list within the specified range. otherwise, the inverted insertion point `(-insertionPoint - 1)`. The insertion point is defined as the index at which the element should be inserted, so that the list remains sorted.

contains

Cmn

Added in 1.5.0-alpha06

operator fun contains(element: Double): Boolean

Returns true if the DoubleList contains element or false otherwise.

containsAll

Cmn

Added in 1.5.0-alpha06

fun containsAll(elements: DoubleList): Boolean

Returns true if the DoubleList contains all elements in elements or false if one or more are missing.

count

Cmn

Added in 1.5.0-alpha06

inline fun count(): Int

Returns the number of elements in this list.

count

Cmn

Added in 1.5.0-alpha06

inline fun count(predicate: (element: Double) -> Boolean): Int

Counts the number of elements matching predicate.

Returns
`Int`	The number of elements in this list for which `predicate` returns true.

elementAt

Cmn

Added in 1.5.0-alpha06

fun elementAt(index: @IntRange(from = 0) Int): Double

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

elementAtOrElse

Cmn

Added in 1.5.0-alpha06

inline fun elementAtOrElse(
    index: @IntRange(from = 0) Int,
    defaultValue: (index: Int) -> Double
): Double

Returns the element at the given index or defaultValue if index is out of bounds of the collection.

Parameters
`index: Int`	The index of the element whose value should be returned
`defaultValue: (index: Int) -> Double`	A lambda to call with `index` as a parameter to return a value at an index not in the list.

equals

Cmn

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

Returns true if other is a DoubleList and the contents of this and other are the same.

first

Cmn

Added in 1.5.0-alpha06

fun first(): Double

Returns the first element in the DoubleList or throws a NoSuchElementException if it isEmpty.

first

Cmn

Added in 1.5.0-alpha06

inline fun first(predicate: (element: Double) -> Boolean): Double

Returns the first element in the DoubleList for which predicate returns true or throws NoSuchElementException if nothing matches.

See also
`indexOfFirst`

fold

Cmn

Added in 1.5.0-alpha06

inline fun <R : Any?> fold(initial: R, operation: (acc, element: Double) -> R): R

Accumulates values, starting with initial, and applying operation to each element in the DoubleList in order.

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

foldIndexed

Cmn

Added in 1.5.0-alpha06

inline fun <R : Any?> foldIndexed(initial: R, operation: (index: Int, acc, element: Double) -> R): R

Accumulates values, starting with initial, and applying operation to each element in the DoubleList in order.

foldRight

Cmn

Added in 1.5.0-alpha06

inline fun <R : Any?> foldRight(initial: R, operation: (element: Double, acc) -> R): R

Accumulates values, starting with initial, and applying operation to each element in the DoubleList in reverse order.

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

foldRightIndexed

Cmn

Added in 1.5.0-alpha06

inline fun <R : Any?> foldRightIndexed(
    initial: R,
    operation: (index: Int, element: Double, acc) -> R
): R

Accumulates values, starting with initial, and applying operation to each element in the DoubleList in reverse order.

forEach

Cmn

Added in 1.5.0-alpha06

inline fun forEach(block: (element: Double) -> Unit): Unit

Calls block for each element in the DoubleList, in order.

Parameters
`block: (element: Double) -> Unit`	will be executed for every element in the list, accepting an element from the list

forEachIndexed

Cmn

Added in 1.5.0-alpha06

inline fun forEachIndexed(block: (index: Int, element: Double) -> Unit): Unit

Calls block for each element in the DoubleList along with its index, in order.

Parameters
`block: (index: Int, element: Double) -> Unit`	will be executed for every element in the list, accepting the index and the element at that index.

forEachReversed

Cmn

Added in 1.5.0-alpha06

inline fun forEachReversed(block: (element: Double) -> Unit): Unit

Calls block for each element in the DoubleList in reverse order.

Parameters
`block: (element: Double) -> Unit`	will be executed for every element in the list, accepting an element from the list

forEachReversedIndexed

Cmn

Added in 1.5.0-alpha06

inline fun forEachReversedIndexed(block: (index: Int, element: Double) -> Unit): Unit

Calls block for each element in the DoubleList along with its index, in reverse order.

Parameters
`block: (index: Int, element: Double) -> Unit`	will be executed for every element in the list, accepting the index and the element at that index.

get

Cmn

Added in 1.5.0-alpha06

operator fun get(index: @IntRange(from = 0) Int): Double

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

hashCode

Cmn

open fun hashCode(): Int

Returns a hash code based on the contents of the DoubleList.

indexOf

Cmn

Added in 1.5.0-alpha06

fun indexOf(element: Double): Int

Returns the index of element in the DoubleList or -1 if element is not there.

indexOfFirst

Cmn

Added in 1.5.0-alpha06

inline fun indexOfFirst(predicate: (element: Double) -> Boolean): Int

Returns the index if the first element in the DoubleList for which predicate returns true.

indexOfLast

Cmn

Added in 1.5.0-alpha06

inline fun indexOfLast(predicate: (element: Double) -> Boolean): Int

Returns the index if the last element in the DoubleList for which predicate returns true.

isEmpty

Cmn

Added in 1.5.0-alpha06

inline fun isEmpty(): Boolean

Returns true if the DoubleList has no elements in it or false otherwise.

isNotEmpty

Cmn

Added in 1.5.0-alpha06

inline fun isNotEmpty(): Boolean

Returns true if there are elements in the DoubleList or false if it is empty.

joinToString

Cmn

Added in 1.5.0-alpha06

fun joinToString(
    separator: CharSequence = ", ",
    prefix: CharSequence = "",
    postfix: CharSequence = "",
    limit: Int = -1,
    truncated: CharSequence = "..."
): String

Creates a String from the elements separated by separator and using prefix before and postfix after, if supplied.

When a non-negative value of limit is provided, a maximum of limit items are used to generate the string. If the collection holds more than limit items, the string is terminated with truncated.

joinToString

Cmn

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

Creates a String from the elements separated by separator and using prefix before and postfix after, if supplied. transform dictates how each element will be represented.

last

Cmn

Added in 1.5.0-alpha06

fun last(): Double

Returns the last element in the DoubleList or throws a NoSuchElementException if it isEmpty.

last

Cmn

Added in 1.5.0-alpha06

inline fun last(predicate: (element: Double) -> Boolean): Double

Returns the last element in the DoubleList for which predicate returns true or throws NoSuchElementException if nothing matches.

See also
`indexOfLast`

lastIndexOf

Cmn

Added in 1.5.0-alpha06

fun lastIndexOf(element: Double): Int

Returns the index of the last element in the DoubleList that is the same as element or -1 if no elements match.

none

Cmn

Added in 1.5.0-alpha06

inline fun none(): Boolean

Returns true if the collection has no elements in it.

reversedAny

Cmn

Added in 1.5.0-alpha06

inline fun reversedAny(predicate: (element: Double) -> Boolean): Boolean

Returns true if any of the elements give a true return value for predicate while iterating in the reverse order.

toString

Cmn

open fun toString(): String

Returns a String representation of the list, surrounded by "[]" and each element separated by ", ".

Public properties

indices

Cmn

Added in 1.5.0-alpha06

val indices: IntRange

Returns an IntRange of the valid indices for this DoubleList.

lastIndex

Cmn

Added in 1.5.0-alpha06

val lastIndex: Int

Returns the last valid index in the DoubleList. This can be -1 when the list is empty.

size

Cmn

Added in 1.5.0-alpha06

val size: Int

The number of elements in the DoubleList.