collection/androidx.collection/CircularArray

CircularArray

class CircularArray<E> constructor(minCapacity: Int = 8)(source)

CircularArray is a generic circular array data structure that provides O(1) random read, O(1) prepend and O(1) append. The CircularArray automatically grows its capacity when number of added items is over its capacity.

Parameters

minCapacity

the minimum capacity, between 1 and 2^30 inclusive

Constructors

CircularArray

fun CircularArray(minCapacity: Int = 8)

Creates a circular array with capacity for at least minCapacity elements.

Functions

addFirst

fun addFirst(element: E)

Add an element in front of the CircularArray.

addLast

fun addLast(element: E)

Add an element at end of the CircularArray.

clear

fun clear()

Remove all elements from the CircularArray.

get

operator fun get(index: Int): E

Get nth (0 <= n <= size()-1) element of the CircularArray.

isEmpty

fun isEmpty(): Boolean

Return true if size is 0.

popFirst

fun popFirst(): E

Remove first element from front of the CircularArray and return it.

popLast

fun popLast(): E

Remove last element from end of the CircularArray and return it.

removeFromEnd

fun removeFromEnd(count: Int)

Remove multiple elements from end of the CircularArray, ignore when count is less than or equals to 0.

removeFromStart

fun removeFromStart(count: Int)

Remove multiple elements from front of the CircularArray, ignore when count is less than or equal to 0.

size

fun size(): Int

Get number of elements in the CircularArray.

Properties

first

val first: E

Get first element of the CircularArray.

last

val last: E

Get last element of the CircularArray.