kotlin-stdlib/kotlin.collections/ArrayDeque

ArrayDeque

class ArrayDeque<E> : AbstractMutableList<E>

Resizable-array implementation of the deque data structure.

The name deque is short for "double ended queue" and is usually pronounced "deck".

The collection provide methods for convenient access to the both ends. It also implements MutableList interface and supports efficient get/set operations by index.

Since Kotlin

1.4

Constructors

ArrayDeque

fun ArrayDeque(initialCapacity: Int)

Constructs an empty deque with specified initialCapacity, or throws IllegalArgumentException if initialCapacity is negative.

ArrayDeque

fun ArrayDeque()

Constructs an empty deque.

ArrayDeque

fun <E> ArrayDeque(elements: Collection<E>)

Constructs a deque that contains the same elements as the specified elements collection in the same order.

Functions

add

open override fun add(element: E): Boolean

Adds the specified element to the end of this list.

open override fun add(index: Int, element: E)

addAll

open override fun addAll(elements: Collection<E>): Boolean

open override fun addAll(index: Int, elements: Collection<E>): Boolean

addFirst

fun addFirst(element: E)

Prepends the specified element to this deque.

addLast

fun addLast(element: E)

Appends the specified element to this deque.

clear

open override fun clear()

contains

open operator override fun contains(element: E): Boolean

containsAll

expect open override fun containsAll(elements: Collection<E>): Boolean

first

fun first(): E

Returns the first element, or throws NoSuchElementException if this deque is empty.

firstOrNull

fun firstOrNull(): E?

Returns the first element, or null if this deque is empty.

get

open operator override fun get(index: Int): E

indexOf

open override fun indexOf(element: E): Int

isEmpty

open override fun isEmpty(): Boolean

iterator

expect open operator override fun iterator(): MutableIterator<E>

last

fun last(): E

Returns the last element, or throws NoSuchElementException if this deque is empty.

lastIndexOf

open override fun lastIndexOf(element: E): Int

lastOrNull

fun lastOrNull(): E?

Returns the last element, or null if this deque is empty.

listIterator

expect open override fun listIterator(): MutableListIterator<E>

expect open override fun listIterator(index: Int): MutableListIterator<E>

remove

open override fun remove(element: E): Boolean

removeAll

open override fun removeAll(elements: Collection<E>): Boolean

removeAt

open override fun removeAt(index: Int): E

removeFirst

fun removeFirst(): E

Removes the first element from this deque and returns that removed element, or throws NoSuchElementException if this deque is empty.

removeFirstOrNull

fun removeFirstOrNull(): E?

Removes the first element from this deque and returns that removed element, or returns null if this deque is empty.

removeLast

fun removeLast(): E

Removes the last element from this deque and returns that removed element, or throws NoSuchElementException if this deque is empty.

removeLastOrNull

fun removeLastOrNull(): E?

Removes the last element from this deque and returns that removed element, or returns null if this deque is empty.

retainAll

open override fun retainAll(elements: Collection<E>): Boolean

set

open operator override fun set(index: Int, element: E): E

subList

expect open override fun subList(fromIndex: Int, toIndex: Int): MutableList<E>

toArray

open fun toArray(): Array<Any?>

open fun <T> toArray(array: Array<T>): Array<T>

Properties

size

open override var size: Int = 0