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

Common

fun ArrayDeque(initialCapacity: Int)

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

ArrayDeque

Common

fun ArrayDeque()

Constructs an empty deque.

ArrayDeque

Common

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

Common

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

Common

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

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

addFirst

Common

fun addFirst(element: E)

Prepends the specified element to this deque.

addLast

Common

fun addLast(element: E)

Appends the specified element to this deque.

clear

Common

open override fun clear()

contains

Common

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

containsAll

Common

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

first

Common

fun first(): E

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

firstOrNull

Common

fun firstOrNull(): E?

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

get

Common

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

indexOf

Common

open override fun indexOf(element: E): Int

isEmpty

Common

open override fun isEmpty(): Boolean

iterator

Common

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

last

Common

fun last(): E

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

lastIndexOf

Common

open override fun lastIndexOf(element: E): Int

lastOrNull

Common

fun lastOrNull(): E?

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

listIterator

Common

open override fun listIterator(): MutableListIterator<E>

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

remove

Common

open override fun remove(element: E): Boolean

removeAll

Common

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

removeAt

Common

open override fun removeAt(index: Int): E

removeFirst

Common

fun removeFirst(): E

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

removeFirstOrNull

Common

fun removeFirstOrNull(): E?

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

removeLast

Common

fun removeLast(): E

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

removeLastOrNull

Common

fun removeLastOrNull(): E?

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

retainAll

Common

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

set

Common

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

subList

Common

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

toArray

Common

open fun toArray(): Array<Any?>

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

Properties

size

Common

open override var size: Int = 0