kone.collections/dev.lounres.kone.collections.deque/KoneDeque

KoneDeque

Represents a finite sequence of elements that can be extended or reduced from both its ends.

This interface's inheritors must have some specific structure that provides optimised elements access and mutability. Without it (or with bad time complexity like \(O(n)\)) the interface should not be used.

Inheritors

KoneListBackedDeque

Properties

size

abstract val size: UInt

Number of elements in the collection.

Functions

addFirst

abstract fun addFirst(element: Element)

Adds the element to the beginning of the collection, making it the first element in the collection.

addLast

abstract fun addLast(element: Element)

Adds the element to the end of the collection, making it the last element in the collection.

getFirst

abstract fun getFirst(): Element

Returns the first element. The element is placed at the beginning of the sequence.

getLast

abstract fun getLast(): Element

Returns the last element. The element is placed at the end of the sequence.

isEmpty

fun KoneDeque<*>.isEmpty(): Boolean

Checks if the collection is empty.

isNotEmpty

fun KoneDeque<*>.isNotEmpty(): Boolean

Checks if the collection is not empty.

popFirst

fun <Element> KoneDeque<out Element>.popFirst(): Element

Returns and removes the first element. The element was placed at the beginning of the sequence.

popLast

fun <Element> KoneDeque<out Element>.popLast(): Element

Returns and removes the last element. The element was placed at the end of the sequence.

removeAll

abstract fun removeAll()

Removes all elements from the collection.

removeFirst

abstract fun removeFirst()

Removes the first element, making the collection one element fewer. The element is placed at the beginning of the sequence.

removeLast

abstract fun removeLast()

Removes the last element, making the collection one element fewer. The element is placed at the end of the sequence.