Kubit/kubit.collections.deque/LongDeque

LongDeque

class LongDeque(initialCapacity: Int)(source)

LongDeque is a double-ended queue for Long values backed by a circular buffer.

Amortized O(1) insertion/removal at both ends.
Indexed access, insertion and removal are supported (may shift elements internally).
Not thread-safe: synchronize externally if multiple threads mutate concurrently.

Throws

IllegalArgumentException

if initialCapacity is negative.

Constructors

LongDeque

constructor(initialCapacity: Int)

Creates a deque with the given initialCapacity. The deque grows automatically as needed when elements are added beyond the current capacity.

Properties

lastIndex

val lastIndex: Int

The last valid element index, or -1 when the deque is empty.

size

val size: Int

The number of elements in this deque.

Functions

add

fun add(value: Long)

Adds value to the end of this deque. Alias for addLast.

fun add(index: Int, value: Long)

Inserts value at index. Elements may be shifted to make room for the new element.

addFirst

fun addFirst(value: Long)

Adds value to the front (head) of this deque.

addLast

fun addLast(value: Long)

Adds value to the end of this deque.

asList

fun LongDeque.asList(): List<Long>

Returns a live List view backed by this deque.

asMutableList

fun LongDeque.asMutableList(): MutableList<Long>

Returns a live MutableList view backed by this deque. Structural changes are reflected both ways.

clear

fun clear()

Removes all elements from this deque. Capacity is preserved.

contains

operator fun contains(value: Long): Boolean

Returns true if value exists in this deque.

dequeue

fun dequeue(): Long

Dequeues and returns the front element (queue-style). Alias for removeFirst.

enqueue

fun enqueue(value: Long)

Enqueues value at the end (queue-style). Alias for addLast.

first

fun first(): Long

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

firstOrNull

fun firstOrNull(): Long?

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

forEach

inline fun forEach(action: (Long) -> Unit)

Iterates elements from first to last, invoking action for each element.

forEachIndexed

inline fun forEachIndexed(action: (index: Int, value: Long) -> Unit)

Iterates elements from first to last, passing the logical index and value to action.

forEachReversed

inline fun forEachReversed(action: (Long) -> Unit)

Iterates elements from last to first, invoking action for each element.

forEachReversedIndexed

inline fun forEachReversedIndexed(action: (index: Int, value: Long) -> Unit)

Iterates elements from last to first, passing the logical index and value to action.

get

operator fun get(index: Int): Long

Returns the element at index.

indexOf

fun indexOf(value: Long): Int

Returns the index of the first occurrence of value, or -1 if not found.

isEmpty

inline fun isEmpty(): Boolean

Returns true if this deque contains no elements.

isNotEmpty

inline fun isNotEmpty(): Boolean

Returns true if this deque contains one or more elements.

last

fun last(): Long

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

lastIndexOf

fun lastIndexOf(value: Long): Int

Returns the index of the last occurrence of value, or -1 if not found.

lastOrNull

fun lastOrNull(): Long?

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

pop

fun pop(): Long

Pops and returns the front element (stack-style). Alias for removeFirst.

push

fun push(value: Long)

Pushes value onto the front (stack-style). Alias for addFirst.

removeAt

fun removeAt(index: Int): Long

Removes and returns the element at index. The internal storage may shift elements towards either end to fill the gap.

removeFirst

fun removeFirst(): Long

Removes and returns the first element.

removeFirstOrNull

fun removeFirstOrNull(): Long?

Removes and returns the first element, or null if the deque is empty.

removeLast

fun removeLast(): Long

Removes and returns the last element.

removeLastOrNull

fun removeLastOrNull(): Long?

Removes and returns the last element, or null if the deque is empty.

set

operator fun set(index: Int, value: Long): Long

Replaces the element at index with value.