CircularArray
public final class CircularArray<E extends Object>
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.
Summary
Public constructors |
|---|
<E extends Object> CircularArray(int minCapacity)Creates a circular array with capacity for at least |
Public methods |
|
|---|---|
final void |
Add an element in front of the |
final void |
Add an element at end of the CircularArray. |
final void |
clear()Remove all elements from the |
final @NonNull E |
get(int index)Get nth (0 <= n <= size()-1) element of the |
final @NonNull E |
getFirst()Get first element of the |
final @NonNull E |
getLast()Get last element of the |
final boolean |
isEmpty()Return |
final @NonNull E |
popFirst()Remove first element from front of the |
final @NonNull E |
popLast()Remove last element from end of the |
final void |
removeFromEnd(int count)Remove multiple elements from end of the |
final void |
removeFromStart(int count)Remove multiple elements from front of the |
final int |
size()Get number of elements in the |
Public constructors
CircularArray
public <E extends Object> CircularArray(int minCapacity)
Creates a circular array with capacity for at least minCapacity elements.
| Parameters | |
|---|---|
int minCapacity |
the minimum capacity, between 1 and 2^30 inclusive |
Public methods
addFirst
public final void addFirst(@NonNull E element)
Add an element in front of the CircularArray.
| Parameters | |
|---|---|
@NonNull E element |
Element to add. |
addLast
public final void addLast(@NonNull E element)
Add an element at end of the CircularArray.
| Parameters | |
|---|---|
@NonNull E element |
Element to add. |
get
public final @NonNull E get(int index)
Get nth (0 <= n <= size()-1) element of the CircularArray.
| Parameters | |
|---|---|
int index |
The zero based element index in the |
| Returns | |
|---|---|
@NonNull E |
The nth element. |
| Throws | |
|---|---|
kotlin.IndexOutOfBoundsException |
if n < 0 or n >= size() |
getFirst
public final @NonNull E getFirst()
Get first element of the CircularArray.
| Returns | |
|---|---|
@NonNull E |
The first element. |
| Throws | |
|---|---|
kotlin.IndexOutOfBoundsException |
if |
getLast
public final @NonNull E getLast()
Get last element of the CircularArray.
| Returns | |
|---|---|
@NonNull E |
The last element. |
| Throws | |
|---|---|
kotlin.IndexOutOfBoundsException |
if |
isEmpty
public final boolean isEmpty()
Return true if size is 0.
| Returns | |
|---|---|
boolean |
|
popFirst
public final @NonNull E popFirst()
Remove first element from front of the CircularArray and return it.
| Returns | |
|---|---|
@NonNull E |
The element removed. |
| Throws | |
|---|---|
kotlin.IndexOutOfBoundsException |
if |
popLast
public final @NonNull E popLast()
Remove last element from end of the CircularArray and return it.
| Returns | |
|---|---|
@NonNull E |
The element removed. |
| Throws | |
|---|---|
kotlin.IndexOutOfBoundsException |
if |
removeFromEnd
public final void removeFromEnd(int count)
Remove multiple elements from end of the CircularArray, ignore when count is less than or equals to 0.
| Parameters | |
|---|---|
int count |
Number of elements to remove. |
removeFromStart
public final void removeFromStart(int count)
Remove multiple elements from front of the CircularArray, ignore when count is less than or equal to 0.
| Parameters | |
|---|---|
int count |
Number of elements to remove. |
size
public final int size()
Get number of elements in the CircularArray.
| Returns | |
|---|---|
int |
Number of elements in the |